Minor formatting changes for consistency #447

Signed-off-by: Thomas Druez <tdruez@nexb.com>

Author: tdruez

scanpipe/models.py

@@ -1477,7 +1477,6 @@ class Compliance(models.TextChoices):
             "provided policies."
         ),
     )
-
     package_data = models.JSONField(
         default=list,
         blank=True,

scanpipe/pipes/scancode.py

@@ -320,28 +320,27 @@ def scan_for_application_packages(project):
     resource_qs = project.codebaseresources.no_status()
 
     # Collect detected Package data and save it to the CodebaseResource it was
-    # detected from
+    # detected from.
     _scan_and_save(
         resource_qs=resource_qs,
         scan_func=scan_for_package_data,
         save_func=save_scan_package_results,
     )
 
     # Iterate through CodebaseResources with Package data and handle them using
-    # the proper Package handler from packagedcode
+    # the proper Package handler from packagedcode.
     assemble_packages(project=project)
 
 
 def add_to_package(package_uid, resource, project):
     """
-    Relate a DiscoveredPackage to `resource` from `project` using `package_uid`
+    Relate a DiscoveredPackage to `resource` from `project` using `package_uid`.
     """
     if not package_uid:
         return
-    package_associated_with_resource = resource.discovered_packages.filter(
-        package_uid=package_uid
-    ).exists()
-    if not package_associated_with_resource:
+
+    resource_package = resource.discovered_packages.filter(package_uid=package_uid)
+    if not resource_package.exists():
         package = project.discoveredpackages.get(package_uid=package_uid)
         resource.discovered_packages.add(package)
 
@@ -351,22 +350,20 @@ def assemble_packages(project):
     Create instances of DiscoveredPackage and DiscoveredDependency for `project`
     from the parsed package data present in the CodebaseResources of `project`.
     """
-    logger.info(f"Project: {project}:\n" "Function: assemble_packages\n")
+    logger.info(f"Project {project} assemble_packages:")
     seen_resource_paths = set()
+
     for resource in project.codebaseresources.has_package_data():
         if resource.path in seen_resource_paths:
             continue
 
-        logger.info(f"Processing: CodebaseResource {resource.path}\n")
-
+        logger.info(f"  Processing: {resource.path}")
         for package_mapping in resource.package_data:
             pd = packagedcode_models.PackageData.from_dict(mapping=package_mapping)
-
-            logger.info(f"Processing: PackageData {pd.purl}\n")
+            logger.info(f"  Package data: {pd.purl}")
 
             handler = get_package_handler(pd)
-
-            logger.info(f"Selected: Package handler {handler}\n")
+            logger.info(f"  Selected package handler: {handler.__name__}")
 
             items = handler.assemble(
                 package_data=pd,
@@ -376,7 +373,7 @@ def assemble_packages(project):
             )
 
             for item in items:
-                logger.info(f"Processing: item {item}\n")
+                logger.info(f"    Processing item: {item}")
                 if isinstance(item, packagedcode_models.Package):
                     package_data = item.to_dict()
                     pipes.update_or_create_package(project, package_data)
@@ -387,7 +384,7 @@ def assemble_packages(project):
                 elif isinstance(item, CodebaseResource):
                     seen_resource_paths.add(item.path)
                 else:
-                    logger.info(f"Unknown Package assembly item type: {item!r}\n")
+                    logger.info(f"Unknown Package assembly item type: {item!r}")
 
 
 def run_scancode(location, output_file, options, raise_on_error=False):

scanpipe/tests/test_pipes.py

@@ -1225,14 +1225,21 @@ def test_scanpipe_pipes_make_codebase_resource(self):
 
     def test_scanpipe_add_to_package(self):
         project1 = Project.objects.create(name="Analysis")
-        codebase_resource = CodebaseResource.objects.create(
+        resource1 = CodebaseResource.objects.create(
             project=project1,
             path="filename.ext",
         )
         package1 = update_or_create_package(project1, package_data1)
-        self.assertFalse(codebase_resource.for_packages)
-        scancode.add_to_package(package1.package_uid, codebase_resource, project1)
-        for_packages = codebase_resource.for_packages
-        self.assertEqual(len(for_packages), 1)
-        result_purl = for_packages[0]
-        self.assertEqual(result_purl, package1.purl)
+        self.assertFalse(resource1.for_packages)
+
+        self.assertIsNone(scancode.add_to_package(None, resource1, project1))
+        self.assertFalse(resource1.for_packages)
+
+        scancode.add_to_package(package1.package_uid, resource1, project1)
+        self.assertEqual(len(resource1.for_packages), 1)
+        self.assertIn(package1.package_url, resource1.for_packages)
+
+        # Package will not be added twice since it is already associated with the
+        # resource.
+        scancode.add_to_package(package1.package_uid, resource1, project1)
+        self.assertEqual(len(resource1.for_packages), 1)