Improve exception support in improve_packages_from_purldb task #303

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

Author: tdruez

component_catalog/views.py

@@ -2435,9 +2435,12 @@ def get_tab_fields(self):
         }
         tab_fields.append(("", alert_context, None, "includes/field_alert.html"))
 
-        if len(purldb_entries) > 1:
+        len_purldb_entries = len(purldb_entries)
+        if len_purldb_entries > 1:
             alert_context = {
-                "message": "There are multiple entries in the PurlDB for this Package.",
+                "message": (
+                    f"There are {len_purldb_entries} entries in the PurlDB for this Package."
+                ),
                 "full_width": True,
                 "alert_class": "alert-warning",
             }

dejacode_toolkit/purldb.py

@@ -56,7 +56,7 @@ def get_package(self, uuid):
 
     def get_package_by_purl(self, package_url):
         """Get a Package details entry providing its `package_url`."""
-        if results := self.find_packages({"purl": package_url}):
+        if results := self.find_packages(payload={"purl": package_url}):
             return results[0]
 
     def find_packages(self, payload, timeout=None):

dje/tasks.py

@@ -275,13 +275,16 @@ def improve_packages_from_purldb(product_uuid, user_uuid):
         created_by=user,
     )
 
+    updated_packages = []
     try:
         updated_packages = product.improve_packages_from_purldb(user)
     except Exception as e:
+        logger.error(f"[improve_packages_from_purldb]: {e}.")
         scancode_project.update(
             status=ScanCodeProject.Status.FAILURE,
-            import_log=str(e),
+            import_log=["Error:", str(e)],
         )
+        return
 
     logger.info(f"[improve_packages_from_purldb]: {len(updated_packages)} updated from PurlDB.")
     verb = "Improved packages from PurlDB:"

product_portfolio/tests/test_views.py

@@ -15,6 +15,7 @@
 from django.contrib.contenttypes.models import ContentType
 from django.core.files.base import ContentFile
 from django.core.files.uploadedfile import SimpleUploadedFile
+from django.db import IntegrityError
 from django.shortcuts import resolve_url
 from django.test import TestCase
 from django.test.utils import override_settings
@@ -3384,6 +3385,7 @@ def test_product_portfolio_scancodeio_project_download_input_view(self):
         response = self.client.get(download_url)
         self.assertEqual(response.status_code, 404)
 
+    # HERE!
     @mock.patch("product_portfolio.models.Product.improve_packages_from_purldb")
     def test_product_portfolio_improve_packages_from_purldb_task(self, mock_improve):
         mock_improve.return_value = ["pkg1", "pkg2"]
@@ -3431,6 +3433,27 @@ def test_product_portfolio_improve_packages_from_purldb_task(self, mock_improve)
         self.assertEqual("dejacodeuser", notification.actor_content_type.model)
         self.assertEqual(self.product1, notification.action_object)
 
+    @mock.patch("product_portfolio.models.Product.improve_packages_from_purldb")
+    def test_product_portfolio_improve_packages_from_purldb_task_exception(self, mock_improve):
+        mock_improve.side_effect = IntegrityError("duplicate key value violates unique constraint")
+
+        self.assertFalse(self.basic_user.has_perm("change_product", self.product1))
+        with self.assertLogs(tasks_logger) as cm:
+            results = improve_packages_from_purldb(self.product1.uuid, self.super_user.uuid)
+        self.assertIsNone(results)
+
+        import_project = self.product1.scancodeprojects.get()
+        self.assertEqual(import_project.type, ScanCodeProject.ProjectType.IMPROVE_FROM_PURLDB)
+        self.assertEqual(import_project.status, ScanCodeProject.Status.FAILURE)
+        expected = ["Error:", "duplicate key value violates unique constraint"]
+        self.assertEqual(expected, import_project.import_log)
+
+        expected = (
+            "ERROR:dje.tasks:[improve_packages_from_purldb]: "
+            "duplicate key value violates unique constraint."
+        )
+        self.assertIn(expected, cm.output)
+
     def test_product_portfolio_vulnerability_analysis_form_view(self):
         self.client.login(username=self.super_user.username, password="secret")