feat: add support for picking storage config from settings

edx_sga/sga.py

@@ -19,7 +19,6 @@
 from django.conf import settings
 from django.core.exceptions import PermissionDenied
 from django.core.files import File
-from django.core.files.storage import default_storage
 from django.template import Context, Template
 from django.utils.encoding import force_str
 from django.utils.timezone import now as django_now
@@ -44,6 +43,7 @@
 from edx_sga.tasks import get_zip_file_name, get_zip_file_path, zip_student_submissions
 from edx_sga.utils import (
     file_contents_iter,
+    get_default_storage,
     get_file_modified_time_utc,
     get_file_storage_path,
     get_sha1,
@@ -53,6 +53,8 @@
 
 log = logging.getLogger(__name__)
 
+default_storage = get_default_storage()
+
 
 def reify(meth):
     """

edx_sga/tasks.py

@@ -6,17 +6,18 @@
 import tempfile
 import zipfile
 
-from django.core.files.storage import default_storage
 from celery import shared_task
 from opaque_keys.edx.locator import BlockUsageLocator
 from common.djangoapps.student.models import user_by_anonymous_id
 from submissions import api as submissions_api
 
 from edx_sga.constants import ITEM_TYPE
-from edx_sga.utils import get_file_storage_path, is_finalized_submission
+from edx_sga.utils import get_default_storage, get_file_storage_path, is_finalized_submission
 
 log = logging.getLogger(__name__)
 
+default_storage = get_default_storage()
+
 
 def _get_student_submissions(block_id, course_id, locator):
     """

edx_sga/tests/test_utils.py

@@ -1,11 +1,14 @@
 """
 Tests for SGA utility functions
 """
+from django.test import override_settings
+from django.core.files.storage import default_storage
 import pytest
 import pytz
+from storages.backends.s3boto3 import S3Boto3Storage
 
 from edx_sga.tests.common import is_near_now
-from edx_sga.utils import is_finalized_submission, utcnow
+from edx_sga.utils import get_default_storage, is_finalized_submission, utcnow
 
 
 @pytest.mark.parametrize(
@@ -31,3 +34,24 @@ def test_utcnow():
     now = utcnow()
     assert is_near_now(now)
     assert now.tzinfo.zone == pytz.utc.zone
+
+@override_settings(SGA_STORAGE_SETTINGS={
+        'STORAGE_CLASS': 'storages.backends.s3boto3.S3Boto3Storage',
+        'STORAGE_KWARGS':
+            {'bucket_name': 'test', 'location': 'abc/def'}
+    })
+def test_get_default_storage_with_settings_override():
+    """
+    get_default_storage should return an S3Boto3Storage object
+    """
+    storage = get_default_storage()
+    assert storage.__class__ == S3Boto3Storage
+    # make sure kwargs are passed through constructor
+    assert storage.bucket.name == 'test'
+
+def test_get_default_storage_without_settings_override():
+    """
+    get_default_storage should return default_storage object
+    """
+    storage = get_default_storage()
+    assert storage == default_storage

edx_sga/utils.py

@@ -9,10 +9,34 @@
 
 import pytz
 from django.conf import settings
-from django.core.files.storage import default_storage
+from django.core.files.storage import default_storage as django_default_storage, get_storage_class
 from edx_sga.constants import BLOCK_SIZE
 
 
+def get_default_storage():
+    """
+    Get config for storage from settings, use Django's default_storage if no such settings are defined
+    """
+    # .. setting_name: SGA_STORAGE_SETTINGS
+    # .. setting_default: {}
+    # .. setting_description: Specifies the storage class and keyword arguments to use in the constructor
+    #    Default storage will be used if this settings in not specified.
+    # .. setting_example: {
+    #        STORAGE_CLASS: 'storage',
+    #        STORAGE_KWARGS: {}
+    #    }
+    sga_storage_settings = getattr(settings, "SGA_STORAGE_SETTINGS", None)
+
+    if sga_storage_settings:
+        return get_storage_class(
+            sga_storage_settings['STORAGE_CLASS']
+        )(**sga_storage_settings['STORAGE_KWARGS'])
+
+    # If settings not defined, use default_storage from Django
+    return django_default_storage
+
+default_storage = get_default_storage()
+
 def utcnow():
     """
     Get current date and time in UTC

test_requirements.txt

@@ -4,6 +4,7 @@ coverage==7.2.7
 cryptography==41.0.1
 ddt==1.6.0
 djangorestframework
+django-storages
 edx-celeryutils==1.2.2
 edx-lint==5.2.4
 edx-opaque-keys