feat: update file storage access to support Django 5.0 storages registry

Author: dwong2708

cms/djangoapps/contentstore/storage.py

@@ -4,7 +4,7 @@
 
 
 from django.conf import settings
-from django.core.files.storage import get_storage_class
+from common.djangoapps.util.storage import resolve_storage_backend
 from storages.backends.s3boto3 import S3Boto3Storage
 from storages.utils import setting
 
@@ -19,4 +19,7 @@ def __init__(self):
         super().__init__(bucket_name=bucket, custom_domain=None, querystring_auth=True)
 
 # pylint: disable=invalid-name
-course_import_export_storage = get_storage_class(settings.COURSE_IMPORT_EXPORT_STORAGE)()
+course_import_export_storage = resolve_storage_backend(
+    storage_key="course_import_export",
+    legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE"
+)

cms/djangoapps/contentstore/tests/test_import.py

@@ -21,6 +21,9 @@
 from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
 from xmodule.modulestore.xml_importer import import_course_from_xml
 
+from common.djangoapps.util.storage import resolve_storage_backend
+from storages.backends.s3boto3 import S3Boto3Storage
+
 TEST_DATA_CONTENTSTORE = copy.deepcopy(settings.CONTENTSTORE)
 TEST_DATA_CONTENTSTORE['DOC_STORE_CONFIG']['db'] = 'test_xcontent_%s' % uuid4().hex
 
@@ -275,3 +278,81 @@ def test_video_components_present_while_import(self):
 
         video = module_store.get_item(vertical.children[1])
         self.assertEqual(video.display_name, 'default')
+
+    @override_settings(
+        COURSE_IMPORT_EXPORT_STORAGE="cms.djangoapps.contentstore.storage.ImportExportS3Storage",
+        DEFAULT_FILE_STORAGE="django.core.files.storage.FileSystemStorage"
+    )
+    def test_resolve_default_storage(self):
+        """ Ensure the default storage is invoked, even if course export storage is configured """
+        storage = resolve_storage_backend(
+            storage_key="default",
+            legacy_setting_key="DEFAULT_FILE_STORAGE"
+        )
+        self.assertEqual(storage.__class__.__name__, "FileSystemStorage")
+
+    @override_settings(
+        COURSE_IMPORT_EXPORT_STORAGE="cms.djangoapps.contentstore.storage.ImportExportS3Storage",
+        DEFAULT_FILE_STORAGE="django.core.files.storage.FileSystemStorage",
+        COURSE_IMPORT_EXPORT_BUCKET="bucket_name_test"
+    )
+    def test_resolve_happy_path_storage(self):
+        """ Make sure that the correct course export storage is being used """
+        storage = resolve_storage_backend(
+            storage_key="course_import_export",
+            legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE"
+        )
+        self.assertEqual(storage.__class__.__name__, "ImportExportS3Storage")
+        self.assertEqual(storage.bucket_name, "bucket_name_test")
+
+    @override_settings()
+    def test_resolve_storage_with_no_config(self):
+        """ If no storage setup is defined, we get FileSystemStorage by default """
+        del settings.DEFAULT_FILE_STORAGE
+        del settings.COURSE_IMPORT_EXPORT_STORAGE
+        del settings.COURSE_IMPORT_EXPORT_BUCKET
+        storage = resolve_storage_backend(
+            storage_key="course_import_export",
+            legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE"
+        )
+        self.assertEqual(storage.__class__.__name__, "FileSystemStorage")
+
+    @override_settings(
+        COURSE_IMPORT_EXPORT_STORAGE=None,
+        COURSE_IMPORT_EXPORT_BUCKET="bucket_name_test",
+        STORAGES={
+            'COURSE_IMPORT_EXPORT_STORAGE': {
+                'BACKEND': 'cms.djangoapps.contentstore.storage.ImportExportS3Storage',
+                'OPTIONS': {}
+            }
+        }
+    )
+    def test_resolve_storage_using_django5_settings(self):
+        """ Simulating a Django 4 environment using Django 5 Storages configuration """
+        storage = resolve_storage_backend(
+            storage_key="course_import_export",
+            legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE"
+        )
+        self.assertEqual(storage.__class__.__name__, "ImportExportS3Storage")
+        self.assertEqual(storage.bucket_name, "bucket_name_test")
+
+    @override_settings(
+        STORAGES={
+            'course_import_export': {
+                'BACKEND': 'storages.backends.s3boto3.S3Boto3Storage',
+                'OPTIONS': {
+                    'bucket_name': 'bucket_name_test'
+                }
+            }
+        }
+    )
+    def test_resolve_storage_using_django5_settings_with_options(self):
+        """ Ensure we call the storage class with the correct parameters and Django 5 setup """
+        del settings.COURSE_IMPORT_EXPORT_STORAGE
+        del settings.COURSE_IMPORT_EXPORT_BUCKET
+        storage = resolve_storage_backend(
+            storage_key="course_import_export",
+            legacy_setting_key="COURSE_IMPORT_EXPORT_STORAGE"
+        )
+        self.assertEqual(storage.__class__.__name__, S3Boto3Storage.__name__)
+        self.assertEqual(storage.bucket_name, "bucket_name_test")

common/djangoapps/util/storage.py

@@ -0,0 +1,59 @@
+""" Utility functions related to django storages """
+
+from typing import Optional
+from django.conf import settings
+from django.core.files.storage import default_storage, storages
+from django.utils.module_loading import import_string
+
+
+def resolve_storage_backend(storage_key: str, legacy_setting_key: str, options: Optional[dict] = None):
+    """
+    Configures and returns a Django `Storage` instance, compatible with both Django 4 and Django 5.
+    Params:
+        storage_key = The key name saved in Django storages settings.
+        legacy_setting_key = The key name saved in Django settings.
+        options = Kwargs for the storage class.
+    Returns:
+        An instance of the configured storage backend.
+    Raises:
+        ImportError: If the specified storage class cannot be imported.
+    Main goal:
+        Deprecate the use of `django.core.files.storage.get_storage_class`.
+    How:
+        Replace `get_storage_class` with direct configuration logic,
+        ensuring backward compatibility with both Django 4 and Django 5 storage settings.
+    """
+
+    storage_path = getattr(settings, legacy_setting_key, None)
+    storages_config = getattr(settings, 'STORAGES', {})
+
+    if options is None:
+        options = {}
+
+    if storage_key == "default":
+        # Use case 1: Default storage
+        # Works consistently across Django 4.2 and 5.x.
+        # In Django 4.2 and above, `default_storage` uses
+        # either `DEFAULT_FILE_STORAGE` or `STORAGES['default']`.
+        return default_storage
+
+    if storage_key in storages_config:
+        # Use case 2: STORAGES is defined
+        # If STORAGES is present, we retrieve it through the storages API
+        # settings.py must define STORAGES like:
+        # STORAGES = {
+        #     "default": {"BACKEND": "...", "OPTIONS": {...}},
+        #     "custom": {"BACKEND": "...", "OPTIONS": {...}},
+        # }
+        # See: https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-STORAGES
+        return storages[storage_key]
+
+    if not storage_path:
+        # Use case 3: No storage settings defined
+        # If no storage settings are defined anywhere, use the default storage
+        return default_storage
+
+    # Use case 4: Legacy settings
+    # Fallback to import the storage_path (Obtained from django settings) manually
+    StorageClass = import_string(storage_path)
+    return StorageClass(**options)