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

@@ -216,3 +216,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

@@ -543,3 +543,79 @@ def delete_exporter(self, request, id, exporter_id):
         project = self.get_object()
         models.Exporter.objects.filter(project=project, pk=exporter_id).delete()
         return Response(status=HTTPStatus.NO_CONTENT)
+
+
+@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.ServiceV2Serializer
+        if self.action == "retrieve":
+            return serializers.ServiceV2Serializer
+        if self.action == "create":
+            return serializers.ServiceV2Serializer
+        if self.action == "update":
+            return serializers.ServiceUpdateSerializer
+        if self.action == "partial_update":
+            return serializers.ServiceUpdateSerializer
+        return serializers.ServiceV2Serializer
+
+    @extend_schema(
+        summary="List Projects",
+        description="Retrieve all projects associated with the specified service.",
+        responses=serializers.ProjectV2Serializer(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.ProjectV2Serializer(service.project_set.all(), many=True).data
+        )
+
+    @extend_schema(
+        summary="Register Project",
+        description="Register a new project for the specified service.",
+        request=serializers.ProjectUpdateSerializer,
+        responses={201: serializers.ProjectV2Serializer},
+    )
+    @projects.mapping.post
+    def register_project(self, request, id):
+        serializer = serializers.ProjectUpdateSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        service = self.get_object()
+
+        attributes = {"service": service}
+
+        for field in serializer.fields:
+            value = serializer.validated_data.get(field)
+            if value is not None:
+                attributes[field] = value
+
+        project, _ = models.Project.objects.get_or_create(**attributes)
+        return Response(
+            serializers.ProjectV2Serializer(project).data, status=HTTPStatus.CREATED
+        )

promgen/serializers.py

@@ -389,3 +389,23 @@ class RegisterNotifierSerializer(serializers.Serializer):
     alias = serializers.CharField(required=False)
     enabled = serializers.BooleanField(required=False, default=True)
     filters = FilterSerializer(many=True, required=False)
+
+
+class ServiceV2Serializer(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]"
+  }
+]