[feature] Add support for inherited variables in DeviceDetialView #818

Expose inherited variables (from templates, groups, and global) in API response via optional query param.

Fixes #818

Author: dee077

openwisp_controller/config/api/serializers.py

@@ -326,6 +326,18 @@ def update(self, instance, validated_data):
                 )
         return super().update(instance, validated_data)
 
+    def get_inherited_variables(self, device):
+        return {
+            'global': getattr(app_settings, 'CONTEXT', {}),
+            'group': DeviceGroupSerializer(device.group, context=self.context).data,
+            'config': DeviceDetailConfigSerializer(
+                device.config, context=self.context
+            ).data,
+            'templates': TemplateSerializer(
+                device.config.templates, many=True, context=self.context
+            ).data,
+        }
+
 
 class FilterGroupTemplates(FilterTemplatesByOrganization):
     def get_queryset(self):

openwisp_controller/config/api/views.py

@@ -111,6 +111,14 @@ def perform_destroy(self, instance):
         force_deletion = self.request.query_params.get('force', None) == 'true'
         instance.delete(check_deactivated=(not force_deletion))
 
+    def retrieve(self, request, *args, **kwargs):
+        device = self.get_object()
+        serializer = self.get_serializer(device)
+        data = serializer.data
+        if request.query_params.get('inherited_variables') == 'True':
+            data['inherited_variables'] = serializer.get_inherited_variables(device)
+        return Response(data)
+
     def get_object(self):
         """Set device property for serializer context."""
         obj = super().get_object()

openwisp_controller/config/tests/test_api.py

@@ -387,6 +387,26 @@ def test_device_detail_config_api(self):
         self.assertEqual(r.status_code, 200)
         self.assertNotEqual(r.data['config'], None)
 
+    def test_device_detail_api_with_inherited_variables(self):
+        org = self._get_org()
+        device_group = self._create_device_group(organization=org)
+        device = self._create_device(organization=org, group=device_group)
+        config = self._create_config(device=device)
+        template = self._create_template(organization=org)
+        config.templates.add(template)
+        path = reverse('config_api:device_detail', args=[device.pk])
+        r = self.client.get(f'{path}?inherited_variables=True')
+        self.assertEqual(r.status_code, 200)
+        self.assertIn('inherited_variables', r.data)
+        self.assertEqual(r.data['inherited_variables']['global'], app_settings.CONTEXT)
+        self.assertEqual(
+            r.data['inherited_variables']['group']['id'], str(device_group.pk)
+        )
+        self.assertEqual(r.data['inherited_variables']['config']['status'], 'modified')
+        self.assertEqual(
+            r.data['inherited_variables']['templates'][0]['id'], str(template.pk)
+        )
+
     def test_device_put_api(self):
         d1 = self._create_device(name='test-device')
         self._create_config(device=d1)