TP2000-1193 Upgrade to Django 4.2

commodities/migrations/0013_alter_goodsnomenclature_origins_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.10 on 2024-02-23 11:51
+
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("commodities", "0012_TOPS_745_description_date_fix"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="goodsnomenclature",
+            name="origins",
+            field=models.ManyToManyField(
+                through="commodities.GoodsNomenclatureOrigin",
+                to="commodities.goodsnomenclature",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="goodsnomenclature",
+            name="successors",
+            field=models.ManyToManyField(
+                through="commodities.GoodsNomenclatureSuccessor",
+                to="commodities.goodsnomenclature",
+            ),
+        ),
+    ]

common/forms.py

@@ -57,8 +57,8 @@ def get_bound_form(self, form_class, *args, **kwargs):
         return bound_form
 
     def bind_nested_forms(self, *args, **kwargs):
-        if kwargs.get("instance"):
-            kwargs.pop("instance")  # this mixin does not support ModelForm as subforms
+        # this mixin does not support ModelForm as subforms
+        kwargs.pop("instance", None)
 
         for name, field in self.fields.items():
             if isinstance(field, RadioNested):
@@ -550,6 +550,7 @@ class FormSet(forms.BaseFormSet):
     validate_min = False
     validate_max = False
     prefix = None
+    renderer = get_default_renderer()
 
     def __init__(
         self,

common/jinja2.py

@@ -11,12 +11,12 @@
 from django.urls import reverse
 from django.utils.safestring import mark_safe
 from django.utils.timezone import template_localtime
-from govuk_frontend_jinja.templates import Environment
-from govuk_frontend_jinja.templates import NunjucksExtension
 from jinja2.utils import markupsafe
-from webpack_loader.templatetags.webpack_loader import render_bundle
+from webpack_loader.contrib.jinja2ext import _render_bundle
 from webpack_loader.templatetags.webpack_loader import webpack_static
 
+from govuk_frontend_jinja.templates import Environment
+from govuk_frontend_jinja.templates import NunjucksExtension
 from workbaskets.models import WorkBasket
 
 
@@ -140,7 +140,7 @@ def environment(**kwargs):
             "get_current_workbasket": WorkBasket.current,
             "localtime": template_localtime,
             "pluralize": pluralize,
-            "render_bundle": render_bundle,
+            "render_bundle": _render_bundle,
             "settings": settings,
             "static": static,
             "format_date_string": format_date_string,

common/jinja2/layouts/_generic.jinja

@@ -26,10 +26,10 @@
   {% endif %}
 
   <!--[if !IE 8]><!-->
-    {{ render_bundle("main", "css") }}
+    {{ render_bundle(bundle_name="main", extension="css") }}
   <!--<![endif]-->
   <!--[if IE 8]>
-    {# render_bundle("ie8", "css") #}
+    {# render_bundle(bundle_name="ie8", extension="css") #}
   <![endif]-->
   {% block styles %}{% endblock %}
 {% endblock %}
@@ -55,5 +55,5 @@
 
 {% block bodyEnd %}
   {% set csp_nonce -%}nonce="{{ cspNonce }}"{% endset %}
-  {{ render_bundle("main", "js", attrs=csp_nonce) }}
+  {{ render_bundle(bundle_name="main", extension="js", attrs=csp_nonce) }}
 {% endblock %}

common/jinja2/layouts/layout.jinja

@@ -28,20 +28,41 @@
   {% endif %}
 {% endset %}
 
+{% set logout_login_link %}
+  {% if request.user.is_authenticated %}
+    <form action="{{ url('logout') }}" method="post">
+      {{ csrf_input }}
+      <button
+        class="fake-link govuk-header__link"
+        id="sign-out"
+        name="submit"
+        value="logout"
+      >
+        Sign out
+      </button>
+    </form>
+  {% else %}
+    <a
+      class="govuk-header__link"
+      href="{{ settings.LOGIN_URL }}"
+    >Sign in</a>
+  {% endif %}
+{% endset %}
+
 {{ govukHeader({
   "homepageUrl": "https://gov.uk/",
   "serviceName": service_name,
   "serviceUrl": "/",
   "navigation": [ 
     { "html": workbasket_html } if workbasket_html else "",
     {
-      "href": url("logout") if request.user.is_authenticated else settings.LOGIN_URL,
-      "text": "Sign out" if request.user.is_authenticated else "Sign In"
+      "html": logout_login_link,
     } if not settings.SSO_ENABLED else "",
   ],
       "useTudorCrown": true,
 }) }}
 {% endblock %}
+
 {% block beforeContent %}
   {{ govukPhaseBanner({
     "tag": {

common/migrations/0011_alter_trackedmodel_polymorphic_ctype.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.2.10 on 2024-02-23 11:51
+
+import django.db.models.deletion
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("common", "0010_set_tracked_model_datetime"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="trackedmodel",
+            name="polymorphic_ctype",
+            field=models.ForeignKey(
+                editable=False,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="polymorphic_%(app_label)s.%(class)s_set+",
+                to="contenttypes.contenttype",
+            ),
+        ),
+    ]

common/models/trackedmodel.py

@@ -507,8 +507,12 @@ def copy(
             kwargs.update(nested_fields)
 
             if not ignore:
-                for model in queryset.approved_up_to_transaction(transaction):
-                    model.copy(transaction, **kwargs)
+                try:
+                    for model in queryset.approved_up_to_transaction(transaction):
+                        model.copy(transaction, **kwargs)
+                except ValueError:
+                    # Calling a related manager for an unsaved instance would nevertheless result in an empty queryset
+                    pass
 
         return new_object
 
@@ -528,7 +532,7 @@ def in_use_by(self, via_relation: str, transaction=None) -> QuerySet[TrackedMode
         remote_field_name = get_accessor(relation.remote_field)
 
         return remote_model.objects.filter(
-            **{f"{remote_field_name}__version_group": self.version_group}
+            **{f"{remote_field_name}__version_group": self.version_group},
         ).approved_up_to_transaction(transaction)
 
     def in_use(self, transaction=None, *relations: str) -> bool:

common/static/common/scss/_components.scss

@@ -42,6 +42,19 @@
       margin-bottom: -4px;
     }
   }
+
+  button#sign-out {
+    color: govuk-colour("white");
+    font-weight: bold;
+    text-decoration: none;
+
+    &:hover {
+      text-decoration: underline;
+      text-decoration-thickness: 3px;
+      text-underline-offset: 0.1em;
+    }
+  }
+
 }
 
 .workbasket-navigation {

common/tests/test_views.py

@@ -51,7 +51,7 @@ def test_index_displays_logout_buttons_correctly_SSO_off_logged_in(valid_user_cl
     assert response.status_code == 200
 
     page = BeautifulSoup(str(response.content), "html.parser")
-    assert page.find_all("a", {"href": "/logout"})
+    assert page.find("form", {"action": reverse("logout")})
 
 
 def test_index_redirects_to_login_page_logged_out_SSO_off(client):
@@ -69,7 +69,7 @@ def test_index_displays_login_buttons_correctly_SSO_on(valid_user_client):
     assert response.status_code == 200
 
     page = BeautifulSoup(str(response.content), "html.parser")
-    assert not page.find_all("a", {"href": "/logout"})
+    assert not page.find("form", {"action": reverse("logout")})
     assert not page.find_all("a", {"href": "/login"})
 
 

common/tests/util.py

@@ -17,6 +17,7 @@
 from unittest.mock import patch
 
 import pytest
+from backports.zoneinfo import ZoneInfo
 from dateutil.parser import parse as parse_date
 from dateutil.relativedelta import relativedelta
 from django import forms
@@ -29,7 +30,6 @@
 from django_filters.views import FilterView
 from freezegun import freeze_time
 from lxml import etree
-from pytz import timezone
 
 from commodities.models.orm import GoodsNomenclature
 from common.business_rules import BusinessRule
@@ -98,7 +98,9 @@ def raises_if(exception, expected):
 
 @contextlib.contextmanager
 def add_business_rules(
-    model: Type[TrackedModel], *rules: Type[BusinessRule], indirect=False
+    model: Type[TrackedModel],
+    *rules: Type[BusinessRule],
+    indirect=False,
 ):
     """Attach BusinessRules to a TrackedModel."""
     target = f"{'indirect_' if indirect else ''}business_rules"
@@ -135,7 +137,7 @@ def make_duplicate_record(factory, identifying_fields=None):
         identifying_fields = list(factory._meta.model.identifying_fields)
 
     return factory.create(
-        **dict(get_field_tuple(existing, field) for field in identifying_fields)
+        **dict(get_field_tuple(existing, field) for field in identifying_fields),
     )
 
 
@@ -627,7 +629,8 @@ def wraps(
                 )
 
             current_instance = instance or factory.create(
-                transaction=approved_transaction, **factory_kwargs or {}
+                transaction=approved_transaction,
+                **factory_kwargs or {},
             )
 
             xml = export_workbasket(
@@ -731,7 +734,7 @@ def now(self):
 
     @property
     def datetime_now(self):
-        return datetime.now(timezone(settings.TIME_ZONE)).replace(
+        return datetime.now(ZoneInfo(settings.TIME_ZONE)).replace(
             hour=0,
             minute=0,
             second=0,
@@ -895,7 +898,7 @@ def get_form_data(form: forms.ModelForm) -> Dict[str, Any]:
                 del data[field]
             value = form.fields[field].widget.decompress(value)
             data.update(
-                **{f"{field}_{i}": v for i, v in enumerate(value) if v is not None}
+                **{f"{field}_{i}": v for i, v in enumerate(value) if v is not None},
             )
         elif value is not None:
             data.setdefault(field, value)

conftest.py

@@ -1004,7 +1004,9 @@ def check(
             kwargs.update(previous_version.get_identifying_fields())
 
         updated_model = run_xml_import(
+            # Give the unsaved instance a placeholder pk value to make it serializable
             lambda: factory.build(
+                pk=1234,
                 update_type=update_type,
                 **kwargs,
             ),

geo_areas/migrations/0006_alter_geographicalarea_memberships.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.10 on 2024-02-23 11:51
+
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("geo_areas", "0005_rename_described_area"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="geographicalarea",
+            name="memberships",
+            field=models.ManyToManyField(
+                through="geo_areas.GeographicalMembership",
+                to="geo_areas.geographicalarea",
+            ),
+        ),
+    ]