Add test for preview endpoint

Author: fsbraun

djangocms_rest/plugin_rendering.py

@@ -52,41 +52,33 @@ def serialize_cms_plugin(
 ) -> Optional[dict[str, Any]]:
     if not instance or not hasattr(instance, "get_plugin_instance"):
         return None
-
-    try:
-        plugin_instance, plugin = instance.get_plugin_instance()
-    except (AttributeError, TypeError):
-        return None
-
-    if not plugin_instance:
-        return None
+    plugin_instance, plugin = instance.get_plugin_instance()
 
     model_cls = plugin_instance.__class__
     serializer_cls = getattr(plugin, "serializer_class", None)
     serializer_cls = serializer_cls or get_auto_model_serializer(model_cls)
+    plugin.__class__.serializer_class = serializer_cls
 
     return serializer_cls(plugin_instance, context=context).data
 
 
 # Template for a collapsable key-value pair
 DETAILS_TEMPLATE = (
     '<details open><summary><span class="key">"{key}"</span>: {open}</summary>'
-    '<div class="indent">{value}</div></details>{close}<span class="sep">,</span>'
+    '<div class="indent">{value}</div></details>{close}'
 )
 
 # Template for a collapsable object/list
 OBJ_TEMPLATE = (
     "<details open><summary>{open}</summary>"
-    '<div class="indent">{value}</div></details>{close}<span class="sep">,</span>'
+    '<div class="indent">{value}</div></details>{close}'
 )
 
 # Tempalte for a non-collasable object/list
-FIXED_TEMPLATE = (
-    '{open}<div class="indent">{value}</div>{close}<span class="sep">,</span>'
-)
+FIXED_TEMPLATE = '{open}<div class="indent">{value}</div>{close}'
 
 # Tempalte for a single line key-value pair
-SIMPLE_TEMPLATE = '<span class="key">"{key}"</span>: {value}<span class="sep">,</span>'
+SIMPLE_TEMPLATE = '<span class="key">"{key}"</span>: {value}'
 
 
 def escapestr(s: str) -> str:
@@ -147,15 +139,15 @@ def highlight_json(
         items.append(
             DETAILS_TEMPLATE.format(
                 key=escape(field),
-                value="".join(children),
+                value=",".join(children),
                 open="[",
                 close="]",
             )
         )
     return {
         "open": "{",
         "close": "}",
-        "value": "<br>".join(items),
+        "value": ",<br>".join(items),
     }
 
 
@@ -164,7 +156,7 @@ def highlight_list(json_data: list) -> dict[str, str]:
     return {
         "open": "[",
         "close": "]",
-        "value": "<br>".join(items),
+        "value": ",<br>".join(items),
     }
 
 

djangocms_rest/static/djangocms_rest/highlight.css

@@ -62,7 +62,4 @@
         width: fit-content;
         cursor: pointer;
     }
-    & > .sep:last-child {
-        display: none;
-    }
 }

tests/test_app/serializers.py

@@ -7,4 +7,12 @@ def to_representation(self, instance):
             "id": instance.id,
             "integer": 42,
             "float": 3.14,
+            "json": [
+                {"key": "value"},
+                {"another_key": "another_value"},
+                [1, 2, 3, 4, 5],
+                True,
+                False,
+                None,
+            ],
         }

tests/test_edit_endpoint.py renamed to tests/test_plugin_renderer.py

@@ -8,12 +8,25 @@
 
 from cms import api
 from cms.models import PageContent
-from cms.toolbar.utils import get_object_edit_url
+from cms.toolbar.utils import get_object_edit_url, get_object_preview_url
 
 from filer.models.imagemodels import Image
 from bs4 import BeautifulSoup
 
 
+def get_text_from_html(html, selector):
+    soup = BeautifulSoup(html, "html.parser")
+    element = soup.select_one(selector)
+    if element:
+        return (
+            element.get_text(strip=True)
+            .replace(",]", "]")
+            .replace(",}", "}")
+            .rstrip(",")
+        )
+    return None
+
+
 class PlaceholdersAPITestCase(BaseCMSRestTestCase):
     def setUp(self):
         super().setUp()
@@ -64,7 +77,6 @@ def setUp(self):
             plugin_type="DummyNumberPlugin",
             language="en",
         )
-        self.endpoint = get_object_edit_url(self.page.get_admin_content("en"))
 
     def create_image(self, filename=None, folder=None):
         filename = filename or "test_image.jpg"
@@ -80,23 +92,40 @@ def create_image(self, filename=None, folder=None):
             image_obj.save()
         return image_obj
 
-    def test_in_sync_with_api_endpoint(self):
+    def test_edit_in_sync_with_api_endpoint(self):
         # Edit endpoint and api endpoint should return the same content
 
-        def get_text_from_html(html, selector):
-            soup = BeautifulSoup(html, "html.parser")
-            element = soup.select_one(selector)
-            if element:
-                return (
-                    element.get_text(strip=True)
-                    .replace(",]", "]")
-                    .replace(",}", "}")
-                    .rstrip(",")
-                )
-            return None
+        self.client.force_login(self.user)
+        response = self.client.get(
+            get_object_edit_url(self.page.get_admin_content("en"))
+        )
+        api_response = self.client.get(
+            reverse(
+                "placeholder-detail",
+                kwargs={
+                    "language": "en",
+                    "content_type_id": ContentType.objects.get_for_model(
+                        PageContent
+                    ).id,
+                    "object_id": self.page.get_admin_content("en").id,
+                    "slot": "content",
+                },
+            )
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(api_response.status_code, 200)
+        content = response.content.decode("utf-8")
+        json_content = json.loads(get_text_from_html(content, "div.rest-placeholder"))
+        api_content = api_response.json()
+        self.assertEqual(json_content, api_content)
+
+    def test_preview_in_sync_with_api_endpoint(self):
+        # Edit endpoint and api endpoint should return the same content
 
         self.client.force_login(self.user)
-        response = self.client.get(self.endpoint)
+        response = self.client.get(
+            get_object_preview_url(self.page.get_admin_content("en"))
+        )
         api_response = self.client.get(
             reverse(
                 "placeholder-detail",
@@ -116,12 +145,15 @@ def get_text_from_html(html, selector):
 
         json_content = json.loads(get_text_from_html(content, "div.rest-placeholder"))
         api_content = api_response.json()
+        self.maxDiff = None  # Allow large diffs for detailed comparison
         self.assertEqual(json_content, api_content)
 
     def test_edit_endpoint(self):
         self.client.force_login(self.user)
 
-        response = self.client.get(self.endpoint)
+        response = self.client.get(
+            get_object_edit_url(self.page.get_admin_content("en"))
+        )
         self.assertEqual(response.status_code, 200)
 
         # Test for plugin markers