display policy violation in views

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

Author: tdruez

policy/models.py

@@ -20,6 +20,7 @@
 from dje.models import DataspacedModel
 from dje.models import DataspacedQuerySet
 from dje.models import colored_icon_mixin_factory
+from policy.rules import RULE_REGISTRY
 
 ColoredIconMixin = colored_icon_mixin_factory(
     verbose_name="usage policy",
@@ -286,6 +287,16 @@ class Meta:
     def __str__(self):
         return self.name
 
+    @property
+    def rule_label(self):
+        handler = RULE_REGISTRY.get(self.rule_type)
+        return handler.label if handler else self.rule_type
+
+    @property
+    def rule_description(self):
+        handler = RULE_REGISTRY.get(self.rule_type)
+        return handler.description if handler else ""
+
 
 class AbstractPolicyViolation(models.Model):
     """Shared fields for all concrete policy violation models. No DB table."""

product_portfolio/admin.py

@@ -384,7 +384,7 @@ class ProductAdmin(
         ProductPackageInline,
     ]
     form = ProductAdminForm
-    actions = []
+    actions = ["evaluate_policy_rules"]
     actions_to_remove = ["copy_to", "compare_with", "delete_selected"]
     navigation_buttons = True
     activity_log = False
@@ -395,6 +395,16 @@ class ProductAdmin(
     awesomplete_data = {"primary_language": PROGRAMMING_LANGUAGES}
     readonly_fields = DataspacedAdmin.readonly_fields + ("get_feature_datalist",)
 
+    def evaluate_policy_rules(self, request, queryset):
+        from policy.tasks import evaluate_product_rules_task
+
+        count = queryset.count()
+        for product in queryset:
+            evaluate_product_rules_task.delay(product_uuid=product.uuid)
+        self.message_user(request, f"Policy rules evaluation enqueued for {count} product(s).")
+
+    evaluate_policy_rules.short_description = _("Evaluate policy rules")
+
     def get_feature_datalist(self, obj):
         if obj.pk:
             return obj.get_feature_datalist()

product_portfolio/models.py

@@ -24,6 +24,7 @@
 from django.db.models import Max
 from django.db.models import OuterRef
 from django.db.models import Q
+from django.db.models import Subquery
 from django.db.models import Value
 from django.db.models import When
 from django.db.models.functions import Coalesce
@@ -244,6 +245,15 @@ def with_has_vulnerable_packages(self):
             has_vulnerable_packages=Exists(vulnerable_productpackage_qs),
         )
 
+    def with_policy_violation_count(self):
+        subquery = ProductPolicyViolation.objects.filter(
+            product=OuterRef("pk"),
+            resolved=False,
+        ).values("product").annotate(violation_count=models.Count("id")).values("violation_count")
+        return self.annotate(
+            policy_violation_count=Subquery(subquery, output_field=models.IntegerField()),
+        )
+
 
 class ProductSecuredManager(DataspacedManager):
     """
@@ -426,6 +436,10 @@ def save(self, *args, **kwargs):
         if self.has_changed("configuration_status_id"):
             self.actions_on_status_change()
 
+        from policy.tasks import evaluate_product_rules_task
+
+        evaluate_product_rules_task.delay(product_uuid=self.uuid)
+
     def get_attribution_url(self):
         return self.get_url("attribution")
 

product_portfolio/templates/product_portfolio/compliance/compliance_dashboard.html

@@ -130,6 +130,7 @@ <h1 class="h3 mb-0">
           <th class="fw-medium text-end">{% trans "License compliance" %}</th>
           <th class="fw-medium text-end">{% trans "Security compliance" %}</th>
           <th class="fw-medium text-end">{% trans "Vulnerabilities" %}</th>
+          <th class="fw-medium text-end">{% trans "Policy violations" %}</th>
         </tr>
       </thead>
       <tbody>
@@ -196,11 +197,18 @@ <h1 class="h3 mb-0">
                 <span class="text-body-tertiary small">{% trans "None" %}</span>
               {% endif %}
             </td>
+            <td class="text-end">
+              {% if product.policy_violation_count %}
+                <span class="badge bg-danger-subtle text-danger-emphasis">{{ product.policy_violation_count }}</span>
+              {% else %}
+                <span class="text-body-tertiary small">{% trans "None" %}</span>
+              {% endif %}
+            </td>
           </tr>
         {% endwith %}
         {% empty %}
           <tr>
-            <td colspan="5" class="text-center text-body-tertiary py-4">
+            <td colspan="6" class="text-center text-body-tertiary py-4">
               {% trans "No active products" %}
             </td>
           </tr>

product_portfolio/templates/product_portfolio/compliance/compliance_panels.html

@@ -214,4 +214,42 @@ <h3 class="fs-6 fw-medium mb-0">{% trans "Security compliance" %}</h3>
       {% endif %}
     </div>
   </div>
-</div>
+</div>
+
+{% if policy_violations %}
+  <div class="row g-4 mb-4">
+    <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>
+          <span class="badge bg-danger-subtle text-danger-emphasis">
+            {{ policy_violation_count }} {% trans "active" %}
+          </span>
+        </div>
+        <table class="table table-sm 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>
+            </tr>
+          </thead>
+          <tbody>
+            {% for violation in policy_violations %}
+            <tr>
+              <td>
+                <div>{{ violation.policy_rule.name }}</div>
+                <div class="text-body-secondary small">{{ violation.policy_rule.rule_label }}</div>
+              </td>
+              <td class="text-body-secondary small">{{ violation.policy_rule.rule_description }}</td>
+              <td>{{ violation.violation_count }}</td>
+              <td class="text-body-tertiary small">{{ violation.detected_date|date:"N j, Y" }}</td>
+            </tr>
+            {% endfor %}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+{% endif %}

product_portfolio/templates/product_portfolio/compliance/metric_cards.html

@@ -1,6 +1,6 @@
 {% load i18n humanize %}
 <div class="row g-3 mb-4">
-  <div class="col-6 col-md-3">
+  <div class="col-6 col-md">
     <div class="bg-body-secondary rounded-3 p-3">
       <div class="small text-body-secondary mb-1">{% trans "Total packages" %}</div>
       <div class="fs-4 fw-medium lh-sm">{{ total_packages|intcomma }}</div>
@@ -15,7 +15,7 @@
       </div>
     </div>
   </div>
-  <div class="col-6 col-md-3">
+  <div class="col-6 col-md">
     <div class="bg-body-secondary rounded-3 p-3">
       <div class="small text-body-secondary mb-1">{% trans "License compliance" %}</div>
       <div class="fs-4 fw-medium lh-sm {% if license_compliance_pct == 100 %}text-success{% elif license_compliance_pct >= 90 %}text-warning-orange{% else %}text-danger{% endif %}">
@@ -32,7 +32,7 @@
       </div>
     </div>
   </div>
-  <div class="col-6 col-md-3">
+  <div class="col-6 col-md">
     <div class="bg-body-secondary rounded-3 p-3">
       <div class="small text-body-secondary mb-1">{% trans "License coverage" %}</div>
       <div class="fs-4 fw-medium lh-sm {% if license_coverage_pct == 100 %}text-success{% elif license_coverage_pct >= 90 %}text-warning-orange{% else %}text-danger{% endif %}">
@@ -49,7 +49,7 @@
       </div>
     </div>
   </div>
-  <div class="col-6 col-md-3">
+  <div class="col-6 col-md">
     <div class="bg-body-secondary rounded-3 p-3">
       <div class="small text-body-secondary mb-1">{% trans "Vulnerabilities" %}</div>
       {% if vulnerability_count == 0 %}
@@ -75,4 +75,18 @@
       {% endif %}
     </div>
   </div>
+  <div class="col-6 col-md">
+    <div class="bg-body-secondary rounded-3 p-3">
+      <div class="small text-body-secondary mb-1">{% trans "Policy violations" %}</div>
+      {% if policy_violation_count == 0 %}
+        <div class="fs-4 fw-medium lh-sm text-success">0</div>
+        <div class="text-body-tertiary fs-xs mt-1">{% trans "No active violations" %}</div>
+      {% else %}
+        <div class="fs-4 fw-medium lh-sm text-danger">{{ policy_violation_count }}</div>
+        <div class="text-body-tertiary fs-xs mt-1">
+          {{ policy_violation_count }} {% trans "rule" %}{{ policy_violation_count|pluralize }} {% trans "triggered" %}
+        </div>
+      {% endif %}
+    </div>
+  </div>
 </div>

product_portfolio/views.py

@@ -2772,6 +2772,7 @@ def get_context_data(self, **kwargs):
                 **self.get_package_compliance_context(productpackages),
                 **self.get_license_compliance_context(licenses),
                 **self.get_security_compliance_context(product),
+                **self.get_policy_compliance_context(product),
             }
         )
 
@@ -2842,6 +2843,17 @@ def get_license_compliance_context(licenses, distribution_limit=10):
             "remaining_license_count": max(0, len(license_distribution) - distribution_limit),
         }
 
+    @staticmethod
+    @staticmethod
+    def get_policy_compliance_context(product):
+        policy_violations = (
+            product.policy_violations.filter(resolved=False).select_related("policy_rule")
+        )
+        return {
+            "policy_violations": policy_violations,
+            "policy_violation_count": policy_violations.count(),
+        }
+
     @staticmethod
     def get_security_compliance_context(product, display_limit=10):
         risk_threshold = product.get_vulnerabilities_risk_threshold()
@@ -3057,6 +3069,7 @@ def get_queryset(self):
             .with_compliance_data()
             .with_max_risk_level()
             .with_has_vulnerable_packages()
+            .with_policy_violation_count()
         )
 
     def get_context_data(self, **kwargs):