Add a "Refresh Scan" button action in Scan list and Scan tab

Signed-off-by: tdruez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -3,6 +3,9 @@ Release notes
 
 ### Version 5.5.0-dev
 
+- Add UI to refresh a package scan.
+  https://github.com/aboutcode-org/dejacode/issues/423
+
 - Update ProductPackage "unknown" license during "Scan all Packages".
   Only "unknown" licenses are updated.
   Products with a is_locked configuration status are excluded.

component_catalog/templates/component_catalog/includes/scan_actions_list.html

@@ -20,4 +20,11 @@
       </a>
     </li>
   {% endif %}
+  {% if scan.refresh_url %}
+    <li class="list-inline-item"{% if not show_btn_label %} data-bs-toggle="tooltip"{% endif %} data-bs-title="Refresh Scan">
+      <a class="btn btn-outline-dark btn-sm" href="{{ scan.refresh_url }}">
+        <i class="fa-solid fa-rotate-right"></i>{% if show_btn_label %} Refresh Scan{% endif %}
+      </a>
+    </li>
+  {% endif %}
 </ul>

component_catalog/templates/component_catalog/includes/scan_progress.html

@@ -1,5 +1,7 @@
 <strong class="ms-1">{{ scan.runs.0.status|title }}</strong>
 {% include 'component_catalog/includes/scan_status.html' with status=scan.runs.0.status only %}
 <div class="text-center mt-2">
-  {% include 'component_catalog/includes/scan_actions_list.html' with scan=scan only %}
+  {% if scan.runs.0.status != "running" %}
+    {% include 'component_catalog/includes/scan_actions_list.html' with scan=scan only %}
+  {% endif %}
 </div>

component_catalog/urls.py

@@ -26,6 +26,7 @@
 from component_catalog.views import get_scan_progress_htmx_view
 from component_catalog.views import package_create_ajax_view
 from component_catalog.views import package_scan_view
+from component_catalog.views import refresh_scan_view
 from component_catalog.views import send_scan_data_as_file_view
 from dje.views import DataspacedDeleteView
 from dje.views import ExportCycloneDXBOMView
@@ -147,6 +148,11 @@
         delete_scan_view,
         name="scan_delete",
     ),
+    path(
+        "scans/<uuid:project_uuid>/refresh/",
+        refresh_scan_view,
+        name="scan_refresh",
+    ),
     path(
         "scans/",
         ScanListView.as_view(),

component_catalog/views.py

@@ -1670,6 +1670,25 @@ def delete_scan_view(request, project_uuid):
     return redirect("component_catalog:scan_list")
 
 
+@login_required
+def refresh_scan_view(request, project_uuid):
+    user = request.user
+    dataspace = user.dataspace
+    if not dataspace.enable_package_scanning:
+        raise Http404
+
+    scancodeio = ScanCodeIO(dataspace)
+    response = scancodeio.refresh_scan(str(project_uuid))
+
+    if response.status_code != 200:
+        raise Http404("Scan could not be refreshed.")
+
+    messages.success(request, "Refresh Scan started.")
+    if referer := request.META.get("HTTP_REFERER"):
+        return redirect(referer)
+    return redirect("component_catalog:scan_list")
+
+
 class ScanListView(
     LoginRequiredMixin,
     AddPackagePermissionMixin,
@@ -1719,13 +1738,15 @@ def get_context_data(self, **kwargs):
 
         scans = []
         for scan in context_data["object_list"]:
+            scan_uuid = scan.get("uuid")
             package_download_url = get_package_download_url(scan)
             package = packages_by_url.get(package_download_url)
             scan["package"] = package
+            scan["created_date"] = parse_datetime(scan.get("created_date"))
             scan["view_url"] = f"{package.details_url}#scan" if package else None
             scan["download_result_url"] = get_scan_results_as_file_url(scan)
-            scan["created_date"] = parse_datetime(scan.get("created_date"))
-            scan["delete_url"] = reverse("component_catalog:scan_delete", args=[scan.get("uuid")])
+            scan["delete_url"] = reverse("component_catalog:scan_delete", args=[scan_uuid])
+            scan["refresh_url"] = reverse("component_catalog:scan_refresh", args=[scan_uuid])
             scans.append(scan)
 
         context_data.update(
@@ -2360,6 +2381,7 @@ def scan_status_fields(self, scan):
         scan_status_fields = []
         scan_run = scan.get("runs", [{}])[-1]
         status = scan_run.get("status")
+        scan_uuid = scan.get("uuid")
         issue_statuses = ["failure", "stale", "stopped"]
         completed_statuses = ["success", *issue_statuses]
 
@@ -2404,17 +2426,20 @@ def scan_status_fields(self, scan):
             filename = package.filename or package.package_url_filename
             download_result_url = reverse(
                 "component_catalog:scan_data_as_file",
-                args=[scan.get("uuid"), quote_plus(filename)],
+                args=[scan_uuid, quote_plus(filename)],
             )
 
         delete_url = None
+        refresh_url = None
         if status in completed_statuses:
-            delete_url = reverse("component_catalog:scan_delete", args=[scan.get("uuid")])
+            delete_url = reverse("component_catalog:scan_delete", args=[scan_uuid])
+            refresh_url = reverse("component_catalog:scan_refresh", args=[scan_uuid])
 
         field_context = {
             "scan": {
                 "download_result_url": download_result_url,
                 "delete_url": delete_url,
+                "refresh_url": refresh_url,
             }
         }
         scan_status_fields.append(

dejacode_toolkit/scancodeio.py

@@ -160,6 +160,16 @@ def delete_scan(self, detail_url):
             logger.debug(f"{self.label} [Exception] {exception}")
         return False
 
+    def refresh_scan(self, project_uuid):
+        reset_url = self.get_scan_action_url(project_uuid, "reset")
+        logger.debug(f"{self.label}: refresh scan reset_url={reset_url}")
+        data = {
+            "keep_input": True,
+            "restore_pipelines": True,
+            "execute_now": True,
+        }
+        return self.session.post(url=reset_url, json=data, timeout=self.default_timeout)
+
     @staticmethod
     def get_status_from_scan_results(scan_results):
         status = ""