Add tests for fk serialization

Author: fsbraun

djangocms_rest/plugin_rendering.py

@@ -10,7 +10,7 @@
 from cms.utils.plugins import get_plugins
 
 from djangocms_rest.serializers.placeholders import PlaceholderSerializer
-from djangocms_rest.serializers.plugins import base_exclude, GenericPluginSerializer
+from djangocms_rest.serializers.plugins import GenericPluginSerializer, base_exclude
 from djangocms_rest.serializers.utils.cache import (
     get_placeholder_rest_cache,
     set_placeholder_rest_cache,

djangocms_rest/serializers/plugins.py

@@ -9,9 +9,10 @@
 from cms.models import CMSPlugin
 from cms.plugin_pool import plugin_pool
 
-from djangocms_rest.utils import get_absolute_frontend_url
 from rest_framework import serializers
 
+from djangocms_rest.utils import get_absolute_frontend_url
+
 
 def serialize_fk(
     request: HttpRequest,
@@ -39,13 +40,14 @@ def serialize_fk(
     if hasattr(related_model, "get_api_endpoint"):
         if obj is None:
             obj = related_model.objects.filter(pk=pk).first()
-        return get_absolute_frontend_url(request, obj.get_api_endpoint())
+        if obj:
+            return get_absolute_frontend_url(request, obj.get_api_endpoint())
 
     # Second choice: Use DRF naming conventions to build the default API URL for the related model
     model_name = related_model._meta.model_name
     try:
         return get_absolute_frontend_url(
-            request, reverse(f"{model_name}_details", args=(pk,))
+            request, reverse(f"{model_name}-detail", args=(pk,))
         )
     except NoReverseMatch:
         pass

djangocms_rest/views.py

@@ -20,8 +20,8 @@
 )
 from djangocms_rest.serializers.placeholders import PlaceholderSerializer
 from djangocms_rest.serializers.plugins import (
-    generate_plugin_definitions,
     PluginDefinitionSerializer,
+    generate_plugin_definitions,
 )
 from djangocms_rest.utils import get_object, get_site_filtered_queryset
 from djangocms_rest.views_base import BaseAPIView, BaseListAPIView

tests/test_fk_serializer.py

@@ -0,0 +1,87 @@
+from django.urls import reverse
+from django.utils import translation
+from djangocms_rest.serializers.plugins import serialize_fk, serialize_soft_refs
+from tests.base import BaseCMSRestTestCase
+from tests.test_app.models import Pizza, Topping
+
+
+# patch function
+def get_api_endpoint(self, language=None):
+    if language is None:
+        language = translation.get_language()
+    return f"/api/{language}/pizza/{self.pk}/"
+
+
+class PlaceholdersAPITestCase(BaseCMSRestTestCase):
+    def test_serialize_fk(self):
+        request = self.get_request(reverse("page-root", kwargs={"language": "en"}))
+
+        # No get_api_endpoint method, no default api name registered
+        fk = serialize_fk(request, Topping, pk="1")
+        self.assertEqual(fk, "test_app.topping:1")
+
+        # No get_api_endpoint method, but default api name registered
+        self.assertEqual(
+            reverse(f"{Pizza._meta.model_name}-detail", kwargs={"pk": 1}),
+            "/api/pizza/1/",
+        )
+        fk = serialize_fk(request, Pizza, pk="1")
+        self.assertEqual(fk, "http://testserver/api/pizza/1/")
+
+        # With get_api_endpoint method
+        try:
+            Pizza.get_api_endpoint = get_api_endpoint
+
+            pizza = Pizza.objects.create(description="Delicious pizza")
+            fk = serialize_fk(request, Pizza, pk=pizza.pk)
+            self.assertEqual(fk, f"http://testserver{pizza.get_api_endpoint('en')}")
+
+            fk = serialize_fk(request, Pizza, pk=pizza.pk, obj=pizza)
+            self.assertEqual(fk, f"http://testserver{pizza.get_api_endpoint('en')}")
+        finally:
+            del Pizza.get_api_endpoint
+
+    def test_serialize_soft_refs(self):
+        request = self.get_request(reverse("page-root", kwargs={"language": "en"}))
+
+        pk = Pizza.objects.create(description="Delicious pizza").pk
+
+        # Serialize a single soft reference
+        fk = serialize_soft_refs(
+            request, dict(ref={"model": "test_app.pizza", "pk": pk})
+        )
+        self.assertEqual(fk, {"ref": f"http://testserver/api/pizza/{pk}/"})
+
+        fk = serialize_soft_refs(
+            request, dict(link={"internal_link": f"test_app.pizza:{pk}"})
+        )
+        self.assertEqual(fk, {"link": f"http://testserver/api/pizza/{pk}/"})
+
+        fk = serialize_soft_refs(
+            request, dict(attrs={"data-cms-href": f"test_app.pizza:{pk}"})
+        )
+        self.assertEqual(
+            fk, {"attrs": {"data-cms-href": f"http://testserver/api/pizza/{pk}/"}}
+        )
+
+    def test_serialize_soft_refs_non_resolvable(self):
+        request = self.get_request(reverse("page-root", kwargs={"language": "en"}))
+
+        # Serialize a single soft reference
+        fk = serialize_soft_refs(
+            request, dict(ref={"model": "test_app.topping", "pk": 314})
+        )
+        self.assertEqual(fk, {"ref": "test_app.topping:314"})
+
+        fk = serialize_soft_refs(
+            request, dict(link={"internal_link": "test_app.topping:314"})
+        )
+        self.assertEqual(fk, {"link": "test_app.topping:314"})
+
+        fk = serialize_soft_refs(request, dict(link={"file_link": "314"}))
+        self.assertEqual(fk, {"link": "filer.file:314"})
+
+        fk = serialize_soft_refs(
+            request, dict(attrs={"data-cms-href": "test_app.topping:314"})
+        )
+        self.assertEqual(fk, {"attrs": {"data-cms-href": "test_app.topping:314"}})

tests/urls.py

@@ -9,6 +9,9 @@
         "api/",
         include("djangocms_rest.urls"),
     ),
+    path(
+        "api/pizza/<int:pk>/", lambda request, pk: f"<Pizza: {pk}>", name="pizza-detail"
+    ),
     path("admin/", admin.site.urls),
     path("", include("cms.urls")),
 ]