Add support for all_formats/all_outputs in REST API #1880

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

Author: tdruez

docs/command-line-interface.rst

@@ -419,10 +419,11 @@ Displays status information about the ``PROJECT`` project.
 
 .. _cli_output:
 
-`$ scanpipe output --project PROJECT --format {json,csv,xlsx,spdx,cyclonedx,attribution}`
------------------------------------------------------------------------------------------
+`$ scanpipe output --project PROJECT --format {json,csv,xlsx,spdx,cyclonedx,attribution,ort-package-list}`
+----------------------------------------------------------------------------------------------------------
 
-Outputs the ``PROJECT`` results as JSON, XLSX, CSV, SPDX, CycloneDX, and Attribution.
+Outputs the ``PROJECT`` results as JSON, XLSX, CSV, SPDX, CycloneDX,
+ORT package-list.yml, and Attribution.
 The output files are created in the ``PROJECT`` :guilabel:`output/` directory.
 
 Multiple formats can be provided at once::

docs/output-files.rst

@@ -285,7 +285,6 @@ Additional sheets are included **only when relevant** (i.e., when data is availa
 
 SPDX
 ^^^^
-
 ScanCode.io can generate Software Bill of Materials (SBOM) in the **SPDX** format,
 which is an open standard for communicating software component information.
 SPDX is widely used for license compliance, security analysis, and software supply
@@ -309,7 +308,6 @@ The SPDX output includes:
 
 CycloneDX
 ^^^^^^^^^
-
 ScanCode.io can generate **CycloneDX** SBOMs, a lightweight standard designed for
 security and dependency management. CycloneDX is optimized for vulnerability analysis
 and software supply chain risk assessment.

docs/rest-api.rst

@@ -694,10 +694,16 @@ Finally, use this action to download the project results in the provided
 ``output_format`` as an attachment file.
 
 Data:
-    - ``output_format``: ``json``, ``xlsx``, ``spdx``, ``cyclonedx``, ``attribution``
+    - ``output_format``: ``json``, ``xlsx``, ``spdx``, ``cyclonedx``, ``attribution``,
+      ``all_formats``, ``all_outputs``
 
 ``GET /api/projects/d4ed9405-5568-45ad-99f6-782a9b82d1d2/results_download/?output_format=cyclonedx``
 
+.. note::
+   Use ``all_formats`` to generate a zip file containing all output formats for a
+   project, while ``all_outputs`` can be used to obtain a zip file of all existing
+   output files for that project.
+
 .. tip::
   Refer to :ref:`output_files` to learn more about the available output formats.
 

scanpipe/api/views.py

@@ -171,6 +171,10 @@ def results_download(self, request, *args, **kwargs):
             output_file = output.to_attribution(project)
         elif format == "ort-package-list":
             output_file = output.to_ort_package_list_yml(project)
+        elif format == "all_formats":
+            output_file = output.to_all_formats(project)
+        elif format == "all_outputs":
+            output_file = output.to_all_outputs(project)
         else:
             message = {"status": f"Format {format} not supported."}
             return Response(message, status=status.HTTP_400_BAD_REQUEST)

scanpipe/tests/test_api.py

@@ -669,6 +669,16 @@ def test_scanpipe_api_project_action_results_download_output_formats(self):
         # to prevent a "ResourceWarning: unclosed file"
         self.assertTrue(response.getvalue().startswith(b"PK"))
 
+        data = {"output_format": "all_formats"}
+        response = self.csrf_client.get(url, data=data)
+        expected = ["application/zip"]
+        self.assertIn(response["Content-Type"], expected)
+
+        data = {"output_format": "all_outputs"}
+        response = self.csrf_client.get(url, data=data)
+        expected = ["application/zip"]
+        self.assertIn(response["Content-Type"], expected)
+
     def test_scanpipe_api_project_action_pipelines(self):
         url = reverse("project-pipelines")
         response = self.csrf_client.get(url)