[chores] Clean up in tests

Author: nemesifier

openwisp_controller/config/api/views.py

@@ -17,7 +17,6 @@
 from openwisp_users.api.permissions import DjangoModelPermissions
 
 from ...mixins import ProtectedAPIMixin
-from ...serializers import DeviceContextMixin
 from .filters import (
     DeviceGroupListFilter,
     DeviceListFilter,
@@ -98,9 +97,7 @@ class DeviceListCreateView(ProtectedAPIMixin, ListCreateAPIView):
     filterset_class = DeviceListFilter
 
 
-class DeviceDetailView(
-    DeviceContextMixin, ProtectedAPIMixin, RetrieveUpdateDestroyAPIView
-):
+class DeviceDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
     """
     Templates: Templates flagged as _required_ will be added automatically
                to the `config` of a device and cannot be unassigned.

openwisp_controller/config/tests/test_api.py

@@ -1,5 +1,3 @@
-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
@@ -33,58 +31,66 @@
 
 
 class ApiTestMixin:
-    _get_template_data = {
-        'name': 'test-template',
-        'organization': None,
-        'backend': 'netjsonconfig.OpenWrt',
-        'config': {'interfaces': [{'name': 'eth0', 'type': 'ethernet'}]},
-    }
-
-    _get_vpn_data = {
-        'name': 'vpn-test',
-        'host': 'vpn.testing.com',
-        'organization': None,
-        'ca': None,
-        'backend': 'openwisp_controller.vpn_backends.OpenVpn',
-        'config': {
-            'openvpn': [
-                {
-                    'ca': 'ca.pem',
-                    'cert': 'cert.pem',
-                    'dev': 'tap0',
-                    'dev_type': 'tap',
-                    'dh': 'dh.pem',
-                    'key': 'key.pem',
-                    'mode': 'server',
-                    'name': 'example-vpn',
-                    'proto': 'udp',
-                    'tls_server': True,
-                }
-            ]
-        },
-    }
-
-    _get_device_data = {
-        'name': 'change-test-device',
-        'organization': None,
-        'mac_address': '00:11:22:33:44:55',
-        'config': {
+    @property
+    def _template_data(self):
+        return {
+            'name': 'test-template',
+            'organization': None,
             'backend': 'netjsonconfig.OpenWrt',
-            'status': 'modified',
-            'templates': [],
-            'context': {'lan_ip': '192.168.1.1'},
-            'config': {'interfaces': [{'name': 'wlan0', 'type': 'wireless'}]},
-        },
-    }
+            'config': {'interfaces': [{'name': 'eth0', 'type': 'ethernet'}]},
+        }
 
-    _get_devicegroup_data = {
-        'name': 'Access Points',
-        'description': 'Group for APs of default organization',
-        'organization': 'None',
-        'meta_data': {'captive_portal_url': 'https://example.com'},
-        'context': {'SSID': 'OpenWISP'},
-        'templates': [],
-    }
+    @property
+    def _vpn_data(self):
+        return {
+            'name': 'vpn-test',
+            'host': 'vpn.testing.com',
+            'organization': None,
+            'ca': None,
+            'backend': 'openwisp_controller.vpn_backends.OpenVpn',
+            'config': {
+                'openvpn': [
+                    {
+                        'ca': 'ca.pem',
+                        'cert': 'cert.pem',
+                        'dev': 'tap0',
+                        'dev_type': 'tap',
+                        'dh': 'dh.pem',
+                        'key': 'key.pem',
+                        'mode': 'server',
+                        'name': 'example-vpn',
+                        'proto': 'udp',
+                        'tls_server': True,
+                    }
+                ]
+            },
+        }
+
+    @property
+    def _device_data(self):
+        return {
+            'name': 'change-test-device',
+            'organization': None,
+            'mac_address': '00:11:22:33:44:55',
+            'config': {
+                'backend': 'netjsonconfig.OpenWrt',
+                'status': 'modified',
+                'templates': [],
+                'context': {'lan_ip': '192.168.1.1'},
+                'config': {'interfaces': [{'name': 'wlan0', 'type': 'wireless'}]},
+            },
+        }
+
+    @property
+    def _devicegroup_data(self):
+        return {
+            'name': 'Access Points',
+            'description': 'Group for APs of default organization',
+            'organization': 'None',
+            'meta_data': {'captive_portal_url': 'https://example.com'},
+            'context': {'SSID': 'OpenWISP'},
+            'templates': [],
+        }
 
 
 class TestConfigApi(
@@ -104,7 +110,7 @@ def setUp(self):
     def test_device_create_with_config_api(self):
         self.assertEqual(Device.objects.count(), 0)
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = self._device_data
         org = self._get_org()
         data['organization'] = org.pk
         r = self.client.post(path, data, content_type='application/json')
@@ -131,7 +137,7 @@ def test_config_serializer_validation(self):
     def test_device_create_no_config_api(self):
         self.assertEqual(Device.objects.count(), 0)
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = self._device_data
         org = self._get_org()
         data['organization'] = org.pk
         data.pop('config')
@@ -143,7 +149,7 @@ def test_device_create_no_config_api(self):
     def test_device_create_default_config_values(self):
         self.assertEqual(Device.objects.count(), 0)
         path = reverse('config_api:device_list')
-        data = deepcopy(self._get_device_data)
+        data = self._device_data
         org = self._get_org()
         data['organization'] = org.pk
         data['config'].update({'context': {}, 'config': {}})
@@ -158,7 +164,7 @@ def test_device_create_with_group(self):
         template = self._create_template()
         dg.templates.add(template)
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = self._device_data
         org = self._get_org()
         data['organization'] = org.pk
         data['group'] = dg.pk
@@ -177,7 +183,7 @@ def test_device_create_exceeds_org_device_limit(self):
         self.assertEqual(Device.objects.count(), 1)
 
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = self._device_data
         data['organization'] = org.pk
         r = self.client.post(path, data, content_type='application/json')
         self.assertEqual(r.status_code, 400)
@@ -190,7 +196,7 @@ def test_device_create_exceeds_org_device_limit(self):
 
     def test_device_create_with_invalid_name_api(self):
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = self._device_data
         org = self._get_org()
         data.pop('config')
         data['name'] = 'T E S T'
@@ -202,7 +208,7 @@ def test_device_create_with_invalid_name_api(self):
     # POST request should fail with validation error
     def test_device_post_with_templates_of_different_org(self):
         path = reverse('config_api:device_list')
-        data = deepcopy(self._get_device_data)
+        data = self._device_data
         org_1 = self._get_org()
         data['organization'] = org_1.pk
         org_2 = self._create_org(name='test org2', slug='test-org2')
@@ -227,7 +233,7 @@ def execute_assertions(data):
     def test_device_create_with_devicegroup(self):
         self.assertEqual(Device.objects.count(), 0)
         path = reverse('config_api:device_list')
-        data = self._get_device_data.copy()
+        data = self._device_data
         org = self._get_org()
         device_group = self._create_device_group()
         data['organization'] = org.pk
@@ -598,7 +604,7 @@ def test_deactivating_device_force_deletion(self):
     def test_template_create_no_org_api(self):
         self.assertEqual(Template.objects.count(), 0)
         path = reverse('config_api:template_list')
-        data = self._get_template_data.copy()
+        data = self._template_data
         r = self.client.post(path, data, content_type='application/json')
         self.assertEqual(Template.objects.count(), 1)
         self.assertEqual(r.status_code, 201)
@@ -609,7 +615,7 @@ def test_template_create_vpn_with_type_as_generic(self):
         test_user = self._create_operator(organizations=[self._get_org()])
         self.client.force_login(test_user)
         vpn1 = self._create_vpn(name='vpn1', organization=self._get_org())
-        data = self._get_template_data.copy()
+        data = self._template_data
         data['organization'] = self._get_org().pk
         data['type'] = 'generic'
         data['vpn'] = vpn1.id
@@ -622,7 +628,7 @@ def test_template_create_api(self):
         self.assertEqual(Template.objects.count(), 0)
         org = self._get_org()
         path = reverse('config_api:template_list')
-        data = self._get_template_data.copy()
+        data = self._template_data
         data['organization'] = org.pk
         data['required'] = True
         r = self.client.post(path, data, content_type='application/json')
@@ -634,7 +640,7 @@ def test_template_create_of_vpn_type(self):
         org = self._get_org()
         vpn1 = self._create_vpn(name='vpn1', organization=org)
         path = reverse('config_api:template_list')
-        data = self._get_template_data.copy()
+        data = self._template_data
         data['type'] = 'vpn'
         data['vpn'] = vpn1.id
         data['organization'] = org.pk
@@ -648,7 +654,7 @@ def test_template_create_with_shared_vpn(self):
         self.client.force_login(test_user)
         vpn1 = self._create_vpn(name='vpn1', organization=None)
         path = reverse('config_api:template_list')
-        data = self._get_template_data.copy()
+        data = self._template_data
         data['type'] = 'vpn'
         data['vpn'] = vpn1.id
         data['organization'] = org1.pk
@@ -659,7 +665,7 @@ def test_template_create_with_shared_vpn(self):
 
     def test_template_creation_with_no_org_by_operator(self):
         path = reverse('config_api:template_list')
-        data = self._get_template_data.copy()
+        data = self._template_data
         test_user = self._create_operator(organizations=[self._get_org()])
         self.client.force_login(test_user)
         r = self.client.post(path, data, content_type='application/json')
@@ -668,7 +674,7 @@ def test_template_creation_with_no_org_by_operator(self):
 
     def test_template_create_with_empty_config(self):
         path = reverse('config_api:template_list')
-        data = self._get_template_data.copy()
+        data = self._template_data
         data['config'] = {}
         data['organization'] = self._get_org().pk
         r = self.client.post(path, data, content_type='application/json')
@@ -820,7 +826,7 @@ def test_vpn_create_api(self):
         self.assertEqual(Vpn.objects.count(), 0)
         path = reverse('config_api:vpn_list')
         ca1 = self._create_ca()
-        data = self._get_vpn_data.copy()
+        data = self._vpn_data
         data['ca'] = ca1.pk
         r = self.client.post(path, data, content_type='application/json')
         self.assertEqual(r.status_code, 201)
@@ -831,7 +837,7 @@ def test_vpn_create_with_shared_objects(self):
         shared_ca = self._create_ca(name='shared_ca', organization=None)
         test_user = self._create_administrator(organizations=[org1])
         self.client.force_login(test_user)
-        data = self._get_vpn_data.copy()
+        data = self._vpn_data
         data['organization'] = org1.pk
         data['ca'] = shared_ca.pk
         path = reverse('config_api:vpn_list')
@@ -1008,7 +1014,7 @@ def test_devicegroup_create_api(self):
         org = self._get_org()
         template = self._create_template(name='t1', organization=org)
         path = reverse('config_api:devicegroup_list')
-        data = self._get_devicegroup_data.copy()
+        data = self._devicegroup_data
         data['organization'] = org.pk
         data['templates'] = [str(template.pk)]
         response = self.client.post(path, data, content_type='application/json')
@@ -1098,13 +1104,13 @@ def test_devicegroup_detail_api(self):
         with self.subTest('Test PATCH'):
             response = self.client.patch(
                 path,
-                data={'meta_data': self._get_devicegroup_data['meta_data']},
+                data={'meta_data': self._devicegroup_data['meta_data']},
                 content_type='application/json',
             )
             self.assertEqual(response.status_code, 200)
             device_group.refresh_from_db()
             self.assertDictEqual(
-                device_group.meta_data, self._get_devicegroup_data['meta_data']
+                device_group.meta_data, self._devicegroup_data['meta_data']
             )
 
         with self.subTest('Test DELETE'):

openwisp_controller/pki/tests/test_api.py

@@ -27,26 +27,28 @@ def setUp(self):
         super().setUp()
         self._login()
 
-    _get_ca_data = {
-        'name': 'Test CA',
-        'organization': None,
-        'key_length': '2048',
-        'digest': 'sha256',
-    }
-
-    _get_cert_data = {
-        'name': 'Test Cert',
-        'organization': None,
-        'ca': None,
-        'key_length': '2048',
-        'digest': 'sha256',
-        'serial_number': "",
-    }
+    def _ca_data(self):
+        return {
+            'name': 'Test CA',
+            'organization': None,
+            'key_length': '2048',
+            'digest': 'sha256',
+        }
+
+    def _cert_data(self):
+        return {
+            'name': 'Test Cert',
+            'organization': None,
+            'ca': None,
+            'key_length': '2048',
+            'digest': 'sha256',
+            'serial_number': "",
+        }
 
     def test_ca_post_api(self):
         self.assertEqual(Ca.objects.count(), 0)
         path = reverse('pki_api:ca_list')
-        data = self._get_ca_data.copy()
+        data = self._ca_data
         with self.assertNumQueries(4):
             r = self.client.post(path, data, content_type='application/json')
         self.assertEqual(r.status_code, 201)
@@ -55,7 +57,7 @@ def test_ca_post_api(self):
     def test_ca_post_with_extensions_field(self):
         self.assertEqual(Ca.objects.count(), 0)
         path = reverse('pki_api:ca_list')
-        data = self._get_ca_data.copy()
+        data = self._ca_data
         data['extensions'] = []
         with self.assertNumQueries(4):
             r = self.client.post(path, data, content_type='application/json')
@@ -166,7 +168,7 @@ def test_ca_post_renew_api(self):
 
     def test_cert_post_api(self):
         path = reverse('pki_api:cert_list')
-        data = self._get_cert_data.copy()
+        data = self._cert_data
         data['ca'] = self._create_ca().pk
         with self.assertNumQueries(8):
             r = self.client.post(path, data, content_type='application/json')
@@ -198,7 +200,7 @@ def test_import_cert_post_api(self):
 
     def test_cert_post_with_extensions_field(self):
         path = reverse('pki_api:cert_list')
-        data = self._get_cert_data.copy()
+        data = self._cert_data
         data['ca'] = self._create_ca().pk
         data['extensions'] = []
         with self.assertNumQueries(8):