WIP2

Author: nemesifier

.github/workflows/ci.yml

@@ -76,6 +76,7 @@ jobs:
         pip install -U -r requirements-test.txt
         pip install -U -e .
         pip install ${{ matrix.django-version }}
+        pip install -U --force-reinstall --no-deps https://github.com/openwisp/openwisp-utils/tarball/exclude_validation
 
     - name: Start postgres and redis
       if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}

openwisp_controller/config/api/serializers.py

@@ -107,6 +107,8 @@ def get_queryset(self):
 
 
 class BaseConfigSerializer(ValidatedDeviceIdSerializer):
+    exclude_validation = ['device']
+
     class Meta:
         model = Config
         fields = ['status', 'error_reason', 'backend', 'templates', 'context', 'config']
@@ -131,14 +133,16 @@ def validate(self, data):
         """
         # Existing device
         device = self.context.get('device')
+        # data.pop('device', None)
+        # import ipdb; ipdb.set_trace()
         if not self.instance and device:
             # Existing device with existing config
             # Or it's an exsiting device with a new config
             if device._has_config():
                 self.instance = device.config
-            return super().validate(data)
+            # return super().validate(data)
         # New device
-        self.exclude_validation = ['device']
+        # self.exclude_validation = ['device']
         return super().validate(data)
 
 
@@ -153,11 +157,29 @@ def _prepare_config(self, device, config_data):
         config.full_clean()
         return config
 
+    def _is_config_data_relevant(self, config_data):
+        """
+        Returns True if ``config_data`` does not equal
+        the default values and hence the config is useful.
+        """
+        return not (
+            config_data.get('backend') == app_settings.DEFAULT_BACKEND
+            and not config_data.get('templates')
+            and not config_data.get('context')
+            and not config_data.get('config')
+        )
+
     @transaction.atomic
     def _create_config(self, device, config_data):
+        # templates = config_data.get('templates')
+        # if len(templates) == 1 and templates[0].name == 't1-org2':
+        #     import ipdb; ipdb.set_trace()
         config_templates = self._get_config_templates(config_data)
         try:
             if not device._has_config():
+                # if the user hasn't set any useful config data, skip
+                if not self._is_config_data_relevant(config_data):
+                    return
                 config = Config(device=device, **config_data)
                 config.full_clean()
                 config.save()
@@ -173,15 +195,10 @@ def _create_config(self, device, config_data):
             raise serializers.ValidationError({'config': error.messages})
 
     def _update_config(self, device, config_data):
-        if (
-            config_data.get('backend') == app_settings.DEFAULT_BACKEND
-            and not config_data.get('templates')
-            and not config_data.get('context')
-            and not config_data.get('config')
-        ):
-            # Do not create Config object if config_data only
-            # contains the default value.
-            # See https://github.com/openwisp/openwisp-controller/issues/699
+        # Do not create Config object if config_data only
+        # contains the default values.
+        # See https://github.com/openwisp/openwisp-controller/issues/699
+        if not self._is_config_data_relevant(config_data):
             return
         if not device._has_config():
             return self._create_config(device, config_data)
@@ -199,6 +216,10 @@ def _update_config(self, device, config_data):
         except ValidationError as error:
             raise serializers.ValidationError({'config': error.messages})
 
+    # def run_validation(self, *args, **kwargs):
+    #     import ipdb; ipdb.set_trace()
+    #     return super().run_validation(*args, **kwargs)
+
 
 class DeviceListConfigSerializer(BaseConfigSerializer):
     config = serializers.JSONField(
@@ -265,6 +286,10 @@ class DeviceDetailConfigSerializer(BaseConfigSerializer):
     )
     templates = FilterTemplatesByOrganization(many=True)
 
+    # def validate(self, *args, **kwargs):
+    #     import ipdb; ipdb.set_trace()
+    #     return super().validate(*args, **kwargs)
+
 
 class DeviceDetailSerializer(DeviceConfigSerializer):
     config = DeviceDetailConfigSerializer(allow_null=True)
@@ -291,6 +316,10 @@ class Meta(BaseMeta):
             'modified',
         ]
 
+    # def to_internal_value(self, *args, **kwargs):
+    #     import ipdb; ipdb.set_trace()
+    #     return super().to_internal_value(*args, **kwargs)
+
     def update(self, instance, validated_data):
         config_data = validated_data.pop('config', {})
         raw_data_for_signal_handlers = {
@@ -299,7 +328,7 @@ def update(self, instance, validated_data):
         if config_data:
             self._update_config(instance, config_data)
 
-        elif hasattr(instance, 'config') and validated_data.get('organization'):
+        elif instance._has_config() and validated_data.get('organization'):
             if instance.organization != validated_data.get('organization'):
                 # config.device.organization is used for validating
                 # the organization of templates. It is also used for adding

openwisp_controller/config/api/views.py

@@ -114,6 +114,21 @@ def perform_destroy(self, instance):
         force_deletion = self.request.query_params.get('force', None) == 'true'
         instance.delete(check_deactivated=(not force_deletion))
 
+    # def update(self, request, *args, **kwargs):
+    #     import ipdb; ipdb.set_trace()
+    #     partial = kwargs.pop('partial', False)
+    #     instance = self.get_object()
+    #     serializer = self.get_serializer(instance, data=request.data, partial=partial)
+    #     serializer.is_valid(raise_exception=True)
+    #     self.perform_update(serializer)
+    #
+    #     if getattr(instance, '_prefetched_objects_cache', None):
+    #         # If 'prefetch_related' has been applied to a queryset, we need to
+    #         # forcibly invalidate the prefetch cache on the instance.
+    #         instance._prefetched_objects_cache = {}
+    #
+    #     return Response(serializer.data)
+
 
 class DeviceActivateView(ProtectedAPIMixin, GenericAPIView):
     serializer_class = serializers.Serializer

openwisp_controller/config/tests/test_api.py

@@ -1,3 +1,5 @@
+from copy import deepcopy
+
 from django.contrib.auth.models import Permission
 from django.test import TestCase
 from django.test.client import BOUNDARY, MULTIPART_CONTENT, encode_multipart
@@ -138,10 +140,10 @@ def test_device_create_no_config_api(self):
         self.assertEqual(Device.objects.count(), 1)
         self.assertEqual(Config.objects.count(), 0)
 
-    def test_device_create_config_default_values(self):
+    def test_device_create_default_config_values(self):
         self.assertEqual(Device.objects.count(), 0)
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = deepcopy(self._get_device_data)
         org = self._get_org()
         data['organization'] = org.pk
         data['config'].update({'context': {}, 'config': {}})
@@ -204,8 +206,8 @@ def test_device_post_with_templates_of_different_org(self):
         org_1 = self._get_org()
         data['organization'] = org_1.pk
         org_2 = self._create_org(name='test org2', slug='test-org2')
-        t1 = self._create_template(name='t1', organization=org_2)
-        data['config']['templates'] += [str(t1.pk)]
+        t1 = self._create_template(name='t1-org2', organization=org_2)
+        data['config']['templates'] = [str(t1.pk)]
         response = self.client.post(path, data, content_type='application/json')
         self.assertEqual(response.status_code, 400)
         self.assertEqual(

openwisp_controller/serializers.py

@@ -3,16 +3,19 @@
 
 
 class ValidatedDeviceIdSerializer(ValidatedModelSerializer):
-    def validate(self, data):
-        """
-        Adds "device_id" to the data dictionary which
-        is going to be used to create the temporary
-        instance used for validation
-        """
-        for key in ['device', 'device_id']:
-            if key in self.context:
-                data[key] = self.context[key]
-        return super().validate(data)
+    pass
+    # def validate(self, data):
+    #     """Adds "device" to the data dictionary.
+    #
+    #     Used to satisfy validation needs."""
+    #     # for key in ['device', 'device_id']:
+    #     #     if key in self.context:
+    #     #         data[key] = self.context[key]
+    #     if 'device' in self.context:
+    #         data['device'] = self.context['device']
+    #     data = super().validate(data)
+    #     data.pop('device', None)
+    #     return data
 
 
 class BaseSerializer(FilterSerializerByOrgManaged, ValidatedModelSerializer):
@@ -32,9 +35,7 @@ class BaseDeviceIdSerializer(FilterSerializerByOrgManaged, ValidatedDeviceIdSeri
 
 
 class DeviceContextMixin:
-    """
-    TODO
-    """
+    """Adds the device object to the serializer context."""
 
     def get_object(self):
         obj = super().get_object()

requirements-test.txt

@@ -1,5 +1,5 @@
 pytest-cov~=6.1.0
-openwisp-utils[qa,selenium,channels-test] @ https://github.com/openwisp/openwisp-utils/tarball/exclude_validation
+openwisp-utils[qa,selenium,channels-test] @ https://github.com/openwisp/openwisp-utils/tarball/1.2
 django_redis~=5.4.0
 mock-ssh-server~=0.9.1
 responses~=0.25.6

requirements.txt

@@ -7,7 +7,7 @@ django-x509 @ https://github.com/openwisp/django-x509/tarball/1.3
 django-loci @ https://github.com/DragnEmperor/django-loci/tarball/1.2
 django-flat-json-widget~=0.3.1
 openwisp-users @ https://github.com/openwisp/openwisp-users/tarball/1.2
-openwisp-utils[celery,channels] @ https://github.com/openwisp/openwisp-utils/tarball/exclude_validation
+openwisp-utils[celery,channels] @ https://github.com/openwisp/openwisp-utils/tarball/1.2
 openwisp-notifications @ https://github.com/openwisp/openwisp-notifications/tarball/1.2
 openwisp-ipam @ https://github.com/openwisp/openwisp-ipam/tarball/1.2
 djangorestframework-gis @ https://github.com/openwisp/django-rest-framework-gis/tarball/1.2