Merge branch 'master' into dependabot/github_actions/pypa/gh-action-pypi-publish-1.12.2

Author: nemesifier

.github/workflows/version-branch.yml

@@ -0,0 +1,12 @@
+name: Replicate Commits to Version Branch
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  version-branch:
+    uses: openwisp/openwisp-utils/.github/workflows/reusable-version-branch.yml@master
+    with:
+      module_name: openwisp_controller

CHANGES.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+Version 1.2.0 [Unreleased]
+--------------------------
+
+Work in progress.
+
 Version 1.1.0 [2024-11-22]
 --------------------------
 

README.rst

@@ -53,8 +53,8 @@ Other popular building blocks that are part of the OpenWISP ecosystem are:
   provides device status monitoring, collection of metrics, charts,
   alerts, possibility to define custom checks
 - `openwisp-firmware-upgrader
-  <https://openwisp.io/docs/stable/firmware-upgrader/>`_: automated firmware
-  upgrades (single devices or mass network upgrades)
+  <https://openwisp.io/docs/stable/firmware-upgrader/>`_: automated
+  firmware upgrades (single devices or mass network upgrades)
 - `openwisp-radius <https://openwisp.io/docs/stable/user/radius.html>`_:
   based on FreeRADIUS, allows to implement network access authentication
   systems like 802.1x WPA2 Enterprise, captive portal authentication,
@@ -65,10 +65,11 @@ Other popular building blocks that are part of the OpenWISP ecosystem are:
   daemons or other network software (e.g.: OpenVPN); it can be used in
   conjunction with openwisp-monitoring to get a better idea of the state
   of the network
-- `openwisp-ipam <https://openwisp.io/docs/stable/ipam/>`_: allows to manage
-  the assignment of IP addresses used in the network
-- `openwisp-notifications <https://openwisp.io/docs/stable/notifications/>`_:
-  allows users to be aware of important events happening in the network.
+- `openwisp-ipam <https://openwisp.io/docs/stable/ipam/>`_: allows to
+  manage the assignment of IP addresses used in the network
+- `openwisp-notifications
+  <https://openwisp.io/docs/stable/notifications/>`_: allows users to be
+  aware of important events happening in the network.
 
 **For a more complete overview of the OpenWISP modules and architecture**,
 see the `OpenWISP Architecture Overview

openwisp_controller/__init__.py

@@ -1,4 +1,4 @@
-VERSION = (1, 1, 0, 'final')
+VERSION = (1, 2, 0, 'alpha')
 __version__ = VERSION  # alias
 
 

openwisp_controller/config/base/device.py

@@ -262,6 +262,7 @@ def _validate_unique_name(self):
 
     def clean(self, *args, **kwargs):
         super().clean(*args, **kwargs)
+        self.mac_address = self.mac_address.upper()
         self._validate_unique_name()
         self._validate_org_relation('group', field_error='group')
         self._validate_org_device_limit()

openwisp_controller/config/base/template.py

@@ -6,6 +6,7 @@
 from django.db import models, transaction
 from django.utils.translation import gettext_lazy as _
 from jsonfield import JSONField
+from netjsonconfig.exceptions import ValidationError as NetjsonconfigValidationError
 from swapper import get_model_name
 from taggit.managers import TaggableManager
 
@@ -115,7 +116,14 @@ def save(self, *args, **kwargs):
             if hasattr(self, 'backend_instance'):
                 del self.backend_instance
             current = self.__class__.objects.get(pk=self.pk)
-            update_related_config_status = self.checksum != current.checksum
+            try:
+                current_checksum = current.checksum
+            except NetjsonconfigValidationError:
+                # If the Netjsonconfig library upgrade changes the schema,
+                # the old configuration may become invalid, raising an exception.
+                # Setting the checksum to None forces related configurations to update.
+                current_checksum = None
+            update_related_config_status = self.checksum != current_checksum
         # save current changes
         super().save(*args, **kwargs)
         # update relations

openwisp_controller/config/tests/test_device.py

@@ -69,6 +69,14 @@ def test_mac_address_validator(self):
             else:
                 self.fail('ValidationError not raised for "{0}"'.format(mac_address))
 
+    def test_device_mac_address_uppercase(self):
+        device = self._create_device(mac_address='00:1a:2b:3c:4d:5e')
+        device.full_clean()
+        self.assertEqual(device.mac_address, '00:1A:2B:3C:4D:5E')
+        device.save()
+        device.refresh_from_db()
+        self.assertEqual(device.mac_address, '00:1A:2B:3C:4D:5E')
+
     def test_config_status_modified(self):
         c = self._create_config(device=self._create_device(), status='applied')
         self.assertEqual(c.status, 'applied')

openwisp_controller/config/tests/test_template.py

@@ -7,6 +7,7 @@
 from django.db import transaction
 from django.test import TestCase, TransactionTestCase
 from netjsonconfig import OpenWrt
+from netjsonconfig.exceptions import ValidationError as NetjsonconfigValidationError
 from swapper import load_model
 
 from openwisp_utils.tests import catch_signal
@@ -500,6 +501,20 @@ def test_required_vpn_template_corner_case(self):
         # {'__all__': ['VPN client with this Config and Vpn already exists.']}
         self.assertIsNotNone(vpn_client)
 
+    def test_regression_preventing_from_fixing_invalid_conf(self):
+        template = self._create_template()
+        # create a template with an invalid configuration
+        Template.objects.update(config={'interfaces': [{'name': 'eth0', 'type': ''}]})
+        # ensure the configuration raises ValidationError
+        with self.assertRaises(NetjsonconfigValidationError):
+            template.refresh_from_db()
+            del template.backend_instance
+            template.checksum
+        del template.backend_instance
+        template.config = {'interfaces': [{'name': 'eth0', 'type': 'ethernet'}]}
+        template.full_clean()
+        template.save()
+
 
 class TestTemplateTransaction(
     TransactionTestMixin,

openwisp_controller/geo/tests/test_api.py

@@ -94,7 +94,7 @@ def test_put_create_location(self):
         device = self._create_object()
         self.assertEqual(self.location_model.objects.count(), 0)
         url = reverse(self.url_name, args=[device.pk])
-        r = self.client.put(f'{url}?key={device.key }')
+        r = self.client.put(f'{url}?key={device.key}')
         self.assertEqual(r.status_code, 200)
         self.assertDictEqual(
             r.json(),

requirements-test.txt

@@ -1,9 +1,9 @@
 pytest-django~=4.9.0
 pytest-asyncio~=0.24.0
 pytest-cov~=5.0.0
-openwisp-utils[qa,selenium]~=1.1.1
+openwisp-utils[qa,selenium] @ https://github.com/openwisp/openwisp-utils/tarball/1.2
 channels_redis~=4.2.1
 django_redis~=5.4.0
 mock-ssh-server~=0.9.1
 responses~=0.25.3
-psycopg2-binary~=2.9.9
+psycopg2-binary~=2.9.10