feat: [AAP-22893] add filtering by activation instance name to audit rules list view

Author: Dostonbek1

poetry.lock

@@ -41,12 +41,13 @@ cryptography = ">=42,<43"
 kubernetes = "26.1.*"
 podman = "4.9.*"
 rq-scheduler = "^0.10"
-django-ansible-base = { git = "https://github.com/ansible/django-ansible-base.git", branch = "devel", extras = [
+django-ansible-base = { git = "https://github.com/ansible/django-ansible-base.git", tag = "2024.12.13", extras = [
     "channel-auth",
     "rbac",
     "redis-client",
     "resource-registry",
     "jwt-consumer",
+    "rest-filters",
 ] }
 jinja2 = ">=3.1.3,<3.2"
 django-split-settings = "^1.2.0"

pyproject.toml

@@ -24,7 +24,6 @@
 )
 from rest_framework import status, viewsets
 from rest_framework.decorators import action
-from rest_framework.filters import OrderingFilter
 from rest_framework.response import Response
 
 from aap_eda.api import exceptions as api_exc, filters, serializers
@@ -152,15 +151,6 @@ class AuditRuleViewSet(
     viewsets.ReadOnlyModelViewSet,
 ):
     queryset = models.AuditRule.objects.all()
-    filter_backends = (defaultfilters.DjangoFilterBackend, OrderingFilter)
-    filterset_class = filters.AuditRuleFilter
-    ordering_fields = [
-        "id",
-        "name",
-        "status",
-        "activation_instance__name",
-        "fired_at",
-    ]
 
     def filter_queryset(self, queryset):
         if queryset.model is models.AuditRule:
@@ -200,13 +190,6 @@ def get_serializer_class(self):
     @action(
         detail=False,
         queryset=models.AuditAction.objects.order_by("id"),
-        filterset_class=filters.AuditRuleActionFilter,
-        ordering_fields=[
-            "name",
-            "status",
-            "url",
-            "fired_at",
-        ],
         rbac_action=Action.READ,
         url_path="(?P<id>[^/.]+)/actions",
     )
@@ -243,12 +226,6 @@ def actions(self, _request, id):
     @action(
         detail=False,
         queryset=models.AuditEvent.objects.order_by("-received_at"),
-        filterset_class=filters.AuditRuleEventFilter,
-        ordering_fields=[
-            "source_name",
-            "source_type",
-            "received_at",
-        ],
         rbac_action=Action.READ,
         url_path="(?P<id>[^/.]+)/events",
     )

src/aap_eda/api/views/rulebook.py

@@ -194,6 +194,7 @@ def _get_boolean(name: str, default=False) -> bool:
     "ansible_base.rbac",
     "ansible_base.resource_registry",
     "ansible_base.jwt_consumer",
+    "ansible_base.rest_filters",
     # Local apps
     "aap_eda.api",
     "aap_eda.core",

src/aap_eda/settings/default.py

@@ -302,7 +302,7 @@ def test_list_audit_rules_ordering(
     ordering_field,
 ):
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/?ordering={ordering_field}"
+        f"{api_url_v1}/audit-rules/?order={ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
     audit_rules = response.data["results"]
@@ -312,7 +312,7 @@ def test_list_audit_rules_ordering(
     )
 
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/?ordering=-{ordering_field}"
+        f"{api_url_v1}/audit-rules/?order=-{ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
     audit_rules = response.data["results"]
@@ -330,7 +330,7 @@ def test_list_audit_rules_ordering_activation_name(
 ):
     ordering_field = "activation_instance__name"
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/?ordering={ordering_field}"
+        f"{api_url_v1}/audit-rules/?order={ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
     audit_rules = response.data["results"]
@@ -341,7 +341,7 @@ def test_list_audit_rules_ordering_activation_name(
     )
 
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/?ordering=-{ordering_field}"
+        f"{api_url_v1}/audit-rules/?order=-{ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
     audit_rules = response.data["results"]
@@ -352,6 +352,34 @@ def test_list_audit_rules_ordering_activation_name(
     )
 
 
+@pytest.mark.django_db
+def test_list_audit_rules_filter_activation_instance_name(
+    audit_rule_1: models.AuditRule,
+    audit_rule_2: models.AuditRule,
+    admin_client: APIClient,
+):
+    filter_name = audit_rule_1.activation_instance.name
+    response = admin_client.get(
+        f"{api_url_v1}/audit-rules/?activation_instance__name={filter_name}"
+    )
+    assert response.status_code == status.HTTP_200_OK
+    audit_rules = response.data["results"]
+
+    assert len(audit_rules) == 1
+    assert (
+        audit_rules[0]["activation_instance"]["name"]
+        == audit_rule_1.activation_instance.name
+    )
+    assert list(audit_rules[0]) == [
+        "id",
+        "name",
+        "status",
+        "activation_instance",
+        "organization",
+        "fired_at",
+    ]
+
+
 @pytest.mark.django_db
 def test_retrieve_audit_rule(
     audit_rule_1: models.AuditRule, admin_client: APIClient
@@ -426,7 +454,7 @@ def test_list_actions_from_audit_rule_ordering(
     ordering_field,
 ):
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/actions/?ordering="
+        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/actions/?order="
         f"{ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
@@ -437,7 +465,7 @@ def test_list_actions_from_audit_rule_ordering(
     )
 
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/actions/?ordering="
+        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/actions/?order="
         f"-{ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
@@ -495,7 +523,7 @@ def test_list_events_from_audit_rule_ordering(
     ordering_field,
 ):
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/events/?ordering="
+        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/events/?order="
         f"{ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK
@@ -504,7 +532,7 @@ def test_list_events_from_audit_rule_ordering(
     assert events[0][ordering_field] == getattr(audit_event_2, ordering_field)
 
     response = admin_client.get(
-        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/events/?ordering="
+        f"{api_url_v1}/audit-rules/{audit_rule_2.id}/events/?order="
         f"-{ordering_field}"
     )
     assert response.status_code == status.HTTP_200_OK