Refine the ORT output naming and rendering

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

Author: tdruez

scanpipe/api/views.py

@@ -168,8 +168,8 @@ def results_download(self, request, *args, **kwargs):
             output_file = output.to_cyclonedx(project, **output_kwargs)
         elif format == "attribution":
             output_file = output.to_attribution(project)
-        elif format == "ort":
-            output_file = output.to_ort(project)
+        elif format == "ort-package-list":
+            output_file = output.to_ort_package_list_yml(project)
         else:
             message = {"status": f"Format {format} not supported."}
             return Response(message, status=status.HTTP_400_BAD_REQUEST)

scanpipe/management/commands/output.py

@@ -25,7 +25,15 @@
 from scanpipe.management.commands import ProjectCommand
 from scanpipe.pipes import output
 
-SUPPORTED_FORMATS = ["json", "csv", "xlsx", "attribution", "spdx", "cyclonedx", "ort"]
+SUPPORTED_FORMATS = [
+    "json",
+    "csv",
+    "xlsx",
+    "attribution",
+    "spdx",
+    "cyclonedx",
+    "ort-package-list",
+]
 
 
 class Command(ProjectCommand):
@@ -84,7 +92,7 @@ def handle_output(self, output_format):
             "spdx": output.to_spdx,
             "cyclonedx": output.to_cyclonedx,
             "attribution": output.to_attribution,
-            "ort": output.to_ort,
+            "ort-package-list": output.to_ort_package_list_yml,
         }.get(output_format)
 
         if not output_function:

scanpipe/pipes/ort.py

@@ -72,7 +72,7 @@ def to_yaml(self) -> str:
         return yaml.safe_dump(asdict(self), sort_keys=False, allow_unicode=True)
 
 
-def to_ort(project):
+def to_ort_package_list_yml(project):
     dependencies = []
     for package in project.discoveredpackages.all():
         dependency = Dependency(

scanpipe/pipes/output.py

@@ -1059,14 +1059,14 @@ def to_attribution(project):
     return output_file
 
 
-def to_ort(project):
+def to_ort_package_list_yml(project):
     """
-    Generate a ORT compatible "package-list.yml" output.
+    Generate an ORT compatible "package-list.yml" output.
     The output file is created in the ``project`` "output/" directory.
     Return the path of the generated output file.
     """
     output_file = project.get_output_file_path("results", "package-list.yml")
-    ort_yml = ort.to_ort(project)
+    ort_yml = ort.to_ort_package_list_yml(project)
     output_file.write_text(ort_yml)
     return output_file
 
@@ -1077,5 +1077,5 @@ def to_ort(project):
     "spdx": to_spdx,
     "cyclonedx": to_cyclonedx,
     "attribution": to_attribution,
-    "ort": to_ort,
+    "ort-package-list": to_ort_package_list_yml,
 }

scanpipe/templates/scanpipe/dropdowns/project_download_dropdown.html

@@ -31,7 +31,7 @@
       <a href="{% url 'project_results' project.slug 'attribution' %}" class="dropdown-item">
         <strong>Attribution</strong>
       </a>
-      <a href="{% url 'project_results' project.slug 'ort' %}" class="dropdown-item">
+      <a href="{% url 'project_results' project.slug 'ort-package-list' %}" class="dropdown-item">
         <strong>ORT (package-list)</strong>
       </a>
     </div>

scanpipe/templates/scanpipe/includes/project_downloads.html

@@ -12,11 +12,14 @@
     </a>
     <div class="dropdown is-hoverable">
       <div class="dropdown-trigger">
-        <button class="button tag is-success is-medium" aria-haspopup="true" aria-controls="dropdown-menu-cyclonedx">
+        <button class="button tag is-success is-medium has-text-weight-normal" aria-haspopup="true" aria-controls="dropdown-menu-cyclonedx">
           <span class="icon">
             <i class="fa-solid fa-download" aria-hidden="true"></i>
           </span>
           <span>CycloneDX</span>
+          <span class="icon is-small">
+            <i class="fa-solid fa-angle-down" aria-hidden="true"></i>
+          </span>
         </button>
       </div>
       <div class="dropdown-menu" id="dropdown-menu-cyclonedx" role="menu">
@@ -36,8 +39,25 @@
     <a class="tag is-success is-medium" href="{% url 'project_results' project.slug 'attribution' %}">
       <span class="icon mr-1"><i class="fa-solid fa-download"></i></span>Attribution
     </a>
-    <a class="tag is-success is-medium" href="{% url 'project_results' project.slug 'ort' %}">
-      <span class="icon mr-1"><i class="fa-solid fa-download"></i></span>ORT
-    </a>
+    <div class="dropdown is-hoverable">
+      <div class="dropdown-trigger">
+        <button class="button tag is-success is-medium has-text-weight-normal" aria-haspopup="true" aria-controls="dropdown-menu-ort">
+          <span class="icon">
+            <i class="fa-solid fa-download" aria-hidden="true"></i>
+          </span>
+          <span>Tools formats</span>
+          <span class="icon is-small">
+            <i class="fa-solid fa-angle-down" aria-hidden="true"></i>
+          </span>
+        </button>
+      </div>
+      <div class="dropdown-menu" id="dropdown-menu-ort" role="menu">
+        <div class="dropdown-content">
+          <a href="{% url 'project_results' project.slug 'cyclonedx' '1.6' %}" class="dropdown-item has-text-weight-semibold">
+            ORT package-list.yml
+          </a>
+        </div>
+      </div>
+    </div>
   </div>
 </article>

scanpipe/views.py

@@ -1630,8 +1630,8 @@ def get(self, request, *args, **kwargs):
             output_file = output.to_cyclonedx(project, **output_kwargs)
         elif format == "attribution":
             output_file = output.to_attribution(project)
-        elif format == "ort":
-            output_file = output.to_ort(project)
+        elif format == "ort-package-list":
+            output_file = output.to_ort_package_list_yml(project)
         else:
             raise Http404("Format not supported.")