Add ability to download all existing outputs for a project #1880

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

Author: tdruez

scanpipe/pipes/output.py

@@ -1153,18 +1153,6 @@ def make_zip_from_files(files):
     return zip_buffer
 
 
-# def to_all_formats(project):
-#     """Generate all output formats for a project and return a zipfile."""
-#     files = []
-#     for output_function in FORMAT_TO_FUNCTION_MAPPING.values():
-#         output_file = output_function(project)
-#         filename = safe_filename(f"{project.name}_{output_file.name}")
-#         files.append((filename, output_file))
-#     zip_buffer = make_zip_from_files(files)
-#     zip_buffer.name = "scancodeio_output_files.zip"
-#     return zip_buffer
-
-
 def to_all_formats(project):
     """Generate all output formats for a project and return a Django File-like zip."""
     files = []
@@ -1180,3 +1168,15 @@ def to_all_formats(project):
     zip_file.name = safe_filename(f"{project.name}_outputs.zip")
 
     return zip_file
+
+
+def to_all_outputs(project):
+    """Return a Django File-like zip containing all existing project's output/ files."""
+    files = [(path.name, path) for path in project.output_path.glob("*")]
+    zip_buffer = make_zip_from_files(files)
+
+    # Wrap it into a Django File-like object
+    zip_file = ContentFile(zip_buffer.getvalue())
+    zip_file.name = safe_filename(f"{project.name}_outputs.zip")
+
+    return zip_file

scanpipe/templates/scanpipe/dropdowns/project_download_dropdown.html

@@ -41,7 +41,7 @@
         <strong>ORT (package-list)</strong>
       </a>
       <hr class="dropdown-divider" />
-      <a href="{% url 'project_results' project.slug 'all' %}" class="dropdown-item">
+      <a href="{% url 'project_results' project.slug 'all_formats' %}" class="dropdown-item">
         <strong>All formats</strong>
       </a>
     </div>

scanpipe/templates/scanpipe/includes/project_downloads.html

@@ -72,7 +72,7 @@
       </div>
     </div>
     <span class="p-1">|</span>
-    <a class="tag is-success is-medium" href="{% url 'project_results' project.slug 'all' %}">
+    <a class="tag is-success is-medium" href="{% url 'project_results' project.slug 'all_formats' %}">
       All formats
     </a>
   </div>

scanpipe/templates/scanpipe/panels/project_outputs.html

@@ -18,4 +18,10 @@
       </div>
     </div>
   {% endfor %}
+  <div class="panel-block">
+    <a class="button is-link is-outlined is-fullwidth" href="{% url 'project_results' project.slug 'all_outputs' %}">
+      <span class="icon mr-1"><i class="fa-solid fa-download"></i></span>
+      Download all outputs
+    </a>
+  </div>
 </article>

scanpipe/tests/pipes/test_output.py

@@ -644,13 +644,28 @@ def test_scanpipe_pipes_outputs_to_all_formats(self):
 
         self.assertEqual("asgiref_outputs.zip", output_file.name)
 
-        output_file.seek(0)  # Important for reading from start
         with zipfile.ZipFile(output_file, "r") as zip_ref:
             zip_contents = zip_ref.namelist()
             file_count = len(zip_contents)
 
         expected_file_count = len(output.FORMAT_TO_FUNCTION_MAPPING)
-        self.assertEqual(file_count, expected_file_count)
+        self.assertEqual(expected_file_count, file_count)
+
+    def test_scanpipe_pipes_outputs_to_all_outputs(self):
+        fixtures = self.data / "asgiref" / "asgiref-3.3.0_fixtures.json"
+        call_command("loaddata", fixtures, **{"verbosity": 0})
+        project = Project.objects.get(name="asgiref")
+
+        with self.assertNumQueries(0):
+            output_file = output.to_all_outputs(project=project)
+
+        self.assertEqual("asgiref_outputs.zip", output_file.name)
+
+        with zipfile.ZipFile(output_file, "r") as zip_ref:
+            zip_contents = zip_ref.namelist()
+            file_count = len(zip_contents)
+
+        self.assertEqual(len(project.output_root), file_count)
 
     def test_scanpipe_pipes_outputs_make_unknown_license_object(self):
         licensing = get_licensing()

scanpipe/views.py

@@ -1630,8 +1630,10 @@ def get(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":
+        elif format == "all_formats":
             output_file = output.to_all_formats(project)
+        elif format == "all_outputs":
+            output_file = output.to_all_outputs(project)
         else:
             raise Http404("Format not supported.")