[feature] Rivision for Rest Api changes openwisp#894

Implemented three endpoints:
1. List all revisions with optional filtering by model.
2. Inspect a specific revision by its ID.
3. Restore a revision using its ID.

 Fixes openwisp#894

Author: dee077

openwisp_controller/config/api/filters.py

@@ -4,6 +4,7 @@
 from django_filters import rest_framework as filters
 from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework.exceptions import ValidationError
+from reversion.models import Version
 from swapper import load_model
 
 from openwisp_users.api.filters import OrganizationManagedFilter
@@ -142,3 +143,18 @@ def __init__(self, *args, **kwargs):
 
     class Meta(BaseConfigAPIFilter.Meta):
         model = DeviceGroup
+
+
+class ReversionFilter(BaseConfigAPIFilter):
+    model = filters.CharFilter(field_name="content_type__model", lookup_expr="iexact")
+
+    def _set_valid_filterform_labels(self):
+        self.filters["model"].label = _("Model")
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._set_valid_filterform_labels()
+
+    class Meta:
+        model = Version
+        fields = ["model"]

openwisp_controller/config/api/serializers.py

@@ -3,6 +3,7 @@
 from django.db.models import Q
 from django.utils.translation import gettext_lazy as _
 from rest_framework import serializers
+from reversion.models import Version
 from swapper import load_model
 
 from openwisp_utils.api.serializers import ValidatedModelSerializer
@@ -376,3 +377,34 @@ def update(self, instance, validated_data):
         instance = super().update(instance, validated_data)
         self._save_m2m_templates(instance)
         return instance
+
+
+class ReversionSerializer(BaseSerializer):
+    user_id = serializers.SerializerMethodField()
+    date_created = serializers.DateTimeField(
+        source="revision.date_created", read_only=True
+    )
+    comment = serializers.CharField(source="revision.comment", read_only=True)
+    content_type = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Version
+        fields = [
+            "id",
+            "revision_id",
+            "object_id",
+            "content_type",
+            "db",
+            "format",
+            "serialized_data",
+            "object_repr",
+            "user_id",
+            "date_created",
+            "comment",
+        ]
+
+    def get_user_id(self, obj):
+        return getattr(obj.revision, "user_id", None)
+
+    def get_content_type(self, obj):
+        return getattr(obj.content_type, "model", None)

openwisp_controller/config/api/urls.py

@@ -83,6 +83,21 @@ def get_api_urls(api_views):
                 api_download_views.download_device_config,
                 name='download_device_config',
             ),
+            path(
+                'controller/reversion/',
+                api_views.reversion_list,
+                name='reversion_list',
+            ),
+            path(
+                'controller/reversion/<str:pk>/',
+                api_views.reversion_detail,
+                name='reversion_detail',
+            ),
+            path(
+                'controller/reversion/<str:pk>/restore/',
+                api_views.reversion_restore,
+                name='reversion_restore',
+            ),
         ]
     else:
         return []

openwisp_controller/config/api/views.py

@@ -1,3 +1,4 @@
+import reversion
 from cache_memoize import cache_memoize
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import F, Q
@@ -7,11 +8,13 @@
 from rest_framework import pagination, serializers, status
 from rest_framework.generics import (
     GenericAPIView,
+    ListAPIView,
     ListCreateAPIView,
     RetrieveAPIView,
     RetrieveUpdateDestroyAPIView,
 )
 from rest_framework.response import Response
+from reversion.models import Version
 from swapper import load_model
 
 from openwisp_users.api.permissions import DjangoModelPermissions
@@ -21,13 +24,15 @@
     DeviceGroupListFilter,
     DeviceListFilter,
     DeviceListFilterBackend,
+    ReversionFilter,
     TemplateListFilter,
     VPNListFilter,
 )
 from .serializers import (
     DeviceDetailSerializer,
     DeviceGroupSerializer,
     DeviceListSerializer,
+    ReversionSerializer,
     TemplateSerializer,
     VpnSerializer,
 )
@@ -289,6 +294,42 @@ def certificate_delete_invalidates_cache(cls, organization_id, common_name):
         cls.get_device_group.invalidate(cls, org_slug, common_name)
 
 
+class ReversionListView(ProtectedAPIMixin, ListAPIView):
+    serializer_class = ReversionSerializer
+    queryset = Version.objects.select_related('revision').order_by(
+        '-revision__date_created'
+    )
+    filter_backends = [DjangoFilterBackend]
+    filterset_class = ReversionFilter
+
+
+class ReversionDetailView(ProtectedAPIMixin, RetrieveAPIView):
+    serializer_class = ReversionSerializer
+    queryset = Version.objects.select_related('revision').order_by(
+        '-revision__date_created'
+    )
+    lookup_field = 'pk'
+
+
+class ReversionRestoreView(ProtectedAPIMixin, GenericAPIView):
+    serializer_class = serializers.Serializer
+    queryset = Version.objects.select_related('revision').order_by(
+        '-revision__date_created'
+    )
+
+    def post(self, request, *args, **kwargs):
+        version = self.get_object()
+        with reversion.create_revision():
+            version.revert()
+            reversion.set_user(request.user)
+            reversion.set_comment(
+                f"Restored to previous revision: {version.revision_id}"
+            )
+
+        serializer = ReversionSerializer(version, context=self.get_serializer_context())
+        return Response(serializer.data, status=status.HTTP_200_OK)
+
+
 template_list = TemplateListCreateView.as_view()
 template_detail = TemplateDetailView.as_view()
 vpn_list = VpnListCreateView.as_view()
@@ -300,3 +341,6 @@ def certificate_delete_invalidates_cache(cls, organization_id, common_name):
 devicegroup_list = DeviceGroupListCreateView.as_view()
 devicegroup_detail = DeviceGroupDetailView.as_view()
 devicegroup_commonname = DeviceGroupCommonName.as_view()
+reversion_list = ReversionListView.as_view()
+reversion_detail = ReversionDetailView.as_view()
+reversion_restore = ReversionRestoreView.as_view()

openwisp_controller/config/tests/test_api.py

@@ -1,3 +1,4 @@
+import reversion
 from django.contrib.auth.models import Permission
 from django.test import TestCase
 from django.test.client import BOUNDARY, MULTIPART_CONTENT, encode_multipart
@@ -1564,3 +1565,42 @@ def test_device_patch_with_templates_of_same_org(self):
         self.assertEqual(r.status_code, 200)
         self.assertEqual(d1.config.templates.count(), 2)
         self.assertEqual(r.data['config']['templates'], [t1.id, t2.id])
+
+    def test_reversion_list_and_restore_api(self):
+        org = self._get_org()
+        with reversion.create_revision():
+            device = self._create_device(
+                organization=org, name="test", _is_deactivated=True
+            )
+        path = reverse("config_api:device_detail", args=[device.pk])
+        response = self.client.delete(path)
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(Device.objects.count(), 0)
+
+        path = reverse("config_api:reversion_list")
+        response = self.client.get(path)
+        response_json = response.json()
+        version_id = response_json[0]["id"]
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response_json), 1)
+
+        with self.subTest("Test filter reversion list with model name"):
+            params = {"id": 1, "model": "Device"}
+            response = self.client.get(path, params)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(len(response.json()), 1)
+            self.assertEqual(response.json()[0]["object_id"], str(device.pk))
+
+        with self.subTest("Test reversion detail"):
+            path = reverse("config_api:reversion_detail", args=[version_id])
+            response = self.client.get(path)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.json()["id"], version_id)
+            self.assertEqual(response.json()["object_id"], str(device.pk))
+
+        with self.subTest("Test reversion restore view"):
+            path = reverse("config_api:reversion_restore", args=[version_id])
+            response = self.client.post(path)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(Device.objects.count(), 1)
+            self.assertEqual(Device.objects.first().id, device.pk)

tests/openwisp2/sample_config/api/views.py

@@ -28,6 +28,15 @@
 from openwisp_controller.config.api.views import (
     DeviceListCreateView as BaseDeviceListCreateView,
 )
+from openwisp_controller.config.api.views import (
+    ReversionDetailView as BaseReversionDetailView,
+)
+from openwisp_controller.config.api.views import (
+    ReversionListView as BaseReversionListView,
+)
+from openwisp_controller.config.api.views import (
+    ReversionRestoreView as BaseReversionRestoreView,
+)
 from openwisp_controller.config.api.views import (
     TemplateDetailView as BaseTemplateDetailView,
 )
@@ -96,6 +105,18 @@ class DownloadDeviceView(BaseDownloadDeviceView):
     pass
 
 
+class ReversionListView(BaseReversionListView):
+    pass
+
+
+class ReversionDetailView(BaseReversionDetailView):
+    pass
+
+
+class ReversionRestoreView(BaseReversionRestoreView):
+    pass
+
+
 template_list = TemplateListCreateView.as_view()
 template_detail = TemplateDetailView.as_view()
 download_template_config = DownloadTemplateconfiguration.as_view()
@@ -110,3 +131,6 @@ class DownloadDeviceView(BaseDownloadDeviceView):
 devicegroup_list = DeviceGroupListCreateView.as_view()
 devicegroup_detail = DeviceGroupDetailView.as_view()
 devicegroup_commonname = DeviceGroupCommonName.as_view()
+reversion_list = ReversionListView.as_view()
+reversion_detail = ReversionDetailView.as_view()
+reversion_restore = ReversionRestoreView.as_view()