fire event

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

Author: tdruez

policy/admin.py

@@ -185,8 +185,9 @@ class PolicyRuleAdmin(DataspacedAdmin):
         "When the number of detected issues exceeds the configured threshold, a "
         "ProductPolicyViolation is recorded and an optional notification event is fired.\n"
         "Set the rule type to match a registered evaluation handler, configure the "
-        "threshold (0 means any violation triggers the rule), and provide an event name "
-        "to send a webhook notification when violations are detected or resolved."
+        "threshold (0 means any violation triggers the rule), and select a notification "
+        "event to dispatch alerts across all registered channels when violations are "
+        "detected or resolved."
     )
 
     def parameters_schema_hint(self, obj):

policy/engine.py

@@ -8,7 +8,7 @@
 
 from django.utils import timezone
 
-from notification.models import fire_webhooks
+from policy.events import fire_event
 from policy.models import PolicyRule
 from policy.rules import RULE_REGISTRY
 from product_portfolio.models import ProductPolicyViolation
@@ -65,11 +65,10 @@ def evaluate_rules(product):
 
 
 def fire_violation_event(policy_rule, product, violation_count):
-    fire_webhooks(
+    fire_event(
         policy_rule.event_name,
-        instance=None,
         dataspace=policy_rule.dataspace,
-        payload_override={
+        payload={
             "rule": policy_rule.name,
             "rule_type": policy_rule.rule_type,
             "violation_count": violation_count,
@@ -79,11 +78,10 @@ def fire_violation_event(policy_rule, product, violation_count):
 
 
 def fire_resolution_event(policy_rule, product):
-    fire_webhooks(
+    fire_event(
         policy_rule.event_name,
-        instance=None,
         dataspace=policy_rule.dataspace,
-        payload_override={
+        payload={
             "rule": policy_rule.name,
             "status": "resolved",
             "product": str(product),

policy/events.py

@@ -0,0 +1,20 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# DejaCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: AGPL-3.0-only
+# See https://github.com/aboutcode-org/dejacode for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
+
+from notification.models import fire_webhooks
+
+POLICY_EVENTS = {
+    "policy.license_alert": "License-related policy rule violation detected or resolved.",
+    "policy.security_alert": "Security-related policy rule violation detected or resolved.",
+    "policy.compliance_alert": "Any policy rule violation detected or resolved.",
+}
+
+
+def fire_event(event_name, dataspace, payload):
+    """Dispatch a policy event to all registered notification channels."""
+    fire_webhooks(event_name, instance=None, dataspace=dataspace, payload_override=payload)

policy/forms.py

@@ -8,9 +8,11 @@
 
 from django import forms
 from django.contrib.contenttypes.models import ContentType
+from django.db.models import BLANK_CHOICE_DASH
 
 from dje.forms import ColorCodeFormMixin
 from dje.forms import DataspacedAdminForm
+from policy.events import POLICY_EVENTS
 from policy.models import PolicyRule
 from policy.rules import RULE_REGISTRY
 
@@ -106,9 +108,18 @@ def __init__(self, *args, **kwargs):
         self.fields["rule_type"].widget = forms.Select(
             choices=[(key, handler.label) for key, handler in RULE_REGISTRY.items()]
         )
+        self.fields["event_name"].widget = forms.Select(
+            choices=BLANK_CHOICE_DASH + list(POLICY_EVENTS.items())
+        )
 
     def clean_rule_type(self):
         value = self.cleaned_data["rule_type"]
         if value not in RULE_REGISTRY:
             raise forms.ValidationError(f"Unknown rule type: {value}")
         return value
+
+    def clean_event_name(self):
+        value = self.cleaned_data.get("event_name")
+        if value and value not in POLICY_EVENTS:
+            raise forms.ValidationError(f"Unknown event: {value}")
+        return value