Merge pull request #169 from open-craft/artur/aws-region

feat: support for specifying AWS region

Author: dianakhuang

CHANGELOG.rst

@@ -14,6 +14,14 @@ Change Log
 Unreleased
 **********
 
+3.5.0
+*****
+
+Added
+=====
+
+* feat: support for specifying AWS region
+
 3.4.1
 *****
 

djpyfs/__init__.py

@@ -1,3 +1,3 @@
 # pylint: disable=django-not-configured
 """init file"""
-__version__ = '3.4.1'
+__version__ = '3.5.0'

djpyfs/djpyfs.py

@@ -126,13 +126,16 @@ def get_s3fs(namespace):
     """
     key_id = DJFS_SETTINGS.get('aws_access_key_id', None)
     key_secret = DJFS_SETTINGS.get('aws_secret_access_key', None)
+    region = DJFS_SETTINGS.get('region', None)
 
     fullpath = namespace
 
     if 'prefix' in DJFS_SETTINGS:
         fullpath = os.path.join(DJFS_SETTINGS['prefix'], fullpath)
 
-    s3fs = S3FS(DJFS_SETTINGS['bucket'], fullpath, aws_access_key_id=key_id, aws_secret_access_key=key_secret)
+    s3fs = S3FS(DJFS_SETTINGS['bucket'], fullpath,
+                aws_access_key_id=key_id, aws_secret_access_key=key_secret,
+                region=region)
 
     def get_s3_url(self, filename, timeout=60):  # pylint: disable=unused-argument
         """
@@ -154,7 +157,9 @@ def get_s3_url(self, filename, timeout=60):  # pylint: disable=unused-argument
 
         try:
             if not S3CONN:
-                S3CONN = boto3.client('s3', aws_access_key_id=key_id, aws_secret_access_key=key_secret)
+                S3CONN = boto3.client('s3', aws_access_key_id=key_id,
+                                      aws_secret_access_key=key_secret,
+                                      region_name=region)
 
             return S3CONN.generate_presigned_url(
                 "get_object",
@@ -168,7 +173,9 @@ def get_s3_url(self, filename, timeout=60):  # pylint: disable=unused-argument
         except Exception:  # pylint: disable=broad-except
             # Retry on error; typically, if the connection has timed out, but
             # the broad except covers all errors.
-            S3CONN = boto3.client('s3', aws_access_key_id=key_id, aws_secret_access_key=key_secret)
+            S3CONN = boto3.client('s3', aws_access_key_id=key_id,
+                                  aws_secret_access_key=key_secret,
+                                  region_name=region)
 
             return S3CONN.generate_presigned_url(
                 "get_object",

djpyfs/tests.py

@@ -312,6 +312,8 @@ def setUp(self):
     def _setUpS3(self):
         """setup class"""
 
+        djpyfs.S3CONN = None
+
         # Start mocking S3
         self.mock_s3 = mock_s3()
         self.mock_s3.start()
@@ -320,19 +322,23 @@ def _setUpS3(self):
         self.conn = boto3.resource('s3')
         self.conn.create_bucket(Bucket=djpyfs.DJFS_SETTINGS['bucket'])
 
-    def test_aws_credentials(self):
+    def test_aws_options(self):
         fs = djpyfs.get_filesystem(self.namespace)
         self.assertEqual(fs.aws_access_key_id, 'foo')
         self.assertEqual(fs.aws_secret_access_key, 'bar')
+        self.assertEqual(fs.region, djpyfs.DJFS_SETTINGS.get('region', None))
 
     # This test is only relevant for S3. Generate some fake errors to make
     # sure we cover the retry code.
     def test_get_url_retry(self):
+        fs = djpyfs.get_filesystem(self.namespace)
+        # Call get_url() once to initialise global S3CONN so we can patch its
+        # generate_presigned_url() method below.
+        fs.get_url(self.relative_path_to_test_file)
         with patch('boto3.client') as mock_client:
             mock_client.side_effect = AttributeError("Some attribute error occurred")
             with patch.object(djpyfs.S3CONN, "generate_presigned_url") as mock_client:
                     mock_client.side_effect = AttributeError("Some attribute error occurred")
-                    fs = djpyfs.get_filesystem(self.namespace)
                     with self.assertRaises(AttributeError):
                         fs.get_url(self.relative_path_to_test_file).startswith(self.expected_url_prefix)
 
@@ -364,3 +370,28 @@ def setUp(self):
                                     f"{djpyfs.DJFS_SETTINGS['prefix']}/{self.namespace}/"
                                     f"{self.relative_path_to_test_file}")
         self._setUpS3()
+
+
+# pylint: disable=test-inherits-tests
+class S3TestRegion(S3Test):
+    """
+    Same as S3Test above, but specifies AWS region.
+    """
+
+    djfs_settings = {
+        'type': 's3fs',
+        'directory_root': 'django-pyfs/static/django-pyfs-test',
+        'url_root': '/static/django-pyfs-test',
+        'aws_access_key_id': 'foo',
+        'aws_secret_access_key': 'bar',
+        'bucket': 'test_bucket',
+        'region': 'me-south-1'
+    }
+
+    def setUp(self):
+        super().setUp()
+
+        self.expected_url_prefix = (f"https://s3.{djpyfs.DJFS_SETTINGS['region']}.amazonaws.com/"
+                                    f"{djpyfs.DJFS_SETTINGS['bucket']}/{self.namespace}/"
+                                    f"{self.relative_path_to_test_file}")
+        self._setUpS3()