Refs #748 - Serialize storage alias whenever possible

Author: claudep

sorl/thumbnail/images.py

@@ -8,7 +8,7 @@
 from urllib.request import Request, urlopen
 
 from django.core.files.base import ContentFile, File
-from django.core.files.storage import Storage
+from django.core.files.storage import InvalidStorageError, Storage, storages
 from django.utils.encoding import force_str
 from django.utils.functional import LazyObject, empty
 
@@ -23,7 +23,10 @@
 
 @lru_cache
 def get_or_create_storage(storage):
-    return get_module_class(storage)()
+    try:
+        return storages[storage]
+    except InvalidStorageError:
+        return get_module_class(storage)()
 
 
 def serialize_image_file(image_file):
@@ -188,7 +191,12 @@ def serialize_storage(self):
             cls = self.storage._wrapped.__class__
         else:
             cls = self.storage.__class__
-        return '%s.%s' % (cls.__module__, cls.__name__)
+        backend = f"{cls.__module__}.{cls.__name__}"
+        # Try our best to find and serialize the storage alias instead of the backend class.
+        for alias, params in storages.backends.items():
+            if params.get("BACKEND") == backend:
+                return alias
+        return backend
 
     @property
     def key(self):

tests/thumbnail_tests/test_alternative_resolutions.py

@@ -23,29 +23,29 @@ def tearDown(self):
     def test_retina(self):
         get_thumbnail(self.image, '50x50')
 
+        cache_path = "test/cache/2c/0f/2c0f909d420e760b8dc4e1d1f79e705b"
         actions = [
-            'exists: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d.jpg',
+            f"exists: {cache_path}.jpg",
 
             # save regular resolution, same as in StorageTestCase
-            'open: retina.jpg',
-            'save: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d.jpg',
-            'get_available_name: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d.jpg',
-            'exists: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d.jpg',
+            "open: retina.jpg",
+            f"save: {cache_path}.jpg",
+            f"get_available_name: {cache_path}.jpg",
+            f"exists: {cache_path}.jpg",
 
             # save the 1.5x resolution version
-            'save: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d@1.5x.jpg',
-            'get_available_name: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d@1.5x.jpg',
-            'exists: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d@1.5x.jpg',
+            f"save: {cache_path}@1.5x.jpg",
+            f"get_available_name: {cache_path}@1.5x.jpg",
+            f"exists: {cache_path}@1.5x.jpg",
 
             # save the 2x resolution version
-            'save: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d@2x.jpg',
-            'get_available_name: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d@2x.jpg',
-            'exists: test/cache/91/bb/91bb06cf9169e4c52132bb113f2d4c0d@2x.jpg'
+            f"save: {cache_path}@2x.jpg",
+            f"get_available_name: {cache_path}@2x.jpg",
+            f"exists: {cache_path}@2x.jpg"
         ]
         self.assertEqual(self.log, actions)
 
-        path = os.path.join(settings.MEDIA_ROOT,
-                            'test/cache/91/bb/[email protected]')
+        path = os.path.join(settings.MEDIA_ROOT, f"{cache_path}@1.5x.jpg")
 
         with open(path) as fp:
             engine = PILEngine()

tests/thumbnail_tests/test_backends.py

@@ -132,7 +132,7 @@ def setUp(self):
     def test_nonascii(self):
         # also test the get_thumbnail shortcut
         th = get_thumbnail(self.name, '200x200')
-        self.assertEqual(th.url, '/media/test/cache/f5/26/f52608b56718f62abc45a90ff9459f2c.jpg')
+        self.assertEqual(th.url, '/media/test/cache/79/48/79489fd416471a8850d1c7c6f7a28343.jpg')
 
     def tearDown(self):
         shutil.rmtree(settings.MEDIA_ROOT)

tests/thumbnail_tests/test_engines.py

@@ -158,18 +158,18 @@ def test_clear_doesnt_regenerate(self):
 
     def test_storage_serialize(self):
         im = ImageFile(Item.objects.get(image='500x500.jpg').image)
-        self.assertEqual(im.serialize_storage(), 'tests.thumbnail_tests.storage.TestStorage')
+        self.assertEqual(im.serialize_storage(), 'default')
         self.assertEqual(
             ImageFile('http://www.image.jpg').serialize_storage(),
             'sorl.thumbnail.images.UrlStorage',
         )
         self.assertEqual(
             ImageFile('http://www.image.jpg', default.storage).serialize_storage(),
-            'tests.thumbnail_tests.storage.TestStorage',
+            'default',
         )
         self.assertEqual(
             ImageFile('getit', default_storage).serialize_storage(),
-            'tests.thumbnail_tests.storage.TestStorage',
+            'default',
         )
 
     @unittest.skipIf(platform.system() == "Darwin", 'quality is saved a different way on os x')
@@ -200,7 +200,7 @@ def test_image_file_deserialize(self):
         default.kvstore.set(im)
         self.assertEqual(
             default.kvstore.get(im).serialize_storage(),
-            'tests.thumbnail_tests.storage.TestStorage',
+            'default',
         )
         im = ImageFile('https://dummyimage.com/300x300/')
         default.kvstore.set(im)

tests/thumbnail_tests/test_filters.py

@@ -20,7 +20,7 @@ def test_html_filter_local_url(self):
 
         self.assertEqual(
             '<img alt="A image!" '
-            'src="/media/test/cache/c7/f2/c7f2880b48e9f07d46a05472c22f0fde.jpg" />',
+            'src="/media/test/cache/62/5b/625b3d4c6020c1179d7888ca8d29845d.jpg" />',
             val
         )
 
@@ -38,6 +38,6 @@ def test_markdown_filter_local_url(self):
         val = render_to_string('markdownfilter.html', {'text': text, }).strip()
 
         self.assertEqual(
-            '![A image!](/media/test/cache/c7/f2/c7f2880b48e9f07d46a05472c22f0fde.jpg)',
+            '![A image!](/media/test/cache/62/5b/625b3d4c6020c1179d7888ca8d29845d.jpg)',
             val
         )

tests/thumbnail_tests/test_storage.py

@@ -13,16 +13,17 @@ class StorageTestCase(BaseStorageTestCase):
 
     def test_new(self):
         get_thumbnail(self.image, '50x50')
+        cache_path = "test/cache/55/ce/55ceec8f0d3f20a89304da3a65644db0.jpg"
         actions = [
-            'exists: test/cache/45/bb/45bbbdab11e235a80e603aa119e8786b.jpg',
+            f"exists: {cache_path}",
             # open the original for thumbnailing
-            'open: org.jpg',
+            "open: org.jpg",
             # save the file
-            'save: test/cache/45/bb/45bbbdab11e235a80e603aa119e8786b.jpg',
+            f"save: {cache_path}",
             # check for filename
-            'get_available_name: test/cache/45/bb/45bbbdab11e235a80e603aa119e8786b.jpg',
+            f"get_available_name: {cache_path}",
             # called by get_available_name
-            'exists: test/cache/45/bb/45bbbdab11e235a80e603aa119e8786b.jpg',
+            f"exists: {cache_path}",
         ]
         self.assertEqual(self.log, actions)
 

tests/thumbnail_tests/test_templatetags.py

@@ -26,8 +26,8 @@ def test_nested(self):
         item = Item.objects.get(image='500x500.jpg')
         val = render_to_string('thumbnail6.html', {'item': item, }).strip()
         self.assertEqual(val, (
-            '<a href="/media/test/cache/fc/f6/fcf65c09cc4bb8671147de41997422bf.jpg">'
-            '<img src="/media/test/cache/67/6b/676b2331a071478b0cb280d0edba7818.jpg" '
+            '<a href="/media/test/cache/bb/a2/bba263a67019189dfeb106ced24dcb4d.jpg">'
+            '<img src="/media/test/cache/a4/d3/a4d3b1e302148aed94200b3a05849884.jpg" '
             'width="400" height="400"></a>'
         ))
 
@@ -195,10 +195,10 @@ def test_nested(self):
         self.assertEqual(
             val,
             (
-                '<a href="/media/test/cache/fc/f6/'
-                'fcf65c09cc4bb8671147de41997422bf.jpg">'
-                '<img src="/media/test/cache/67/6b/'
-                '676b2331a071478b0cb280d0edba7818.jpg" '
+                '<a href="/media/test/cache/bb/a2/'
+                'bba263a67019189dfeb106ced24dcb4d.jpg">'
+                '<img src="/media/test/cache/a4/d3/'
+                'a4d3b1e302148aed94200b3a05849884.jpg" '
                 'width="400" height="400"></a>'
             )
         )