Add v2 APIs for Farm

We have added several APIs for interacting with Farm, as well as Farm's hosts.

Author: hoangpn

promgen/filters.py

@@ -23,8 +23,17 @@ class RuleFilter(django_filters.rest_framework.FilterSet):
 
 
 class FarmFilter(django_filters.rest_framework.FilterSet):
-    name = django_filters.CharFilter(field_name="name", lookup_expr="contains")
-    source = django_filters.CharFilter(field_name="source", lookup_expr="exact")
+    name = django_filters.CharFilter(
+        field_name="name",
+        lookup_expr="contains",
+        help_text="Filter by farm name containing a specific substring. Example: name=Example Farm",
+    )
+    source = django_filters.ChoiceFilter(
+        field_name="source",
+        choices=[(name, name) for name, _ in models.Farm.driver_set()],
+        lookup_expr="exact",
+        help_text="Filter by exact source name. Example: source=Example Source",
+    )
 
 class UserFilter(django_filters.rest_framework.FilterSet):
     username = django_filters.CharFilter(

promgen/fixtures/testcases.yaml

@@ -53,6 +53,11 @@
   fields:
     name: test-farm
     source: promgen
+- model: promgen.farm
+  pk: 2
+  fields:
+    name: other-farm
+    source: external
 - model: promgen.project
   pk: 1
   fields:
@@ -69,6 +74,11 @@
     service: 1
     shard: 1
     farm: 1
+- model: promgen.host
+  pk: 1
+  fields:
+    name: example.com
+    farm: 1
 - model: promgen.exporter
   pk: 1
   fields:

promgen/rest_v2.py

@@ -173,3 +173,85 @@ class RuleViewSet(
     lookup_value_regex = "[^/]+"
     lookup_field = "id"
     pagination_class = PromgenPagination
+
+
+@extend_schema_view(
+    list=extend_schema(summary="List Farms", description="Retrieve a list of all farms."),
+    retrieve=extend_schema(
+        summary="Retrieve Farm", description="Retrieve detailed information about a specific farm."
+    ),
+    create=extend_schema(summary="Create Farm", description="Create a new farm."),
+    update=extend_schema(summary="Update Farm", description="Update an existing farm."),
+    partial_update=extend_schema(
+        summary="Partially Update Farm", description="Partially update an existing farm."
+    ),
+    destroy=extend_schema(summary="Delete Farm", description="Delete an existing farm."),
+)
+@extend_schema(tags=["Farm"])
+class FarmViewSet(viewsets.ModelViewSet):
+    queryset = models.Farm.objects.all()
+    filterset_class = filters.FarmFilter
+    serializer_class = serializers.FarmRetrieveSerializer
+    lookup_value_regex = "[^/]+"
+    lookup_field = "id"
+    pagination_class = PromgenPagination
+
+    @extend_schema(
+        summary="List Hosts in Farm",
+        description="Retrieve all hosts associated with the specified farm.",
+        parameters=[
+            OpenApiParameter(name="page_number", required=False, type=int),
+            OpenApiParameter(name="page_size", required=False, type=int),
+        ],
+    )
+    @action(detail=True, methods=["get"])
+    def hosts(self, request, id):
+        farm = self.get_object()
+        hosts = farm.host_set.all()
+        page = self.paginate_queryset(hosts)
+        return self.get_paginated_response(serializers.HostRetrieveSerializer(page, many=True).data)
+
+    @extend_schema(
+        summary="List Projects in Farm",
+        description="Retrieve all projects associated with the specified farm.",
+        parameters=[
+            OpenApiParameter(name="page_number", required=False, type=int),
+            OpenApiParameter(name="page_size", required=False, type=int),
+        ],
+    )
+    @action(detail=True, methods=["get"])
+    def projects(self, request, id):
+        farm = self.get_object()
+        projects = farm.project_set.all()
+        page = self.paginate_queryset(projects)
+        return self.get_paginated_response(
+            serializers.ProjectRetrieveSerializer(page, many=True).data
+        )
+
+    @extend_schema(
+        summary="Register Hosts",
+        description="Register new hosts for the specified farm.",
+        request=serializers.HostListSerializer,
+        responses=serializers.HostRetrieveSerializer(many=True),
+    )
+    @action(detail=True, methods=["post"], url_path="hosts/register", pagination_class=None)
+    def register_host(self, request, id):
+        farm = self.get_object()
+        hostnames = request.data.get("hosts", [])
+        for hostname in hostnames:
+            models.Host.objects.get_or_create(name=hostname, farm_id=farm.id)
+        return Response(serializers.HostRetrieveSerializer(farm.host_set, many=True).data)
+
+    @extend_schema(
+        summary="Delete Hosts",
+        description="Delete hosts from the specified farm.",
+        request=serializers.HostListSerializer,
+        responses=serializers.HostRetrieveSerializer(many=True),
+    )
+    @action(detail=True, methods=["post"], url_path="hosts/delete", pagination_class=None)
+    def delete_host(self, request, id):
+        farm = self.get_object()
+        hostnames = request.data.get("hosts", [])
+        for hostname in hostnames:
+            farm.host_set.filter(name=hostname).delete()
+        return Response(serializers.HostRetrieveSerializer(farm.host_set, many=True).data)

promgen/serializers.py

@@ -214,3 +214,21 @@ class RuleSerializer(serializers.ModelSerializer):
     class Meta:
         model = models.Rule
         exclude = ("object_id",)
+
+
+class HostRetrieveSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = models.Host
+        fields = "__all__"
+
+
+class FarmRetrieveSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = models.Farm
+        fields = "__all__"
+
+
+class HostListSerializer(serializers.Serializer):
+    hosts = serializers.ListField(
+        child=serializers.CharField(), help_text="List of hostnames to add."
+    )

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

@@ -0,0 +1,5 @@
+{
+  "id": 3,
+  "name": "new-farm",
+  "source": "promgen"
+}

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

@@ -0,0 +1,17 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 2,
+      "name": "other-farm",
+      "source": "external"
+    },
+    {
+      "id": 1,
+      "name": "test-farm",
+      "source": "promgen"
+    }
+  ]
+}

promgen/tests/examples/rest.farm.delete_hosts.json

@@ -0,0 +1,12 @@
+[
+  {
+    "farm": 1,
+    "id": 1,
+    "name": "example.com"
+  },
+  {
+    "farm": 1,
+    "id": 2,
+    "name": "new-host"
+  }
+]

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

@@ -0,0 +1,5 @@
+{
+  "id": 1,
+  "name": "test-farm",
+  "source": "promgen"
+}

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

@@ -0,0 +1,12 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 1,
+      "name": "test-farm",
+      "source": "promgen"
+    }
+  ]
+}

promgen/tests/examples/rest.farm.filter_by_source.json

@@ -0,0 +1,12 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 1,
+      "name": "test-farm",
+      "source": "promgen"
+    }
+  ]
+}

promgen/tests/examples/rest.farm.hosts.json

@@ -0,0 +1,12 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "farm": 1,
+      "id": 1,
+      "name": "example.com"
+    }
+  ]
+}

promgen/tests/examples/rest.farm.json

@@ -0,0 +1,12 @@
+{
+  "count": 2,
+  "next": "http://testserver/rest/v2/farms/?page_number=2&page_size=1",
+  "previous": null,
+  "results": [
+    {
+      "id": 2,
+      "name": "other-farm",
+      "source": "external"
+    }
+  ]
+}

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

@@ -0,0 +1,5 @@
+{
+  "id": 1,
+  "name": "new-new-name",
+  "source": "new-source"
+}

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

@@ -0,0 +1,25 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "description": "",
+      "farm": "test-farm",
+      "id": 2,
+      "name": "another-project",
+      "owner": "admin",
+      "service": "test-service",
+      "shard": "test-shard"
+    },
+    {
+      "description": "",
+      "farm": "test-farm",
+      "id": 1,
+      "name": "test-project",
+      "owner": "admin",
+      "service": "test-service",
+      "shard": "test-shard"
+    }
+  ]
+}

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

@@ -0,0 +1,17 @@
+[
+  {
+    "farm": 1,
+    "id": 1,
+    "name": "example.com"
+  },
+  {
+    "farm": 1,
+    "id": 2,
+    "name": "new-host"
+  },
+  {
+    "farm": 1,
+    "id": 3,
+    "name": "new-host-2"
+  }
+]

promgen/tests/examples/rest.farm.register_hosts.json

@@ -0,0 +1,5 @@
+{
+  "id": 1,
+  "name": "new-name",
+  "source": "new-source"
+}

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

@@ -5,8 +5,8 @@
   "source": "promgen",
   "hosts": [
     {
-      "name": "host.example.com",
-      "url": "http://promgen.example.com/host/host.example.com"
+      "name": "example.com",
+      "url": "http://promgen.example.com/host/example.com"
     }
   ]
 }

promgen/tests/examples/rest.farm.1.json renamed to promgen/tests/examples/rest.farm.v1.detail.json

@@ -0,0 +1,8 @@
+[
+  {
+    "id": 1,
+    "name": "test-farm",
+    "source": "promgen",
+    "url": "http://promgen.example.com/farm/1"
+  }
+]

promgen/tests/examples/rest.farm.v1.filter_by_source.json

@@ -0,0 +1,14 @@
+[
+  {
+    "id": 2,
+    "name": "other-farm",
+    "source": "external",
+    "url": "http://promgen.example.com/farm/2"
+  },
+  {
+    "id": 1,
+    "name": "test-farm",
+    "source": "promgen",
+    "url": "http://promgen.example.com/farm/1"
+  }
+]

promgen/tests/examples/rest.farm.v1.json

@@ -21,15 +21,15 @@ def test_newline(self):
             {"hosts": "\naaa.example.com\nbbb.example.com\nccc.example.com \n"},
             follow=False,
         )
-        self.assertCount(models.Host, 3, "Expected 3 hosts")
+        self.assertCount(models.Host, 4, "Expected 4 hosts (Fixture has one host)")
 
     def test_comma(self):
         self.client.post(
             reverse("hosts-add", args=[1]),
             {"hosts": ",,aaa.example.com, bbb.example.com,ccc.example.com,"},
             follow=False,
         )
-        self.assertCount(models.Host, 3, "Expected 3 hosts")
+        self.assertCount(models.Host, 4, "Expected 4 hosts (Fixture has one host)")
 
     # Within our new host code, the hosts are split (by newline or comma) and then
     # individually tested. Here we will test our validator on specific entries that