[deps] Added support for Django >=5.1,<5.3 and Python >=3.12, 3.14 #645

- Upgraded django-nested-admin~=4.1.0
- Dropped support for Python < 3.9
- Dropped support for Django < 4.2

Closes #645

Author: pandafy

.github/workflows/ci.yml

@@ -14,8 +14,7 @@ on:
 jobs:
   build:
     name: Python==${{ matrix.python-version }} | ${{ matrix.django-version }}
-    # Update this only when support for Django 3.2 is removed
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     services:
       redis:
@@ -27,13 +26,24 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
         django-version:
-          - django~=3.2.0
-          - django~=4.1.0
           - django~=4.2.0
+          - django~=5.1.0
+          - django~=5.2.0
+        exclude:
+          # Django 5.1+ requires Python >=3.10
+          - python-version: "3.9"
+            django-version: django~=5.1.0
+          - python-version: "3.9"
+            django-version: django~=5.2.0
+          # Python 3.13 supported only in Django >=5.1.3
+          - python-version: "3.13"
+            django-version: django~=4.2.0
 
     steps:
       - uses: actions/checkout@v4
@@ -77,7 +87,7 @@ jobs:
           pip install -U pip wheel setuptools
           pip install -r requirements-test.txt
           pip install -U -I -e .
-          pip uninstall -y django
+          pip uninstall -y Django
           pip install -U ${{ matrix.django-version }}
           sudo npm install -g prettier
 

openwisp_monitoring/device/tests/test_admin.py

@@ -6,7 +6,7 @@
 from django.contrib.contenttypes.forms import generic_inlineformset_factory
 from django.core.cache import cache
 from django.db import connection
-from django.test import TestCase
+from django.test import TestCase, override_settings
 from django.urls import reverse
 from django.utils.timezone import datetime, now, timedelta
 from freezegun import freeze_time
@@ -89,6 +89,28 @@ def _login_admin(self):
         u = User.objects.create_superuser('admin', 'admin', 'test@test.com')
         self.client.force_login(u)
 
+    def _get_inline_admin_heading(self, heading):
+        """
+        TODO: Remove this when dropping support for Django 4.2
+
+        Django 5.1 introduced a new way to render inline headings with IDs and classes.
+        For versions before 5.1, we use the old-style heading format except for "Alert Settings"
+        which is already handled differently by django-nested-admin==4.1.0.
+        This method helps us generate the appropriate HTML heading format
+        based on the Django version being used.
+        """
+        if django.VERSION < (5, 1) and heading != 'Alert Settings':
+            return f'<h2>{heading}</h2>'
+        heading_map = {
+            'Checks': f'{Check._meta.app_label}-check-content_type-object_id-heading',
+            'Alert Settings': f'{Metric._meta.app_label}-metric-content_type-object_id-heading',
+            'WiFi Sessions': 'wifisession_set-heading',
+            'Configuration': 'config-heading',
+            'Map': 'devicelocation-heading',
+            'Credentials': 'deviceconnection_set-heading',
+        }
+        return f'<h2 id="{heading_map[heading]}" class="inline-heading">\n\n{heading}\n\n</h2>'
+
     def test_device_admin(self):
         dd = self.create_test_data()
         check = Check.objects.create(
@@ -101,7 +123,9 @@ def test_device_admin(self):
         response = self.client.get(url)
         self.assertContains(response, '<h2>Status</h2>')
         self.assertContains(response, '<h2>Charts</h2>')
-        self.assertContains(response, '<h2>Checks</h2>')
+        self.assertContains(
+            response, self._get_inline_admin_heading('Checks'), html=True
+        )
         self.assertContains(response, 'Storage')
         self.assertContains(response, 'CPU')
         self.assertContains(response, 'RAM status')
@@ -315,9 +339,11 @@ def test_device_add_view(self):
         url = reverse('admin:config_device_add')
         r = self.client.get(url)
         self.assertNotContains(r, 'AlertSettings')
-        self.assertContains(r, '<h2>Configuration</h2>')
-        self.assertContains(r, '<h2>Map</h2>')
-        self.assertContains(r, '<h2>Credentials</h2>')
+        self.assertContains(
+            r, self._get_inline_admin_heading('Configuration'), html=True
+        )
+        self.assertContains(r, self._get_inline_admin_heading('Map'), html=True)
+        self.assertContains(r, self._get_inline_admin_heading('Credentials'), html=True)
 
     def test_device_disabled_organization_admin(self):
         self.create_test_data()
@@ -335,8 +361,12 @@ def test_device_disabled_organization_admin(self):
         response = self.client.get(url)
         self.assertContains(response, '<h2>Status</h2>')
         self.assertContains(response, '<h2>Charts</h2>')
-        self.assertNotContains(response, '<h2>Checks</h2>')
-        self.assertNotContains(response, '<h2>AlertSettings</h2>')
+        self.assertNotContains(
+            response, self._get_inline_admin_heading('Checks'), html=True
+        )
+        self.assertNotContains(
+            response, self._get_inline_admin_heading('Alert Settings'), html=True
+        )
 
     def test_remove_invalid_interface(self):
         d = self._create_device(organization=self._create_org())
@@ -535,22 +565,34 @@ def test_wifisession_inline(self):
 
         with self.subTest('Test inline absent when no WiFiSession is present'):
             response = self.client.get(path)
-            self.assertNotContains(response, '<h2>WiFi Sessions</h2>')
+            self.assertNotContains(
+                response,
+                self._get_inline_admin_heading('WiFi Sessions'),
+                html=True,
+            )
             self.assertNotContains(response, 'monitoring-wifisession-changelist-url')
 
         wifi_session = self._create_wifi_session(device=device)
 
         with self.subTest('Test inline present when WiFiSession is open'):
             response = self.client.get(path)
-            self.assertContains(response, '<h2>WiFi Sessions</h2>')
+            self.assertContains(
+                response,
+                self._get_inline_admin_heading('WiFi Sessions'),
+                html=True,
+            )
             self.assertContains(response, 'monitoring-wifisession-changelist-url')
 
         wifi_session.stop_time = now()
         wifi_session.save()
 
         with self.subTest('Test inline absent when WiFiSession is closed'):
             response = self.client.get(path)
-            self.assertNotContains(response, '<h2>WiFi Sessions</h2>')
+            self.assertNotContains(
+                response,
+                self._get_inline_admin_heading('WiFi Sessions'),
+                html=True,
+            )
             self.assertNotContains(response, 'monitoring-wifisession-changelist-url')
 
     def test_check_alertsetting_inline(self):
@@ -584,13 +626,17 @@ def _add_user_permissions(user, permission_query, expected_perm_count):
             self.assertEqual(user.user_permissions.count(), expected_perm_count)
 
         def _assert_check_inline_in_response(response):
-            self.assertContains(response, '<h2>Checks</h2>', html=True)
+            self.assertContains(
+                response, self._get_inline_admin_heading('Checks'), html=True
+            )
             self.assertContains(response, 'check-content_type-object_id-0-is_active')
             self.assertContains(response, 'check-content_type-object_id-0-check_type')
             self.assertContains(response, 'check-content_type-object_id-0-DELETE')
 
         def _assert_alertsettings_inline_in_response(response):
-            self.assertContains(response, '<h2>Alert Settings</h2>', html=True)
+            self.assertContains(
+                response, self._get_inline_admin_heading('Alert Settings'), html=True
+            )
             self.assertContains(response, 'form-row field-name')
             self.assertContains(
                 response,
@@ -620,8 +666,12 @@ def _assert_alertsettings_inline_in_response(response):
             _add_device_permissions(test_user)
             response = self.client.get(url)
             self.assertEqual(response.status_code, 200)
-            self.assertNotContains(response, '<h2>Checks</h2>', html=True)
-            self.assertNotContains(response, '<h2>Alert Settings</h2>', html=True)
+            self.assertNotContains(
+                response, self._get_inline_admin_heading('Checks'), html=True
+            )
+            self.assertNotContains(
+                response, self._get_inline_admin_heading('Alert Settings'), html=True
+            )
 
         with self.subTest('Test check & alert settings with model permissions'):
             _add_device_permissions(test_user)
@@ -659,10 +709,14 @@ def _assert_alertsettings_inline_in_response(response):
             )
             response = self.client.get(url)
             self.assertEqual(response.status_code, 200)
-            self.assertContains(response, '<h2>Checks</h2>', html=True)
+            self.assertContains(
+                response, self._get_inline_admin_heading('Checks'), html=True
+            )
             self.assertContains(response, 'form-row field-check_type')
             self.assertContains(response, 'form-row field-is_active')
-            self.assertContains(response, '<h2>Alert Settings</h2>', html=True)
+            self.assertContains(
+                response, self._get_inline_admin_heading('Alert Settings'), html=True
+            )
             self.assertContains(response, 'form-row field-is_healthy djn-form-row-last')
             self.assertContains(
                 response,
@@ -1064,44 +1118,43 @@ def test_wifi_client_he_vht_ht_unknown(self):
                 """
                     <div class="form-row field-he">
                         <div>
-                            {start_div}
+                            <div class="flex-container">
                                 <label>WiFi 6 (802.11ax):</label>
                                     <div class="readonly">
                                         <img src="/static/admin/img/icon-unknown.svg">
                                     </div>
-                            {end_div}
+                            </div>
                         </div>
                     </div>
                     <div class="form-row field-vht">
                         <div>
-                            {start_div}<label>WiFi 5 (802.11ac):</label>
+                            <div class="flex-container">
+                                <label>WiFi 5 (802.11ac):</label>
                                 <div class="readonly">
                                     <img src="/static/admin/img/icon-unknown.svg">
                                 </div>
-                            {end_div}
+                            </div>
                         </div>
                     </div>
                     <div class="form-row field-ht">
                         <div>
-                            {start_div}<label>WiFi 4 (802.11n):</label>
+                            <div class="flex-container">
+                                <label>WiFi 4 (802.11n):</label>
                                 <div class="readonly">
                                     <img src="/static/admin/img/icon-unknown.svg">
                                 </div>
-                            {end_div}
+                            </div>
                         </div>
                     </div>
-                """.format(
-                    # TODO: Remove this when dropping support for Django 3.2 and 4.0
-                    start_div=(
-                        '<div class="flex-container">'
-                        if django.VERSION >= (4, 2)
-                        else ''
-                    ),
-                    end_div='</div>' if django.VERSION >= (4, 2) else '',
-                ),
+                """,
                 html=True,
             )
 
+    # TODO: Remove override_setting when dropping support for Django 4.2
+    # The DATETIME_FORMAT for en-gb locale changed for Django 5.1+,
+    # thus we override the project setting here to have consistent
+    # result with tests.
+    @override_settings(LANGUAGE_CODE='en')
     def test_wifi_session_stop_time_formatting(self):
         start_time = datetime.strptime('2023-8-24 17:08:00', '%Y-%m-%d %H:%M:%S')
         stop_time = datetime.strptime('2023-8-24 19:46:00', '%Y-%m-%d %H:%M:%S')

openwisp_monitoring/monitoring/base/models.py

@@ -4,6 +4,7 @@
 from copy import deepcopy
 from datetime import date, datetime, timedelta
 
+import django
 from cache_memoize import cache_memoize
 from dateutil.parser import parse as parse_date
 from django.conf import settings
@@ -31,7 +32,9 @@
     DEFAULT_COLORS,
     METRIC_CONFIGURATION_CHOICES,
     get_chart_configuration,
+    get_chart_configuration_choices,
     get_metric_configuration,
+    get_metric_configuration_choices,
 )
 from ..exceptions import InvalidChartConfigException, InvalidMetricConfigException
 from ..signals import pre_metric_write, threshold_crossed
@@ -69,7 +72,18 @@ class AbstractMetric(TimeStampedEditableModel):
         help_text=_('leave blank to determine automatically'),
     )
     configuration = models.CharField(
-        max_length=16, null=True, choices=METRIC_CONFIGURATION_CHOICES
+        max_length=16,
+        null=True,
+        choices=(
+            METRIC_CONFIGURATION_CHOICES
+            if django.VERSION < (5, 0)
+            # TODO: Remove when dropping support for Django 4.2
+            # In Django 5.0+, choices are normalized at model definition,
+            # creating a static list of tuples that doesn't update when metrics
+            # are dynamically registered or unregistered. Using a callable
+            # ensures we always get the current choices from the registry.
+            else get_metric_configuration_choices
+        ),
     )
     content_type = models.ForeignKey(
         ContentType, on_delete=models.CASCADE, null=True, blank=True
@@ -489,7 +503,18 @@ class AbstractChart(TimeStampedEditableModel):
         get_model_name('monitoring', 'Metric'), on_delete=models.CASCADE
     )
     configuration = models.CharField(
-        max_length=16, null=True, choices=CHART_CONFIGURATION_CHOICES
+        max_length=16,
+        null=True,
+        choices=(
+            CHART_CONFIGURATION_CHOICES
+            if django.VERSION < (5, 0)
+            # TODO: Remove when dropping support for Django 4.2
+            # In Django 5.0+, choices are normalized at model definition,
+            # creating a static list of tuples that doesn't update when charts
+            # are dynamically registered or unregistered. Using a callable
+            # ensures we always get the current choices from the registry.
+            else get_chart_configuration_choices
+        ),
     )
     GROUP_MAP = {'1d': '10m', '3d': '20m', '7d': '1h', '30d': '24h', '365d': '7d'}
     DEFAULT_TIME = DEFAULT_CHART_TIME

openwisp_monitoring/monitoring/migrations/0001_squashed_0023_alert_settings_tolerance_remove_default.py

@@ -2,6 +2,7 @@
 
 import uuid
 
+import django
 import django.core.validators
 import django.db.migrations.operations.special
 import django.db.models.deletion
@@ -12,7 +13,12 @@
 from django.db import migrations, models
 from swapper import split
 
-from ..configuration import CHART_CONFIGURATION_CHOICES, METRIC_CONFIGURATION_CHOICES
+from ..configuration import (
+    CHART_CONFIGURATION_CHOICES,
+    METRIC_CONFIGURATION_CHOICES,
+    get_chart_configuration_choices,
+    get_metric_configuration_choices,
+)
 
 
 class Migration(migrations.Migration):
@@ -59,7 +65,11 @@ class Migration(migrations.Migration):
                 (
                     'configuration',
                     models.CharField(
-                        choices=METRIC_CONFIGURATION_CHOICES, max_length=16, null=True
+                        choices=METRIC_CONFIGURATION_CHOICES
+                        if django.VERSION < (5, 0)
+                        else get_metric_configuration_choices,
+                        max_length=16,
+                        null=True,
                     ),
                 ),
                 (
@@ -128,7 +138,11 @@ class Migration(migrations.Migration):
                 (
                     'configuration',
                     models.CharField(
-                        choices=CHART_CONFIGURATION_CHOICES, max_length=16, null=True
+                        choices=CHART_CONFIGURATION_CHOICES
+                        if django.VERSION < (5, 0)
+                        else get_chart_configuration_choices,
+                        max_length=16,
+                        null=True,
                     ),
                 ),
                 (

requirements.txt

@@ -1,4 +1,4 @@
 openwisp-controller @ https://github.com/openwisp/openwisp-controller/tarball/1.2
 influxdb~=5.3.2
-django-nested-admin~=4.0.2
+django-nested-admin~=4.1.0
 python-dateutil>=2.7.0,<3.0.0