From 49a835c5eb6c59a01bcec86a270c405523c23a48 Mon Sep 17 00:00:00 2001 From: Sage Abdullah Date: Fri, 8 Mar 2024 20:01:10 +0000 Subject: [PATCH] Add tests for page_breadcrumbs tag To ensure we don't break things while refactoring --- wagtail/admin/tests/test_templatetags.py | 177 ++++++++++++++++++++++- 1 file changed, 176 insertions(+), 1 deletion(-) diff --git a/wagtail/admin/tests/test_templatetags.py b/wagtail/admin/tests/test_templatetags.py index 3388a12885..ce4274f1a9 100644 --- a/wagtail/admin/tests/test_templatetags.py +++ b/wagtail/admin/tests/test_templatetags.py @@ -19,8 +19,9 @@ from wagtail.admin.templatetags.wagtailadmin_tags import ( timesince_simple, ) from wagtail.admin.templatetags.wagtailadmin_tags import locales as locales_tag +from wagtail.coreutils import get_dummy_request from wagtail.images.tests.utils import get_test_image_file -from wagtail.models import Locale +from wagtail.models import Locale, Page from wagtail.test.utils import WagtailTestUtils from wagtail.test.utils.template_tests import AdminTemplateTestUtils from wagtail.users.models import UserProfile @@ -701,3 +702,177 @@ class BreadcrumbsTagTest(AdminTemplateTestUtils, WagtailTestUtils, SimpleTestCas div = soup.select_one("div.w-breadcrumbs") self.assertIsNotNone(div) self.assertIn("my-class", div["class"]) + + +class PageBreadcrumbsTagTest(AdminTemplateTestUtils, WagtailTestUtils, TestCase): + fixtures = ["test.json"] + base_breadcrumb_items = [] + + def setUp(self): + self.request = get_dummy_request() + self.user = self.login() + self.request.user = self.user + + def test_root_single_item(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_explore' url_root_name='wagtailadmin_explore_root' %} + """ + page = Page.objects.get(id=1) + items = [{"label": "Root", "url": "/admin/pages/"}] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + # Without specifying is_expanded=False, the breadcrumbs should not be + # collapsible anyway, so it is not controlled by Stimulus + soup = self.get_soup(rendered) + breadcrumbs = soup.select_one(".w-breadcrumbs") + self.assertIsNotNone(breadcrumbs) + self.assertIsNone(breadcrumbs.get("data-controller")) + + def test_url_name(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_choose_page_child' %} + """ + page = Page.objects.get(id=15) + items = [ + { + "label": "Root", + "url": "/admin/choose-page/1/", + }, + { + "label": "Welcome to the Wagtail test site!", + "url": "/admin/choose-page/2/", + }, + { + "label": "Events", + "url": "/admin/choose-page/3/", + }, + { + "label": "Businessy events", + "url": "/admin/choose-page/15/", + }, + ] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + + def test_not_include_self(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_explore' url_root_name='wagtailadmin_explore_root' include_self=False %} + """ + page = Page.objects.get(id=15) + items = [ + {"label": "Root", "url": "/admin/pages/"}, + {"label": "Welcome to the Wagtail test site!", "url": "/admin/pages/2/"}, + {"label": "Events", "url": "/admin/pages/3/"}, + ] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + + def test_not_is_expanded(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_explore' url_root_name='wagtailadmin_explore_root' %} + """ + page = Page.objects.get(id=15) + items = [ + {"label": "Root", "url": "/admin/pages/"}, + {"label": "Welcome to the Wagtail test site!", "url": "/admin/pages/2/"}, + {"label": "Events", "url": "/admin/pages/3/"}, + {"label": "Businessy events", "url": "/admin/pages/15/"}, + ] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + # If is_expanded=False, the breadcrumbs should be collapsible via Stimulus + soup = self.get_soup(rendered) + breadcrumbs = soup.select_one(".w-breadcrumbs") + self.assertIsNotNone(breadcrumbs) + self.assertEqual(breadcrumbs.get("data-controller"), "w-breadcrumbs") + + def test_is_expanded(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_explore' url_root_name='wagtailadmin_explore_root' is_expanded=True %} + """ + page = Page.objects.get(id=15) + items = [ + {"label": "Root", "url": "/admin/pages/"}, + {"label": "Welcome to the Wagtail test site!", "url": "/admin/pages/2/"}, + {"label": "Events", "url": "/admin/pages/3/"}, + {"label": "Businessy events", "url": "/admin/pages/15/"}, + ] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + # If is_expanded=True, the breadcrumbs should not be collapsible, so it + # is not controlled by Stimulus + soup = self.get_soup(rendered) + breadcrumbs = soup.select_one(".w-breadcrumbs") + self.assertIsNotNone(breadcrumbs) + self.assertIsNone(breadcrumbs.get("data-controller")) + + def test_querystring_value(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_explore' url_root_name='wagtailadmin_explore_root' querystring_value='?site=2&has_child_pages=true' %} + """ + page = Page.objects.get(id=15) + params = "?site=2&has_child_pages=true" + items = [ + {"label": "Root", "url": f"/admin/pages/{params}"}, + { + "label": "Welcome to the Wagtail test site!", + "url": f"/admin/pages/2/{params}", + }, + {"label": "Events", "url": f"/admin/pages/3/{params}"}, + {"label": "Businessy events", "url": f"/admin/pages/15/{params}"}, + ] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + + def test_trailing_breadcrumb_title(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_explore' url_root_name='wagtailadmin_explore_root' trailing_breadcrumb_title='New: Simple Page' %} + """ + page = Page.objects.get(id=15) + items = [ + {"label": "Root", "url": "/admin/pages/"}, + {"label": "Welcome to the Wagtail test site!", "url": "/admin/pages/2/"}, + {"label": "Events", "url": "/admin/pages/3/"}, + {"label": "Businessy events", "url": "/admin/pages/15/"}, + {"label": "New: Simple Page"}, + ] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + + def test_classname(self): + template = """ + {% load wagtailadmin_tags %} + {% page_breadcrumbs page 'wagtailadmin_choose_page_child' classname='my-class' %} + """ + page = Page.objects.get(id=1) + items = [{"label": "Root", "url": "/admin/choose-page/1/"}] + rendered = Template(template).render( + Context({"page": page, "request": self.request}) + ) + self.assertBreadcrumbsItemsRendered(items, rendered) + + soup = self.get_soup(rendered) + div = soup.select_one("div.w-breadcrumbs") + self.assertIsNotNone(div) + self.assertIn("my-class", div["class"])