Django Migration Linter Integration

.github/workflows/ci.yml

@@ -131,6 +131,51 @@ jobs:
       - name: Test
         run: make test
 
+  test-lint-migrations:
+    runs-on: ubuntu-latest
+    needs:
+      - lint
+
+    env:
+      DJANGO_SETTINGS_MODULE: cms.settings.dev
+      DATABASE_URL: postgres://postgres:postgres@localhost/postgres # pragma: allowlist secret
+      ENABLE_DJANGO_DEFENDER: 'false'
+      POSTGRES_HOST_AUTH_METHOD: trust
+      SECRET_KEY: fake_secret_key_to_run_tests # pragma: allowlist secret
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres # pragma: allowlist secret
+          POSTGRES_DB: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Poetry
+        run: pipx install poetry==${{ env.POETRY_VERSION }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version
+          cache: poetry
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: static
+          path: cms/static_compiled/
+
+      - name: Lint Migrations
+        run: make lint-migrations
+
   docker:
     runs-on: ubuntu-latest
     steps:

Makefile

@@ -33,7 +33,7 @@ format-frontend:  ## Format front-end files (CSS, JS, YAML, MD)
 	npm run format
 
 .PHONY: lint
-lint: lint-py lint-html lint-frontend ## Run all linters (python, html, front-end)
+lint: lint-py lint-html lint-frontend lint-migrations ## Run all linters (python, html, front-end, migrations)
 
 .PHONY: lint-py
 lint-py:  ## Run all Python linters (ruff/pylint/mypy).
@@ -50,6 +50,10 @@ lint-html:  ## Run HTML Linters
 lint-frontend:  ## Run front-end linters
 	npm run lint
 
+.PHONY: lint-migrations
+lint-migrations: ## Run django-migration-linter
+	poetry run python manage.py lintmigrations --quiet ignore ok
+
 .PHONY: test
 test:  ## Run the tests and check coverage.
 	poetry run coverage erase

README.md

@@ -119,7 +119,7 @@ Follow these steps to set up and run the project using Docker.
 
     Once the containers are running, you need to manually start Django from within the web container. This allows for running both the Django server and any additional background services (e.g., schedulers).
 
-    > ⚠️ WARNING  
+    > ⚠️ WARNING
     >  The `honcho` command will pick up your local mounted `.env` file when running via `docker-compose`. Ensure that you comment out any variables in the `.env` file which might cause clashes in the container context as they will take precedence when running `honcho start`.
 
     ```bash
@@ -244,6 +244,18 @@ To lint the Python code, run:
 make lint
 ```
 
+#### Django Migration Linter
+
+[Django Migration Linter](https://github.com/3YOURMIND/django-migration-linter) for linting migrations files in the project.
+
+To lint the django migration files:
+
+```bash
+make lint-migrations
+```
+
+#### Format
+
 To auto-format the Python code, and correct fixable linting issues, run:
 
 ```bash

cms/core/migrations/0004_contactdetails_core_contactdetails_name_unique.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.1.4 on 2024-12-10 11:08
+import django
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0003_delete_tracking"),
+    ]
+
+    operations = [
+        migrations.AddConstraint(
+            model_name="contactdetails",
+            constraint=models.UniqueConstraint(
+                django.db.models.functions.text.Lower("name"),
+                django.db.models.functions.text.Lower("email"),
+                name="core_contactdetails_name_unique",
+                violation_error_message="Contact details with this name and email combination already exists.",
+            ),
+        ),
+    ]

cms/core/models/snippets.py

@@ -1,6 +1,8 @@
-from typing import ClassVar
+from typing import Any, ClassVar
 
 from django.db import models
+from django.db.models.functions import Lower
+from django.utils.translation import gettext_lazy as _
 from wagtail.admin.panels import FieldPanel
 from wagtail.search import index
 
@@ -26,11 +28,26 @@ class ContactDetails(index.Indexed, models.Model):
         index.SearchField("name"),
         index.AutocompleteField("name"),
         index.SearchField("email"),
+        index.AutocompleteField("email"),
         index.SearchField("phone"),
     ]
 
     class Meta:
-        verbose_name_plural = "contact details"
+        verbose_name = _("contact details")
+        verbose_name_plural = _("contact details")
+        constraints: ClassVar[list[models.BaseConstraint]] = [
+            models.UniqueConstraint(
+                Lower("name"),
+                Lower("email"),
+                name="core_contactdetails_name_unique",
+                violation_error_message=_("Contact details with this name and email combination already exists."),
+            ),
+        ]
+
+    def save(self, *args: Any, **kwargs: Any) -> None:
+        if self.name:
+            self.name = self.name.strip()
+        super().save(*args, **kwargs)
 
     def __str__(self) -> str:
         return str(self.name)

cms/core/tests/test_models.py

@@ -1,12 +1,45 @@
+from django.db import IntegrityError
 from django.test import TestCase
+from django.urls import reverse
+from wagtail.test.utils.wagtail_tests import WagtailTestUtils
 
 from cms.core.models import ContactDetails
 
 
-class ContactDetailsTestCase(TestCase):
-    """Tests for the ContactDetails model."""
+class ContactDetailsTestCase(WagtailTestUtils, TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.contact = ContactDetails.objects.create(name="PSF", email="[email protected]")
 
     def test_contactdetails__str(self):
-        """Checks the contact details string representation."""
-        contact = ContactDetails(name="PSF", email="[email protected]")
-        self.assertEqual(str(contact), "PSF")
+        self.assertEqual(str(self.contact), "PSF")
+
+    def test_contactdetails_trims_trailing_whitespace_on_save(self):
+        details = ContactDetails(name=" Retail ", email="[email protected]")
+        details.save()
+
+        self.assertEqual(details.name, "Retail")
+
+    def test_contactdetails_uniqueness_validation__with_name_case_variation(self):
+        with self.assertRaisesMessage(IntegrityError, "core_contactdetails_name_unique"):
+            ContactDetails.objects.create(name="Psf", email="[email protected]")
+
+    def test_contactdetails_uniqueness_validation__with_email_case_variation(self):
+        with self.assertRaisesMessage(IntegrityError, "core_contactdetails_name_unique"):
+            ContactDetails.objects.create(name="PSF", email="[email protected]")
+
+    def test_contactdetails_creation(self):
+        self.assertEqual(ContactDetails.objects.count(), 1)
+        ContactDetails.objects.create(name="PSF", email="[email protected]")
+
+        self.assertEqual(ContactDetails.objects.count(), 2)
+
+    def test_contactdetails_add_via_ui(self):
+        self.login()
+        response = self.client.post(
+            reverse(ContactDetails.snippet_viewset.get_url_name("add")),  # pylint: disable=no-member
+            data={"name": self.contact.name, "email": self.contact.email},
+        )
+
+        self.assertContains(response, "Contact details with this name and email combination already exists.")
+        self.assertEqual(ContactDetails.objects.count(), 1)

cms/core/viewsets.py

@@ -0,0 +1,49 @@
+from typing import ClassVar
+
+from django.utils.translation import gettext_lazy as _
+from wagtail.admin.ui.tables import Column, UpdatedAtColumn
+from wagtail.snippets.views.chooser import ChooseResultsView as SnippetChooseResultsView
+from wagtail.snippets.views.chooser import ChooseView as SnippetChooseView
+from wagtail.snippets.views.chooser import SnippetChooserViewSet
+from wagtail.snippets.views.snippets import IndexView as SnippetIndexView
+from wagtail.snippets.views.snippets import SnippetViewSet
+
+from cms.core.models import ContactDetails
+
+
+class ContactDetailsIndex(SnippetIndexView):
+    list_display: ClassVar[list[str | Column]] = ["name", "email", "phone", UpdatedAtColumn()]
+
+
+class ContactDetailsChooseColumnsMixin:
+    @property
+    def columns(self) -> list[Column]:
+        title_column = self.title_column  # type: ignore[attr-defined]
+        title_column.label = _("Name")
+        return [title_column, Column("email"), Column("phone")]
+
+
+class ContactDetailsChooseView(ContactDetailsChooseColumnsMixin, SnippetChooseView): ...
+
+
+class ContactDetailsChooseResultsView(ContactDetailsChooseColumnsMixin, SnippetChooseResultsView): ...
+
+
+class ContactDetailsChooserViewset(SnippetChooserViewSet):
+    choose_view_class = ContactDetailsChooseView
+    choose_results_view_class = ContactDetailsChooseResultsView
+
+
+class ContactDetailsViewSet(SnippetViewSet):
+    """A snippet viewset for ContactDetails.
+
+    See:
+     - https://docs.wagtail.org/en/stable/topics/snippets/registering.html
+     - https://docs.wagtail.org/en/stable/topics/snippets/customizing.html#icon
+    """
+
+    model = ContactDetails
+    icon = "identity"
+
+    index_view_class = ContactDetailsIndex
+    chooser_viewset_class = ContactDetailsChooserViewset

cms/core/wagtail_hooks.py

@@ -1,8 +1,7 @@
 from wagtail import hooks
 from wagtail.snippets.models import register_snippet
-from wagtail.snippets.views.snippets import SnippetViewSet
 
-from cms.core.models import ContactDetails
+from cms.core.viewsets import ContactDetailsViewSet
 
 
 @hooks.register("register_icons")
@@ -21,16 +20,4 @@ def register_icons(icons: list[str]) -> list[str]:
     ]
 
 
-class ContactDetailsViewSet(SnippetViewSet):
-    """A snippet viewset for ContactDetails.
-
-    See:
-     - https://docs.wagtail.org/en/stable/topics/snippets/registering.html
-     - https://docs.wagtail.org/en/stable/topics/snippets/customizing.html#icon
-    """
-
-    model = ContactDetails
-    icon = "identity"
-
-
 register_snippet(ContactDetailsViewSet)

cms/documents/migrations/0001_initial.py

@@ -28,7 +28,7 @@ class Migration(migrations.Migration):
                 ("title", models.CharField(max_length=255)),
                 ("file", models.FileField()),
                 ("created_at", models.DateTimeField(auto_now_add=True)),
-                ("file_size", models.PositiveIntegerField(editable=False, null=True)),
+                ("file_size", models.PositiveBigIntegerField(editable=False, null=True)),
                 (
                     "file_hash",
                     models.CharField(blank=True, editable=False, max_length=40),

cms/jinja2/templates/base.html

@@ -350,7 +350,7 @@
     onsCookiesBanner({
       'lang': "cy" if LANGUAGE_CODE == "cy" else "en",
       'serviceName': COOKIE_BANNER_SERVICE_NAME,
-      'settingsLinkURL': MANAGE_COOKIE_SETTINGS_URL,
+      'settingsLinkUrl': MANAGE_COOKIE_SETTINGS_URL,
     })
   }}
   {# fmt:on #}

cms/settings/dev.py

@@ -28,7 +28,7 @@
 # Enable Wagtail's style guide in Wagtail's settings menu.
 # http://docs.wagtail.io/en/stable/contributing/styleguide.html
 INSTALLED_APPS += ["wagtail.contrib.styleguide"]  # noqa: F405
-
+INSTALLED_APPS += ["django_migration_linter"]
 
 # Disable forcing HTTPS locally since development server supports HTTP only.
 SECURE_SSL_REDIRECT = False
@@ -57,3 +57,17 @@
 except ImportError:
     pass
 # pylint: enable=unused-wildcard-import,useless-suppression
+
+MIGRATION_LINTER_OPTIONS = {
+    "exclude_apps": [
+        "taggit",
+        "wagtailcore",
+        "wagtailembeds",
+        "wagtailimages",
+        "wagtailadmin",
+        "wagtailsearch",
+        "wagtaildocs",
+        "wagtailredirects",
+        "wagtailusers",
+    ]
+}