[AAP-18613] Add message attribute to AuditAction (#543)

Author: hsong-rh

src/aap_eda/api/serializers/rulebook.py

@@ -335,6 +335,12 @@ class AuditActionSerializer(serializers.ModelSerializer):
         help_text="The fired timestamp of the action",
     )
 
+    status_message = serializers.CharField(
+        required=False,
+        allow_null=True,
+        help_text="Message of the action",
+    )
+
     class Meta:
         model = models.AuditAction
         fields = [
@@ -345,6 +351,7 @@ class Meta:
             "fired_at",
             "rule_fired_at",
             "audit_rule_id",
+            "status_message",
         ]
         read_only_fields = ["id"]
 

src/aap_eda/core/migrations/0013_auditaction_status_message.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.7 on 2023-12-12 21:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0012_activation_latest_instance_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="auditaction",
+            name="status_message",
+            field=models.TextField(default=None, null=True),
+        ),
+    ]

src/aap_eda/core/models/rulebook.py

@@ -102,6 +102,7 @@ class Meta:
     url = models.URLField(blank=True)
     fired_at = models.DateTimeField()
     rule_fired_at = models.DateTimeField(null=True)
+    status_message = models.TextField(null=True, default=None)
 
     audit_rule = models.ForeignKey(
         "AuditRule", on_delete=models.CASCADE, null=True

src/aap_eda/wsapi/consumers.py

@@ -249,6 +249,7 @@ def insert_audit_rule_data(self, message: ActionMessage) -> None:
                 status=message.status,
                 rule_fired_at=message.rule_run_at,
                 audit_rule_id=audit_rule.id,
+                status_message=message.message,
             )
 
             logger.info(f"Audit action [{audit_action.name}] is created.")

tests/integration/api/test_rulebook.py

@@ -486,6 +486,7 @@ def test_list_actions_from_audit_rule_filter_name(client: APIClient, init_db):
         "fired_at",
         "rule_fired_at",
         "audit_rule_id",
+        "status_message",
     ]
 
 

tests/integration/wsapi/test_consumer.py

@@ -547,6 +547,7 @@ def create_action_payload(
         "rule_run_at": rule_run_at,
         "matching_events": matching_events,
         "status": action_status,
+        "message": "Action run successfully",
     }