Add notes field on the DiscoveredPackage model #1342 (#1349)

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

Author: tdruez

CHANGELOG.rst

@@ -35,6 +35,9 @@ v34.7.2 (unreleased)
   processed at once.
   https://github.com/nexB/scancode.io/issues/1287
 
+- Add notes field on the DiscoveredPackage model.
+  https://github.com/nexB/scancode.io/issues/1342
+
 v34.7.1 (2024-07-15)
 --------------------
 

scanpipe/api/serializers.py

@@ -391,6 +391,7 @@ class Meta:
             "tag",
             "primary_language",
             "description",
+            "notes",
             "release_date",
             "parties",
             "keywords",

scanpipe/migrations/0067_discoveredpackage_notes.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.7 on 2024-08-06 10:29
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('scanpipe', '0066_alter_webhooksubscription_options_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='discoveredpackage',
+            name='notes',
+            field=models.TextField(blank=True),
+        ),
+    ]

scanpipe/models.py

@@ -3256,6 +3256,7 @@ class DiscoveredPackage(
         help_text=_("Unique identifier for this package."),
     )
     keywords = models.JSONField(default=list, blank=True)
+    notes = models.TextField(blank=True)
     source_packages = models.JSONField(default=list, blank=True)
     tag = models.CharField(blank=True, max_length=50)
 

scanpipe/tests/data/scancode/is-npm-1.0.0_summary.json

@@ -164,6 +164,7 @@
       "tag": "",
       "primary_language": "JavaScript",
       "description": "Check if your code is running as an npm script",
+      "notes": "",
       "release_date": null,
       "parties": [
         {

scanpipe/tests/test_api.py

@@ -1048,7 +1048,7 @@ def test_scanpipe_api_serializer_get_model_serializer(self):
             get_model_serializer(None)
 
     def test_scanpipe_api_serializer_get_serializer_fields(self):
-        self.assertEqual(48, len(get_serializer_fields(DiscoveredPackage)))
+        self.assertEqual(49, len(get_serializer_fields(DiscoveredPackage)))
         self.assertEqual(14, len(get_serializer_fields(DiscoveredDependency)))
         self.assertEqual(37, len(get_serializer_fields(CodebaseResource)))
         self.assertEqual(5, len(get_serializer_fields(CodebaseRelation)))

scanpipe/tests/test_models.py

@@ -2340,6 +2340,7 @@ def test_scanpipe_package_model_integrity_with_toolkit_package_model(self):
             "resolved_from_dependencies",
             "parent_packages",
             "children_packages",
+            "notes",
         ]
 
         package_data_only_field = ["datasource_id", "dependencies"]

scanpipe/views.py

@@ -1891,6 +1891,7 @@ class DiscoveredPackageDetailsView(
                 "source_packages",
                 "keywords",
                 "description",
+                "notes",
                 "tag",
             ],
             "icon_class": "fa-solid fa-circle-check",