wagtail 7.2.1__py3-none-any.whl → 7.3rc1__py3-none-any.whl

wagtail/snippets/tests/test_chooser_block.py

@@ -0,0 +1,197 @@
+from django.core.exceptions import ImproperlyConfigured, ValidationError
+from django.test import TestCase
+
+from wagtail.blocks.field_block import FieldBlockAdapter
+from wagtail.models import Locale
+from wagtail.snippets.blocks import SnippetChooserBlock
+from wagtail.snippets.widgets import AdminSnippetChooser
+from wagtail.test.testapp.models import Advert, AdvertWithCustomPrimaryKey
+
+
+class TestSnippetChooserBlock(TestCase):
+    fixtures = ["test.json"]
+
+    def test_serialize(self):
+        """The value of a SnippetChooserBlock (a snippet instance) should serialize to an ID"""
+        block = SnippetChooserBlock(Advert)
+        test_advert = Advert.objects.get(text="test_advert")
+
+        self.assertEqual(block.get_prep_value(test_advert), test_advert.id)
+
+        # None should serialize to None
+        self.assertIsNone(block.get_prep_value(None))
+
+    def test_deserialize(self):
+        """The serialized value of a SnippetChooserBlock (an ID) should deserialize to a snippet instance"""
+        block = SnippetChooserBlock(Advert)
+        test_advert = Advert.objects.get(text="test_advert")
+
+        self.assertEqual(block.to_python(test_advert.id), test_advert)
+
+        # None should deserialize to None
+        self.assertIsNone(block.to_python(None))
+
+    def test_reference_model_by_string(self):
+        block = SnippetChooserBlock("tests.Advert")
+        test_advert = Advert.objects.get(text="test_advert")
+        self.assertEqual(block.to_python(test_advert.id), test_advert)
+
+    def test_adapt(self):
+        block = SnippetChooserBlock(
+            Advert,
+            help_text="pick an advert, any advert",
+            description="An advert to be displayed on the sidebar.",
+        )
+
+        block.set_name("test_snippetchooserblock")
+        js_args = FieldBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "test_snippetchooserblock")
+        self.assertIsInstance(js_args[1], AdminSnippetChooser)
+        self.assertEqual(js_args[1].model, Advert)
+        self.assertEqual(
+            js_args[2],
+            {
+                "label": "Test snippetchooserblock",
+                "description": "An advert to be displayed on the sidebar.",
+                "required": True,
+                "icon": "snippet",
+                "blockDefId": block.definition_prefix,
+                "isPreviewable": block.is_previewable,
+                "helpText": "pick an advert, any advert",
+                "classname": "w-field w-field--model_choice_field w-field--admin_snippet_chooser",
+                "attrs": {},
+                "showAddCommentButton": True,
+                "strings": {"ADD_COMMENT": "Add Comment"},
+            },
+        )
+
+    def test_form_response(self):
+        block = SnippetChooserBlock(Advert)
+        test_advert = Advert.objects.get(text="test_advert")
+
+        value = block.value_from_datadict({"advert": str(test_advert.id)}, {}, "advert")
+        self.assertEqual(value, test_advert)
+
+        empty_value = block.value_from_datadict({"advert": ""}, {}, "advert")
+        self.assertIsNone(empty_value)
+
+    def test_clean(self):
+        required_block = SnippetChooserBlock(Advert)
+        nonrequired_block = SnippetChooserBlock(Advert, required=False)
+        test_advert = Advert.objects.get(text="test_advert")
+
+        self.assertEqual(required_block.clean(test_advert), test_advert)
+        with self.assertRaises(ValidationError):
+            required_block.clean(None)
+
+        self.assertEqual(nonrequired_block.clean(test_advert), test_advert)
+        self.assertIsNone(nonrequired_block.clean(None))
+
+    def test_deconstruct(self):
+        block = SnippetChooserBlock(Advert, required=False)
+        path, args, kwargs = block.deconstruct()
+        self.assertEqual(path, "wagtail.snippets.blocks.SnippetChooserBlock")
+        self.assertEqual(args, (Advert,))
+        self.assertEqual(kwargs, {"required": False})
+
+    def test_extract_references(self):
+        block = SnippetChooserBlock(Advert)
+        test_advert = Advert.objects.get(text="test_advert")
+
+        self.assertListEqual(
+            list(block.extract_references(test_advert)),
+            [(Advert, str(test_advert.id), "", "")],
+        )
+
+        # None should not yield any references
+        self.assertListEqual(list(block.extract_references(None)), [])
+
+    def test_exception_on_non_snippet_model(self):
+        with self.assertRaises(ImproperlyConfigured):
+            block = SnippetChooserBlock(Locale)
+            block.widget
+
+
+class TestSnippetChooserBlockWithCustomPrimaryKey(TestCase):
+    fixtures = ["test.json"]
+
+    def test_serialize(self):
+        """The value of a SnippetChooserBlock (a snippet instance) should serialize to an ID"""
+        block = SnippetChooserBlock(AdvertWithCustomPrimaryKey)
+        test_advert = AdvertWithCustomPrimaryKey.objects.get(pk="advert/01")
+
+        self.assertEqual(block.get_prep_value(test_advert), test_advert.pk)
+
+        # None should serialize to None
+        self.assertIsNone(block.get_prep_value(None))
+
+    def test_deserialize(self):
+        """The serialized value of a SnippetChooserBlock (an ID) should deserialize to a snippet instance"""
+        block = SnippetChooserBlock(AdvertWithCustomPrimaryKey)
+        test_advert = AdvertWithCustomPrimaryKey.objects.get(pk="advert/01")
+
+        self.assertEqual(block.to_python(test_advert.pk), test_advert)
+
+        # None should deserialize to None
+        self.assertIsNone(block.to_python(None))
+
+    def test_adapt(self):
+        block = SnippetChooserBlock(
+            AdvertWithCustomPrimaryKey,
+            help_text="pick an advert, any advert",
+            description="An advert to be displayed on the footer.",
+        )
+
+        block.set_name("test_snippetchooserblock")
+        js_args = FieldBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "test_snippetchooserblock")
+        self.assertIsInstance(js_args[1], AdminSnippetChooser)
+        self.assertEqual(js_args[1].model, AdvertWithCustomPrimaryKey)
+        self.assertEqual(
+            js_args[2],
+            {
+                "label": "Test snippetchooserblock",
+                "description": "An advert to be displayed on the footer.",
+                "required": True,
+                "icon": "snippet",
+                "blockDefId": block.definition_prefix,
+                "isPreviewable": block.is_previewable,
+                "helpText": "pick an advert, any advert",
+                "classname": "w-field w-field--model_choice_field w-field--admin_snippet_chooser",
+                "attrs": {},
+                "showAddCommentButton": True,
+                "strings": {"ADD_COMMENT": "Add Comment"},
+            },
+        )
+
+    def test_form_response(self):
+        block = SnippetChooserBlock(AdvertWithCustomPrimaryKey)
+        test_advert = AdvertWithCustomPrimaryKey.objects.get(pk="advert/01")
+
+        value = block.value_from_datadict(
+            {"advertwithcustomprimarykey": str(test_advert.pk)},
+            {},
+            "advertwithcustomprimarykey",
+        )
+        self.assertEqual(value, test_advert)
+
+        empty_value = block.value_from_datadict(
+            {"advertwithcustomprimarykey": ""}, {}, "advertwithcustomprimarykey"
+        )
+        self.assertIsNone(empty_value)
+
+    def test_clean(self):
+        required_block = SnippetChooserBlock(AdvertWithCustomPrimaryKey)
+        nonrequired_block = SnippetChooserBlock(
+            AdvertWithCustomPrimaryKey, required=False
+        )
+        test_advert = AdvertWithCustomPrimaryKey.objects.get(pk="advert/01")
+
+        self.assertEqual(required_block.clean(test_advert), test_advert)
+        with self.assertRaises(ValidationError):
+            required_block.clean(None)
+
+        self.assertEqual(nonrequired_block.clean(test_advert), test_advert)
+        self.assertIsNone(nonrequired_block.clean(None))

wagtail/snippets/tests/test_chooser_panel.py

@@ -0,0 +1,149 @@
+from django.contrib.auth.models import AnonymousUser
+from django.test import RequestFactory, TestCase
+
+from wagtail.admin.panels import FieldPanel, ObjectList, get_edit_handler
+from wagtail.snippets.widgets import AdminSnippetChooser
+from wagtail.test.testapp.models import (
+    Advert,
+    AdvertWithCustomPrimaryKey,
+    SnippetChooserModel,
+    SnippetChooserModelWithCustomPrimaryKey,
+)
+from wagtail.test.utils import WagtailTestUtils
+
+
+class TestSnippetChooserPanel(WagtailTestUtils, TestCase):
+    fixtures = ["test.json"]
+
+    def setUp(self):
+        self.request = RequestFactory().get("/")
+        user = AnonymousUser()  # technically, Anonymous users cannot access the admin
+        self.request.user = user
+
+        model = SnippetChooserModel
+        self.advert_text = "Test advert text"
+        test_snippet = model.objects.create(
+            advert=Advert.objects.create(text=self.advert_text)
+        )
+
+        self.edit_handler = get_edit_handler(model)
+        self.form_class = self.edit_handler.get_form_class()
+        form = self.form_class(instance=test_snippet)
+        edit_handler = self.edit_handler.get_bound_panel(
+            instance=test_snippet, form=form, request=self.request
+        )
+
+        self.snippet_chooser_panel = [
+            panel
+            for panel in edit_handler.children
+            if getattr(panel, "field_name", None) == "advert"
+        ][0]
+
+    def test_render_html(self):
+        field_html = self.snippet_chooser_panel.render_html()
+        self.assertIn(self.advert_text, field_html)
+        self.assertIn("Choose advert", field_html)
+        self.assertIn("Choose another advert", field_html)
+        self.assertIn("icon icon-snippet icon", field_html)
+
+    def test_render_as_empty_field(self):
+        test_snippet = SnippetChooserModel()
+        form = self.form_class(instance=test_snippet)
+        edit_handler = self.edit_handler.get_bound_panel(
+            instance=test_snippet, form=form, request=self.request
+        )
+
+        snippet_chooser_panel = [
+            panel
+            for panel in edit_handler.children
+            if getattr(panel, "field_name", None) == "advert"
+        ][0]
+
+        field_html = snippet_chooser_panel.render_html()
+        self.assertIn("Choose advert", field_html)
+        self.assertIn("Choose another advert", field_html)
+
+    def test_render_js(self):
+        self.assertIn(
+            'new SnippetChooser("id_advert", {"modalUrl": "/admin/snippets/choose/tests/advert/"});',
+            self.snippet_chooser_panel.render_html(),
+        )
+
+    def test_target_model_autodetected(self):
+        edit_handler = ObjectList([FieldPanel("advert")]).bind_to_model(
+            SnippetChooserModel
+        )
+        form_class = edit_handler.get_form_class()
+        form = form_class()
+        widget = form.fields["advert"].widget
+        self.assertIsInstance(widget, AdminSnippetChooser)
+        self.assertEqual(widget.model, Advert)
+
+
+class TestSnippetChooserPanelWithCustomPrimaryKey(WagtailTestUtils, TestCase):
+    fixtures = ["test.json"]
+
+    def setUp(self):
+        self.request = RequestFactory().get("/")
+        user = AnonymousUser()  # technically, Anonymous users cannot access the admin
+        self.request.user = user
+
+        model = SnippetChooserModelWithCustomPrimaryKey
+        self.advert_text = "Test advert text"
+        test_snippet = model.objects.create(
+            advertwithcustomprimarykey=AdvertWithCustomPrimaryKey.objects.create(
+                advert_id="advert/02", text=self.advert_text
+            )
+        )
+
+        self.edit_handler = get_edit_handler(model)
+        self.form_class = self.edit_handler.get_form_class()
+        form = self.form_class(instance=test_snippet)
+        edit_handler = self.edit_handler.get_bound_panel(
+            instance=test_snippet, form=form, request=self.request
+        )
+
+        self.snippet_chooser_panel = [
+            panel
+            for panel in edit_handler.children
+            if getattr(panel, "field_name", None) == "advertwithcustomprimarykey"
+        ][0]
+
+    def test_render_html(self):
+        field_html = self.snippet_chooser_panel.render_html()
+        self.assertIn(self.advert_text, field_html)
+        self.assertIn("Choose advert with custom primary key", field_html)
+        self.assertIn("Choose another advert with custom primary key", field_html)
+
+    def test_render_as_empty_field(self):
+        test_snippet = SnippetChooserModelWithCustomPrimaryKey()
+        form = self.form_class(instance=test_snippet)
+        edit_handler = self.edit_handler.get_bound_panel(
+            instance=test_snippet, form=form, request=self.request
+        )
+
+        snippet_chooser_panel = [
+            panel
+            for panel in edit_handler.children
+            if getattr(panel, "field_name", None) == "advertwithcustomprimarykey"
+        ][0]
+
+        field_html = snippet_chooser_panel.render_html()
+        self.assertIn("Choose advert with custom primary key", field_html)
+        self.assertIn("Choose another advert with custom primary key", field_html)
+
+    def test_render_js(self):
+        self.assertIn(
+            'new SnippetChooser("id_advertwithcustomprimarykey", {"modalUrl": "/admin/snippets/choose/tests/advertwithcustomprimarykey/"});',
+            self.snippet_chooser_panel.render_html(),
+        )
+
+    def test_target_model_autodetected(self):
+        edit_handler = ObjectList(
+            [FieldPanel("advertwithcustomprimarykey")]
+        ).bind_to_model(SnippetChooserModelWithCustomPrimaryKey)
+        form_class = edit_handler.get_form_class()
+        form = form_class()
+        widget = form.fields["advertwithcustomprimarykey"].widget
+        self.assertIsInstance(widget, AdminSnippetChooser)
+        self.assertEqual(widget.model, AdvertWithCustomPrimaryKey)