wagtail 6.2.3__py3-none-any.whl → 6.3__py3-none-any.whl

wagtail/snippets/tests/test_workflows.py

@@ -1,12 +1,20 @@
+import datetime
+
+from django.conf import settings
 from django.contrib.admin.utils import quote
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from django.test import TestCase, override_settings
 from django.urls import reverse
+from django.utils import timezone
+from django.utils.formats import localize
+from freezegun import freeze_time
 
+from wagtail.admin.utils import get_user_display_name
 from wagtail.models import Workflow, WorkflowContentType, WorkflowState
 from wagtail.test.testapp.models import FullFeaturedSnippet, ModeratedModel
 from wagtail.test.utils import WagtailTestUtils
+from wagtail.test.utils.template_tests import AdminTemplateTestUtils
 
 # This module serves to gather snippets-equivalent of workflows-related tests
 # that are found throughout page-specific test modules, e.g. test_create_page.py,
@@ -153,18 +161,50 @@ class TestEditViewNotLockable(TestEditView):
     model = ModeratedModel
 
 
-class TestWorkflowHistory(BaseWorkflowsTestCase):
+class TestWorkflowHistory(AdminTemplateTestUtils, BaseWorkflowsTestCase):
+    base_breadcrumb_items = AdminTemplateTestUtils.base_breadcrumb_items + [
+        {"label": "Snippets", "url": "/admin/snippets/"},
+    ]
+
     def setUp(self):
         super().setUp()
+        self.timestamps = [
+            datetime.datetime(2020, 1, 1, 10, 0, 0),
+            datetime.datetime(2020, 1, 1, 11, 0, 0),
+            datetime.datetime(2020, 1, 2, 12, 0, 0),
+            datetime.datetime(2020, 1, 3, 13, 0, 0),
+            datetime.datetime(2020, 1, 4, 14, 0, 0),
+        ]
+
+        if settings.USE_TZ:
+            self.timestamps[:] = [
+                timezone.make_aware(timestamp, timezone=datetime.timezone.utc)
+                for timestamp in self.timestamps
+            ]
+            self.localized_timestamps = [
+                localize(timezone.localtime(timestamp), "c")
+                for timestamp in self.timestamps
+            ]
+        else:
+            self.localized_timestamps = [
+                localize(timestamp, "c") for timestamp in self.timestamps
+            ]
+
+        self.moderator = self.create_superuser("moderator")
+        self.moderator_name = get_user_display_name(self.moderator)
+        self.user_name = get_user_display_name(self.user)
+
         self.object.text = "Edited!"
-        self.object.save_revision()
-        self.workflow_state = self.workflow.start(self.object, self.user)
+        with freeze_time(self.timestamps[0]):
+            self.object.save_revision()
+        with freeze_time(self.timestamps[1]):
+            self.workflow_state = self.workflow.start(self.object, self.user)
 
     def test_get_index(self):
         response = self.client.get(self.get_url("workflow_history"))
         self.assertEqual(response.status_code, 200)
         self.assertTemplateUsed(
-            response, "wagtailadmin/shared/workflow_history/index.html"
+            response, "wagtailadmin/shared/workflow_history/listing.html"
         )
 
         self.assertContains(response, self.get_url("edit"))
@@ -196,12 +236,28 @@ class TestWorkflowHistory(BaseWorkflowsTestCase):
         self.assertRedirects(response, reverse("wagtailadmin_home"))
 
     def test_get_detail(self):
-        response = self.client.get(
-            self.get_url(
-                "workflow_history_detail",
-                (quote(self.object.pk), self.workflow_state.id),
-            ),
+        task_state = self.workflow_state.current_task_state
+
+        with freeze_time(self.timestamps[2]):
+            task_state.task.on_action(
+                task_state, user=self.moderator, action_name="reject"
+            )
+        self.workflow_state.refresh_from_db()
+
+        with freeze_time(self.timestamps[3]):
+            self.object.save_revision(user=self.user)
+            self.workflow_state.resume(user=self.user)
+        self.workflow_state.refresh_from_db()
+
+        url = self.get_url(
+            "workflow_history_detail",
+            (quote(self.object.pk), self.workflow_state.id),
         )
+        self.client.get(url)
+
+        with self.assertNumQueries(18):
+            response = self.client.get(url)
+
         self.assertEqual(response.status_code, 200)
         self.assertTemplateUsed(
             response, "wagtailadmin/shared/workflow_history/detail.html"
@@ -212,8 +268,61 @@ class TestWorkflowHistory(BaseWorkflowsTestCase):
 
         self.assertContains(response, '<div class="w-tabs" data-tabs>')
         self.assertContains(response, '<div class="tab-content">')
-        self.assertContains(response, "Tasks")
-        self.assertContains(response, "Timeline")
+
+        soup = self.get_soup(response.content)
+        tasks = soup.select_one("#tab-tasks table")
+        self.assertIsNotNone(tasks)
+        cells = [
+            [td.get_text(separator=" ", strip=True) for td in tr.select("td")]
+            for tr in tasks.select("tr")
+        ]
+
+        self.assertEqual(
+            cells,
+            [
+                # This is divided into different columns per task, so it makes
+                # sense to start with the initial revision on the first cell and
+                # then it should be rendered in ascending order.
+                [
+                    "Initial Revision",
+                    f"Rejected by {self.moderator_name} at {self.localized_timestamps[2]}",
+                ],
+                [
+                    f"Edited by {self.user_name} at {self.localized_timestamps[3]}",
+                    "In progress",
+                ],
+            ],
+        )
+
+        timeline = soup.select_one("#tab-timeline table")
+        self.assertIsNotNone(timeline)
+        cells = [
+            [td.get_text(separator=" ", strip=True) for td in tr.select("td")]
+            for tr in timeline.select("tr")
+        ]
+        self.assertEqual(
+            cells,
+            [
+                # The items are merged into a single column as a timeline, so it
+                # should be rendered in reverse chronological order.
+                [
+                    self.localized_timestamps[3],
+                    "Edited",
+                ],
+                [
+                    self.localized_timestamps[2],
+                    f"Moderators approval Rejected by {self.moderator_name}",
+                ],
+                [
+                    self.localized_timestamps[1],
+                    "Workflow started",
+                ],
+                [
+                    self.localized_timestamps[0],
+                    "Edited",
+                ],
+            ],
+        )
 
         # Should show the currently in progress workflow with the latest revision
         self.assertContains(response, "Edited!")
@@ -221,14 +330,57 @@ class TestWorkflowHistory(BaseWorkflowsTestCase):
         self.assertContains(response, "In progress")
         self.assertContains(response, "test@email.com")
 
+        items = [
+            {
+                "url": self.get_url("list", args=()),
+                "label": "Full-featured snippets",
+            },
+            {
+                "url": self.get_url("edit"),
+                "label": str(self.object),
+            },
+            {
+                "url": self.get_url("workflow_history"),
+                "label": "Workflow history",
+            },
+            {
+                "url": "",
+                "label": "Workflow progress",
+                "sublabel": str(self.object),
+            },
+        ]
+        self.assertBreadcrumbsItemsRendered(items, response.content)
+
     def test_get_detail_completed(self):
-        self.workflow_state.current_task_state.approve(user=None)
-        response = self.client.get(
-            self.get_url(
-                "workflow_history_detail",
-                (quote(self.object.pk), self.workflow_state.id),
-            ),
+        task_state = self.workflow_state.current_task_state
+
+        with freeze_time(self.timestamps[2]):
+            task_state.task.on_action(
+                task_state, user=self.moderator, action_name="reject"
+            )
+        self.workflow_state.refresh_from_db()
+
+        with freeze_time(self.timestamps[3]):
+            self.object.save_revision(user=self.user)
+            self.workflow_state.resume(user=self.user)
+        self.workflow_state.refresh_from_db()
+
+        with freeze_time(self.timestamps[4]):
+            task_state = self.workflow_state.current_task_state
+            task_state.task.on_action(
+                task_state, user=self.moderator, action_name="approve"
+            )
+        self.workflow_state.refresh_from_db()
+
+        url = self.get_url(
+            "workflow_history_detail",
+            (quote(self.object.pk), self.workflow_state.id),
         )
+        self.client.get(url)
+
+        with self.assertNumQueries(19):
+            response = self.client.get(url)
+
         self.assertEqual(response.status_code, 200)
         self.assertTemplateUsed(
             response, "wagtailadmin/shared/workflow_history/detail.html"
@@ -239,8 +391,69 @@ class TestWorkflowHistory(BaseWorkflowsTestCase):
 
         self.assertContains(response, '<div class="w-tabs" data-tabs>')
         self.assertContains(response, '<div class="tab-content">')
-        self.assertContains(response, "Tasks")
-        self.assertContains(response, "Timeline")
+
+        soup = self.get_soup(response.content)
+        tasks = soup.select_one("#tab-tasks table")
+        self.assertIsNotNone(tasks)
+        cells = [
+            [td.get_text(separator=" ", strip=True) for td in tr.select("td")]
+            for tr in tasks.select("tr")
+        ]
+
+        self.assertEqual(
+            cells,
+            [
+                # This is divided into different columns per task, so it makes
+                # sense to start with the initial revision on the first cell and
+                # then it should be rendered in ascending order.
+                [
+                    "Initial Revision",
+                    f"Rejected by {self.moderator_name} at {self.localized_timestamps[2]}",
+                ],
+                [
+                    f"Edited by {self.user_name} at {self.localized_timestamps[3]}",
+                    f"Approved by {self.moderator_name} at {self.localized_timestamps[4]}",
+                ],
+            ],
+        )
+
+        timeline = soup.select_one("#tab-timeline table")
+        self.assertIsNotNone(timeline)
+        cells = [
+            [td.get_text(separator=" ", strip=True) for td in tr.select("td")]
+            for tr in timeline.select("tr")
+        ]
+        self.assertEqual(
+            cells,
+            [
+                # The items are merged into a single column as a timeline, so it
+                # should be rendered in reverse chronological order.
+                [
+                    self.localized_timestamps[4],
+                    "Workflow completed Approved",
+                ],
+                [
+                    self.localized_timestamps[4],
+                    f"Moderators approval Approved by {self.moderator_name}",
+                ],
+                [
+                    self.localized_timestamps[3],
+                    "Edited",
+                ],
+                [
+                    self.localized_timestamps[2],
+                    f"Moderators approval Rejected by {self.moderator_name}",
+                ],
+                [
+                    self.localized_timestamps[1],
+                    "Workflow started",
+                ],
+                [
+                    self.localized_timestamps[0],
+                    "Edited",
+                ],
+            ],
+        )
 
         # Should show the completed workflow with the latest revision
         self.assertContains(response, "Edited!")

wagtail/snippets/views/snippets.py

@@ -77,7 +77,6 @@ class ModelIndexView(generic.BaseListingView):
     header_icon = "snippet"
     index_url_name = "wagtailsnippets:index"
     default_ordering = "name"
-    _show_breadcrumbs = True
 
     def setup(self, request, *args, **kwargs):
         super().setup(request, *args, **kwargs)
@@ -100,9 +99,6 @@ class ModelIndexView(generic.BaseListingView):
             raise PermissionDenied
         return super().dispatch(request, *args, **kwargs)
 
-    def get_breadcrumbs_items(self):
-        return self.breadcrumbs_items + [{"url": "", "label": _("Snippets")}]
-
     def get_list_url(self, model):
         if model.snippet_viewset.permission_policy.user_has_any_permission(
             self.request.user,
@@ -765,11 +761,9 @@ class SnippetViewSet(ModelViewSet):
                 "workflow_history/index",
                 fallback=self.workflow_history_view_class.template_name,
             ),
-            workflow_history_url_name=self.get_url_name("workflow_history"),
             workflow_history_detail_url_name=self.get_url_name(
                 "workflow_history_detail"
             ),
-            _show_breadcrumbs=False,
         )
 
     @property
@@ -780,10 +774,7 @@ class SnippetViewSet(ModelViewSet):
                 "workflow_history/detail",
                 fallback=self.workflow_history_detail_view_class.template_name,
             ),
-            object_icon=self.icon,
-            header_icon="list-ul",
             workflow_history_url_name=self.get_url_name("workflow_history"),
-            _show_breadcrumbs=False,
         )
 
     @property
@@ -840,7 +831,7 @@ class SnippetViewSet(ModelViewSet):
 
         **Deprecated** - the preferred way to customise this is to define a ``menu_label`` property.
         """
-        return self.model_opts.verbose_name_plural.title()
+        return capfirst(self.model_opts.verbose_name_plural)
 
     @cached_property
     def menu_name(self):

wagtail/test/numberformat.py

@@ -0,0 +1,104 @@
+# Patch Django's number formatting functions during tests so that outputting a number onto a
+# template without explicitly passing it through one of |intcomma, |localize, |unlocalize or
+# |filesizeformat will raise an exception. This helps to catch bugs where
+# USE_THOUSAND_SEPARATOR = True incorrectly reformats numbers that are not intended to be
+# human-readable (such as image dimensions, or IDs within data attributes).
+
+from decimal import Decimal
+
+import django.contrib.humanize.templatetags.humanize
+import django.template.defaultfilters
+import django.templatetags.l10n
+import django.utils.numberformat
+from django.core.exceptions import ImproperlyConfigured
+from django.utils import formats
+from django.utils.html import avoid_wrapping
+from django.utils.translation import gettext, ngettext
+
+original_numberformat = django.utils.numberformat.format
+original_intcomma = django.contrib.humanize.templatetags.humanize.intcomma
+
+
+def patched_numberformat(*args, use_l10n=None, **kwargs):
+    if use_l10n is False or use_l10n == "explicit":
+        return original_numberformat(*args, use_l10n=use_l10n, **kwargs)
+
+    raise ImproperlyConfigured(
+        "A number was used directly on a template. "
+        "Numbers output on templates should be passed through one of |intcomma, |localize, "
+        "|unlocalize or |filesizeformat to avoid issues with USE_THOUSAND_SEPARATOR."
+    )
+
+
+def patched_intcomma(value, use_l10n=True):
+    if use_l10n:
+        try:
+            if not isinstance(value, (float, Decimal)):
+                value = int(value)
+        except (TypeError, ValueError):
+            return original_intcomma(value, False)
+        else:
+            return formats.number_format(
+                value, use_l10n="explicit", force_grouping=True
+            )
+
+    return original_intcomma(value, use_l10n=use_l10n)
+
+
+def patched_filesizeformat(bytes_):
+    """
+    Format the value like a 'human-readable' file size (i.e. 13 KB, 4.1 MB,
+    102 bytes, etc.).
+    """
+    try:
+        bytes_ = int(bytes_)
+    except (TypeError, ValueError, UnicodeDecodeError):
+        value = ngettext("%(size)d byte", "%(size)d bytes", 0) % {"size": 0}
+        return avoid_wrapping(value)
+
+    def filesize_number_format(value):
+        return formats.number_format(round(value, 1), 1, use_l10n="explicit")
+
+    KB = 1 << 10
+    MB = 1 << 20
+    GB = 1 << 30
+    TB = 1 << 40
+    PB = 1 << 50
+
+    negative = bytes_ < 0
+    if negative:
+        bytes_ = -bytes_  # Allow formatting of negative numbers.
+
+    if bytes_ < KB:
+        value = ngettext("%(size)d byte", "%(size)d bytes", bytes_) % {"size": bytes_}
+    elif bytes_ < MB:
+        value = gettext("%s KB") % filesize_number_format(bytes_ / KB)
+    elif bytes_ < GB:
+        value = gettext("%s MB") % filesize_number_format(bytes_ / MB)
+    elif bytes_ < TB:
+        value = gettext("%s GB") % filesize_number_format(bytes_ / GB)
+    elif bytes_ < PB:
+        value = gettext("%s TB") % filesize_number_format(bytes_ / TB)
+    else:
+        value = gettext("%s PB") % filesize_number_format(bytes_ / PB)
+
+    if negative:
+        value = "-%s" % value
+    return avoid_wrapping(value)
+
+
+def patched_localize(value):
+    return str(formats.localize(value, use_l10n="explicit"))
+
+
+def patch_number_formats():
+    django.utils.numberformat.format = patched_numberformat
+    django.contrib.humanize.templatetags.humanize.intcomma = patched_intcomma
+    django.template.defaultfilters.filesizeformat = patched_filesizeformat
+    django.template.defaultfilters.register.filter(
+        "filesizeformat", patched_filesizeformat, is_safe=True
+    )
+    django.templatetags.l10n.localize = patched_localize
+    django.templatetags.l10n.register.filter(
+        "localize", patched_localize, is_safe=False
+    )

wagtail/test/settings.py

@@ -3,6 +3,16 @@ import os
 from django.contrib.messages import constants as message_constants
 from django.utils.translation import gettext_lazy as _
 
+from wagtail.test.numberformat import patch_number_formats
+
+WAGTAIL_CHECK_TEMPLATE_NUMBER_FORMAT = (
+    os.environ.get("WAGTAIL_CHECK_TEMPLATE_NUMBER_FORMAT", "0") == "1"
+)
+if WAGTAIL_CHECK_TEMPLATE_NUMBER_FORMAT:
+    # Patch Django number formatting functions to raise exceptions if a number is output directly
+    # on a template (which is liable to cause bugs when USE_THOUSAND_SEPARATOR is in use).
+    patch_number_formats()
+
 DEBUG = os.environ.get("DJANGO_DEBUG", "false").lower() == "true"
 WAGTAIL_ROOT = os.path.dirname(os.path.dirname(__file__))
 WAGTAILADMIN_BASE_URL = "http://testserver"

wagtail/test/settings_ui.py

@@ -25,3 +25,5 @@ PATTERN_LIBRARY = {
     "PATTERN_BASE_TEMPLATE_NAME": "",
     "BASE_TEMPLATE_NAMES": [],
 }
+
+DEBUG = True

wagtail/test/testapp/migrations/0010_alter_customimage_file_and_more.py

@@ -1,78 +1,71 @@
-# Generated by Django 4.0.7 on 2022-10-19 00:20
-
-from django import VERSION as DJANGO_VERSION
-from django.db import migrations
-import wagtail.images.models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ("tests", "0009_alter_eventpage_options"),
-    ]
-
-    rendition_file_options = {
-        "height_field": "height",
-        "upload_to": wagtail.images.models.get_rendition_upload_to,
-        "width_field": "width",
-    }
-    # See https://code.djangoproject.com/ticket/34192 - prior to Django 4.2, a callable storage
-    # argument that returns default_storage would be incorrectly omitted from the deconstructed
-    # field. We need to match that behaviour and include/omit it accordingly to prevent
-    # makemigrations from seeing a difference and generating a spurious migration in
-    # wagtail.images.
-    if DJANGO_VERSION >= (4, 2):
-        rendition_file_options["storage"] = wagtail.images.models.get_rendition_storage
-
-    operations = [
-        migrations.AlterField(
-            model_name="customimage",
-            name="file",
-            field=wagtail.images.models.WagtailImageField(
-                height_field="height",
-                upload_to=wagtail.images.models.get_upload_to,
-                verbose_name="file",
-                width_field="width",
-            ),
-        ),
-        migrations.AlterField(
-            model_name="customimagefilepath",
-            name="file",
-            field=wagtail.images.models.WagtailImageField(
-                height_field="height",
-                upload_to=wagtail.images.models.get_upload_to,
-                verbose_name="file",
-                width_field="width",
-            ),
-        ),
-        migrations.AlterField(
-            model_name="customimagewithauthor",
-            name="file",
-            field=wagtail.images.models.WagtailImageField(
-                height_field="height",
-                upload_to=wagtail.images.models.get_upload_to,
-                verbose_name="file",
-                width_field="width",
-            ),
-        ),
-        migrations.AlterField(
-            model_name="customrendition",
-            name="file",
-            field=wagtail.images.models.WagtailImageField(**rendition_file_options),
-        ),
-        migrations.AlterField(
-            model_name="customrenditionwithauthor",
-            name="file",
-            field=wagtail.images.models.WagtailImageField(**rendition_file_options),
-        ),
-        migrations.AlterField(
-            model_name="customrestaurantimage",
-            name="file",
-            field=wagtail.images.models.WagtailImageField(
-                height_field="height",
-                upload_to=wagtail.images.models.get_upload_to,
-                verbose_name="file",
-                width_field="width",
-            ),
-        ),
-    ]
+# Generated by Django 4.0.7 on 2022-10-19 00:20
+
+from django.db import migrations
+import wagtail.images.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0009_alter_eventpage_options"),
+    ]
+
+    rendition_file_options = {
+        "height_field": "height",
+        "upload_to": wagtail.images.models.get_rendition_upload_to,
+        "width_field": "width",
+        "storage": wagtail.images.models.get_rendition_storage,
+    }
+
+    operations = [
+        migrations.AlterField(
+            model_name="customimage",
+            name="file",
+            field=wagtail.images.models.WagtailImageField(
+                height_field="height",
+                upload_to=wagtail.images.models.get_upload_to,
+                verbose_name="file",
+                width_field="width",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="customimagefilepath",
+            name="file",
+            field=wagtail.images.models.WagtailImageField(
+                height_field="height",
+                upload_to=wagtail.images.models.get_upload_to,
+                verbose_name="file",
+                width_field="width",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="customimagewithauthor",
+            name="file",
+            field=wagtail.images.models.WagtailImageField(
+                height_field="height",
+                upload_to=wagtail.images.models.get_upload_to,
+                verbose_name="file",
+                width_field="width",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="customrendition",
+            name="file",
+            field=wagtail.images.models.WagtailImageField(**rendition_file_options),
+        ),
+        migrations.AlterField(
+            model_name="customrenditionwithauthor",
+            name="file",
+            field=wagtail.images.models.WagtailImageField(**rendition_file_options),
+        ),
+        migrations.AlterField(
+            model_name="customrestaurantimage",
+            name="file",
+            field=wagtail.images.models.WagtailImageField(
+                height_field="height",
+                upload_to=wagtail.images.models.get_upload_to,
+                verbose_name="file",
+                width_field="width",
+            ),
+        ),
+    ]