wagtail 6.3.2__py3-none-any.whl → 6.4__py3-none-any.whl

wagtail/snippets/tests/test_snippets.py

@@ -4129,9 +4129,10 @@ class TestSnippetDelete(WagtailTestUtils, TestCase):
         self.assertContains(response, delete_url)
 
     def test_delete_get_with_protected_reference(self):
-        VariousOnDeleteModel.objects.create(
-            text="Undeletable", on_delete_protect=self.test_snippet
-        )
+        with self.captureOnCommitCallbacks(execute=True):
+            VariousOnDeleteModel.objects.create(
+                text="Undeletable", on_delete_protect=self.test_snippet
+            )
         delete_url = reverse(
             "wagtailsnippets_tests_advert:delete",
             args=[quote(self.test_snippet.pk)],
@@ -4186,9 +4187,10 @@ class TestSnippetDelete(WagtailTestUtils, TestCase):
         self.assertEqual(Advert.objects.filter(text="test_advert").count(), 0)
 
     def test_delete_post_with_protected_reference(self):
-        VariousOnDeleteModel.objects.create(
-            text="Undeletable", on_delete_protect=self.test_snippet
-        )
+        with self.captureOnCommitCallbacks(execute=True):
+            VariousOnDeleteModel.objects.create(
+                text="Undeletable", on_delete_protect=self.test_snippet
+            )
         delete_url = reverse(
             "wagtailsnippets_tests_advert:delete",
             args=[quote(self.test_snippet.pk)],
@@ -4870,7 +4872,7 @@ class TestSnippetRevisions(WagtailTestUtils, TestCase):
         self.assertEqual(self.snippet.live_revision, self.snippet.latest_revision)
 
 
-class TestCompareRevisions(WagtailTestUtils, TestCase):
+class TestCompareRevisions(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     # Actual tests for the comparison classes can be found in test_compare.py
 
     def setUp(self):
@@ -4908,6 +4910,32 @@ class TestCompareRevisions(WagtailTestUtils, TestCase):
             html=True,
         )
 
+        index_url = reverse("wagtailsnippets_tests_revisablemodel:list", args=[])
+        edit_url = reverse(
+            "wagtailsnippets_tests_revisablemodel:edit",
+            args=(self.snippet.id,),
+        )
+        history_url = reverse(
+            "wagtailsnippets_tests_revisablemodel:history",
+            args=(self.snippet.id,),
+        )
+
+        self.assertBreadcrumbsItemsRendered(
+            [
+                {"url": reverse("wagtailsnippets:index"), "label": "Snippets"},
+                {"url": index_url, "label": "Revisable models"},
+                {"url": edit_url, "label": str(self.snippet)},
+                {"url": history_url, "label": "History"},
+                {"url": "", "label": "Compare", "sublabel": str(self.snippet)},
+            ],
+            response.content,
+        )
+
+        soup = self.get_soup(response.content)
+        edit_button = soup.select_one(f"a.w-header-button[href='{edit_url}']")
+        self.assertIsNotNone(edit_button)
+        self.assertEqual(edit_button.text.strip(), "Edit")
+
     def test_compare_revisions_earliest(self):
         response = self.get("earliest", self.edit_revision.pk)
         self.assertEqual(response.status_code, 200)
@@ -5496,7 +5524,11 @@ class TestSnippetChooserBlock(TestCase):
         self.assertEqual(block.to_python(test_advert.id), test_advert)
 
     def test_adapt(self):
-        block = SnippetChooserBlock(Advert, help_text="pick an advert, any advert")
+        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)
@@ -5508,8 +5540,11 @@ class TestSnippetChooserBlock(TestCase):
             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",
                 "showAddCommentButton": True,
@@ -5622,6 +5657,9 @@ class TestSnippetViewWithCustomPrimaryKey(WagtailTestUtils, TestCase):
         self.snippet_a = StandardSnippetWithCustomPrimaryKey.objects.create(
             snippet_id="snippet/01", text="Hello"
         )
+        self.snippet_b = StandardSnippetWithCustomPrimaryKey.objects.create(
+            snippet_id="abc_407269_1", text="Goodbye"
+        )
 
     def get(self, snippet, params={}):
         args = [quote(snippet.pk)]
@@ -5644,9 +5682,11 @@ class TestSnippetViewWithCustomPrimaryKey(WagtailTestUtils, TestCase):
         )
 
     def test_show_edit_view(self):
-        response = self.get(self.snippet_a)
-        self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailsnippets/snippets/edit.html")
+        for snippet in [self.snippet_a, self.snippet_b]:
+            with self.subTest(snippet=snippet):
+                response = self.get(snippet)
+                self.assertEqual(response.status_code, 200)
+                self.assertTemplateUsed(response, "wagtailsnippets/snippets/edit.html")
 
     def test_edit_invalid(self):
         response = self.post(self.snippet_a, post_data={"foo": "bar"})
@@ -5669,8 +5709,10 @@ class TestSnippetViewWithCustomPrimaryKey(WagtailTestUtils, TestCase):
         )
 
         snippets = StandardSnippetWithCustomPrimaryKey.objects.all()
-        self.assertEqual(snippets.count(), 2)
-        self.assertEqual(snippets.last().snippet_id, "snippet_id_edited")
+        self.assertEqual(snippets.count(), 3)
+        self.assertEqual(
+            snippets.order_by("snippet_id").last().snippet_id, "snippet_id_edited"
+        )
 
     def test_create(self):
         response = self.create(
@@ -5685,40 +5727,48 @@ class TestSnippetViewWithCustomPrimaryKey(WagtailTestUtils, TestCase):
         )
 
         snippets = StandardSnippetWithCustomPrimaryKey.objects.all()
-        self.assertEqual(snippets.count(), 2)
-        self.assertEqual(snippets.last().text, "test snippet")
+        self.assertEqual(snippets.count(), 3)
+        self.assertEqual(snippets.order_by("snippet_id").last().text, "test snippet")
 
     def test_get_delete(self):
-        response = self.client.get(
-            reverse(
-                "wagtailsnippets_snippetstests_standardsnippetwithcustomprimarykey:delete",
-                args=[quote(self.snippet_a.pk)],
-            )
-        )
-        self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailadmin/generic/confirm_delete.html")
+        for snippet in [self.snippet_a, self.snippet_b]:
+            with self.subTest(snippet=snippet):
+                response = self.client.get(
+                    reverse(
+                        "wagtailsnippets_snippetstests_standardsnippetwithcustomprimarykey:delete",
+                        args=[quote(snippet.pk)],
+                    )
+                )
+                self.assertEqual(response.status_code, 200)
+                self.assertTemplateUsed(
+                    response, "wagtailadmin/generic/confirm_delete.html"
+                )
 
     def test_usage_link(self):
-        response = self.client.get(
-            reverse(
-                "wagtailsnippets_snippetstests_standardsnippetwithcustomprimarykey:delete",
-                args=[quote(self.snippet_a.pk)],
-            )
-        )
-        self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailadmin/generic/confirm_delete.html")
-        self.assertContains(
-            response,
-            "This standard snippet with custom primary key is referenced 0 times",
-        )
-        self.assertContains(
-            response,
-            reverse(
-                "wagtailsnippets_snippetstests_standardsnippetwithcustomprimarykey:usage",
-                args=[quote(self.snippet_a.pk)],
-            )
-            + "?describe_on_delete=1",
-        )
+        for snippet in [self.snippet_a, self.snippet_b]:
+            with self.subTest(snippet=snippet):
+                response = self.client.get(
+                    reverse(
+                        "wagtailsnippets_snippetstests_standardsnippetwithcustomprimarykey:delete",
+                        args=[quote(snippet.pk)],
+                    )
+                )
+                self.assertEqual(response.status_code, 200)
+                self.assertTemplateUsed(
+                    response, "wagtailadmin/generic/confirm_delete.html"
+                )
+                self.assertContains(
+                    response,
+                    "This standard snippet with custom primary key is referenced 0 times",
+                )
+                self.assertContains(
+                    response,
+                    reverse(
+                        "wagtailsnippets_snippetstests_standardsnippetwithcustomprimarykey:usage",
+                        args=[quote(snippet.pk)],
+                    )
+                    + "?describe_on_delete=1",
+                )
 
     def test_redirect_to_edit(self):
         with self.assertWarnsRegex(
@@ -5788,7 +5838,9 @@ class TestSnippetChooserBlockWithCustomPrimaryKey(TestCase):
 
     def test_adapt(self):
         block = SnippetChooserBlock(
-            AdvertWithCustomPrimaryKey, help_text="pick an advert, any advert"
+            AdvertWithCustomPrimaryKey,
+            help_text="pick an advert, any advert",
+            description="An advert to be displayed on the footer.",
         )
 
         block.set_name("test_snippetchooserblock")
@@ -5801,8 +5853,11 @@ class TestSnippetChooserBlockWithCustomPrimaryKey(TestCase):
             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",
                 "showAddCommentButton": True,
@@ -6000,7 +6055,7 @@ class TestPanelConfigurationChecks(WagtailTestUtils, TestCase):
 
         warning = checks.Warning(
             "StandardSnippet.content_panels will have no effect on snippets editing",
-            hint="""Ensure that StandardSnippet uses `panels` instead of `content_panels`\
+            hint="""Ensure that StandardSnippet uses `panels` instead of `content_panels` \
 or set up an `edit_handler` if you want a tabbed editing interface.
 There are no default tabs on non-Page models so there will be no\
  Content tab for the content_panels to render in.""",

wagtail/snippets/tests/test_usage.py

@@ -74,15 +74,16 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertEqual(sublabel.get_text(strip=True), "Draft-enabled Bar, In Draft")
 
     def test_usage(self):
-        # resave so that usage count gets updated
-        page = Page.objects.get(pk=2)
-        page.save()
-
-        gfk_page = GenericSnippetPage(
-            title="Foobar Title",
-            snippet_content_object=Advert.objects.get(pk=1),
-        )
-        page.add_child(instance=gfk_page)
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = Page.objects.get(pk=2)
+            page.save()
+
+            gfk_page = GenericSnippetPage(
+                title="Foobar Title",
+                snippet_content_object=Advert.objects.get(pk=1),
+            )
+            page.add_child(instance=gfk_page)
 
         response = self.client.get(
             reverse(
@@ -124,9 +125,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertRedirects(response, reverse("wagtailadmin_home"))
 
     def test_usage_without_edit_permission_on_page(self):
-        # resave so that usage count gets updated
-        page = Page.objects.get(pk=2)
-        page.save()
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = Page.objects.get(pk=2)
+            page.save()
 
         # Create a user with edit access to snippets but not pages
         user = self.create_user(
@@ -157,9 +159,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertContains(response, "<li>Advert</li>", html=True)
 
     def test_usage_with_describe_on_delete_cascade(self):
-        # resave so that usage count gets updated
-        page = Page.objects.get(pk=2)
-        page.save()
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = Page.objects.get(pk=2)
+            page.save()
 
         response = self.client.get(
             reverse("wagtailsnippets_tests_advert:usage", args=["1"])
@@ -173,9 +176,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertContains(response, ": the advert placement will also be deleted")
 
     def test_usage_with_describe_on_delete_set_null(self):
-        # resave so that usage count gets updated
-        page = EventPage.objects.first()
-        page.save()
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = EventPage.objects.first()
+            page.save()
 
         self.assertEqual(page.feed_image.get_usage().count(), 1)
 
@@ -191,13 +195,14 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertContains(response, ": will unset the reference")
 
     def test_usage_with_describe_on_delete_gfk(self):
-        advert = Advert.objects.get(pk=1)
+        with self.captureOnCommitCallbacks(execute=True):
+            advert = Advert.objects.get(pk=1)
 
-        gfk_page = GenericSnippetPage(
-            title="Foobar Title",
-            snippet_content_object=advert,
-        )
-        Page.objects.get(pk=1).add_child(instance=gfk_page)
+            gfk_page = GenericSnippetPage(
+                title="Foobar Title",
+                snippet_content_object=advert,
+            )
+            Page.objects.get(pk=1).add_child(instance=gfk_page)
 
         self.assertEqual(ReferenceIndex.get_grouped_references_to(advert).count(), 1)
 

wagtail/snippets/tests/test_viewset.py

@@ -95,7 +95,7 @@ class TestCustomIcon(BaseSnippetViewSetTests):
             (
                 "revisions_compare",
                 [pk, self.revision_1.id, self.revision_2.id],
-                "header.html",
+                "headers/slim_header.html",
             ),
             ("revisions_unschedule", [pk, self.revision_2.id], "header.html"),
         ]

wagtail/snippets/views/snippets.py

@@ -358,18 +358,6 @@ class PreviewRevisionView(PermissionCheckedMixin, PreviewRevision):
 class RevisionsCompareView(PermissionCheckedMixin, generic.RevisionsCompareView):
     permission_required = "change"
 
-    @property
-    def edit_label(self):
-        return _("Edit this %(model_name)s") % {
-            "model_name": self.model._meta.verbose_name
-        }
-
-    @property
-    def history_label(self):
-        return _("%(model_name)s history") % {
-            "model_name": self.model._meta.verbose_name
-        }
-
 
 class UnpublishView(PermissionCheckedMixin, generic.UnpublishView):
     permission_required = "publish"

wagtail/tasks.py

@@ -0,0 +1,41 @@
+from django.apps import apps
+from django.db import transaction
+from django.utils.module_loading import import_string
+from django_tasks import task
+from modelcluster.fields import ParentalKey
+
+from wagtail.models import ReferenceIndex
+
+
+@task()
+def update_reference_index_task(app_label, model_name, pk):
+    model = apps.get_model(app_label, model_name)
+    instance = model.objects.get(pk=pk)
+
+    # If the model is a child model, find the parent instance and index that instead
+    while True:
+        parental_keys = list(
+            filter(
+                lambda field: isinstance(field, ParentalKey),
+                instance._meta.get_fields(),
+            )
+        )
+        if not parental_keys:
+            break
+
+        instance = getattr(instance, parental_keys[0].name)
+        if instance is None:
+            # parent is null, so there is no valid object to record references against
+            return
+
+    if ReferenceIndex.is_indexed(instance._meta.model):
+        with transaction.atomic():
+            ReferenceIndex.create_or_update_for_object(instance)
+
+
+@task()
+def delete_file_from_storage_task(deconstructed_storage, path):
+    storage_module, storage_args, storage_kwargs = deconstructed_storage
+    storage = import_string(storage_module)(*storage_args, **storage_kwargs)
+
+    storage.delete(path)

wagtail/templates/wagtailcore/shared/block_preview.html

@@ -0,0 +1,37 @@
+{% load wagtailcore_tags i18n %}
+{% get_current_language as LANGUAGE_CODE %}
+{% get_current_language_bidi as LANGUAGE_BIDI %}
+<!DOCTYPE html>
+<html lang="{{ LANGUAGE_CODE }}" dir="{% if LANGUAGE_BIDI %}rtl{% else %}ltr{% endif %}">
+    <head>
+        {% block head %}
+            <meta charset="UTF-8" />
+            <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+            <meta name="robots" content="noindex" />
+            <title>{{ page_title }}</title>
+
+            {% block css %}
+            {% endblock %}
+        {% endblock %}
+    </head>
+    <body>
+        {% block body %}
+            <main>
+                {% block content %}
+                    {% comment %}
+                        StreamBlock renders each child block in a `div` wrapper
+                        like the following. Since we are rendering the block
+                        directly (without a StreamBlock), add the div wrapper
+                        here in case the styles rely on the `block-` CSS class.
+                    {% endcomment %}
+                    <div class="block-{{ block_def.name }}">
+                        {% include_block bound_block %}
+                    </div>
+                {% endblock %}
+            </main>
+
+            {% block js %}
+            {% endblock %}
+        {% endblock %}
+    </body>
+</html>

wagtail/test/earlypage/migrations/0001_initial.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.1.4 on 2025-01-03 15:30
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("wagtailcore", "0094_alter_page_locale"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="EarlyPage",
+            fields=[
+                (
+                    "page_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="wagtailcore.page",
+                    ),
+                ),
+                ("intro", models.TextField(blank=True)),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail/test/earlypage/models.py

@@ -0,0 +1,14 @@
+# This module DOES NOT import from wagtail.admin -
+# this tests that we are able to define Page models before wagtail.admin is loaded.
+
+from django.db import models
+
+from wagtail.models import Page
+
+
+class EarlyPage(Page):
+    intro = models.TextField(blank=True)
+
+    content_panels = Page.content_panels + [
+        "intro",
+    ]

wagtail/test/settings.py

@@ -135,6 +135,9 @@ MIDDLEWARE = (
 )
 
 INSTALLED_APPS = [
+    # Place wagtail.test.earlypage first, to test the behaviour of page models
+    # that are defined before wagtail.admin is loaded
+    "wagtail.test.earlypage",
     # Install wagtailredirects with its appconfig
     # There's nothing special about wagtailredirects, we just need to have one
     # app which uses AppConfigs to test that hooks load properly

wagtail/test/snippets/apps.py

@@ -7,3 +7,13 @@ class WagtailSnippetsTestsAppConfig(AppConfig):
     name = "wagtail.test.snippets"
     label = "snippetstests"
     verbose_name = _("Wagtail snippets tests")
+
+    def ready(self):
+        # Test registration of permission order within the group permissions view,
+        # as per https://docs.wagtail.org/en/stable/extending/customizing_group_views.html#customizing-the-group-editor-permissions-ordering
+        # Invoking `register` from `ready` confirms that it does not perform any database queries -
+        # if it did, it would fail (on a standard test run without --keepdb at least) because the
+        # test database hasn't been migrated yet.
+        from wagtail.users.permission_order import register
+
+        register("snippetstests.fancysnippet", order=999)

wagtail/test/streamfield_migrations/testutils.py

@@ -10,7 +10,7 @@ class MigrationTestMixin:
     default_operation_and_block_path = []
     app_name = None
 
-    def init_migration(self, revisions_from=None, operations_and_block_path=None):
+    def init_migration(self, revisions_from=None, operations_and_block_paths=None):
         migration = Migration(
             "test_migration", "wagtail_streamfield_migration_toolkit_test"
         )
@@ -18,7 +18,7 @@ class MigrationTestMixin:
             app_name=self.app_name,
             model_name=self.model.__name__,
             field_name="content",
-            operations_and_block_paths=operations_and_block_path
+            operations_and_block_paths=operations_and_block_paths
             or self.default_operation_and_block_path,
             revisions_from=revisions_from,
         )
@@ -29,11 +29,11 @@ class MigrationTestMixin:
     def apply_migration(
         self,
         revisions_from=None,
-        operations_and_block_path=None,
+        operations_and_block_paths=None,
     ):
         migration = self.init_migration(
             revisions_from=revisions_from,
-            operations_and_block_path=operations_and_block_path,
+            operations_and_block_paths=operations_and_block_paths,
         )
 
         loader = MigrationLoader(connection=connection)

wagtail/test/testapp/fixtures/test.json

@@ -1027,5 +1027,12 @@
     "fields": {
       "content": "non-url-safe pk modelwithstringtypeprimarykey model"
     }
+  },
+  {
+    "pk": "web_407269_1",
+    "model": "tests.modelwithstringtypeprimarykey",
+    "fields": {
+      "content": "unquote-sensitive modelwithstringtypeprimarykey model"
+    }
   }
 ]

wagtail/test/testapp/fixtures/test_specific.json

@@ -141,7 +141,8 @@
       "audience": "public",
       "location": "The moon",
       "body": "<p>I haven't worked out the details yet, but it's going to have cake and ponies</p>",
-      "cost": "Free"
+      "cost": "Free",
+      "feed_image": 1
     }
   },
 
@@ -170,7 +171,8 @@
       "audience": "private",
       "location": "The moon",
       "body": "<p>your name's not down, you're not coming in</p>",
-      "cost": "Free (but not for you)"
+      "cost": "Free (but not for you)",
+      "feed_image": 1
     }
   },
 
@@ -246,7 +248,8 @@
       "audience": "public",
       "location": "Hobart",
       "body": "<p>Party time</p>",
-      "cost": "free"
+      "cost": "free",
+      "feed_image": 1
     }
   },