Include project errors in XLSX results output #364

Signed-off-by: Thomas Druez <[email protected]>

CHANGELOG.rst

@@ -4,6 +4,9 @@ Changelog
 Unreleased
 ----------
 
+- Include project errors in XLSX results output.
+  https://github.com/nexB/scancode.io/issues/364
+
 - Refactor the update_or_create_package pipe to support the ProjectError system
   and fix a database transaction error.
   https://github.com/nexB/scancode.io/issues/381

scanpipe/api/serializers.py

@@ -230,7 +230,7 @@ class ProjectErrorSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = ProjectError
-        fields = ["uuid", "model", "details", "message", "traceback", "created_date"]
+        fields = ["uuid", "model", "message", "details", "traceback", "created_date"]
 
     def get_traceback(self, project_error):
         return project_error.traceback.split("\n")
@@ -261,8 +261,9 @@ def get_model_serializer(model_class):
     Returns a Serializer class that ia related to a given `model_class`.
     """
     serializer = {
-        DiscoveredPackage: DiscoveredPackageSerializer,
         CodebaseResource: CodebaseResourceSerializer,
+        DiscoveredPackage: DiscoveredPackageSerializer,
+        ProjectError: ProjectErrorSerializer,
     }.get(model_class, None)
 
     if not serializer:

scanpipe/pipes/output.py

@@ -368,6 +368,7 @@ def to_xlsx(project):
     querysets = [
         project.discoveredpackages.all(),
         project.codebaseresources.without_symlinks(),
+        project.projecterrors.all(),
     ]
 
     with xlsxwriter.Workbook(output_file) as workbook:

scanpipe/tests/test_pipes.py

@@ -40,6 +40,7 @@
 from scanpipe.models import CodebaseResource
 from scanpipe.models import DiscoveredPackage
 from scanpipe.models import Project
+from scanpipe.models import ProjectError
 from scanpipe.pipes import codebase
 from scanpipe.pipes import fetch
 from scanpipe.pipes import filename_now
@@ -221,6 +222,9 @@ def test_scanpipe_pipes_outputs_to_xlsx(self):
             path="filename.ext",
         )
         codebase_resource.create_and_add_package(package_data1)
+        ProjectError.objects.create(
+            project=project1, model="Model", details={}, message="Error"
+        )
 
         output_file = output.to_xlsx(project=project1)
         self.assertEqual([output_file.name], project1.output_root)