Add v2 APIs for URL

We have added several APIs for retrieving URL data.

Author: hoangpn

promgen/filters.py

@@ -1,6 +1,8 @@
 import django_filters
 from django.contrib.contenttypes.models import ContentType
 
+from promgen import models
+
 
 class ShardFilter(django_filters.rest_framework.FilterSet):
     name = django_filters.CharFilter(field_name="name", lookup_expr="contains")
@@ -176,3 +178,16 @@ class ExporterFilter(django_filters.rest_framework.FilterSet):
         field_name="enabled",
         help_text="Filter by enabled status (true or false). Example: enabled=true",
     )
+
+
+class URLFilter(django_filters.rest_framework.FilterSet):
+    project = django_filters.CharFilter(
+        field_name="project__name",
+        lookup_expr="contains",
+        help_text="Filter by project name containing a specific substring. Example: project=Example Project",
+    )
+    probe = django_filters.ChoiceFilter(
+        field_name="probe__module",
+        choices=models.Probe.objects.values_list("module", "description").distinct(),
+        help_text="Filter by exact probe scheme. Example: probe=http_2xx",
+    )

promgen/fixtures/testcases.yaml

@@ -98,12 +98,22 @@
   pk: 1
   fields:
     module: fixture_test
+- model: promgen.probe
+  pk: 2
+  fields:
+    module: http_2xx
 - model: promgen.url
   pk: 1
   fields:
     project: 1
     probe: 1
     url: probe.example.com
+- model: promgen.url
+  pk: 2
+  fields:
+    project: 2
+    probe: 2
+    url: probe-2.example.com
 - model: promgen.audit
   pk: 1
   fields:

promgen/rest_v2.py

@@ -272,3 +272,19 @@ class ExporterViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, viewsets
     lookup_value_regex = "[^/]+"
     lookup_field = "id"
     pagination_class = PromgenPagination
+
+
+@extend_schema_view(
+    list=extend_schema(summary="List URLs", description="Retrieve a list of all URLs."),
+    retrieve=extend_schema(
+        summary="Retrieve URL", description="Retrieve detailed information about a specific URL."
+    ),
+)
+@extend_schema(tags=["URL"])
+class URLViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, viewsets.GenericViewSet):
+    queryset = models.URL.objects.all()
+    filterset_class = filters.URLFilter
+    serializer_class = serializers.URLSerializer
+    lookup_value_regex = "[^/]+"
+    lookup_field = "id"
+    pagination_class = PromgenPagination

promgen/serializers.py

@@ -240,3 +240,12 @@ class ExporterSerializer(serializers.ModelSerializer):
     class Meta:
         model = models.Exporter
         fields = "__all__"
+
+
+class URLSerializer(serializers.ModelSerializer):
+    project = serializers.ReadOnlyField(source="project.name")
+    probe = serializers.ReadOnlyField(source="probe.module")
+
+    class Meta:
+        model = models.URL
+        fields = "__all__"

promgen/tests/examples/export.urls.json

@@ -1,4 +1,16 @@
 [
+  {
+    "labels": {
+      "__param_module": "http_2xx",
+      "__shard": "test-shard",
+      "job": "http_2xx",
+      "project": "another-project",
+      "service": "test-service"
+    },
+    "targets": [
+      "probe-2.example.com"
+    ]
+  },
   {
     "labels": {
       "__param_module": "fixture_test",
@@ -7,6 +19,8 @@
       "project": "test-project",
       "service": "test-service"
     },
-    "targets": ["probe.example.com"]
+    "targets": [
+      "probe.example.com"
+    ]
   }
 ]

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

@@ -0,0 +1,19 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 2,
+      "probe": "http_2xx",
+      "project": "another-project",
+      "url": "probe-2.example.com"
+    },
+    {
+      "id": 1,
+      "probe": "fixture_test",
+      "project": "test-project",
+      "url": "probe.example.com"
+    }
+  ]
+}

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

@@ -0,0 +1,6 @@
+{
+  "id": 1,
+  "probe": "fixture_test",
+  "project": "test-project",
+  "url": "probe.example.com"
+}

promgen/tests/examples/rest.url.filter_by_probe.json

@@ -0,0 +1,13 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 1,
+      "probe": "fixture_test",
+      "project": "test-project",
+      "url": "probe.example.com"
+    }
+  ]
+}

promgen/tests/examples/rest.url.filter_by_project.json

@@ -0,0 +1,13 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": 1,
+      "probe": "fixture_test",
+      "project": "test-project",
+      "url": "probe.example.com"
+    }
+  ]
+}

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

@@ -0,0 +1,13 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": "http://testserver/rest/v2/urls/?page_size=1",
+  "results": [
+    {
+      "id": 1,
+      "probe": "fixture_test",
+      "project": "test-project",
+      "url": "probe.example.com"
+    }
+  ]
+}

promgen/tests/test_rest.py

@@ -848,3 +848,43 @@ def test_rest_exporter(self):
         # Check retrieving exporters with a non-existent "id" returns 404 Not Found
         response = self.client.get(reverse("api-v2:exporter-detail", args=[-1]))
         self.assertEqual(response.status_code, 404)
+
+    @override_settings(PROMGEN=tests.SETTINGS)
+    def test_rest_url(self):
+        # Check retrieving all urls
+        expected = tests.Data("examples", "rest.url.default.json").json()
+        response = self.client.get(reverse("api-v2:url-list"))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving paginated urls
+        expected = tests.Data("examples", "rest.url.paginated.json").json()
+        response = self.client.get(reverse("api-v2:url-list"), {"page_number": 2, "page_size": 1})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving urls whose "probe" is "fixture_test"
+        expected = tests.Data("examples", "rest.url.filter_by_probe.json").json()
+        response = self.client.get(reverse("api-v2:url-list"), {"probe": "fixture_test"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving urls with a non-existent "probe" returns 400 Bad Request
+        response = self.client.get(reverse("api-v2:url-list"), {"probe": "non-existent"})
+        self.assertEqual(response.status_code, 400)
+
+        # Check retrieving urls whose "project" contains "test"
+        expected = tests.Data("examples", "rest.url.filter_by_project.json").json()
+        response = self.client.get(reverse("api-v2:url-list"), {"project": "test"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving urls with a non-existent "project" returns an empty list
+        response = self.client.get(reverse("api-v2:url-list"), {"project": "non-existent"})
+        self.assertEqual(response.status_code, 200)
+
+        # Check retrieving urls whose "id" is "1"
+        expected = tests.Data("examples", "rest.url.detail.json").json()
+        response = self.client.get(reverse("api-v2:url-detail", args=[1]))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)

promgen/urls.py

@@ -39,6 +39,7 @@
 v2_router.register("rules", rest_v2.RuleViewSet)
 v2_router.register("farms", rest_v2.FarmViewSet)
 v2_router.register("exporters", rest_v2.ExporterViewSet)
+v2_router.register("urls", rest_v2.URLViewSet)
 
 urlpatterns = [
     path("admin/", admin.site.urls),