refine polivy violation table

Signed-off-by: tdruez <tdruez@aboutcode.org>

Author: tdruez

policy/rules.py

@@ -15,6 +15,7 @@ class BaseRule:
     rule_type = None
     label = None
     description = None
+    severity = "warning"
     default_threshold = 0
     parameters_schema = {}
 
@@ -53,6 +54,7 @@ def get_package_filter(self):
 class UsagePolicyErrorRule(PackageBaseRule):
     rule_type = "usage_policy_error"
     label = "Usage Policy Error"
+    severity = "error"
     description = (
         "Detects packages assigned a usage policy with a compliance alert level of 'error'."
     )
@@ -71,6 +73,7 @@ class UsagePolicyWarningRule(PackageBaseRule):
 class LicensePolicyErrorRule(PackageBaseRule):
     rule_type = "license_policy_error"
     label = "License Policy Error"
+    severity = "error"
     description = (
         "Detects packages whose licenses are assigned a usage policy"
         " with a compliance alert level of 'error'."
@@ -100,6 +103,7 @@ class LicenseCoverageGapRule(PackageBaseRule):
 class VulnerabilityDetectedRule(BaseRule):
     rule_type = "vulnerability_detected"
     label = "Vulnerability Detected"
+    severity = "error"
     description = "Detects packages with at least one known vulnerability (non-null risk score)."
     parameters_schema = {
         "min_risk_score": "Minimum risk score (0.0-10.0). Default: any vulnerability.",

product_portfolio/models.py

@@ -58,6 +58,7 @@
 from dje.validators import validate_url_segment
 from dje.validators import validate_version
 from policy.models import AbstractPolicyViolation
+from policy.rules import RULE_REGISTRY
 from vulnerabilities.fetch import fetch_for_packages
 from vulnerabilities.models import AffectedByVulnerabilityMixin
 from vulnerabilities.models import AffectedByVulnerabilityRelationship
@@ -1956,14 +1957,15 @@ def __str__(self):
 
     @property
     def rule_label(self):
-        from policy.rules import RULE_REGISTRY
-
         handler = RULE_REGISTRY.get(self.rule_type)
         return handler.label if handler else self.rule_type
 
     @property
     def rule_description(self):
-        from policy.rules import RULE_REGISTRY
-
         handler = RULE_REGISTRY.get(self.rule_type)
         return handler.description if handler else ""
+
+    @property
+    def rule_severity(self):
+        handler = RULE_REGISTRY.get(self.rule_type)
+        return handler.severity if handler else "warning"

product_portfolio/templates/product_portfolio/compliance/compliance_panels.html

@@ -6,39 +6,90 @@
     <div class="col-12">
       <div class="border rounded-3 p-3">
         <div class="d-flex justify-content-between align-items-center mb-3">
-          <h3 class="fs-6 fw-medium mb-0">{% trans "Policy violations" %}</h3>
+          <div class="d-flex align-items-center gap-2">
+            <h3 class="fs-6 fw-medium mb-0">{% trans "Policy violations" %}</h3>
+            <button type="button"
+                    id="rules-overview-btn"
+                    class="btn btn-link p-0 text-body-tertiary lh-1"
+                    aria-label="{% trans 'View active rules' %}">
+              <i class="fas fa-circle-info small"></i>
+            </button>
+          </div>
           <span class="badge bg-danger-subtle text-danger-emphasis">
             {{ policy_violation_count }} {% trans "active" %}
           </span>
         </div>
-        <table class="table table-sm mb-0">
+        <table class="table table-sm align-middle mb-0">
           <thead>
             <tr>
               <th class="fw-medium">{% trans "Rule" %}</th>
               <th class="fw-medium">{% trans "Description" %}</th>
-              <th class="fw-medium">{% trans "Objects in violation" %}</th>
-              <th class="fw-medium">{% trans "Detected" %}</th>
+              <th class="fw-medium text-end">{% trans "In violation" %}</th>
+              <th class="fw-medium text-end">{% trans "Detected" %}</th>
             </tr>
           </thead>
           <tbody>
             {% for violation in policy_violations %}
             <tr>
-              <td>{{ violation.rule_label }}</td>
+              <td class="text-nowrap">
+                {% if violation.rule_severity == "error" %}
+                  <span class="badge bg-danger-subtle text-danger-emphasis">{{ violation.rule_label }}</span>
+                {% else %}
+                  <span class="badge bg-warning-subtle text-warning-emphasis">{{ violation.rule_label }}</span>
+                {% endif %}
+              </td>
               <td class="text-body-secondary small">{{ violation.rule_description }}</td>
-              <td>
+              <td class="text-end">
                 <a href="{{ product_url }}?inventory-policy_rule={{ violation.rule_type }}#inventory"
                    class="text-decoration-none">
                   {{ violation.violation_count }}
                 </a>
               </td>
-              <td class="text-body-tertiary small">{{ violation.detected_date|date:"N j, Y" }}</td>
+              <td class="text-end text-body-tertiary small text-nowrap">{{ violation.detected_date|date:"N j, Y" }}</td>
             </tr>
             {% endfor %}
           </tbody>
         </table>
       </div>
     </div>
   </div>
+
+  {# Hidden popover content -- not data-bs-toggle so the global init doesn't conflict #}
+  <div id="rules-overview-content" class="d-none">
+    {% for rule in all_rules %}
+      <div class="d-flex align-items-center justify-content-between {% if not forloop.last %}mb-2{% endif %}">
+        <span class="small me-3">{{ rule.label }}</span>
+        {% if not rule.is_active %}
+          <span class="badge text-bg-secondary">{% trans "Disabled" %}</span>
+        {% elif rule.is_violated %}
+          {% if rule.severity == "error" %}
+            <span class="badge bg-danger-subtle text-danger-emphasis">{% trans "Triggered" %}</span>
+          {% else %}
+            <span class="badge bg-warning-subtle text-warning-emphasis">{% trans "Triggered" %}</span>
+          {% endif %}
+        {% else %}
+          <span class="badge bg-success-subtle text-success-emphasis">{% trans "OK" %}</span>
+        {% endif %}
+      </div>
+    {% endfor %}
+  </div>
+  <script>
+    (function () {
+      const btn = document.getElementById("rules-overview-btn");
+      const content = document.getElementById("rules-overview-content");
+      const popover = new bootstrap.Popover(btn, {
+        html: true,
+        container: "body",
+        placement: "right",
+        trigger: "click",
+        title: "{% trans 'Active rules' %}",
+        content: content.innerHTML,
+      });
+      document.addEventListener("click", function (event) {
+        if (!btn.contains(event.target)) popover.hide();
+      });
+    })();
+  </script>
 {% endif %}
 
 <div class="row g-4 mb-4">

product_portfolio/views.py

@@ -143,6 +143,8 @@
 from product_portfolio.models import ScanCodeProject
 from product_portfolio.tasks import improve_packages_from_purldb_task
 from product_portfolio.tasks import pull_project_data_from_scancodeio_task
+from policy.engine import get_effective_config
+from policy.rules import RULE_REGISTRY
 from vulnerabilities.forms import VulnerabilityAnalysisForm
 from vulnerabilities.models import AffectedByVulnerabilityMixin
 from vulnerabilities.models import Vulnerability
@@ -2849,9 +2851,21 @@ def get_license_compliance_context(licenses, distribution_limit=10):
     @staticmethod
     def get_policy_compliance_context(product):
         policy_violations = product.policy_violations.filter(resolved=False).order_by("rule_type")
+        violated_rule_types = {violation.rule_type for violation in policy_violations}
+        all_rules = [
+            {
+                "label": handler.label,
+                "rule_type": rule_type,
+                "severity": handler.severity,
+                "is_active": get_effective_config(rule_type, product.dataspace)["is_active"],
+                "is_violated": rule_type in violated_rule_types,
+            }
+            for rule_type, handler in RULE_REGISTRY.items()
+        ]
         return {
             "policy_violations": policy_violations,
             "policy_violation_count": policy_violations.count(),
+            "all_rules": all_rules,
         }
 
     @staticmethod