[feature] Add support to reversion to the REST API #894

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,28 @@ def update(self, instance, validated_data):
         instance = super().update(instance, validated_data)
         self._save_m2m_templates(instance)
         return instance
+
+
+class VersionSerializer(BaseSerializer):
+    user_id = serializers.CharField(source="revision.user_id", read_only=True)
+    date_created = serializers.DateTimeField(
+        source="revision.date_created", read_only=True
+    )
+    comment = serializers.CharField(source="revision.comment", read_only=True)
+    content_type = serializers.CharField(source="revision.content_type", read_only=True)
+
+    class Meta:
+        model = Version
+        fields = [
+            "id",
+            "revision_id",
+            "object_id",
+            "content_type",
+            "db",
+            "format",
+            "serialized_data",
+            "object_repr",
+            "user_id",
+            "date_created",
+            "comment",
+        ]

openwisp_controller/config/api/urls.py

@@ -13,6 +13,21 @@ def get_api_urls(api_views):
     """
     if getattr(settings, "OPENWISP_CONTROLLER_API", True):
         return [
+            path(
+                "controller/<str:model>/revision/",
+                api_views.revision_list,
+                name="revision_list",
+            ),
+            path(
+                "controller/<str:model>/revision/<str:pk>/",
+                api_views.version_detail,
+                name="version_detail",
+            ),
+            path(
+                "controller/<str:model>/revision/<str:pk>/restore/",
+                api_views.revision_restore,
+                name="revision_restore",
+            ),
             path(
                 "controller/template/",
                 api_views.template_list,

openwisp_controller/config/api/views.py

@@ -1,22 +1,27 @@
+import reversion
 from cache_memoize import cache_memoize
 from django.core.exceptions import ObjectDoesNotExist
+from django.db import transaction
 from django.db.models import F, Q
 from django.http import Http404
+from django.shortcuts import get_list_or_404
 from django.urls.base import reverse
 from django_filters.rest_framework import DjangoFilterBackend
 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
 
-from ...mixins import ProtectedAPIMixin
+from ...mixins import AutoRevisionMixin, ProtectedAPIMixin
 from .filters import (
     DeviceGroupListFilter,
     DeviceListFilter,
@@ -29,6 +34,7 @@
     DeviceGroupSerializer,
     DeviceListSerializer,
     TemplateSerializer,
+    VersionSerializer,
     VpnSerializer,
 )
 
@@ -48,28 +54,30 @@ class ListViewPagination(pagination.PageNumberPagination):
     max_page_size = 100
 
 
-class TemplateListCreateView(ProtectedAPIMixin, ListCreateAPIView):
+class TemplateListCreateView(ProtectedAPIMixin, AutoRevisionMixin, ListCreateAPIView):
     serializer_class = TemplateSerializer
     queryset = Template.objects.prefetch_related("tags").order_by("-created")
     pagination_class = ListViewPagination
     filter_backends = [DjangoFilterBackend]
     filterset_class = TemplateListFilter
 
 
-class TemplateDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
+class TemplateDetailView(
+    ProtectedAPIMixin, AutoRevisionMixin, RetrieveUpdateDestroyAPIView
+):
     serializer_class = TemplateSerializer
     queryset = Template.objects.all()
 
 
-class VpnListCreateView(ProtectedAPIMixin, ListCreateAPIView):
+class VpnListCreateView(ProtectedAPIMixin, AutoRevisionMixin, ListCreateAPIView):
     serializer_class = VpnSerializer
     queryset = Vpn.objects.select_related("subnet").order_by("-created")
     pagination_class = ListViewPagination
     filter_backends = [DjangoFilterBackend]
     filterset_class = VPNListFilter
 
 
-class VpnDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
+class VpnDetailView(ProtectedAPIMixin, AutoRevisionMixin, RetrieveUpdateDestroyAPIView):
     serializer_class = VpnSerializer
     queryset = Vpn.objects.all()
 
@@ -82,7 +90,7 @@ def has_object_permission(self, request, view, obj):
         return perm and not obj.is_deactivated()
 
 
-class DeviceListCreateView(ProtectedAPIMixin, ListCreateAPIView):
+class DeviceListCreateView(ProtectedAPIMixin, AutoRevisionMixin, ListCreateAPIView):
     """
     Templates: Templates flagged as required will be added automatically
                to the `config` of a device and cannot be unassigned.
@@ -97,7 +105,9 @@ class DeviceListCreateView(ProtectedAPIMixin, ListCreateAPIView):
     filterset_class = DeviceListFilter
 
 
-class DeviceDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
+class DeviceDetailView(
+    ProtectedAPIMixin, AutoRevisionMixin, RetrieveUpdateDestroyAPIView
+):
     """
     Templates: Templates flagged as _required_ will be added automatically
                to the `config` of a device and cannot be unassigned.
@@ -124,7 +134,7 @@ def get_serializer_context(self):
         return context
 
 
-class DeviceActivateView(ProtectedAPIMixin, GenericAPIView):
+class DeviceActivateView(ProtectedAPIMixin, AutoRevisionMixin, GenericAPIView):
     serializer_class = serializers.Serializer
     queryset = Device.objects.filter(_is_deactivated=True)
 
@@ -137,7 +147,7 @@ def post(self, request, *args, **kwargs):
         return Response(serializer.data, status=status.HTTP_200_OK)
 
 
-class DeviceDeactivateView(ProtectedAPIMixin, GenericAPIView):
+class DeviceDeactivateView(ProtectedAPIMixin, AutoRevisionMixin, GenericAPIView):
     serializer_class = serializers.Serializer
     queryset = Device.objects.filter(_is_deactivated=False)
 
@@ -150,15 +160,19 @@ def post(self, request, *args, **kwargs):
         return Response(serializer.data, status=status.HTTP_200_OK)
 
 
-class DeviceGroupListCreateView(ProtectedAPIMixin, ListCreateAPIView):
+class DeviceGroupListCreateView(
+    ProtectedAPIMixin, AutoRevisionMixin, ListCreateAPIView
+):
     serializer_class = DeviceGroupSerializer
     queryset = DeviceGroup.objects.prefetch_related("templates").order_by("-created")
     pagination_class = ListViewPagination
     filter_backends = [DjangoFilterBackend]
     filterset_class = DeviceGroupListFilter
 
 
-class DeviceGroupDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
+class DeviceGroupDetailView(
+    ProtectedAPIMixin, AutoRevisionMixin, RetrieveUpdateDestroyAPIView
+):
     serializer_class = DeviceGroupSerializer
     queryset = DeviceGroup.objects.select_related("organization").order_by("-created")
 
@@ -172,7 +186,7 @@ def get_cached_devicegroup_args_rewrite(cls, org_slugs, common_name):
     return url
 
 
-class DeviceGroupCommonName(ProtectedAPIMixin, RetrieveAPIView):
+class DeviceGroupCommonName(ProtectedAPIMixin, AutoRevisionMixin, RetrieveAPIView):
     serializer_class = DeviceGroupSerializer
     queryset = DeviceGroup.objects.select_related("organization").order_by("-created")
     # Not setting lookup_field makes DRF raise error. but it is not used
@@ -289,6 +303,60 @@ def certificate_delete_invalidates_cache(cls, organization_id, common_name):
         cls.get_device_group.invalidate(cls, org_slug, common_name)
 
 
+class RevisionListView(ProtectedAPIMixin, ListAPIView):
+    serializer_class = VersionSerializer
+    queryset = Version.objects.select_related("revision").order_by(
+        "-revision__date_created"
+    )
+
+    def get_queryset(self):
+        model = self.kwargs.get("model").lower()
+        queryset = self.queryset.filter(content_type__model=model)
+        revision_id = self.request.query_params.get("revision_id")
+        if revision_id:
+            queryset = queryset.filter(revision_id=revision_id)
+        return self.queryset.filter(content_type__model=model)
+
+
+class VersionDetailView(ProtectedAPIMixin, RetrieveAPIView):
+    serializer_class = VersionSerializer
+    queryset = Version.objects.select_related("revision").order_by(
+        "-revision__date_created"
+    )
+
+    def get_queryset(self):
+        model = self.kwargs.get("model").lower()
+        return self.queryset.filter(content_type__model=model)
+
+
+class RevisionRestoreView(ProtectedAPIMixin, GenericAPIView):
+    serializer_class = serializers.Serializer
+    queryset = Version.objects.select_related("revision").order_by(
+        "-revision__date_created"
+    )
+
+    def get_queryset(self):
+        model = self.kwargs.get("model").lower()
+        return self.queryset.filter(content_type__model=model)
+
+    def post(self, request, *args, **kwargs):
+        qs = self.get_queryset()
+        versions = get_list_or_404(qs, revision_id=kwargs["pk"])
+        with transaction.atomic():
+            with reversion.create_revision():
+                for version in versions:
+                    version.revert()
+                reversion.set_user(request.user)
+                reversion.set_comment(
+                    f"Restored to previous revision: {self.kwargs.get('pk')}"
+                )
+
+        serializer = VersionSerializer(
+            versions, many=True, 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 +368,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()
+revision_list = RevisionListView.as_view()
+version_detail = VersionDetailView.as_view()
+revision_restore = RevisionRestoreView.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
@@ -1634,3 +1635,49 @@ 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_revision_list_and_restore_api(self):
+        org = self._get_org()
+        model_slug = "device"
+        with reversion.create_revision():
+            device = self._create_device(
+                organization=org,
+                name="test",
+            )
+        path = reverse("config_api:device_detail", args=[device.pk])
+        data = dict(name="change-test-device")
+        response = self.client.patch(path, data, content_type="application/json")
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["name"], "change-test-device")
+
+        with self.subTest("Test revision list"):
+            path = reverse("config_api:revision_list", args=[model_slug])
+            response = self.client.get(path)
+            response_json = response.json()
+            version_id = response_json[1]["id"]
+            revision_id = response_json[1]["revision_id"]
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(len(response_json), 2)
+
+        with self.subTest("Test revision list filter by revision id"):
+            path = reverse("config_api:revision_list", args=[model_slug])
+            response = self.client.get(f"{path}?revision_id={revision_id}")
+            response_json = response.json()
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(len(response_json), 2)
+
+        with self.subTest("Test version detail"):
+            path = reverse("config_api:version_detail", args=[model_slug, 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 revision restore view"):
+            revision_id = response_json[1]["revision_id"]
+            path = reverse(
+                "config_api:revision_restore", args=[model_slug, revision_id]
+            )
+            response = self.client.post(path)
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(Device.objects.get(name="test").pk, device.pk)

openwisp_controller/connection/api/views.py

@@ -14,6 +14,7 @@
 from openwisp_users.api.mixins import ProtectedAPIMixin as BaseProtectedAPIMixin
 
 from ...mixins import (
+    AutoRevisionMixin,
     ProtectedAPIMixin,
     RelatedDeviceModelPermission,
     RelatedDeviceProtectedAPIMixin,
@@ -61,7 +62,7 @@ def get_serializer_context(self):
         return context
 
 
-class CommandListCreateView(BaseCommandView, ListCreateAPIView):
+class CommandListCreateView(BaseCommandView, AutoRevisionMixin, ListCreateAPIView):
     pagination_class = ListViewPagination
 
     def create(self, request, *args, **kwargs):
@@ -81,13 +82,15 @@ def get_object(self):
         return obj
 
 
-class CredentialListCreateView(ProtectedAPIMixin, ListCreateAPIView):
+class CredentialListCreateView(ProtectedAPIMixin, AutoRevisionMixin, ListCreateAPIView):
     queryset = Credentials.objects.order_by("-created")
     serializer_class = CredentialSerializer
     pagination_class = ListViewPagination
 
 
-class CredentialDetailView(ProtectedAPIMixin, RetrieveUpdateDestroyAPIView):
+class CredentialDetailView(
+    ProtectedAPIMixin, AutoRevisionMixin, RetrieveUpdateDestroyAPIView
+):
     queryset = Credentials.objects.all()
     serializer_class = CredentialSerializer
 
@@ -119,7 +122,9 @@ def get_parent_queryset(self):
         return Device.objects.filter(pk=self.kwargs["device_id"])
 
 
-class DeviceConnenctionListCreateView(BaseDeviceConnection, ListCreateAPIView):
+class DeviceConnenctionListCreateView(
+    BaseDeviceConnection, AutoRevisionMixin, ListCreateAPIView
+):
     pagination_class = ListViewPagination
 
     def get_queryset(self):
@@ -131,7 +136,9 @@ def get_queryset(self):
         )
 
 
-class DeviceConnectionDetailView(BaseDeviceConnection, RetrieveUpdateDestroyAPIView):
+class DeviceConnectionDetailView(
+    BaseDeviceConnection, AutoRevisionMixin, RetrieveUpdateDestroyAPIView
+):
     def get_object(self):
         queryset = self.filter_queryset(self.get_queryset())
         filter_kwargs = {