Add tests

Author: fsbraun

djangocms_frontend/component_pool.py

@@ -3,6 +3,7 @@
 import os
 import warnings
 
+from django import forms
 from django.apps import apps
 from django.template import loader
 from django.utils.module_loading import autodiscover_modules
@@ -54,6 +55,8 @@ def component_factory(component: tuple, fields: list[tuple], template: str) -> C
         (name,) = args
 
         kwargs["render_template"] = template
+        print(kwargs)
+        print(fields)
         meta = type("Meta", (), kwargs)
         cls = type(
             name,
@@ -64,7 +67,7 @@ def component_factory(component: tuple, fields: list[tuple], template: str) -> C
                 **{
                     # Django template engine instantiates objects -- re-instantiate them here
                     args[0]: args[1].__class__(**kwargs)
-                    for args, kwargs in fields
+                    for args, kwargs in fields if isinstance(args[1], forms.Field)
                 },
             },
         )

djangocms_frontend/fields.py

@@ -1,4 +1,5 @@
 from django import forms
+from django.apps import apps
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils.safestring import mark_safe
@@ -9,6 +10,19 @@
 from .helpers import first_choice
 
 
+if apps.is_installed("djangocms_text"):
+    from djangocms_text.fields import HTMLFormField  # noqa F401
+
+    HTMLsanitized = True
+elif apps.is_installed("djangocms_text_ckeditor"):
+    from djangocms_text_ckeditor.fields import HTMLFormField  # noqa F401
+
+    HTMLsanitized = True
+else:
+    HTMLFormField = forms.CharField
+    HTMLsanitized = False
+
+
 class TemplateChoiceMixin:
     """Mixin that hides the template field if only one template is available and is selected"""
 
@@ -170,10 +184,3 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
 
-try:
-    from djangocms_text_ckeditor.fields import HTMLFormField  # noqa
-
-    HTMLsanitized = True
-except ModuleNotFoundError:
-    HTMLFormField = forms.CharField
-    HTMLsanitized = False

tests/test_app/templates/test_app/cms_components/hero.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 "AutoHero" name=_("My 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 %}
+                    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

@@ -0,0 +1,23 @@
+from cms.test_utils.testcases import CMSTestCase
+
+from tests.fixtures import TestFixture
+
+
+class AutoComponentTestCase(TestFixture, CMSTestCase):
+    def test_autocomponents_are_auto_detected(self):
+        from cms.plugin_pool import plugin_pool
+
+        self.assertIn("AutoHeroPlugin", plugin_pool.plugins)
+
+        plugin = plugin_pool.get_plugin("AutoHeroPlugin")
+        model = plugin.model
+        form = plugin.form
+
+        self.assertEqual(plugin.name, "My Hero Auto Component")
+        self.assertEqual(model.__name__, "AutoHero")
+        self.assertIn("title", form.base_fields)
+        self.assertIn("slogan", form.base_fields)
+        self.assertIn("hero_image", form.base_fields)
+        self.assertIn("config", form.base_fields)  # Inherited from djangocms_frontend.models.FrontendUIItem
+
+        self.assertTrue(plugin.allow_children)