Add unit tests and changelog entry #310

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

Author: tdruez

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Release notes
 =============
 
+### Version 5.3.1-dev (unreleased)
+
+- Add new `is_locked` "Locked inventory" field to the ProductStatus model.
+  When a Product is locked through his status, its inventory cannot be modified.
+  https://github.com/aboutcode-org/dejacode/issues/189
+
 ### Version 5.3.0
 
 - Rename ProductDependency is_resolved to is_pinned.

dejacode/__init__.py

@@ -14,7 +14,7 @@
 
 import git
 
-VERSION = "5.3.0"
+VERSION = "5.3.1-dev"
 
 PROJECT_DIR = Path(__file__).resolve().parent
 ROOT_DIR = PROJECT_DIR.parent

product_portfolio/models.py

@@ -368,6 +368,7 @@ def actions_on_status_change(self):
     def is_locked(self):
         if self.configuration_status_id:
             return self.configuration_status.is_locked
+        return False
 
     @cached_property
     def all_packages(self):

product_portfolio/tests/__init__.py

@@ -18,6 +18,7 @@
 from product_portfolio.models import ProductDependency
 from product_portfolio.models import ProductItemPurpose
 from product_portfolio.models import ProductPackage
+from product_portfolio.models import ProductStatus
 
 
 def make_product(dataspace, inventory=None, **data):
@@ -71,9 +72,24 @@ def make_product_component(product, component=None):
 
 
 def make_product_item_purpose(dataspace, **data):
+    if "label" not in data:
+        data["label"] = make_string(10)
+    if "text" not in data:
+        data["text"] = make_string(10)
+
     return ProductItemPurpose.objects.create(
-        label=make_string(10),
-        text=make_string(10),
+        dataspace=dataspace,
+        **data,
+    )
+
+
+def make_product_status(dataspace, **data):
+    if "label" not in data:
+        data["label"] = make_string(10)
+    if "text" not in data:
+        data["text"] = make_string(10)
+
+    return ProductStatus.objects.create(
         dataspace=dataspace,
         **data,
     )

product_portfolio/tests/test_models.py

@@ -37,12 +37,12 @@
 from product_portfolio.models import ProductPackage
 from product_portfolio.models import ProductRelationStatus
 from product_portfolio.models import ProductSecuredManager
-from product_portfolio.models import ProductStatus
 from product_portfolio.models import ScanCodeProject
 from product_portfolio.tests import make_product
 from product_portfolio.tests import make_product_dependency
 from product_portfolio.tests import make_product_item_purpose
 from product_portfolio.tests import make_product_package
+from product_portfolio.tests import make_product_status
 from vulnerabilities.tests import make_vulnerability
 from workflow.models import RequestTemplate
 
@@ -69,19 +69,15 @@ def setUp(self):
         )
 
     def test_product_model_default_status_on_product_addition(self):
-        status1 = ProductStatus.objects.create(
-            label="S1", text="Status1", default_on_addition=True, dataspace=self.dataspace
-        )
-        status2 = ProductStatus.objects.create(label="S2", text="Status2", dataspace=self.dataspace)
+        status1 = make_product_status(default_on_addition=True, dataspace=self.dataspace)
+        status2 = make_product_status(dataspace=self.dataspace)
 
         # No status given at creation time, the default is set
-        p1 = Product.objects.create(name="P1", dataspace=self.dataspace)
+        p1 = make_product(dataspace=self.dataspace, name="P1")
         self.assertEqual(status1, p1.configuration_status)
 
         # A status is given at creation time, no default is set
-        p2 = Product.objects.create(
-            name="P2", configuration_status=status2, dataspace=self.dataspace
-        )
+        p2 = make_product(dataspace=self.dataspace, name="P2", configuration_status=status2)
         self.assertEqual(status2, p2.configuration_status)
 
     def test_product_model_get_attribution_url(self):
@@ -105,6 +101,19 @@ def test_product_model_secured_manager(self):
         self.assertEqual(1, Product.objects.get_queryset(self.super_user).count())
         self.assertIn(self.product1, Product.objects.get_queryset(self.super_user))
 
+    def test_product_model_secured_manager_get_queryset_exclude_locked(self):
+        qs = Product.objects.get_queryset(self.super_user)
+        self.assertIn(self.product1, qs)
+        qs = Product.objects.get_queryset(self.super_user, exclude_locked=True)
+        self.assertIn(self.product1, qs)
+
+        locked_status = make_product_status(self.dataspace, is_locked=True)
+        self.product1.update(configuration_status=locked_status)
+        qs = Product.objects.get_queryset(self.super_user)
+        self.assertIn(self.product1, qs)
+        qs = Product.objects.get_queryset(self.super_user, exclude_locked=True)
+        self.assertNotIn(self.product1, qs)
+
     def test_product_model_is_active(self):
         qs = Product.objects.get_queryset(self.super_user)
         self.assertIn(self.product1, qs)
@@ -490,14 +499,12 @@ def test_product_model_actions_on_status_change(self):
             dataspace=self.super_user.dataspace,
             content_type=product_ct,
         )
-
-        status1 = ProductStatus.objects.create(
+        status1 = make_product_status(
+            self.dataspace,
             label="status1",
             text="status1",
             request_to_generate=request_template1,
-            dataspace=self.dataspace,
         )
-
         product.configuration_status = status1
         product.last_modified_by = self.super_user
         self.assertTrue(product.has_changed("configuration_status_id"))
@@ -509,6 +516,19 @@ def test_product_model_actions_on_status_change(self):
         product.refresh_from_db()
         self.assertEqual(1, product.request_count)
 
+    def test_product_model_is_locked_property(self):
+        product = make_product(self.dataspace)
+        self.assertFalse(product.is_locked)
+
+        status1 = make_product_status(self.dataspace, is_locked=False)
+        product.update(configuration_status=status1)
+        product = Product.unsecured_objects.get(pk=product.pk)
+        self.assertFalse(product.is_locked)
+
+        status1.update(is_locked=True)
+        product = Product.unsecured_objects.get(pk=product.pk)
+        self.assertTrue(product.is_locked)
+
     @mock.patch("component_catalog.models.Package.update_from_purldb")
     def test_product_model_improve_packages_from_purldb(self, mock_update_from_purldb):
         mock_update_from_purldb.return_value = 1

product_portfolio/tests/test_views.py

@@ -54,6 +54,7 @@
 from product_portfolio.tests import make_product
 from product_portfolio.tests import make_product_dependency
 from product_portfolio.tests import make_product_package
+from product_portfolio.tests import make_product_status
 from product_portfolio.views import ManageComponentGridView
 from vulnerabilities.models import VulnerabilityAnalysis
 from vulnerabilities.tests import make_vulnerability
@@ -1113,6 +1114,31 @@ def test_product_portfolio_detail_view_display_purldb_features(self):
         self.assertContains(response, expected2)
         self.assertContains(response, expected3)
 
+    def test_product_portfolio_detail_view_status_is_locked(self):
+        self.client.login(username=self.super_user.username, password="secret")
+        url = self.product1.get_absolute_url()
+        expected1 = (
+            '<button type="button" class="btn btn-outline-dark dropdown-toggle" disabled>'
+            '<i class="fas fa-tasks"></i> Manage'
+            "</button>"
+        )
+        expected2 = (
+            '<button type="button" class="btn btn-outline-dark dropdown-toggle" disabled>'
+            '<i class="fas fa-toolbox"></i> Actions'
+            "</button>"
+        )
+        expected3 = (
+            "This product version is marked as read-only, preventing any modifications "
+            "to its inventory."
+        )
+
+        locked_status = make_product_status(self.dataspace, is_locked=True)
+        self.product1.update(configuration_status=locked_status)
+        response = self.client.get(url)
+        self.assertContains(response, expected1, html=True)
+        self.assertContains(response, expected2, html=True)
+        self.assertContains(response, expected3, html=True)
+
     def test_product_portfolio_list_view_secured_queryset(self):
         self.client.login(username=self.basic_user.username, password="secret")
         url = resolve_url("product_portfolio:product_list")

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = dejacode
-version = 5.3.0
+version = 5.3.1-dev
 license = AGPL-3.0-only
 description = Automate open source license compliance and ensure supply chain integrity
 long_description = file:README.rst