Refactor the Scan status system for dynamic UI

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

Author: tdruez

component_catalog/templates/component_catalog/includes/scan_actions_list.html

@@ -5,26 +5,34 @@
         <i class="far fa-file-alt"></i>{% if show_btn_label %} View Scan results{% endif %}
       </a>
     </li>
+  {% else %}
+    <li class="list-inline-item" style="width:36px;"></li>
   {% endif %}
   {% if scan.download_result_url %}
     <li class="list-inline-item"{% if not show_btn_label %} data-bs-toggle="tooltip"{% endif %} data-bs-title="Download Scan results">
       <a class="btn btn-outline-dark btn-sm" href="{{ scan.download_result_url }}" target="_blank">
         <i class="fas fa-download"></i>{% if show_btn_label %} Download Scan results{% endif %}
       </a>
     </li>
+  {% else %}
+    <li class="list-inline-item" style="width:36px;"></li>
   {% endif %}
   {% if scan.delete_url %}
     <li class="list-inline-item"{% if not show_btn_label %} data-bs-toggle="tooltip"{% endif %} data-bs-title="Delete Scan">
       <a class="btn btn-outline-danger btn-sm scan_delete_link" href="#scan-delete-modal" role="button" data-delete-url="{{ scan.delete_url }}" data-bs-toggle="modal">
         <i class="far fa-trash-alt"></i>{% if show_btn_label %} Delete Scan{% endif %}
       </a>
     </li>
+  {% else %}
+    <li class="list-inline-item" style="width:36px;"></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 scan_refresh_link" href="#scan-refresh-modal" role="button" data-refresh-url="{{ scan.refresh_url }}" data-bs-toggle="modal">
         <i class="fa-solid fa-rotate-right"></i>{% if show_btn_label %} Refresh Scan{% endif %}
       </a>
     </li>
+  {% else %}
+    <li class="list-inline-item" style="width:36px;"></li>
   {% endif %}
 </ul>

component_catalog/templates/component_catalog/includes/scan_progress.html

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

component_catalog/templates/component_catalog/includes/scan_status.html

@@ -1,4 +1,4 @@
-<div class="progress" style="width: 100%; margin-bottom: 0; height: .5rem;">
+<div class="progress" style="width: 100%; min-width:190px ;margin-bottom: 0; height: .5rem;">
   {% if status == 'success' %}
     <div class="progress-bar {% if has_errors %}bg-warning{% else %}bg-success{% endif %}" title="{{ status|title }}" role="progressbar" style="width: 100%" aria-label="Scan progress" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100"></div>
   {% elif status == 'failure' or status == "stopped" or status == "stale" %}

component_catalog/views.py

@@ -73,6 +73,7 @@
 from dejacode_toolkit.download import DataCollectionException
 from dejacode_toolkit.purldb import PurlDB
 from dejacode_toolkit.scancodeio import ScanCodeIO
+from dejacode_toolkit.scancodeio import ScanStatus
 from dejacode_toolkit.scancodeio import get_package_download_url
 from dejacode_toolkit.scancodeio import get_scan_results_as_file_url
 from dje import tasks
@@ -1689,6 +1690,32 @@ def refresh_scan_view(request, project_uuid):
     return redirect("component_catalog:scan_list")
 
 
+def get_scan_context_data(scan, package=None):
+    scan_uuid = scan.get("uuid")
+
+    status = ""
+    if scan_run := scan.get("runs"):
+        status = scan_run[-1].get("status")
+
+    context_data = {
+        "status": status,
+        "status_for_display": status.replace("_", " ").capitalize(),
+        "created_date": parse_datetime(scan.get("created_date")),
+        "package": package,
+    }
+
+    scan_status = ScanStatus(status)
+    if package and scan_status.is_completed:
+        context_data["view_url"] = f"{package.details_url}#scan" if package else None
+    if scan_status.is_completed:
+        context_data["download_result_url"] = get_scan_results_as_file_url(scan)
+    if not scan_status.is_in_progress:
+        context_data["delete_url"] = reverse("component_catalog:scan_delete", args=[scan_uuid])
+        context_data["refresh_url"] = reverse("component_catalog:scan_refresh", args=[scan_uuid])
+
+    return context_data
+
+
 class ScanListView(
     LoginRequiredMixin,
     AddPackagePermissionMixin,
@@ -1738,23 +1765,12 @@ 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["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(
-            {
-                "scans": scans,
-            }
-        )
+            scan_context_data = get_scan_context_data(scan, package)
+            scans.append(scan_context_data)
 
+        context_data["scans"] = scans
         return context_data
 
 

dejacode_toolkit/scancodeio.py

@@ -449,6 +449,43 @@ def map_detected_package_data(cls, detected_package):
         return package_data_for_model
 
 
+class ScanStatus:
+    """List of ScanCode.io Run status."""
+
+    NOT_STARTED = "not_started"
+    QUEUED = "queued"
+    RUNNING = "running"
+    SUCCESS = "success"
+    FAILURE = "failure"
+    STOPPED = "stopped"
+    STALE = "stale"
+
+    # Status groupings
+    IN_PROGRESS = [QUEUED, RUNNING]
+    COMPLETED = [SUCCESS, FAILURE, STOPPED, STALE]
+    ISSUES = [FAILURE, STOPPED, STALE]
+    PENDING = [NOT_STARTED]
+
+    def __init__(self, status):
+        self.value = status
+
+    @property
+    def is_in_progress(self):
+        return self.value in self.IN_PROGRESS
+
+    @property
+    def is_completed(self):
+        return self.value in self.COMPLETED
+
+    @property
+    def has_issues(self):
+        return self.value in self.ISSUES
+
+    @property
+    def is_pending(self):
+        return self.value in self.PENDING
+
+
 def get_hash_uid(value):
     """Return a Unique ID based on a 10 characters hash of the provided `value`."""
     return md5(str(value).encode("utf-8"), usedforsecurity=False).hexdigest()[:10]