Rename policy related method for clarity

Signed-off-by: tdruez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -4,6 +4,16 @@ Changelog
 v35.2.0 (unreleased)
 --------------------
 
+- Refactor policies implementation to support more than licenses.
+  The entire ``policies`` data is now stored on the ``ScanPipeConfig`` in place of the
+  ``license_policy_index``.
+  Also, a new method ``get_policies_dict`` methods is now available on the ``Project``
+  model to easily retrieve all the policies data as a dictionary.
+  Renamed for clarity:
+  * ``policy_index`` to ``license_policy_index``
+  * ``policies_enabled`` to ``license_policies_enabled``
+  https://github.com/aboutcode-org/scancode.io/pull/1718
+
 - Add support for SPDX license identifiers as ``license_key`` in license policies
   ``policies.yml`` file.
   https://github.com/aboutcode-org/scancode.io/issues/1348

scanpipe/models.py

@@ -1521,14 +1521,14 @@ def get_license_policy_index(self):
         return {}
 
     @cached_property
-    def policy_index(self):
+    def license_policy_index(self):
         """Return the cached license policy index for this project instance."""
         return self.get_license_policy_index()
 
     @property
-    def policies_enabled(self):
-        """Return True if the policies are enabled for this project."""
-        return bool(self.policy_index)
+    def license_policies_enabled(self):
+        """Return True if the license policies are available for this project."""
+        return bool(self.license_policy_index)
 
 
 class GroupingQuerySetMixin:
@@ -2543,7 +2543,7 @@ def save(self, codebase=None, *args, **kwargs):
         ``codebase`` is not used in this context but required for compatibility
         with the commoncode.resource.Codebase class API.
         """
-        if self.policies_enabled:
+        if self.license_policies_enabled:
             loaded_license_expression = getattr(self, "_loaded_license_expression", "")
             license_expression = getattr(self, self.license_expression_field, "")
             if license_expression != loaded_license_expression:
@@ -2569,28 +2569,29 @@ def from_db(cls, db, field_names, values):
         return new
 
     @property
-    def policy_index(self):
-        return self.project.policy_index
+    def license_policy_index(self):
+        return self.project.license_policy_index
 
     @cached_property
-    def policies_enabled(self):
-        return self.project.policies_enabled
+    def license_policies_enabled(self):
+        return self.project.license_policies_enabled
 
     def compute_compliance_alert(self):
         """
         Compute and return the compliance_alert value from the license policies.
         Chooses the most severe compliance_alert found among licenses.
         """
         license_expression = getattr(self, self.license_expression_field, "")
-        policy_index = self.policy_index
-        if not license_expression or not policy_index:
+        license_policy_index = self.license_policy_index
+        if not license_expression or not license_policy_index:
             return ""
 
         licensing = get_licensing()
         parsed_symbols = licensing.parse(license_expression, simple=True).symbols
 
         alerts = [
-            self.get_alert_for_symbol(policy_index, symbol) for symbol in parsed_symbols
+            self.get_alert_for_symbol(license_policy_index, symbol)
+            for symbol in parsed_symbols
         ]
         most_severe_alert = max(alerts, key=self.COMPLIANCE_SEVERITY_MAP.get)
         return most_severe_alert or self.Compliance.OK

scanpipe/pipes/output.py

@@ -541,7 +541,7 @@ def to_xlsx(project):
     exclude_fields = XLSX_EXCLUDE_FIELDS.copy()
     output_file = project.get_output_file_path("results", "xlsx")
 
-    if not project.policies_enabled:
+    if not project.license_policies_enabled:
         exclude_fields.append("compliance_alert")
 
     model_names = [

scanpipe/templates/scanpipe/forms/project_settings_form.html

@@ -153,7 +153,7 @@
     <p id="policies" class="panel-heading">Policies</p>
     <div class="panel-block is-block px-4">
       <div>
-        {% if project.policies_enabled %}
+        {% if project.license_policies_enabled %}
           <i class="fa-solid fa-check"></i>
           Policies are <strong>enabled</strong> for this project.
         {% else %}

scanpipe/templates/scanpipe/project_detail.html

@@ -117,7 +117,7 @@
         <div hx-get="{% url 'project_resource_license_summary' project.slug %}" hx-trigger="load" hx-swap="outerHTML"></div>
       </div>
 
-      {% if policies_enabled %}
+      {% if license_policies_enabled %}
         <div class="columns">
           <div hx-get="{% url 'project_compliance_panel' project.slug %}" hx-trigger="load" hx-swap="outerHTML"></div>
         </div>

scanpipe/tests/test_models.py

@@ -698,6 +698,28 @@ def test_scanpipe_project_get_input_policies_file(self):
         policies_file_location = str(self.project1.get_input_policies_file())
         self.assertTrue(policies_file_location.endswith("input/policies.yml"))
 
+    @patch.object(scanpipe_app, "policies", new=global_policies)
+    def test_scanpipe_project_model_get_policies_dict(self):
+        self.assertEqual(scanpipe_app.policies, self.project1.get_policies_dict())
+
+        policies_from_input_dir = {"license_policies": [{"license_key": "input_dir"}]}
+        policies_file = self.project1.input_path / "policies.yml"
+        policies_file.touch()
+        policies_as_yaml = saneyaml.dump(policies_from_input_dir)
+        policies_file.write_text(policies_as_yaml)
+        self.assertEqual(policies_from_input_dir, self.project1.get_policies_dict())
+        # Refresh the instance to bypass the cached_property cache.
+        self.project1 = Project.objects.get(uuid=self.project1.uuid)
+        self.assertTrue(self.project1.license_policies_enabled)
+
+        policies_from_project_env = {
+            "license_policies": [{"license_key": "project_env"}]
+        }
+        config = {"policies": policies_from_project_env}
+        self.project1.settings = config
+        self.project1.save()
+        self.assertEqual(policies_from_project_env, self.project1.get_policies_dict())
+
     @patch.object(scanpipe_app, "policies", new=global_policies)
     def test_scanpipe_project_model_get_license_policy_index(self):
         self.assertEqual(
@@ -715,7 +737,7 @@ def test_scanpipe_project_model_get_license_policy_index(self):
         )
         # Refresh the instance to bypass the cached_property cache.
         self.project1 = Project.objects.get(uuid=self.project1.uuid)
-        self.assertTrue(self.project1.policies_enabled)
+        self.assertTrue(self.project1.license_policies_enabled)
 
         policies_from_project_env = {
             "license_policies": [{"license_key": "project_env"}]
@@ -728,6 +750,23 @@ def test_scanpipe_project_model_get_license_policy_index(self):
             expected_index_from_env, self.project1.get_license_policy_index()
         )
 
+    def test_scanpipe_models_license_policies_enabled(self):
+        resource1 = make_resource_file(self.project1, path="example")
+        package1 = make_package(self.project1, "pkg:type/a")
+
+        self.assertFalse(self.project1.license_policies_enabled)
+        self.assertFalse(resource1.license_policies_enabled)
+        self.assertFalse(package1.license_policies_enabled)
+
+        with patch.object(scanpipe_app, "policies", new=global_policies):
+            # Refresh the instance to bypass the cached_property cache.
+            self.project1 = Project.objects.get(uuid=self.project1.uuid)
+            resource1 = self.project1.codebaseresources.get()
+            package1 = self.project1.discoveredpackages.get()
+            self.assertTrue(self.project1.license_policies_enabled)
+            self.assertTrue(resource1.license_policies_enabled)
+            self.assertTrue(package1.license_policies_enabled)
+
     def test_scanpipe_project_get_settings_as_yml(self):
         self.assertEqual("{}\n", self.project1.get_settings_as_yml())
 
@@ -1549,7 +1588,7 @@ def test_scanpipe_codebase_resource_model_commoncode_methods_extracted_to_from(
 
     @patch.object(scanpipe_app, "policies", new=global_policies)
     def test_scanpipe_codebase_resource_model_compliance_alert(self):
-        project_license_policies_index = self.project1.policy_index
+        project_license_policies_index = self.project1.license_policy_index
         self.assertEqual(license_policies_index, project_license_policies_index)
 
         resource = CodebaseResource.objects.create(project=self.project1, path="file")
@@ -2427,12 +2466,12 @@ def test_scanpipe_discovered_package_model_compliance_alert(self):
         self.assertEqual("", package.compliance_alert)
 
         license_expression = "bsd-new"
-        self.assertNotIn(license_expression, self.project1.policy_index)
+        self.assertNotIn(license_expression, self.project1.license_policy_index)
         package.update(declared_license_expression=license_expression)
         self.assertEqual("missing", package.compliance_alert)
 
         license_expression = "apache-2.0"
-        self.assertIn(license_expression, self.project1.policy_index)
+        self.assertIn(license_expression, self.project1.license_policy_index)
         package.update(declared_license_expression=license_expression)
         self.assertEqual("ok", package.compliance_alert)
 

scanpipe/tests/test_policies.py

@@ -129,7 +129,7 @@ def test_scanpipe_policies_scan_codebase_pipeline_integration(self):
         expected = "codebase/include_policies_file.zip-extract/policies.yml"
         project_policies_file = project1.get_input_policies_file()
         self.assertTrue(str(project_policies_file).endswith(expected))
-        self.assertTrue(project1.policies_enabled)
+        self.assertTrue(project1.license_policies_enabled)
         expected_index = {
             "apache-2.0": {"license_key": "apache-2.0", "compliance_alert": ""},
             "gpl-2.0": {"license_key": "gpl-2.0", "compliance_alert": "error"},

scanpipe/tests/test_views.py

@@ -618,9 +618,11 @@ def test_scanpipe_views_project_details_codebase_root(self):
         expected = ["Dir", "Zdir", "a", "z", "a.txt", "z.txt"]
         self.assertEqual(expected, [path.name for path in codebase_root])
 
-    @mock.patch.object(Project, "policies_enabled", new_callable=mock.PropertyMock)
+    @mock.patch.object(
+        Project, "license_policies_enabled", new_callable=mock.PropertyMock
+    )
     def test_scanpipe_views_project_details_compliance_panel_availability(
-        self, mock_policies_enabled
+        self, mock_license_policies_enabled
     ):
         url = self.project1.get_absolute_url()
         make_package(
@@ -630,11 +632,11 @@ def test_scanpipe_views_project_details_compliance_panel_availability(
         )
 
         expected_url = reverse("project_compliance_panel", args=[self.project1.slug])
-        mock_policies_enabled.return_value = False
+        mock_license_policies_enabled.return_value = False
         response = self.client.get(url)
         self.assertNotContains(response, expected_url)
 
-        mock_policies_enabled.return_value = True
+        mock_license_policies_enabled.return_value = True
         response = self.client.get(url)
         self.assertContains(response, expected_url)
 
@@ -988,20 +990,24 @@ def test_scanpipe_views_project_run_step_selection_view(self):
         )
         self.assertContains(response, expected_input2)
 
-    @mock.patch.object(Project, "policies_enabled", new_callable=mock.PropertyMock)
-    def test_scanpipe_views_project_compliance_panel_view(self, mock_policies_enabled):
+    @mock.patch.object(
+        Project, "license_policies_enabled", new_callable=mock.PropertyMock
+    )
+    def test_scanpipe_views_project_compliance_panel_view(
+        self, mock_license_policies_enabled
+    ):
         url = reverse("project_compliance_panel", args=[self.project1.slug])
         make_package(
             self.project1,
             package_url="pkg:generic/[email protected]",
             compliance_alert=DiscoveredPackage.Compliance.ERROR,
         )
 
-        mock_policies_enabled.return_value = False
+        mock_license_policies_enabled.return_value = False
         response = self.client.get(url)
         self.assertEqual(404, response.status_code)
 
-        mock_policies_enabled.return_value = True
+        mock_license_policies_enabled.return_value = True
         response = self.client.get(url)
         self.assertContains(response, "Compliance alerts")
         self.assertContains(response, "1 Error")

scanpipe/views.py

@@ -808,9 +808,9 @@ def get_context_data(self, **kwargs):
         pipeline_runs = project.runs.all()
         self.check_run_scancode_version(pipeline_runs)
 
-        policies_enabled = False
+        license_policies_enabled = False
         try:
-            policies_enabled = project.policies_enabled
+            license_policies_enabled = project.license_policies_enabled
         except ValidationError as e:
             messages.error(self.request, str(e))
 
@@ -830,7 +830,7 @@ def get_context_data(self, **kwargs):
                 "pipeline_runs": pipeline_runs,
                 "codebase_root": codebase_root,
                 "file_filter": self.request.GET.get("file-filter", "all"),
-                "policies_enabled": policies_enabled,
+                "license_policies_enabled": license_policies_enabled,
             }
         )
 
@@ -1201,7 +1201,7 @@ def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         project = self.object
 
-        if not project.policies_enabled:
+        if not project.license_policies_enabled:
             raise Http404
 
         compliance_alerts = compliance.get_project_compliance_alerts(