Added updated status Audit endpoint (#835)

* serializer and test added for Audit - UpdatedStatus

* Added view and url mappings

* Used Black fix linter issue

* addresses review comments

api/data_workspace/audit_views.py

@@ -7,7 +7,7 @@
 from api.audit_trail.models import Audit
 from api.cases.models import Case
 from api.core.authentication import DataWorkspaceOnlyAuthentication
-from api.data_workspace.serializers import AuditMoveCaseSerializer
+from api.data_workspace.serializers import AuditMoveCaseSerializer, AuditUpdatedCaseStatusSerializer
 
 
 class AuditMoveCaseListView(viewsets.ReadOnlyModelViewSet):
@@ -44,3 +44,14 @@ def get_queryset(self):
             """,
             {"verb": AuditType.MOVE_CASE, "action_type": content_type.pk, "target_type": content_type.pk},
         )
+
+
+class AuditUpdatedCaseStatusListView(viewsets.ReadOnlyModelViewSet):
+    """Expose 'updated status' audit events to data workspace."""
+
+    authentication_classes = (DataWorkspaceOnlyAuthentication,)
+    serializer_class = AuditUpdatedCaseStatusSerializer
+    pagination_class = LimitOffsetPagination
+
+    def get_queryset(self):
+        return Audit.objects.filter(verb=AuditType.UPDATED_STATUS).order_by("created_at")

api/data_workspace/serializers.py

@@ -56,3 +56,26 @@ def get_queue(self, instance):
         if queue:
             return queue.pk
         return None
+
+
+class AuditUpdatedCaseStatusSerializer(serializers.ModelSerializer):
+
+    user = serializers.SerializerMethodField()
+    case = serializers.SerializerMethodField()
+    status = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Audit
+        fields = ("created_at", "user", "case", "status")
+
+    def get_user(self, instance):
+        if instance.actor:
+            return instance.actor.pk
+        return None
+
+    def get_case(self, instance):
+        return instance.target_object_id or None
+
+    def get_status(self, instance):
+        status = instance.payload["status"]["new"]
+        return status

api/data_workspace/tests/test_audit_views.py

@@ -55,3 +55,36 @@ def test_payload_multiple_queues(self):
         # The record with multiple queues should have been split into separate entries.
         self.assertEqual(results[1]["queue"], str(queue1.pk))
         self.assertEqual(results[2]["queue"], str(queue2.pk))
+
+
+class DataWorkspaceUpdatedCaseStatusTests(DataTestClient):
+    def setUp(self):
+        super().setUp()
+        self.url = reverse("data_workspace:dw-audit-updated-status-list")
+        case = self.create_standard_application_case(self.organisation, "Test Application")
+        # Audit events are only created for non-draft cases
+        case.status = get_case_status_by_status(CaseStatusEnum.OPEN)
+        # This will generate an updated status audit entry.
+        case.save()
+        self.create_audit = partial(
+            super().create_audit, verb=AuditType.UPDATED_STATUS, actor=self.gov_user, target=case.get_case()
+        )
+
+        self.create_audit(verb=AuditType.CREATED_USER_ADVICE)
+
+    def test_audit_updated_status(self):
+        expected_fields = ("created_at", "user", "case", "status")
+
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        results = response.json()["results"]
+        self.assertEqual(len(results), 1)
+        self.assertEqual(tuple(results[0].keys()), expected_fields)
+        self.assertEqual(results[0]["status"], "Submitted")
+
+        response = self.client.options(self.url)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        options = response.json()["actions"]["GET"]
+        self.assertEqual(tuple(options.keys()), expected_fields)

api/data_workspace/tests/test_serializers.py

@@ -1,6 +1,11 @@
 from api.audit_trail.models import AuditType
 from api.audit_trail.tests.factories import AuditFactory
-from api.data_workspace.serializers import AuditMoveCaseSerializer, CaseAssignmentSerializer, EcjuQuerySerializer
+from api.data_workspace.serializers import (
+    AuditMoveCaseSerializer,
+    CaseAssignmentSerializer,
+    EcjuQuerySerializer,
+    AuditUpdatedCaseStatusSerializer,
+)
 from api.cases.tests.factories import EcjuQueryFactory, CaseAssignmentFactory
 
 
@@ -25,3 +30,12 @@ def test_AuditMoveCaseSerializer(db):
     serialized = AuditMoveCaseSerializer(audit)
     expected_fields = {"created_at", "user", "case", "queue"}
     assert set(serialized.data.keys()) == expected_fields
+
+
+def test_AuditUpdatedCaseStatusSerializer(db):
+    audit = AuditFactory(
+        verb=AuditType.UPDATED_STATUS, payload={"status": {"new": "finalised", "old": "under_final_review"}}
+    )
+    serialized = AuditUpdatedCaseStatusSerializer(audit)
+    expected_fields = {"created_at", "user", "case", "status"}
+    assert set(serialized.data.keys()) == expected_fields

api/data_workspace/urls.py

@@ -70,5 +70,8 @@
 router_v1.register("users-gov-users", users_views.GovUserListView, basename="dw-users-gov-users")
 router_v1.register("audit-move-case", audit_views.AuditMoveCaseListView, basename="dw-audit-move-case")
 router_v1.register("advice", advice_views.AdviceListView, basename="dw-advice")
+router_v1.register(
+    "audit-updated-status", audit_views.AuditUpdatedCaseStatusListView, basename="dw-audit-updated-status"
+)
 
 urlpatterns = [path("v0/", include(router_v0.urls)), path("v1/", include(router_v1.urls))]