Add v2 APIs for Service

We have added several APIs to help users easily manage Services
and objects related to each service, includes notifiers and rules.

Author: hoangpn

promgen/filters.py

@@ -214,3 +214,16 @@ class ProjectFilterV2(django_filters.rest_framework.FilterSet):
         lookup_expr="exact",
         help_text="Filter by exact owner username. Example: owner=Example Owner",
     )
+
+
+class ServiceFilterV2(django_filters.rest_framework.FilterSet):
+    name = django_filters.CharFilter(
+        field_name="name",
+        lookup_expr="contains",
+        help_text="Filter by service name containing a specific substring. Example: name=Example Service",
+    )
+    owner = django_filters.CharFilter(
+        field_name="owner__username",
+        lookup_expr="exact",
+        help_text="Filter by exact owner username. Example: owner=Example Owner",
+    )

promgen/fixtures/testcases.yaml

@@ -47,7 +47,7 @@
   pk: 2
   fields:
     name: other-service
-    owner: 1
+    owner: 2
 - model: promgen.farm
   pk: 1
   fields:

promgen/rest_v2.py

@@ -595,3 +595,105 @@ def register_rule(self, request, id):
 
         rule, _ = models.Rule.objects.get_or_create(**attributes)
         return Response(serializers.RuleSerializer(project.rule_set, many=True).data)
+
+
+@extend_schema_view(
+    list=extend_schema(
+        summary="List Services",
+        description="Retrieve a list of all services.",
+    ),
+    retrieve=extend_schema(
+        summary="Retrieve Service",
+        description="Retrieve detailed information about a specific service.",
+    ),
+    create=extend_schema(summary="Create Service", description="Create a new service."),
+    update=extend_schema(summary="Update Service", description="Update an existing service."),
+    partial_update=extend_schema(
+        summary="Partially Update Service", description="Partially update an existing service."
+    ),
+    destroy=extend_schema(summary="Delete Service", description="Delete an existing service."),
+)
+@extend_schema(tags=["Service"])
+class ServiceViewSet(NotifierMixin, RuleMixin, viewsets.ModelViewSet):
+    model = "Service"
+    queryset = models.Service.objects.all()
+    filterset_class = filters.ServiceFilterV2
+    serializer_class = serializers.ServiceSerializer
+    lookup_value_regex = "[^/]+"
+    lookup_field = "id"
+    pagination_class = PromgenPagination
+
+    def get_serializer_class(self):
+        if self.action == "list":
+            return serializers.ServiceRetrieveSerializer
+        if self.action == "retrieve":
+            return serializers.ServiceRetrieveSerializer
+        if self.action == "create":
+            return serializers.ServiceCreateSerializer
+        if self.action == "update":
+            return serializers.ServiceUpdateSerializer
+        if self.action == "partial_update":
+            return serializers.ServiceUpdateSerializer
+        return None
+
+    @extend_schema(
+        summary="List Projects",
+        description="Retrieve all projects associated with the specified service.",
+        responses=serializers.ProjectSerializer(many=True),
+    )
+    @action(detail=True, methods=["get"], pagination_class=None, filterset_class=None)
+    def projects(self, request, id):
+        service = self.get_object()
+        return Response(serializers.ProjectSerializer(service.project_set.all(), many=True).data)
+
+    @extend_schema(
+        summary="Register Notifier",
+        description="Register a new notifier for the specified service.",
+        request=serializers.RegisterNotifierSerializer,
+        responses=serializers.NotifierSerializer(many=True),
+    )
+    @action(detail=True, methods=["post"], url_path="notifiers/register")
+    def register_notifier(self, request, id):
+        serializer = serializers.RegisterNotifierSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        service = self.get_object()
+
+        attributes = {
+            "content_type_id": get_content_type_for_model(models.Service).id,
+            "object_id": service.id,
+        }
+
+        for field in serializer.fields:
+            value = serializer.validated_data.get(field)
+            if value is not None and field != "filters":
+                attributes[field] = value
+
+        notifier, _ = models.Sender.objects.get_or_create(**attributes)
+        for filter_data in serializer.validated_data.get("filters", []):
+            models.Filter.objects.get_or_create(sender=notifier, **filter_data)
+        return Response(serializers.NotifierSerializer(service.notifiers, many=True).data)
+
+    @extend_schema(
+        summary="Register Rule",
+        description="Register a new rule for the specified service.",
+        request=serializers.RuleSerializer,
+        responses=serializers.RuleSerializer(many=True),
+    )
+    @action(detail=True, methods=["post"], url_path="rules/register")
+    def register_rule(self, request, id):
+        serializer = serializers.RuleSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        service = self.get_object()
+
+        attributes = {
+            "content_type_id": get_content_type_for_model(models.Service).id,
+            "object_id": service.id,
+        }
+
+        for field in serializer.fields:
+            value = serializer.validated_data.get(field)
+            if value is not None:
+                attributes[field] = value
+
+        rule, _ = models.Rule.objects.get_or_create(**attributes)
+        return Response(serializers.RuleSerializer(service.rule_set, many=True).data)

promgen/serializers.py

@@ -362,3 +362,31 @@ class RegisterNotifierSerializer(serializers.Serializer):
     alias = serializers.CharField(required=False)
     enabled = serializers.BooleanField(required=False, default=True)
     filters = FilterSerializer(many=True, required=False)
+
+
+class ServiceRetrieveSerializer(serializers.ModelSerializer):
+    owner = serializers.ReadOnlyField(source="owner.username")
+
+    class Meta:
+        model = models.Service
+        fields = "__all__"
+
+
+class ServiceCreateSerializer(serializers.ModelSerializer):
+    owner = OwnerField(required=False, default=serializers.CurrentUserDefault())
+    id = serializers.ReadOnlyField()
+
+    class Meta:
+        model = models.Service
+        fields = "__all__"
+
+
+class ServiceUpdateSerializer(serializers.ModelSerializer):
+    owner = OwnerField(required=False)
+    name = serializers.CharField(required=False)
+    description = serializers.CharField(required=False)
+    id = serializers.ReadOnlyField()
+
+    class Meta:
+        model = models.Service
+        fields = "__all__"

promgen/tests/examples/rest.service.create.json

@@ -0,0 +1,6 @@
+{
+  "description": "Test New Service Description",
+  "id": 3,
+  "name": "new-service",
+  "owner": "demo"
+}

promgen/tests/examples/rest.service.default.json

@@ -0,0 +1,19 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "description": "",
+      "id": 2,
+      "name": "other-service",
+      "owner": "demo"
+    },
+    {
+      "description": "",
+      "id": 1,
+      "name": "test-service",
+      "owner": "admin"
+    }
+  ]
+}

promgen/tests/examples/rest.service.detail.json

@@ -0,0 +1,6 @@
+{
+  "description": "",
+  "id": 1,
+  "name": "test-service",
+  "owner": "admin"
+}

promgen/tests/examples/rest.service.filter_by_name.json

@@ -0,0 +1,13 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "description": "",
+      "id": 1,
+      "name": "test-service",
+      "owner": "admin"
+    }
+  ]
+}

promgen/tests/examples/rest.service.filter_by_owner.json

@@ -0,0 +1,13 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "description": "",
+      "id": 2,
+      "name": "other-service",
+      "owner": "demo"
+    }
+  ]
+}

promgen/tests/examples/rest.service.notifiers.json

@@ -0,0 +1,13 @@
+[
+  {
+    "alias": "",
+    "content_type": 11,
+    "enabled": true,
+    "id": 1,
+    "label": "[email protected]",
+    "object_id": 1,
+    "owner": "admin",
+    "sender": "promgen.notification.email",
+    "value": "[email protected]"
+  }
+]

promgen/tests/examples/rest.service.paginated.json

@@ -0,0 +1,13 @@
+{
+  "count": 2,
+  "next": "http://testserver/rest/v2/services/?page_number=2&page_size=1",
+  "previous": null,
+  "results": [
+    {
+      "description": "",
+      "id": 2,
+      "name": "other-service",
+      "owner": "demo"
+    }
+  ]
+}

promgen/tests/examples/rest.service.partial_update.json

@@ -0,0 +1,6 @@
+{
+  "description": "Test Updated Description",
+  "id": 1,
+  "name": "partial-updated-service",
+  "owner": "demo"
+}

promgen/tests/examples/rest.service.projects.json

@@ -0,0 +1,9 @@
+[
+  {
+    "description": "",
+    "html": "http://promgen.example.com/project/1",
+    "name": "test-project",
+    "owner": "admin",
+    "service": "test-service"
+  }
+]

promgen/tests/examples/rest.service.register_notifier.json

@@ -0,0 +1,33 @@
+[
+  {
+    "alias": "",
+    "content_name": "partial-updated-service",
+    "content_type": "service",
+    "enabled": true,
+    "filters": [
+      {
+        "name": "severity",
+        "value": "critical"
+      }
+    ],
+    "id": 1,
+    "owner": "admin",
+    "sender": "promgen.notification.email",
+    "value": "[email protected]"
+  },
+  {
+    "alias": "",
+    "content_name": "partial-updated-service",
+    "content_type": "service",
+    "enabled": false,
+    "filters": [
+      {
+        "name": "test-name",
+        "value": "test-value"
+      }
+    ],
+    "id": 6,
+    "sender": "promgen.notification.slack",
+    "value": "https://test.slack.com"
+  }
+]

promgen/tests/examples/rest.service.register_rule.json

@@ -0,0 +1,37 @@
+[
+  {
+    "annotations": {
+      "rule": "http://promgen.example.com/rule/1"
+    },
+    "clause": "up == 0",
+    "content_name": "partial-updated-service",
+    "content_type": "service",
+    "description": "Test Rule Description",
+    "duration": "5m",
+    "enabled": true,
+    "id": 1,
+    "labels": {
+      "severity": "critical"
+    },
+    "name": "Test Rule",
+    "parent": null
+  },
+  {
+    "annotations": {
+      "rule": "http://promgen.example.com/rule/4",
+      "summary": "Test Rule Summary"
+    },
+    "clause": "up == 1",
+    "content_name": "partial-updated-service",
+    "content_type": "service",
+    "description": "Test Rule Description",
+    "duration": "5m",
+    "enabled": false,
+    "id": 4,
+    "labels": {
+      "severity": "critical"
+    },
+    "name": "TestRuleCreated",
+    "parent": null
+  }
+]

promgen/tests/examples/rest.service.rules.json

@@ -0,0 +1,19 @@
+[
+  {
+    "annotations": {
+      "rule": "http://promgen.example.com/rule/1"
+    },
+    "clause": "up == 0",
+    "content_name": "test-service",
+    "content_type": "service",
+    "description": "Test Rule Description",
+    "duration": "5m",
+    "enabled": true,
+    "id": 1,
+    "labels": {
+      "severity": "critical"
+    },
+    "name": "Test Rule",
+    "parent": null
+  }
+]

promgen/tests/examples/rest.service.update.json

@@ -0,0 +1,6 @@
+{
+  "description": "Test Updated Description",
+  "id": 1,
+  "name": "updated-service",
+  "owner": "demo"
+}