Merge branch 'master' into issues/204-sortedm2m-queries

Author: DragnEmperor

docs/user/rest-api.rst

@@ -275,28 +275,28 @@ Get Device Connection Detail
 
 .. code-block:: text
 
-    GET /api/v1/controller/device/{id}/connection/{id}/
+    GET /api/v1/controller/device/{device_id}/connection/{connection_id}/
 
 Change Device Connection Detail
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
-    PUT /api/v1/controller/device/{id}/connection/{id}/
+    PUT /api/v1/controller/device/{device_id}/connection/{connection_id}/
 
 Patch Device Connection Detail
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
-    PATCH /api/v1/controller/device/{id}/connection/{id}/
+    PATCH /api/v1/controller/device/{device_id}/connection/{connection_id}/
 
 Delete Device Connection
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
-    DELETE /api/v1/controller/device/{id}/connection/{id}/
+    DELETE /api/v1/controller/device/{device_id}/connection/{connection_id}/
 
 List Credentials
 ~~~~~~~~~~~~~~~~
@@ -345,14 +345,14 @@ List Commands of a Device
 
 .. code-block:: text
 
-    GET /api/v1/controller/device/{id}/command/
+    GET /api/v1/controller/device/{device_id}/command/
 
-Execute a Command a Device
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+Execute a Command on a Device
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
-    POST /api/v1/controller/device/{id}/command/
+    POST /api/v1/controller/device/{device_id}/command/
 
 Get Command Details
 ~~~~~~~~~~~~~~~~~~~

openwisp_controller/config/tests/test_notifications.py

@@ -4,6 +4,7 @@
 from django.apps.registry import apps
 from django.conf import settings
 from django.test import TransactionTestCase
+from django.urls import reverse
 from requests.exceptions import RequestException
 from swapper import load_model
 
@@ -40,6 +41,7 @@ def setUp(self):
 
     def test_config_problem_notification(self):
         config = self._create_config()
+        device = config.device
         config.set_status_error()
 
         self.assertEqual(config.status, 'error')
@@ -53,8 +55,15 @@ def test_config_problem_notification(self):
             f'[example.com] ERROR: "{config.device}"'
             ' configuration encountered an error',
         )
-        self.assertIn('encountered an error', notification.message)
-        self.assertEqual(notification.target_url.endswith('#config-group'), True)
+        expected_target_url = ('https://example.com{}#config-group').format(
+            reverse(f'admin:{self.app_label}_device_change', args=[device.id])
+        )
+        self.assertEqual(
+            notification.message,
+            f'<p>The configuration of <a href="{expected_target_url}">{device.name}</a>'
+            ' has encountered an error. The last working configuration has been'
+            ' restored from a backup present on the filesystem of the device.</p>',
+        )
 
     def test_device_registered(self):
         # To avoid adding repetitive code for registering a device,

openwisp_controller/config/utils.py

@@ -203,5 +203,5 @@ def get_default_templates_queryset(
 
 
 def get_config_error_notification_target_url(obj, field, absolute_url=True):
-    url = _get_object_link(obj, field, absolute_url)
+    url = _get_object_link(obj._related_object(field), absolute_url)
     return f'{url}#config-group'

openwisp_controller/connection/api/urls.py

@@ -11,12 +11,12 @@ def get_api_urls(api_views):
     """
     return [
         path(
-            'api/v1/controller/device/<uuid:device_pk>/command/',
+            'api/v1/controller/device/<uuid:device_id>/command/',
             api_views.command_list_create_view,
             name='device_command_list',
         ),
         path(
-            'api/v1/controller/device/<uuid:device_pk>/command/<uuid:pk>/',
+            'api/v1/controller/device/<uuid:device_id>/command/<uuid:pk>/',
             api_views.command_details_view,
             name='device_command_details',
         ),
@@ -31,12 +31,12 @@ def get_api_urls(api_views):
             name='credential_detail',
         ),
         path(
-            'api/v1/controller/device/<uuid:device_pk>/connection/',
+            'api/v1/controller/device/<uuid:device_id>/connection/',
             api_views.deviceconnection_list_create_view,
             name='deviceconnection_list',
         ),
         path(
-            'api/v1/controller/device/<uuid:device_pk>/connection/<uuid:pk>/',
+            'api/v1/controller/device/<uuid:device_id>/connection/<uuid:pk>/',
             api_views.deviceconnection_details_view,
             name='deviceconnection_detail',
         ),

openwisp_controller/connection/api/views.py

@@ -49,15 +49,15 @@ def get_permissions(self):
 
     def get_parent_queryset(self):
         return Device.objects.filter(
-            pk=self.kwargs['device_pk'],
+            pk=self.kwargs['device_id'],
         )
 
     def get_queryset(self):
-        return super().get_queryset().filter(device_id=self.kwargs['device_pk'])
+        return super().get_queryset().filter(device_id=self.kwargs['device_id'])
 
     def get_serializer_context(self):
         context = super().get_serializer_context()
-        context['device_id'] = self.kwargs['device_pk']
+        context['device_id'] = self.kwargs['device_id']
         return context
 
 
@@ -101,7 +101,7 @@ def get_queryset(self):
 
     def get_serializer_context(self):
         context = super().get_serializer_context()
-        context['device_id'] = self.kwargs['device_pk']
+        context['device_id'] = self.kwargs['device_id']
         return context
 
     def initial(self, *args, **kwargs):
@@ -112,11 +112,11 @@ def assert_parent_exists(self):
         try:
             assert self.get_parent_queryset().exists()
         except (AssertionError, ValidationError):
-            device_id = self.kwargs['device_pk']
+            device_id = self.kwargs['device_id']
             raise NotFound(detail=f'Device with ID "{device_id}" not found.')
 
     def get_parent_queryset(self):
-        return Device.objects.filter(pk=self.kwargs['device_pk'])
+        return Device.objects.filter(pk=self.kwargs['device_id'])
 
 
 class DeviceConnenctionListCreateView(BaseDeviceConnection, ListCreateAPIView):
@@ -126,7 +126,7 @@ def get_queryset(self):
         return (
             super()
             .get_queryset()
-            .filter(device_id=self.kwargs['device_pk'])
+            .filter(device_id=self.kwargs['device_id'])
             .order_by('-created')
         )
 

openwisp_controller/connection/apps.py

@@ -81,14 +81,14 @@ def command_save_receiver(cls, sender, created, instance, **kwargs):
         )
 
     @classmethod
-    def _launch_update_config(cls, device_pk):
+    def _launch_update_config(cls, device_id):
         """
         Calls the background task update_config only if
         no other tasks are running for the same device
         """
         from .tasks import update_config
 
-        update_config.delay(device_pk)
+        update_config.delay(device_id)
 
     @classmethod
     def is_working_changed_receiver(

openwisp_controller/connection/tasks.py

@@ -15,14 +15,14 @@
 _TASK_NAME = 'openwisp_controller.connection.tasks.update_config'
 
 
-def _is_update_in_progress(device_pk):
+def _is_update_in_progress(device_id):
     active = current_app.control.inspect().active()
     if not active:
         return False
     # check if there's any other running task before adding it
     for task_list in active.values():
         for task in task_list:
-            if task['name'] == _TASK_NAME and str(device_pk) in task['args']:
+            if task['name'] == _TASK_NAME and str(device_id) in task['args']:
                 return True
     return False