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

wagtail/snippets/tests/test_unpublish_view.py

@@ -0,0 +1,228 @@
+from unittest import mock
+
+from django.contrib.admin.utils import quote
+from django.contrib.auth.models import Permission
+from django.http import HttpRequest, HttpResponse
+from django.test import TestCase
+from django.urls import reverse
+
+from wagtail.signals import unpublished
+from wagtail.test.testapp.models import DraftStateCustomPrimaryKeyModel
+from wagtail.test.utils.wagtail_tests import WagtailTestUtils
+
+
+class TestSnippetUnpublish(WagtailTestUtils, TestCase):
+    def setUp(self):
+        self.user = self.login()
+        self.snippet = DraftStateCustomPrimaryKeyModel.objects.create(
+            custom_id="custom/1", text="to be unpublished"
+        )
+        self.unpublish_url = reverse(
+            "wagtailsnippets_tests_draftstatecustomprimarykeymodel:unpublish",
+            args=(quote(self.snippet.pk),),
+        )
+
+    def test_unpublish_view(self):
+        """
+        This tests that the unpublish view responds with an unpublish confirm page
+        """
+        # Get unpublish page
+        response = self.client.get(self.unpublish_url)
+
+        # Check that the user received an unpublish confirm page
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, "wagtailadmin/generic/confirm_unpublish.html")
+
+    def test_unpublish_view_invalid_pk(self):
+        """
+        This tests that the unpublish view returns an error if the object pk is invalid
+        """
+        # Get unpublish page
+        response = self.client.get(
+            reverse(
+                "wagtailsnippets_tests_draftstatecustomprimarykeymodel:unpublish",
+                args=(quote(12345),),
+            )
+        )
+
+        # Check that the user received a 404 response
+        self.assertEqual(response.status_code, 404)
+
+    def test_unpublish_view_get_bad_permissions(self):
+        """
+        This tests that the unpublish view doesn't allow users without unpublish permissions
+        """
+        # Remove privileges from user
+        self.user.is_superuser = False
+        self.user.user_permissions.add(
+            Permission.objects.get(
+                content_type__app_label="wagtailadmin", codename="access_admin"
+            )
+        )
+        self.user.save()
+
+        # Get unpublish page
+        response = self.client.get(self.unpublish_url)
+
+        # Check that the user received a 302 redirected response
+        self.assertEqual(response.status_code, 302)
+
+    def test_unpublish_view_post_bad_permissions(self):
+        """
+        This tests that the unpublish view doesn't allow users without unpublish permissions
+        """
+        # Connect a mock signal handler to unpublished signal
+        mock_handler = mock.MagicMock()
+        unpublished.connect(mock_handler)
+
+        try:
+            # Remove privileges from user
+            self.user.is_superuser = False
+            self.user.user_permissions.add(
+                Permission.objects.get(
+                    content_type__app_label="wagtailadmin", codename="access_admin"
+                )
+            )
+            self.user.save()
+
+            # Post to the unpublish view
+            response = self.client.post(self.unpublish_url)
+
+            # Should be redirected to the home page
+            self.assertRedirects(response, reverse("wagtailadmin_home"))
+
+            # Check that the object was not unpublished
+            self.assertTrue(
+                DraftStateCustomPrimaryKeyModel.objects.get(pk=self.snippet.pk).live
+            )
+
+            # Check that the unpublished signal was not fired
+            self.assertEqual(mock_handler.call_count, 0)
+        finally:
+            unpublished.disconnect(mock_handler)
+
+    def test_unpublish_view_post_with_publish_permission(self):
+        """
+        This posts to the unpublish view and checks that the object was unpublished,
+        using a specific publish permission instead of relying on the superuser flag
+        """
+        # Connect a mock signal handler to unpublished signal
+        mock_handler = mock.MagicMock()
+        unpublished.connect(mock_handler)
+
+        try:
+            # Only add edit and publish permissions
+            self.user.is_superuser = False
+            edit_permission = Permission.objects.get(
+                content_type__app_label="tests",
+                codename="change_draftstatecustomprimarykeymodel",
+            )
+            publish_permission = Permission.objects.get(
+                content_type__app_label="tests",
+                codename="publish_draftstatecustomprimarykeymodel",
+            )
+            admin_permission = Permission.objects.get(
+                content_type__app_label="wagtailadmin", codename="access_admin"
+            )
+            self.user.user_permissions.add(
+                edit_permission,
+                publish_permission,
+                admin_permission,
+            )
+            self.user.save()
+
+            # Post to the unpublish view
+            response = self.client.post(self.unpublish_url)
+
+            # Should be redirected to the listing page
+            self.assertRedirects(
+                response,
+                reverse("wagtailsnippets_tests_draftstatecustomprimarykeymodel:list"),
+            )
+
+            # Check that the object was unpublished
+            self.assertFalse(
+                DraftStateCustomPrimaryKeyModel.objects.get(pk=self.snippet.pk).live
+            )
+
+            # Check that the unpublished signal was fired
+            self.assertEqual(mock_handler.call_count, 1)
+            mock_call = mock_handler.mock_calls[0][2]
+
+            self.assertEqual(mock_call["sender"], DraftStateCustomPrimaryKeyModel)
+            self.assertEqual(mock_call["instance"], self.snippet)
+            self.assertIsInstance(
+                mock_call["instance"], DraftStateCustomPrimaryKeyModel
+            )
+        finally:
+            unpublished.disconnect(mock_handler)
+
+    def test_unpublish_view_post(self):
+        """
+        This posts to the unpublish view and checks that the object was unpublished
+        """
+        # Connect a mock signal handler to unpublished signal
+        mock_handler = mock.MagicMock()
+        unpublished.connect(mock_handler)
+
+        try:
+            # Post to the unpublish view
+            response = self.client.post(self.unpublish_url)
+
+            # Should be redirected to the listing page
+            self.assertRedirects(
+                response,
+                reverse("wagtailsnippets_tests_draftstatecustomprimarykeymodel:list"),
+            )
+
+            # Check that the object was unpublished
+            self.assertFalse(
+                DraftStateCustomPrimaryKeyModel.objects.get(pk=self.snippet.pk).live
+            )
+
+            # Check that the unpublished signal was fired
+            self.assertEqual(mock_handler.call_count, 1)
+            mock_call = mock_handler.mock_calls[0][2]
+
+            self.assertEqual(mock_call["sender"], DraftStateCustomPrimaryKeyModel)
+            self.assertEqual(mock_call["instance"], self.snippet)
+            self.assertIsInstance(
+                mock_call["instance"], DraftStateCustomPrimaryKeyModel
+            )
+        finally:
+            unpublished.disconnect(mock_handler)
+
+    def test_after_unpublish_hook(self):
+        def hook_func(request, snippet):
+            self.assertIsInstance(request, HttpRequest)
+            self.assertEqual(snippet.pk, self.snippet.pk)
+
+            return HttpResponse("Overridden!")
+
+        with self.register_hook("after_unpublish", hook_func):
+            post_data = {}
+            response = self.client.post(self.unpublish_url, post_data)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b"Overridden!")
+
+        self.snippet.refresh_from_db()
+        self.assertEqual(self.snippet.status_string, "draft")
+
+    def test_before_unpublish(self):
+        def hook_func(request, snippet):
+            self.assertIsInstance(request, HttpRequest)
+            self.assertEqual(snippet.pk, self.snippet.pk)
+
+            return HttpResponse("Overridden!")
+
+        with self.register_hook("before_unpublish", hook_func):
+            post_data = {}
+            response = self.client.post(self.unpublish_url, post_data)
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b"Overridden!")
+
+        # The hook response is served before unpublish is called.
+        self.snippet.refresh_from_db()
+        self.assertEqual(self.snippet.status_string, "live")

wagtail/snippets/tests/test_unschedule_view.py

@@ -0,0 +1,151 @@
+import datetime
+
+from django.contrib.admin.utils import quote
+from django.contrib.auth.models import Permission
+from django.test import TestCase
+from django.urls import reverse
+from django.utils.timezone import now
+
+from wagtail.models import Revision
+from wagtail.test.testapp.models import DraftStateCustomPrimaryKeyModel
+from wagtail.test.utils import WagtailTestUtils
+
+
+class TestSnippetUnschedule(WagtailTestUtils, TestCase):
+    def setUp(self):
+        self.user = self.login()
+        self.test_snippet = DraftStateCustomPrimaryKeyModel.objects.create(
+            custom_id="custom/1", text="Draft-enabled Foo", live=False
+        )
+        self.go_live_at = now() + datetime.timedelta(days=1)
+        self.test_snippet.text = "I've been edited!"
+        self.test_snippet.go_live_at = self.go_live_at
+        self.latest_revision = self.test_snippet.save_revision()
+        self.latest_revision.publish()
+        self.test_snippet.refresh_from_db()
+        self.unschedule_url = reverse(
+            "wagtailsnippets_tests_draftstatecustomprimarykeymodel:revisions_unschedule",
+            args=[quote(self.test_snippet.pk), self.latest_revision.pk],
+        )
+
+    def set_permissions(self, set_publish_permission):
+        self.user.is_superuser = False
+
+        permissions = [
+            Permission.objects.get(
+                content_type__app_label="tests",
+                codename="change_draftstatecustomprimarykeymodel",
+            ),
+            Permission.objects.get(
+                content_type__app_label="wagtailadmin", codename="access_admin"
+            ),
+        ]
+
+        if set_publish_permission:
+            permissions.append(
+                Permission.objects.get(
+                    content_type__app_label="tests",
+                    codename="publish_draftstatecustomprimarykeymodel",
+                )
+            )
+
+        self.user.user_permissions.add(*permissions)
+        self.user.save()
+
+    def test_get_unschedule_view_with_publish_permissions(self):
+        self.set_permissions(True)
+
+        # Get unschedule page
+        response = self.client.get(self.unschedule_url)
+
+        # Check that the user received a confirmation page
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(
+            response, "wagtailadmin/shared/revisions/confirm_unschedule.html"
+        )
+
+    def test_get_unschedule_view_bad_permissions(self):
+        self.set_permissions(False)
+
+        # Get unschedule page
+        response = self.client.get(self.unschedule_url)
+
+        # Check that the user is redirected to the admin homepage
+        self.assertRedirects(response, reverse("wagtailadmin_home"))
+
+    def test_post_unschedule_view_with_publish_permissions(self):
+        self.set_permissions(True)
+
+        # Post unschedule page
+        response = self.client.post(self.unschedule_url)
+
+        # Check that the user was redirected to the history page
+        self.assertRedirects(
+            response,
+            reverse(
+                "wagtailsnippets_tests_draftstatecustomprimarykeymodel:history",
+                args=[quote(self.test_snippet.pk)],
+            ),
+        )
+
+        self.test_snippet.refresh_from_db()
+        self.latest_revision.refresh_from_db()
+
+        # Check that the revision is no longer scheduled
+        self.assertIsNone(self.latest_revision.approved_go_live_at)
+
+        # No revisions with approved_go_live_at
+        self.assertFalse(
+            Revision.objects.for_instance(self.test_snippet)
+            .exclude(approved_go_live_at__isnull=True)
+            .exists()
+        )
+
+    def test_post_unschedule_view_bad_permissions(self):
+        self.set_permissions(False)
+
+        # Post unschedule page
+        response = self.client.post(self.unschedule_url)
+
+        # Check that the user is redirected to the admin homepage
+        self.assertRedirects(response, reverse("wagtailadmin_home"))
+
+        self.test_snippet.refresh_from_db()
+        self.latest_revision.refresh_from_db()
+
+        # Check that the revision is still scheduled
+        self.assertIsNotNone(self.latest_revision.approved_go_live_at)
+
+        # Revision with approved_go_live_at exists
+        self.assertTrue(
+            Revision.objects.for_instance(self.test_snippet)
+            .exclude(approved_go_live_at__isnull=True)
+            .exists()
+        )
+
+    def test_post_unschedule_view_with_next_url(self):
+        self.set_permissions(True)
+
+        edit_url = reverse(
+            "wagtailsnippets_tests_draftstatecustomprimarykeymodel:edit",
+            args=[quote(self.test_snippet.pk)],
+        )
+
+        # Post unschedule page
+        response = self.client.post(self.unschedule_url + f"?next={edit_url}")
+
+        # Check that the user was redirected to the next url
+        self.assertRedirects(response, edit_url)
+
+        self.test_snippet.refresh_from_db()
+        self.latest_revision.refresh_from_db()
+
+        # Check that the revision is no longer scheduled
+        self.assertIsNone(self.latest_revision.approved_go_live_at)
+
+        # No revisions with approved_go_live_at
+        self.assertFalse(
+            Revision.objects.for_instance(self.test_snippet)
+            .exclude(approved_go_live_at__isnull=True)
+            .exists()
+        )

wagtail/snippets/tests/test_viewset.py

@@ -33,6 +33,8 @@ from wagtail.snippets.views.snippets import SnippetViewSet
 from wagtail.snippets.widgets import AdminSnippetChooser
 from wagtail.test.testapp.models import (
     Advert,
+    AdvertTag,
+    AdvertWithCustomUUIDPrimaryKey,
     DraftStateModel,
     FullFeaturedSnippet,
     ModeratedModel,
@@ -60,6 +62,21 @@ class TestIncorrectRegistration(SimpleTestCase):
         )
 
 
+class TestIncorrectConverter(SimpleTestCase):
+    def test_unknown_converter(self):
+        class BadViewSet(SnippetViewSet):
+            model = AdvertTag
+            pk_path_converter = "foo"
+
+        with self.assertRaises(ImproperlyConfigured) as cm:
+            register_snippet(BadViewSet)
+        message = str(cm.exception)
+        self.assertEqual(
+            "BadViewSet.pk_path_converter is not a registered path converter",
+            message,
+        )
+
+
 class BaseSnippetViewSetTests(WagtailTestUtils, TestCase):
     model = None
 
@@ -383,6 +400,20 @@ class TestAdminURLs(BaseSnippetViewSetTests):
             expected_choose_url,
         )
 
+    def test_cannot_reverse_mismatched_converter_value(self):
+        viewset = AdvertWithCustomUUIDPrimaryKey.snippet_viewset
+        with self.assertRaises(NoReverseMatch):
+            reverse(viewset.get_url_name("edit"), kwargs={"pk": 123})
+
+    def test_404_on_mismatched_converter_value(self):
+        viewsets = [
+            AdvertWithCustomUUIDPrimaryKey.snippet_viewset,
+            FullFeaturedSnippet.snippet_viewset,
+        ]
+        for viewset in viewsets:
+            response = self.client.get(f"/admin/{viewset.url_prefix}/edit/123abc/")
+            self.assertEqual(response.status_code, 404)
+
 
 class TestPagination(BaseSnippetViewSetTests):
     @classmethod
@@ -444,7 +475,7 @@ class TestPagination(BaseSnippetViewSetTests):
 class TestFilterSetClass(BaseSnippetViewSetTests):
     model = FullFeaturedSnippet
 
-    def get(self, params={}):
+    def get(self, params=None):
         return self.client.get(self.get_url("list"), params)
 
     def create_test_snippets(self):
@@ -570,7 +601,7 @@ class TestFilterSetClassSearch(WagtailTestUtils, TransactionTestCase):
             FullFeaturedSnippet.snippet_viewset.get_url_name(url_name), args=args
         )
 
-    def get(self, params={}):
+    def get(self, params=None):
         return self.client.get(self.get_url("list"), params)
 
     def create_test_snippets(self):
@@ -611,7 +642,7 @@ class TestListFilterWithList(BaseSnippetViewSetTests):
         self.date = now()
         self.date_str = self.date.isoformat()
 
-    def get(self, params={}):
+    def get(self, params=None):
         return self.client.get(self.get_url("list"), params)
 
     def create_test_snippets(self):
@@ -746,7 +777,7 @@ class TestListViewWithCustomColumns(BaseSnippetViewSetTests):
         cls.model.objects.create(text="From Indonesia", country_code="ID")
         cls.model.objects.create(text="From the UK", country_code="UK")
 
-    def get(self, params={}):
+    def get(self, params=None):
         return self.client.get(self.get_url("list"), params)
 
     def test_custom_columns(self):
@@ -1091,7 +1122,7 @@ class TestDjangoORMSearchBackend(BaseSnippetViewSetTests):
             text="Python is a programming-bas, uh, language",
         )
 
-    def get(self, params={}, url_name="list"):
+    def get(self, params=None, url_name="list"):
         return self.client.get(self.get_url(url_name), params)
 
     def test_simple(self):
@@ -1658,6 +1689,7 @@ class TestCustomMethods(BaseSnippetViewSetTests):
             {
                 "data-controller": "w-teleport",
                 "data-w-teleport-target-value": "#w-slim-header-buttons",
+                "data-w-teleport-mode-value": "innerHTML",
             },
         )
         self.assertIsNotNone(template)
@@ -1675,6 +1707,7 @@ class TestCustomMethods(BaseSnippetViewSetTests):
             {
                 "data-controller": "w-teleport",
                 "data-w-teleport-target-value": "#w-slim-header-buttons",
+                "data-w-teleport-mode-value": "innerHTML",
             },
         )
         self.assertIsNotNone(template)