Add status url in live evaluation API response #1953

Signed-off-by: Michael Ehab Mikhail <michael.ehab@hotmail.com>

Author: michaelehab

vulnerabilities/api_v2.py

@@ -8,10 +8,8 @@
 #
 
 
-from concurrent.futures import ThreadPoolExecutor
-from concurrent.futures import as_completed
-
 from django.db.models import Prefetch
+from django.urls import reverse
 from django_filters import rest_framework as filters
 from drf_spectacular.utils import OpenApiParameter
 from drf_spectacular.utils import extend_schema
@@ -1371,8 +1369,24 @@ def evaluate(self, request):
                     "run_id": str(run_id) if run_id else None,
                 }
             )
+
+        request_obj = request
+        status_path = reverse(
+            "live-evaluation-status", kwargs={"live_run_id": str(live_run.run_id)}
+        )
+
+        if hasattr(request_obj, "build_absolute_uri"):
+            status_url = request_obj.build_absolute_uri(status_path)
+        else:
+            status_url = status_path
+
         return Response(
-            {"live_run_id": str(live_run.run_id), "runs": runs}, status=status.HTTP_202_ACCEPTED
+            {
+                "live_run_id": str(live_run.run_id),
+                "runs": runs,
+                "status_url": status_url,
+            },
+            status=status.HTTP_202_ACCEPTED,
         )
 
     @extend_schema(
@@ -1390,7 +1404,6 @@ def evaluate(self, request):
     @action(detail=False, methods=["get"], url_path=r"status/(?P<live_run_id>[0-9a-f\-]{36})")
     def status(self, request, live_run_id=None):
         from vulnerabilities.models import LivePipelineRun
-        from vulnerabilities.models import PipelineRun
 
         try:
             live_run = LivePipelineRun.objects.get(run_id=live_run_id)

vulnerabilities/tests/test_api_v2.py

@@ -915,15 +915,17 @@ def setUp(self):
     @patch("vulnerabilities.api_v2.enqueue_ad_hoc_pipeline")
     @patch("vulnerabilities.models.PipelineRun.objects.get")
     @patch("vulnerabilities.models.LivePipelineRun.objects.create")
+    @patch("django.urls.reverse")
     def test_evaluate_success(
-        self, mock_live_create, mock_pipeline_get, mock_enqueue, mock_registry
+        self, mock_reverse, mock_live_create, mock_pipeline_get, mock_enqueue, mock_registry
     ):
         class MockImporter:
             pipeline_id = "pypa_live_importer_v2"
             supported_types = ["pypi"]
 
         mock_registry.values.return_value = [MockImporter]
-        mock_live_run = type("MockLiveRun", (), {"run_id": "mock-live-id"})()
+        valid_uuid = "00000000-0000-0000-0000-000000000001"
+        mock_live_run = type("MockLiveRun", (), {"run_id": valid_uuid})()
         mock_live_create.return_value = mock_live_run
         mock_enqueue.return_value = "mock-run-id"
         mock_pipeline_run = type(
@@ -932,6 +934,7 @@ class MockImporter:
             {"run_id": "mock-run-id", "live_pipeline": None, "save": lambda self: None},
         )()
         mock_pipeline_get.return_value = mock_pipeline_run
+        mock_reverse.return_value = f"/api/v2/live-evaluation/status/{valid_uuid}"
 
         data = {"purl": "pkg:pypi/django@3.2"}
         response = self.client.post(self.url, data, format="json")
@@ -940,6 +943,8 @@ class MockImporter:
         assert response.data["live_run_id"] is not None
         assert response.data["runs"][0]["importer"] == "pypa_live_importer_v2"
         assert response.data["runs"][0]["run_id"] is not None
+        assert "status_url" in response.data
+        assert response.data["status_url"].endswith(f"/api/v2/live-evaluation/status/{valid_uuid}")
 
     @patch("vulnerabilities.api_v2.LIVE_IMPORTERS_REGISTRY")
     def test_evaluate_no_importer_found(self, mock_registry):