integrating the clarity-compliance in UI

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

Author: NucleonGodX

scanpipe/pipes/license_clarity.py

@@ -41,6 +41,7 @@
 
 from pathlib import Path
 
+from django.conf import settings
 from django.core.exceptions import ValidationError
 
 import saneyaml
@@ -163,3 +164,27 @@ def load_clarity_thresholds_from_file(file_path):
         return load_clarity_thresholds_from_yaml(yaml_content)
     except (OSError, UnicodeDecodeError) as e:
         raise ValidationError(f"Error reading file {file_path}: {e}")
+
+
+def get_project_clarity_thresholds(project):
+    """
+    Get clarity thresholds for a project, checking multiple sources.
+
+    Returns:
+        ClarityThresholdsPolicy or None: Policy object if thresholds are configured
+
+    """
+    if hasattr(project, "get_input_policies_file"):
+        policies_file = project.get_input_policies_file()
+        if policies_file:
+            policy = load_clarity_thresholds_from_file(policies_file)
+            if policy:
+                return policy
+
+    global_policies_file = getattr(settings, "SCANCODEIO_POLICIES_FILE", None)
+    if global_policies_file:
+        policy = load_clarity_thresholds_from_file(global_policies_file)
+        if policy:
+            return policy
+
+    return None

scanpipe/pipes/scancode.py

@@ -52,6 +52,7 @@
 from scanpipe.models import DiscoveredDependency
 from scanpipe.models import DiscoveredPackage
 from scanpipe.pipes import flag
+from scanpipe.pipes.license_clarity import get_project_clarity_thresholds
 
 logger = logging.getLogger("scanpipe.pipes")
 
@@ -931,7 +932,10 @@ 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.
     """
+    import json
+
     from scanpipe.api.serializers import CodebaseResourceSerializer
     from scanpipe.api.serializers import DiscoveredPackageSerializer
 
@@ -964,4 +968,16 @@ def make_results_summary(project, scan_results_location):
         DiscoveredPackageSerializer(package).data for package in key_files_packages_qs
     ]
 
+    clarity_score = summary.get("license_clarity_score", {}).get("score")
+    if clarity_score is not None:
+        clarity_policy = get_project_clarity_thresholds(project)
+        if clarity_policy:
+            alert = clarity_policy.get_alert_for_score(clarity_score)
+            summary["clarity_compliance_alert"] = alert
+
+            extra_data = project.extra_data or {}
+            extra_data["clarity_compliance_alert"] = alert
+            project.extra_data = extra_data
+            project.save(update_fields=["extra_data"])
+
     return summary

scanpipe/templates/scanpipe/panels/clarity_compliance.html

@@ -0,0 +1,36 @@
+{% if clarity_compliance_alert %}
+  <div class="column is-half">
+    <nav id="clarity-compliance-panel" class="panel
+      {% if clarity_compliance_alert == 'error' %}is-danger
+      {% elif clarity_compliance_alert == 'warning' %}is-warning
+      {% elif clarity_compliance_alert == 'ok' %}is-success
+      {% else %}is-light{% endif %}">
+      <p class="panel-heading">
+        Clarity Compliance
+      </p>
+      <div class="panel-block">
+        <span class="tag is-rounded
+          {% if clarity_compliance_alert == 'error' %}is-danger
+          {% elif clarity_compliance_alert == 'warning' %}is-warning
+          {% elif clarity_compliance_alert == 'ok' %}is-success
+          {% else %}is-light{% endif %}">
+          {{ clarity_compliance_alert|title }}
+        </span>
+        {% if clarity_compliance_score %}
+          <span class="ml-2">Score: {{ clarity_compliance_score }}</span>
+        {% endif %}
+        <span class="ml-2">
+          {% if clarity_compliance_alert == "ok" %}
+            License clarity is sufficient.
+          {% elif clarity_compliance_alert == "warning" %}
+            License clarity is borderline. Please review.
+          {% elif clarity_compliance_alert == "error" %}
+            License clarity is insufficient! Immediate attention required.
+          {% else %}
+            No clarity compliance data available.
+          {% endif %}
+        </span>
+      </div>
+    </nav>
+  </div>
+{% endif %}

scanpipe/templates/scanpipe/project_detail.html

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

scanpipe/tests/test_views.py

@@ -1008,6 +1008,24 @@ def test_scanpipe_views_project_compliance_panel_view(self, mock_policies_enable
         expected = f"/project/{self.project1.slug}/packages/?compliance_alert=error"
         self.assertContains(response, expected)
 
+    @mock.patch.object(Project, "policies_enabled", new_callable=mock.PropertyMock)
+    def test_scanpipe_views_project_clarity_compliance_panel_view(
+        self, mock_policies_enabled
+    ):
+        url = reverse("clarity_compliance_panel", args=[self.project1.slug])
+        self.project1.extra_data = {"clarity_compliance_alert": "error"}
+        self.project1.save(update_fields=["extra_data"])
+
+        mock_policies_enabled.return_value = False
+        response = self.client.get(url)
+        self.assertEqual(404, response.status_code)
+
+        mock_policies_enabled.return_value = True
+        response = self.client.get(url)
+        self.assertContains(response, "Clarity Compliance")
+        self.assertContains(response, "Error")
+        self.assertContains(response, "License clarity is insufficient")
+
     def test_scanpipe_views_pipeline_help_view(self):
         url = reverse("pipeline_help", args=["not_existing_pipeline"])
         response = self.client.get(url)

scanpipe/urls.py

@@ -221,6 +221,11 @@
         views.ProjectCompliancePanelView.as_view(),
         name="project_compliance_panel",
     ),
+    path(
+        "projects/<slug:slug>/clarity_compliance_panel/",
+        views.ClarityCompliancePanelView.as_view(),
+        name="clarity_compliance_panel",
+    ),
     path(
         "project/<slug:slug>/",
         views.ProjectDetailView.as_view(),

scanpipe/views.py

@@ -1212,6 +1212,23 @@ def get_context_data(self, **kwargs):
         return context
 
 
+class ClarityCompliancePanelView(ConditionalLoginRequired, generic.DetailView):
+    model = Project
+    template_name = "scanpipe/panels/clarity_compliance.html"
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        project = self.object
+
+        if not project.policies_enabled:
+            raise Http404
+
+        extra_data = project.extra_data or {}
+        context["clarity_compliance_alert"] = extra_data.get("clarity_compliance_alert")
+
+        return context
+
+
 class ProjectArchiveView(ConditionalLoginRequired, SingleObjectMixin, FormView):
     model = Project
     http_method_names = ["post"]