Add v2 APIs for Shard

We have added several APIs for retrieving Shard data and the list of projects for each shard.

Author: hoangpn

promgen/fixtures/testcases.yaml

@@ -38,6 +38,13 @@
     url: http://prometheus.example.com
     proxy: true
     enabled: true
+- model: promgen.shard
+  pk: 2
+  fields:
+    name: other-shard
+    url: http://prometheus-002.example.com
+    proxy: false
+    enabled: false
 - model: promgen.service
   pk: 1
   fields:

promgen/rest_v2.py

@@ -607,3 +607,37 @@ def register_project(self, request, id):
         return Response(
             serializers.ProjectRetrieveSerializer(project).data, status=HTTPStatus.CREATED
         )
+
+
+@extend_schema_view(
+    list=extend_schema(summary="List Shards", description="Retrieve a list of all shards."),
+    retrieve=extend_schema(
+        summary="Retrieve Shard",
+        description="Retrieve detailed information about a specific shard.",
+    ),
+)
+@extend_schema(tags=["Shard"])
+class ShardViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, viewsets.GenericViewSet):
+    queryset = models.Shard.objects.all()
+    filterset_class = filters.ShardFilter
+    serializer_class = serializers.ShardRetrieveSerializer
+    lookup_field = "id"
+    pagination_class = PromgenPagination
+
+    @extend_schema(
+        summary="List Projects in Shard",
+        description="Retrieve all projects associated with the specified shard.",
+        parameters=[
+            OpenApiParameter(name="page_number", required=False, type=int),
+            OpenApiParameter(name="page_size", required=False, type=int),
+        ],
+        responses=serializers.ProjectRetrieveSerializer(many=True),
+    )
+    @action(detail=True, methods=["get"], filterset_class=None)
+    def projects(self, request, id):
+        shard = self.get_object()
+        projects = shard.project_set.all()
+        page = self.paginate_queryset(projects)
+        return self.get_paginated_response(
+            serializers.ProjectRetrieveSerializer(page, many=True).data
+        )

promgen/serializers.py

@@ -417,3 +417,9 @@ class ServiceUpdateSerializer(serializers.ModelSerializer):
     class Meta:
         model = models.Service
         fields = "__all__"
+
+
+class ShardRetrieveSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = models.Shard
+        exclude = ("authorization",)

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

@@ -0,0 +1,25 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": false,
+      "id": 2,
+      "name": "other-shard",
+      "proxy": false,
+      "samples": 5000000,
+      "targets": 10000,
+      "url": "http://prometheus-002.example.com"
+    },
+    {
+      "enabled": true,
+      "id": 1,
+      "name": "test-shard",
+      "proxy": true,
+      "samples": 5000000,
+      "targets": 10000,
+      "url": "http://prometheus.example.com"
+    }
+  ]
+}

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

@@ -0,0 +1,9 @@
+{
+  "enabled": true,
+  "id": 1,
+  "name": "test-shard",
+  "proxy": true,
+  "samples": 5000000,
+  "targets": 10000,
+  "url": "http://prometheus.example.com"
+}

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

@@ -0,0 +1,16 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": true,
+      "id": 1,
+      "name": "test-shard",
+      "proxy": true,
+      "samples": 5000000,
+      "targets": 10000,
+      "url": "http://prometheus.example.com"
+    }
+  ]
+}

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

@@ -0,0 +1,16 @@
+{
+  "count": 2,
+  "next": "http://testserver/rest/v2/shards/?page_number=2&page_size=1",
+  "previous": null,
+  "results": [
+    {
+      "enabled": false,
+      "id": 2,
+      "name": "other-shard",
+      "proxy": false,
+      "samples": 5000000,
+      "targets": 10000,
+      "url": "http://prometheus-002.example.com"
+    }
+  ]
+}

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

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

promgen/tests/test_rest.py

@@ -2205,3 +2205,82 @@ def test_rest_service(self):
             HTTP_AUTHORIZATION=f"Token {token}",
         )
         self.assertEqual(response.status_code, 204)
+
+    @override_settings(PROMGEN=tests.SETTINGS)
+    def test_rest_shard(self):
+        token = Token.objects.filter(user__username="demo").first().key
+
+        # Check retrieving shards without token returns 401 Unauthorized
+        response = self.client.get(reverse("api-v2:shard-list"))
+        self.assertEqual(response.status_code, 401)
+
+        # Check retrieving all shards
+        expected = tests.Data("examples", "rest.shard.default.json").json()
+        response = self.client.get(
+            reverse("api-v2:shard-list"),
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving paginated shards
+        expected = tests.Data("examples", "rest.shard.paginated.json").json()
+        response = self.client.get(
+            reverse("api-v2:shard-list"),
+            {"page_number": 1, "page_size": 1},
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving shards whose "name" contains "test"
+        expected = tests.Data("examples", "rest.shard.filter_by_name.json").json()
+        response = self.client.get(
+            reverse("api-v2:shard-list"),
+            {"name": "test"},
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving shards with a non-existent "name" returns an empty list
+        response = self.client.get(
+            reverse("api-v2:shard-list"),
+            {"name": "non-existent"},
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], 0)
+
+        # Check retrieving shards whose "id" is "1" without token returns 401 Unauthorized
+        response = self.client.get(reverse("api-v2:shard-detail", args=[1]))
+        self.assertEqual(response.status_code, 401)
+
+        # Check retrieving shards whose "id" is "1"
+        expected = tests.Data("examples", "rest.shard.detail.json").json()
+        response = self.client.get(
+            reverse("api-v2:shard-detail", args=[1]),
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving shards with a non-existent "id" returns 404 Not Found
+        response = self.client.get(
+            reverse("api-v2:shard-detail", args=[-1]),
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 404)
+
+        # Check retrieving list of projects for a shard without token returns 401 Unauthorized
+        response = self.client.get(reverse("api-v2:shard-projects", args=[1]))
+        self.assertEqual(response.status_code, 401)
+
+        # Check retrieving list of projects for a shard
+        expected = tests.Data("examples", "rest.shard.projects.json").json()
+        response = self.client.get(
+            reverse("api-v2:shard-projects", args=[1]),
+            HTTP_AUTHORIZATION=f"Token {token}",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)

promgen/urls.py

@@ -42,6 +42,7 @@
 v2_router.register("urls", rest_v2.URLViewSet)
 v2_router.register("projects", rest_v2.ProjectViewSet)
 v2_router.register("services", rest_v2.ServiceViewSet)
+v2_router.register("shards", rest_v2.ShardViewSet)
 
 urlpatterns = [
     path("admin/", admin.site.urls),