add test for api and replace clarity_compliance with license_clarity_compliance everywhere

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

Author: NucleonGodX

docs/policies.rst

@@ -57,7 +57,7 @@ structure similar to the following:
 Creating Clarity Thresholds Files
 ---------------------------------
 
-A valid clarity thresholds file is required to **enable clarity compliance features**.
+A valid clarity thresholds file is required to **enable license clarity compliance features**.
 
 The clarity thresholds file, by default named ``policies.yml``, is a **YAML file** with a
 structure similar to the following:

docs/rest-api.rst

@@ -495,25 +495,27 @@ Data:
 
 .. _rest_api_clarity_compliance:
 
-Clarity Compliance
-^^^^^^^^^^^^^^^^^^
+License Clarity Compliance
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This action returns the **clarity compliance alert** for a project.
+This action returns the **license clarity compliance alert** for a project.
 
-The clarity compliance alert is a single value (``ok``, ``warning``, or ``error``) that summarizes
-the project's **license clarity status**, based on the thresholds defined in the ``policies.yml`` file.
+The license clarity compliance alert is a single value (``ok``, ``warning``, or ``error``)
+that summarizes the project's **license clarity status**, based on the thresholds defined in
+the ``policies.yml`` file.
 
-``GET /api/projects/6461408c-726c-4b70-aa7a-c9cc9d1c9685/clarity_compliance/``
+``GET /api/projects/6461408c-726c-4b70-aa7a-c9cc9d1c9685/license_clarity_compliance/``
 
 Data:
-    - ``clarity_compliance_alert``: The overall clarity compliance alert for the project.
+    - ``license_clarity_compliance_alert``: The overall license clarity compliance alert
+      for the project.
 
       Possible values: ``ok``, ``warning``, ``error``.
 
 .. code-block:: json
 
     {
-        "clarity_compliance_alert": "warning"
+        "license_clarity_compliance_alert": "warning"
     }
 
 Reset

docs/tutorial_license_policies.rst

@@ -103,11 +103,11 @@ Add a ``license_clarity_thresholds`` section to your ``policies.yml`` file, for
       0: error
 
 
-Clarity Compliance in Results
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+License Clarity Compliance in Results
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 When you run a pipeline with clarity thresholds defined in your ``policies.yml``,
-the computed clarity compliance alert is included in the project's ``extra_data`` field.
+the computed license clarity compliance alert is included in the project's ``extra_data`` field.
 
 For example:
 
@@ -121,10 +121,10 @@ For example:
       "sha512": "208f6a83c83a4c770b3c0",
       "filename": "cuckoo_filter-1.0.6.tar.gz",
       "sha1_git": "3fdb0f82ad59",
-      "clarity_compliance_alert": "error"
+      "license_clarity_compliance_alert": "error"
     }
 
-The ``clarity_compliance_alert`` value (e.g., ``"error"``, ``"warning"``, or ``"ok"``)
+The ``license_clarity_compliance_alert`` value (e.g., ``"error"``, ``"warning"``, or ``"ok"``)
 is computed automatically based on the thresholds you configured and reflects the
 overall license clarity status of the scanned codebase.
 
@@ -149,8 +149,8 @@ in the project:
     [resources]
      > ERROR: 1
        cuckoo_filter-1.0.6.tar.gz-extract/cuckoo_filter-1.0.6/README.md
-    [License Clarity]
-     > Alert Level: error
+    [license clarity]
+     > Alert Level: ERROR
 
 .. tip::
     In case of compliance alerts, the command returns a non-zero exit code which

scanpipe/api/views.py

@@ -484,18 +484,18 @@ def compliance(self, request, *args, **kwargs):
     @action(detail=True, methods=["get"])
     def clarity_compliance(self, request, *args, **kwargs):
         """
-        Retrieve the clarity compliance alert for a project.
+        Retrieve the license clarity compliance alert for a project.
 
-        This endpoint returns the clarity compliance alert stored in the
+        This endpoint returns the license clarity compliance alert stored in the
         project's extra_data.
 
         Example:
-          GET /api/projects/{project_id}/clarity_compliance/
+          GET /api/projects/{project_id}/license_clarity_compliance/
 
         """
         project = self.get_object()
-        clarity_alert = project.get_clarity_compliance_alert()
-        return Response({"clarity_compliance_alert": clarity_alert})
+        clarity_alert = project.get_license_clarity_compliance_alert()
+        return Response({"license_clarity_compliance_alert": clarity_alert})
 
 
 class RunViewSet(mixins.RetrieveModelMixin, viewsets.GenericViewSet):

scanpipe/management/commands/check-compliance.py

@@ -74,7 +74,7 @@ def check_compliance(self, fail_level):
             len(issues) for model in alerts.values() for issues in model.values()
         )
 
-        clarity_alert = self.project.get_clarity_compliance_alert()
+        clarity_alert = self.project.get_license_clarity_compliance_alert()
         has_clarity_issue = clarity_alert not in (None, "ok")
 
         total_issues = count + (1 if has_clarity_issue else 0)
@@ -89,8 +89,8 @@ def check_compliance(self, fail_level):
                         self.stderr.write("   " + "\n   ".join(entries))
 
             if has_clarity_issue:
-                self.stderr.write("[License Clarity]")
-                self.stderr.write(f" > Alert Level: {clarity_alert}")
+                self.stderr.write("[license clarity]")
+                self.stderr.write(f" > Alert Level: {clarity_alert.upper()}")
 
         return total_issues > 0
 

scanpipe/models.py

@@ -1514,13 +1514,13 @@ def get_policies_dict(self):
 
         return scanpipe_app.policies
 
-    def get_clarity_compliance_alert(self):
+    def get_license_clarity_compliance_alert(self):
         """
-        Return the clarity compliance alert value for the project,
+        Return the license clarity compliance alert value for the project,
         or None if not set.
         """
         extra_data = self.extra_data or {}
-        return extra_data.get("clarity_compliance_alert")
+        return extra_data.get("license_clarity_compliance_alert")
 
     def get_license_policy_index(self):
         """Return the policy license index for this project instance."""

scanpipe/pipes/scancode.py

@@ -932,7 +932,7 @@ def make_results_summary(project, scan_results_location):
     Extract selected sections of the Scan results, such as the `summary`
     `license_clarity_score`, and `license_matches` related data.
     The `key_files` are also collected and injected in the `summary` output.
-    Additionally, store clarity_compliance_alert in project's extra_data.
+    Additionally, store license_clarity_compliance_alert in project's extra_data.
     """
     import json
 
@@ -973,7 +973,7 @@ def make_results_summary(project, scan_results_location):
         clarity_policy = get_project_clarity_thresholds(project)
         if clarity_policy:
             alert = clarity_policy.get_alert_for_score(clarity_score)
-            summary["clarity_compliance_alert"] = alert
+            summary["license_clarity_compliance_alert"] = alert
 
-            project.update_extra_data({"clarity_compliance_alert": alert})
+            project.update_extra_data({"license_clarity_compliance_alert": alert})
     return summary

scanpipe/templates/scanpipe/panels/project_compliance.html

@@ -1,5 +1,5 @@
 {% load humanize %}
-{% if compliance_alerts or clarity_compliance_alert %}
+{% if compliance_alerts or license_clarity_compliance_alert %}
   <div class="column is-half">
     <nav id="compliance-panel" class="panel is-dark">
       <p class="panel-heading">
@@ -19,17 +19,17 @@
           {% endfor %}
         </div>
       {% endfor %}
-      {% if clarity_compliance_alert %}
+      {% if license_clarity_compliance_alert %}
         <div class="panel-block">
           <span class="pr-1">
             License clarity
           </span>
           <span class="tag is-rounded ml-1
-            {% if clarity_compliance_alert == 'error' %}is-danger
-            {% elif clarity_compliance_alert == 'warning' %}is-warning
-            {% elif clarity_compliance_alert == 'ok' %}is-success
+            {% if license_clarity_compliance_alert == 'error' %}is-danger
+            {% elif license_clarity_compliance_alert == 'warning' %}is-warning
+            {% elif license_clarity_compliance_alert == 'ok' %}is-success
             {% else %}is-light{% endif %}">
-            {{ clarity_compliance_alert|title }}
+            {{ license_clarity_compliance_alert|title }}
           </span>
         </div>
       {% endif %}

scanpipe/tests/test_api.py

@@ -1252,6 +1252,24 @@ def test_scanpipe_api_project_action_compliance(self):
         }
         self.assertDictEqual(expected, response.data)
 
+    def test_scanpipe_api_project_action_license_clarity_compliance(self):
+        project = make_project()
+        url = reverse("project-clarity-compliance", args=[project.uuid])
+
+        response = self.csrf_client.get(url)
+        expected = {"license_clarity_compliance_alert": None}
+        self.assertEqual(expected, response.data)
+
+        project.update_extra_data({"license_clarity_compliance_alert": "ok"})
+        response = self.csrf_client.get(url)
+        expected = {"license_clarity_compliance_alert": "ok"}
+        self.assertEqual(expected, response.data)
+
+        project.update_extra_data({"license_clarity_compliance_alert": "error"})
+        response = self.csrf_client.get(url)
+        expected = {"license_clarity_compliance_alert": "error"}
+        self.assertEqual(expected, response.data)
+
     def test_scanpipe_api_serializer_get_model_serializer(self):
         self.assertEqual(
             DiscoveredPackageSerializer, get_model_serializer(DiscoveredPackage)

scanpipe/tests/test_commands.py

@@ -1216,7 +1216,7 @@ def test_scanpipe_management_command_check_compliance(self):
     def test_scanpipe_management_command_check_clarity_compliance_only(self):
         project = make_project(name="my_project_clarity")
 
-        project.extra_data = {"clarity_compliance_alert": "error"}
+        project.extra_data = {"license_clarity_compliance_alert": "error"}
         project.save(update_fields=["extra_data"])
 
         out = StringIO()
@@ -1226,7 +1226,7 @@ def test_scanpipe_management_command_check_clarity_compliance_only(self):
         self.assertEqual(cm.exception.code, 1)
         out_value = out.getvalue().strip()
         expected = (
-            "1 compliance issues detected.\n[License Clarity]\n > Alert Level: error"
+            "1 compliance issues detected.\n[license clarity]\n > Alert Level: ERROR"
         )
         self.assertEqual(expected, out_value)
 
@@ -1238,7 +1238,7 @@ def test_scanpipe_management_command_check_both_compliance_and_clarity(self):
             package_url="pkg:generic/[email protected]",
             compliance_alert=CodebaseResource.Compliance.ERROR,
         )
-        project.extra_data = {"clarity_compliance_alert": "warning"}
+        project.extra_data = {"license_clarity_compliance_alert": "warning"}
         project.save(update_fields=["extra_data"])
 
         out = StringIO()
@@ -1250,7 +1250,7 @@ def test_scanpipe_management_command_check_both_compliance_and_clarity(self):
         expected = (
             "2 compliance issues detected."
             "\n[packages]\n > ERROR: 1"
-            "\n[License Clarity]\n > Alert Level: warning"
+            "\n[license clarity]\n > Alert Level: WARNING"
         )
         self.assertEqual(expected, out_value)