Simplify the Project.add_message method for object_instance (#1363)

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

Author: tdruez

scanpipe/models.py

@@ -1231,8 +1231,7 @@ def add_message(
         model="",
         details=None,
         exception=None,
-        resource=None,
-        package=None,
+        object_instance=None,
     ):
         """
         Create a ProjectMessage record for this Project.
@@ -1255,13 +1254,16 @@ def add_message(
 
         details = details or {}
 
-        # Do not change the following field names as those have special behavior in
-        # templates.
-        if resource:
-            details["resource_path"] = resource.path
-        if package:
+        # The following field names have a special behavior in templates.
+        if isinstance(object_instance, CodebaseResource):
+            details["resource_path"] = object_instance.path
+
+        elif isinstance(object_instance, DiscoveredPackage):
             details.update(
-                {"package_url": package.package_url, "package_uuid": package.uuid}
+                {
+                    "package_url": object_instance.package_url,
+                    "package_uuid": object_instance.uuid,
+                }
             )
 
         return ProjectMessage.objects.create(
@@ -1279,13 +1281,17 @@ def add_info(
         model="",
         details=None,
         exception=None,
-        resource=None,
-        package=None,
+        object_instance=None,
     ):
         """Create an INFO ProjectMessage record for this project."""
         severity = ProjectMessage.Severity.INFO
         return self.add_message(
-            severity, description, model, details, exception, resource, package
+            severity,
+            description,
+            model,
+            details,
+            exception,
+            object_instance,
         )
 
     def add_warning(
@@ -1294,13 +1300,17 @@ def add_warning(
         model="",
         details=None,
         exception=None,
-        resource=None,
-        package=None,
+        object_instance=None,
     ):
         """Create a WARNING ProjectMessage record for this project."""
         severity = ProjectMessage.Severity.WARNING
         return self.add_message(
-            severity, description, model, details, exception, resource, package
+            severity,
+            description,
+            model,
+            details,
+            exception,
+            object_instance,
         )
 
     def add_error(
@@ -1309,13 +1319,17 @@ def add_error(
         model="",
         details=None,
         exception=None,
-        resource=None,
-        package=None,
+        object_instance=None,
     ):
         """Create an ERROR ProjectMessage record using for this project."""
         severity = ProjectMessage.Severity.ERROR
         return self.add_message(
-            severity, description, model, details, exception, resource, package
+            severity,
+            description,
+            model,
+            details,
+            exception,
+            object_instance,
         )
 
     def get_absolute_url(self):
@@ -1608,7 +1622,7 @@ def add_error(self, exception):
             model=self.__class__,
             details=model_to_dict(self),
             exception=exception,
-            resource=resource,
+            object_instance=resource,
         )
 
     def add_errors(self, exceptions):
@@ -2831,7 +2845,7 @@ def create_and_add_package(self, package_data):
                 model=DiscoveredPackage,
                 details=package_data,
                 exception=exception,
-                resource=self,
+                object_instance=self,
             )
         else:
             self.add_package(package)

scanpipe/pipelines/__init__.py

@@ -204,7 +204,7 @@ def add_error(self, exception, resource=None):
         self.project.add_error(
             model=self.pipeline_name,
             exception=exception,
-            resource=resource,
+            object_instance=resource,
         )
 
     @contextmanager

scanpipe/pipes/d2d.py

@@ -834,7 +834,7 @@ def create_indexes(cls, project, from_about_files, logger=None):
                     description="Cannot create package from ABOUT file",
                     model="map_about_files",
                     details=error_message_details,
-                    resource=about_file_resource,
+                    object_instance=about_file_resource,
                 )
                 continue
 
@@ -846,7 +846,7 @@ def create_indexes(cls, project, from_about_files, logger=None):
                     description="ABOUT file does not have about_resource",
                     model="map_about_files",
                     details=error_message_details,
-                    resource=about_file_resource,
+                    object_instance=about_file_resource,
                 )
                 continue
             else:

scanpipe/pipes/purldb.py

@@ -491,7 +491,7 @@ def enrich_package(package):
     try:
         purldb_entries = collect_data_for_purl(package_url, raise_on_error=True)
     except PurlDBException as exception:
-        project.add_error(model="PurlDB", exception=exception, package=package)
+        project.add_error(model="PurlDB", exception=exception, object_instance=package)
         return
 
     if not purldb_entries:
@@ -507,7 +507,7 @@ def enrich_package(package):
                 f'Multiple entries found in the PurlDB for "{package_url}". '
                 f"Using data from the most recent version."
             ),
-            package=package,
+            object_instance=package,
         )
         # Do not set version-specific fields, such as the download_url.
         purldb_entry = {

scanpipe/pipes/resolve.py

@@ -81,7 +81,7 @@ def get_packages(project, package_registry, manifest_resources, model=None):
             project.add_error(
                 description="No packages could be resolved",
                 model=model,
-                resource=resource,
+                object_instance=resource,
             )
 
     if sboms_headers:

scanpipe/pipes/scancode.py

@@ -428,7 +428,7 @@ def add_resource_to_package(package_uid, resource, project):
     except ObjectDoesNotExist as error:
         details = {"package_uid": str(package_uid)}
         project.add_error(
-            error, model="assemble_package", details=details, resource=resource
+            error, model="assemble_package", details=details, object_instance=resource
         )
         return