Merge pull request #1433 from plone/maurits-fix-tests-pre-scale

Tests: patch unique url for scale in old or new way.

Author: jensens

news/57.bugfix

@@ -0,0 +1,3 @@
+Tests: patch unique url for scale in old or new way.
+This is only in serializer tests for images.
+[maurits]

src/plone/restapi/tests/helpers.py

@@ -1,4 +1,7 @@
+from contextlib import contextmanager
+from plone.scale import storage
 from Products.CMFCore.utils import getToolByName
+from unittest.mock import patch
 from urllib.parse import urlparse
 
 import quopri
@@ -43,3 +46,30 @@ def ascii_token(text):
     bytestring that is safe to use in term tokens.
     """
     return quopri.encodestring(text.encode("utf-8"))
+
+
+@contextmanager
+def patch_scale_uuid(value):
+    """Patch plone.scale to use a hard coded value as unique id.
+
+    Until plone.scale 4.0.0a3 (2022-05-09) this goes via the uuid4 function.
+    For later versions we need to patch the new hash_key method.
+
+    We also patch the _modified_since method to always return True.
+    Otherwise you may get info from a different scale back,
+    precisely because we give all scales the same "unique" id,
+    which then is of course no longer unique, making the logic unstable.
+    This is needed for the newer plone.scale versions,
+    but should be perfectly fine for the older ones.
+    """
+    if hasattr(storage.AnnotationStorage, "hash_key"):
+        to_patch = storage.AnnotationStorage
+        name = "hash_key"
+    else:
+        to_patch = storage
+        name = "uuid4"
+    with patch.object(to_patch, name, return_value=value):
+        with patch.object(
+            storage.AnnotationStorage, "_modified_since", return_value=True
+        ):
+            yield

src/plone/restapi/tests/test_documentation.py

@@ -1,6 +1,5 @@
 from base64 import b64encode
 from datetime import datetime
-from unittest.mock import patch
 from pkg_resources import resource_filename
 from plone import api
 from plone.app.discussion.interfaces import IConversation
@@ -25,8 +24,8 @@
 from plone.restapi.testing import PLONE_RESTAPI_ITERATE_FUNCTIONAL_TESTING
 from plone.restapi.testing import register_static_uuid_utility
 from plone.restapi.testing import RelativeSession
+from plone.restapi.tests.helpers import patch_scale_uuid
 from plone.restapi.tests.statictime import StaticTime
-from plone.scale import storage
 from plone.testing.z2 import Browser
 from zope.component import createObject
 from zope.component import getUtility
@@ -301,7 +300,8 @@ def test_documentation_news_item(self):
         self.portal.newsitem.image_caption = "This is an image caption."
         transaction.commit()
 
-        with patch.object(storage, "uuid4", return_value="uuid1"):
+        scale_url_uuid = "uuid1"
+        with patch_scale_uuid(scale_url_uuid):
             response = self.api_session.get(self.portal.newsitem.absolute_url())
             save_request_and_response_for_docs("newsitem", response)
 
@@ -349,7 +349,8 @@ def test_documentation_image(self):
             data=image_data, contentType="image/png", filename="image.png"
         )
         transaction.commit()
-        with patch.object(storage, "uuid4", return_value="uuid1"):
+        scale_url_uuid = "uuid1"
+        with patch_scale_uuid(scale_url_uuid):
             response = self.api_session.get(self.portal.image.absolute_url())
             save_request_and_response_for_docs("image", response)
 

src/plone/restapi/tests/test_dxfield_serializer.py

@@ -13,10 +13,9 @@
 from plone.restapi.interfaces import IFieldSerializer
 from plone.restapi.serializer.dxfields import DefaultFieldSerializer
 from plone.restapi.testing import PLONE_RESTAPI_DX_INTEGRATION_TESTING
-from plone.scale import storage
+from plone.restapi.tests.helpers import patch_scale_uuid
 from plone.uuid.interfaces import IUUID
 from unittest import TestCase
-from unittest.mock import patch
 from z3c.form.interfaces import IDataManager
 from zope.component import getMultiAdapter
 from zope.interface.verify import verifyClass
@@ -387,7 +386,8 @@ def test_namedimage_field_serialization_returns_dict_with_original_scale(self):
         with open(image_file, "rb") as f:
             image_data = f.read()
         fn = "test_namedimage_field"
-        with patch.object(storage, "uuid4", return_value="uuid_1"):
+        scale_url_uuid = "uuid_1"
+        with patch_scale_uuid(scale_url_uuid):
             value = self.serialize(
                 fn,
                 NamedImage(
@@ -396,7 +396,6 @@ def test_namedimage_field_serialization_returns_dict_with_original_scale(self):
             )
             self.assertTrue(isinstance(value, dict), "Not a <dict>")
 
-            scale_url_uuid = "uuid_1"
             obj_url = self.doc1.absolute_url()
 
             # Original image is still a "scale"
@@ -483,7 +482,8 @@ def test_namedimage_field_serialization_doesnt_choke_on_corrupt_image(self):
         is returned as is and we need to check it, but the scales should be empty"""
         image_data = b"INVALID IMAGE DATA"
         fn = "test_namedimage_field"
-        with patch.object(storage, "uuid4", return_value="uuid_1"):
+        scale_url_uuid = "uuid_1"
+        with patch_scale_uuid(scale_url_uuid):
             value = self.serialize(
                 fn,
                 NamedImage(
@@ -492,7 +492,6 @@ def test_namedimage_field_serialization_doesnt_choke_on_corrupt_image(self):
             )
 
         obj_url = self.doc1.absolute_url()
-        scale_url_uuid = "uuid_1"
         self.assertEqual(
             {
                 "content-type": "image/gif",
@@ -514,7 +513,8 @@ def test_namedblobimage_field_serialization_returns_dict_with_original_scale(sel
         with open(image_file, "rb") as f:
             image_data = f.read()
         fn = "test_namedblobimage_field"
-        with patch.object(storage, "uuid4", return_value="uuid_1"):
+        scale_url_uuid = "uuid_1"
+        with patch_scale_uuid(scale_url_uuid):
             value = self.serialize(
                 fn,
                 NamedBlobImage(
@@ -523,7 +523,6 @@ def test_namedblobimage_field_serialization_returns_dict_with_original_scale(sel
             )
             self.assertTrue(isinstance(value, dict), "Not a <dict>")
 
-            scale_url_uuid = "uuid_1"
             obj_url = self.doc1.absolute_url()
 
             # Original image is still a "scale"
@@ -610,7 +609,8 @@ def test_namedblobimage_field_serialization_doesnt_choke_on_corrupt_image(self):
         is returned as is and we need to check it, but the scales should be empty"""
         image_data = b"INVALID IMAGE DATA"
         fn = "test_namedblobimage_field"
-        with patch.object(storage, "uuid4", return_value="uuid_1"):
+        scale_url_uuid = "uuid_1"
+        with patch_scale_uuid(scale_url_uuid):
             value = self.serialize(
                 fn,
                 NamedBlobImage(
@@ -619,7 +619,6 @@ def test_namedblobimage_field_serialization_doesnt_choke_on_corrupt_image(self):
             )
 
         obj_url = self.doc1.absolute_url()
-        scale_url_uuid = "uuid_1"
         self.assertEqual(
             {
                 "content-type": "image/gif",

src/plone/restapi/tests/test_serializer.py

@@ -7,9 +7,8 @@
 from plone.namedfile.file import NamedFile
 from plone.restapi.interfaces import ISerializeToJson
 from plone.restapi.testing import PLONE_RESTAPI_DX_INTEGRATION_TESTING
-from plone.scale import storage
+from plone.restapi.tests.helpers import patch_scale_uuid
 from Products.CMFCore.utils import getToolByName
-from unittest.mock import patch
 from zope.component import getMultiAdapter
 
 import json
@@ -261,9 +260,9 @@ def test_serialize_image(self):
 
         self.maxDiff = 99999
 
-        with patch.object(storage, "uuid4", return_value="uuid_1"):
+        scale_url_uuid = "uuid_1"
+        with patch_scale_uuid(scale_url_uuid):
             obj_url = self.portal.image1.absolute_url()
-            scale_url_uuid = "uuid_1"
             download_url = f"{obj_url}/@@images/{scale_url_uuid}.png"
             scales = {
                 "listing": {"download": download_url, "width": 16, "height": 4},

src/plone/restapi/tests/test_services.py

@@ -1,4 +1,3 @@
-from unittest.mock import patch
 from plone.app.testing import setRoles
 from plone.app.testing import SITE_OWNER_NAME
 from plone.app.testing import SITE_OWNER_PASSWORD
@@ -8,7 +7,7 @@
 from plone.namedfile.file import NamedBlobImage
 from plone.restapi.testing import PLONE_RESTAPI_DX_FUNCTIONAL_TESTING
 from plone.restapi.testing import RelativeSession
-from plone.scale import storage
+from plone.restapi.tests.helpers import patch_scale_uuid
 from z3c.relationfield import RelationValue
 from zope.component import getUtility
 from zope.intid.interfaces import IIntIds
@@ -87,7 +86,8 @@ def test_get_news_item(self):
         self.portal.news1.image_caption = "This is an image caption."
         transaction.commit()
 
-        with patch.object(storage, "uuid4", return_value="uuid1"):
+        scale_url_uuid = "uuid1"
+        with patch_scale_uuid(scale_url_uuid):
             response = self.api_session.get(self.portal.news1.absolute_url())
 
             self.assertEqual(response.status_code, 200)
@@ -112,7 +112,7 @@ def test_get_news_item(self):
                 "This is an image caption.", response.json()["image_caption"]
             )
             self.assertDictContainsSubset(
-                {"download": self.portal_url + "/news1/@@images/uuid1.png"},  # noqa
+                {"download": self.portal_url + f"/news1/@@images/{scale_url_uuid}.png"},
                 response.json()["image"],
             )