Add slot tests

Author: fsbraun

djangocms_frontend/component_base.py

@@ -195,7 +195,7 @@ def slot_plugin_factory(cls) -> list[type]:
                     "edit_disabled": True,
                     "is_local": False,
                     "show_add_form": False,
-                    "parent_classes": cls.__name__ + "Plugin",
+                    "parent_classes": [cls.__name__ + "Plugin"],
                     "render_template": cls.slot_template,
                     **slot.kwargs,
                 },

djangocms_frontend/component_pool.py

@@ -83,7 +83,7 @@ def scan_templates_for_component_declaration(self, templates: list[tuple[str, st
             fields = context["_cms_components"].get("fields", [])
             if len(cms_component) == 1:
                 components.append(self.component_factory(module, cms_component[0], fields, template_name))
-            elif len(cms_component) > 1:
+            elif len(cms_component) > 1:  # pragma: no cover
                 raise ValueError(f"Multiple cms_component tags found in {template_name}")
         return components
 
@@ -93,7 +93,7 @@ class Components:
     _discovered: bool = False
 
     def register(self, component):
-        if component.__name__ in self._registry:
+        if component.__name__ in self._registry:  # pragma: no cover
             warnings.warn(f"Component {component.__name__} already registered", stacklevel=2)
             return component
         self._registry[component.__name__] = component.get_registration()

djangocms_frontend/templatetags/frontend.py

@@ -219,7 +219,7 @@ class RenderChildPluginsTag(Tag):
     {% endchildplugins %}
 
     Keyword arguments:
-    name -- the name of the placeholder
+    instance -- instance of the plugin whose children are to be rendered
     plugin_type -- optional argument which if given will result in filtering
         the direct child plugin types that are rendered.
     or -- optional argument which if given will make the template tag a block
@@ -230,7 +230,7 @@ class RenderChildPluginsTag(Tag):
     options = Options(
         # PlaceholderOptions parses until the "endchildplugins" tag is found if
         # the "or" option is given
-        Argument("instance", required=True),
+        Argument("instance", required=False),
         Argument("plugin_type", required=False),
         Argument("verbose_name", required=False),
         blocks=[("endchildplugins", "nodelist")],
@@ -254,6 +254,9 @@ def render_tag(self, context, instance, plugin_type, verbose_name, nodelist):
                     kwargs["slots"] = [(plugin_type, verbose_name)]
             context["_cms_components"]["cms_component"][0] = (args, kwargs)
 
+        if not instance:
+            instance = context.get("instance", None)
+
         context.push()
         context["parent"] = instance
         content = []

tests/test_app/templates/test_app/cms_components/hero.html

@@ -16,7 +16,7 @@ <h1 class="max-w-2xl mb-4 text-4xl font-extrabold tracking-tight leading-none md
             <p class="max-w-2xl mb-6 font-light text-gray-500 lg:mb-8 md:text-lg lg:text-xl dark:text-gray-400">
                 {{ slogan }}
             </p>
-                {% childplugins instance %}
+                {% childplugins %}
                     Add buttons here
                 {% endchildplugins %}
         </div>

tests/test_app/templates/test_app/cms_components/with_slots.html

@@ -0,0 +1,27 @@
+{% load cms_tags frontend cms_component %}
+
+{# Declare component - template tags are evaluated at project startup and will render empty #}
+{% cms_component "AutoHeroWithSlots" name=_("My Slotted Hero Auto Component") %}
+{% field "title" forms.CharField required=True %}
+{% field "slogan" forms.CharField required=True widget=forms.Textarea %}
+{% field "hero_image" ImageFormField required=True help_text=_("At least 1024px wide image") %}
+
+{# Actual template - when rendering declared fields are available in the context #}
+<section class="bg-white dark:bg-gray-900">
+    <div class="grid max-w-screen-xl px-4 py-8 mx-auto lg:gap-8 xl:gap-0 lg:py-16 lg:grid-cols-12">
+        <div class="mr-auto place-self-center lg:col-span-7">
+            <h1 class="max-w-2xl mb-4 text-4xl font-extrabold tracking-tight leading-none md:text-5xl xl:text-6xl dark:text-white">
+                {{ title }}
+            </h1>
+            <p class="max-w-2xl mb-6 font-light text-gray-500 lg:mb-8 md:text-lg lg:text-xl dark:text-gray-400">
+                {{ slogan }}
+            </p>
+                {% childplugins instance "buttons" _("Buttons") %}
+                    Add buttons here
+                {% endchildplugins %}
+        </div>
+        <div class="hidden lg:mt-0 lg:col-span-5 lg:flex">
+            <img src="{{ hero_image.url }}">
+        </div>
+    </div>
+</section>

tests/test_autocomponent.py

@@ -47,4 +47,21 @@ def test_split_template_tag(self):
         self.assertEqual(split("hero.html"), ["hero.html"])
         self.assertEqual(split("Mixin1|Mixin2"), ["Mixin1", "Mixin2"])
         self.assertEqual(split("hero.html"), ["hero.html"])
-        self.assertEqual(split("hero.html, Mixin1, Mixin2", ", "), ["hero.html", "Mixin1", "Mixin2"])
+        self.assertEqual(split("hero.html, Mixin1, Mixin2", ", "), ["hero.html", "Mixin1", "Mixin2"])
+
+    def test_autocomponents_slots_are_created(self):
+        from cms.plugin_pool import plugin_pool
+
+        self.assertIn("AutoHeroWithSlotsPlugin", plugin_pool.plugins)
+
+        plugin = plugin_pool.get_plugin("AutoHeroWithSlotsPlugin")
+        model = plugin.model
+
+        self.assertEqual(model.__name__, "AutoHeroWithSlots")
+        self.assertTrue(plugin.allow_children)
+        self.assertEqual(plugin.child_classes, ["AutoHeroWithSlotsButtonsPlugin"])
+
+        self.assertIn("AutoHeroWithSlotsButtonsPlugin", plugin_pool.plugins)
+        slot_plugin = plugin_pool.get_plugin("AutoHeroWithSlotsButtonsPlugin")
+
+        self.assertEqual(slot_plugin.parent_classes, ["AutoHeroWithSlotsPlugin"])