netbox-plugin-prometheus-sd 1.3.0__tar.gz → 2.0.0__tar.gz

{netbox_plugin_prometheus_sd-1.3.0 → netbox_plugin_prometheus_sd-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-prometheus-sd
-Version: 1.3.0
+Version: 2.0.0
 Summary: A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery
 License: MIT
 Author: Felix Peters

{netbox_plugin_prometheus_sd-1.3.0 → netbox_plugin_prometheus_sd-2.0.0}/netbox_prometheus_sd/__init__.py

@@ -1,11 +1,7 @@
-try:
-    from netbox.plugins import PluginConfig
-except ImportError:
-    # Fallback for old NetBox versions < 4.0
-    from extras.plugins import PluginConfig
+from netbox.plugins import PluginConfig
 
 # Placeholder for semantic release
-__VERSION__ = "1.3.0"
+__VERSION__ = "2.0.0"
 
 
 class PrometheusSD(PluginConfig):
@@ -20,6 +16,7 @@ class PrometheusSD(PluginConfig):
     base_url = "prometheus-sd"
     required_settings = []
     default_settings = {}
+    min_version = "4.0.0"
 
 
 config = PrometheusSD

netbox_plugin_prometheus_sd-2.0.0/netbox_prometheus_sd/api/views.py

@@ -0,0 +1,153 @@
+from django.contrib.contenttypes.prefetch import GenericPrefetch
+
+from ipam.models import IPAddress, Service
+from virtualization.models import VirtualMachine
+from dcim.models.devices import Device
+
+from netbox.api.viewsets import BaseViewSet
+from netbox.api.viewsets.mixins import CustomFieldsMixin
+from rest_framework.mixins import ListModelMixin
+
+from .utils import NETBOX_RELEASE_CURRENT, NETBOX_RELEASE_41
+
+from ipam.filtersets import IPAddressFilterSet
+from dcim.filtersets import DeviceFilterSet
+from virtualization.filtersets import VirtualMachineFilterSet
+
+from ..filtersets import ServiceFilterSet
+from .serializers import (
+    PrometheusIPAddressSerializer,
+    PrometheusDeviceSerializer,
+    PrometheusVirtualMachineSerializer,
+    PrometheusServiceSerializer,
+)
+
+
+# Netbox MosdelViewSet with list only
+class NetboxPrometheusSDModelViewSet(CustomFieldsMixin, ListModelMixin, BaseViewSet):
+    pass
+
+
+# Netbox 4.2 replaced the direct Cluster.site FK with a generic `scope` relation.
+# It stays in prefetch_related either way: a GenericForeignKey cannot be JOINed
+# via select_related.
+if NETBOX_RELEASE_CURRENT > NETBOX_RELEASE_41:
+    CLUSTER_SCOPE = "cluster__scope"
+else:
+    CLUSTER_SCOPE = "cluster__site"
+
+# Netbox 4.3 replaced Service.device/Service.virtual_machine with a single
+# generic `parent` relation, exposed via parent_object_type/parent_object_id.
+# Note: hasattr(Service, "device") is NOT a usable check — Device and
+# VirtualMachine declare `services = GenericRelation(..., related_query_name=...)`,
+# which makes Service.device resolve to a read-only reverse accessor on every
+# Netbox version, including 4.3+.
+SERVICE_HAS_GENERIC_PARENT = hasattr(Service, "parent_object_type")
+
+# Relations read off `obj.cluster` by utils.extract_cluster(), and off
+# `obj.contacts` by utils.extract_contacts(). Shared by the device and VM
+# querysets, which run the same extractors.
+CLUSTER_RELATED = ("cluster", "cluster__group", "cluster__type")
+CONTACTS_RELATED = ("contacts__contact", "contacts__role")
+
+
+class ServiceViewSet(NetboxPrometheusSDModelViewSet):
+    # utils.extract_parent() walks the service's parent device/VM and pulls its
+    # name, IPs, tenant, cluster and contacts, so the parent's own relations have
+    # to be fetched too or every service row re-queries them.
+    _parent_related = (
+        "tenant__group",
+        "primary_ip4",
+        "primary_ip6",
+        "site",
+        *CLUSTER_RELATED,
+        CLUSTER_SCOPE,
+        *CONTACTS_RELATED,
+    )
+
+    if SERVICE_HAS_GENERIC_PARENT:  # Netbox >= 4.3
+        queryset = Service.objects.prefetch_related(
+            GenericPrefetch(
+                "parent",
+                [
+                    Device.objects.prefetch_related(*_parent_related, "oob_ip"),
+                    VirtualMachine.objects.prefetch_related(*_parent_related),
+                ],
+            ),
+            "ipaddresses",
+            "tags",
+        )
+    else:  # Netbox < 4.3
+        queryset = Service.objects.prefetch_related(
+            *(f"device__{rel}" for rel in _parent_related),
+            "device__oob_ip",
+            *(f"virtual_machine__{rel}" for rel in _parent_related),
+            "device",
+            "virtual_machine",
+            "ipaddresses",
+            "tags",
+        )
+    filterset_class = ServiceFilterSet
+    serializer_class = PrometheusServiceSerializer
+    pagination_class = None
+
+
+class VirtualMachineViewSet(NetboxPrometheusSDModelViewSet):
+    queryset = (
+        VirtualMachine.objects.select_related(
+            "role",
+            "tenant__group",
+            "platform",
+            "primary_ip4",
+            "primary_ip6",
+            # utils.extract_cluster() falls through to obj.site for anything that
+            # has one, and VMs do on every supported Netbox release.
+            "site",
+        )
+        .prefetch_related(
+            CLUSTER_SCOPE,
+            *CLUSTER_RELATED,
+            *CONTACTS_RELATED,
+            "tags",
+            "services",
+        )
+        .annotate_config_context_data()
+    )
+    filterset_class = VirtualMachineFilterSet
+    serializer_class = PrometheusVirtualMachineSerializer
+    pagination_class = None
+
+
+class DeviceViewSet(NetboxPrometheusSDModelViewSet):
+    queryset = (
+        Device.objects.select_related(
+            "device_type",
+            "role",
+            "tenant__group",
+            "platform",
+            "site",
+            "location",
+            "rack",
+            "primary_ip4",
+            "primary_ip6",
+            "oob_ip",
+        )
+        .prefetch_related(
+            CLUSTER_SCOPE,
+            *CLUSTER_RELATED,
+            *CONTACTS_RELATED,
+            "tags",
+            "services",
+        )
+        .annotate_config_context_data()
+    )
+    filterset_class = DeviceFilterSet
+    serializer_class = PrometheusDeviceSerializer
+    pagination_class = None
+
+
+class IPAddressViewSet(NetboxPrometheusSDModelViewSet):
+    queryset = IPAddress.objects.select_related("tenant__group").prefetch_related("tags")
+    serializer_class = PrometheusIPAddressSerializer
+    filterset_class = IPAddressFilterSet
+    pagination_class = None

{netbox_plugin_prometheus_sd-1.3.0 → netbox_plugin_prometheus_sd-2.0.0}/netbox_prometheus_sd/filtersets.py

@@ -1,5 +1,3 @@
-# Filtersets have been renamed, we support both
-# https://github.com/netbox-community/netbox/commit/1024782b9e0abb48f6da65f8248741227d53dbed#diff-d9224204dab475bbe888868c02235b8ef10f07c9201c45c90804d395dc161c40
 from django.db.models import Q
 from django.utils.translation import gettext as _
 
@@ -9,10 +7,7 @@ from utilities.filters import (
     NumericArrayFilter,
 )
 
-try:
-    from ipam.filtersets import ServiceFilterSet as NetboxServiceFilterSet
-except ImportError:
-    from ipam.filters import ServiceFilterSet as NetboxServiceFilterSet
+from ipam.filtersets import ServiceFilterSet as NetboxServiceFilterSet
 
 
 class ServiceFilterSet(NetboxServiceFilterSet):

netbox_plugin_prometheus_sd-2.0.0/netbox_prometheus_sd/tests/test_api.py

@@ -0,0 +1,176 @@
+import json
+
+from users.models import ObjectPermission, User
+from core.models import ObjectType
+
+from django.db import connection
+from django.test import TestCase
+from django.test.utils import CaptureQueriesContext
+
+from rest_framework.test import APIClient
+from rest_framework import status
+
+from . import utils
+
+
+class AuthenticatedApiTestCase(TestCase):
+    """Base class providing an API client authenticated with view permissions."""
+
+    def setUp(self):
+
+        self.client = APIClient()
+
+        # Create test user and view permissions
+        user = User.objects.create_user("username", "Pas$w0rd")
+        obj_perm = ObjectPermission(name="test", actions=["view"])
+        obj_perm.save()
+        obj_perm.users.add(user)
+        obj_perm.object_types.add(
+            ObjectType.objects.get(app_label="dcim", model="device")
+        )
+        obj_perm.object_types.add(
+            ObjectType.objects.get(app_label="ipam", model="ipaddress")
+        )
+        obj_perm.object_types.add(
+            ObjectType.objects.get(app_label="ipam", model="service")
+        )
+        obj_perm.object_types.add(
+            ObjectType.objects.get(app_label="virtualization", model="virtualmachine")
+        )
+        self.client.force_authenticate(user)
+
+
+class ApiEndpointTests(AuthenticatedApiTestCase):
+    """Test cases for ensuring API endpoint is working properly."""
+
+    def test_endpoint_device(self):
+        """Ensure device endpoint returns a valid response"""
+
+        for i in range(1, 61):
+            utils.build_device_full(f"api-test-{i}.example.com", i)
+
+        resp = self.client.get("/api/plugins/prometheus-sd/devices/")
+        self.assertEqual(resp.status_code, status.HTTP_200_OK)
+        data = json.loads(resp.content)
+
+        self.assertIsNotNone(data[0]["targets"])
+        self.assertIsNotNone(data[0]["labels"])
+        self.assertEqual(len(data), 60)
+
+        # Serializer tests render the in-memory fixture object, so they cannot
+        # catch a fixture that sets an attribute without persisting it. Assert
+        # these here, where the objects come back out of the database.
+        labels = {d["labels"]["__meta_netbox_name"]: d["labels"] for d in data}
+        first = labels["api-test-1.example.com"]
+        self.assertEqual(first.get("__meta_netbox_rack_u_position"), "1.0")
+        self.assertEqual(first.get("__meta_netbox_contact_primary_name"), "Jane Doe")
+        self.assertEqual(first.get("__meta_netbox_contact_primary_role"), "On Call")
+
+    def test_endpoint_virtual_machine(self):
+        """Ensure virtual machine endpoint returns a valid response"""
+
+        for i in range(1, 61):
+            utils.build_vm_full(f"api-test-vm-{i}.example.com", i)
+
+        resp = self.client.get("/api/plugins/prometheus-sd/virtual-machines/")
+        self.assertEqual(resp.status_code, status.HTTP_200_OK)
+        data = json.loads(resp.content)
+
+        self.assertIsNotNone(data[0]["targets"])
+        self.assertIsNotNone(data[0]["labels"])
+        # Full vm contains two entry in the config context so we have to double the number of vm
+        self.assertEqual(len(data), 120)
+
+        labels = {d["labels"]["__meta_netbox_name"]: d["labels"] for d in data}
+        first = labels["api-test-vm-1.example.com"]
+        self.assertEqual(first.get("__meta_netbox_contact_primary_name"), "Jane Doe")
+        self.assertEqual(first.get("__meta_netbox_contact_primary_role"), "On Call")
+
+    def test_endpoint_ip_address(self):
+        """Ensure ip address endpoint returns a valid response"""
+
+        for i in range(1, 61):
+            utils.build_full_ip(address=f"10.10.10.{i}/24")
+
+        resp = self.client.get("/api/plugins/prometheus-sd/ip-addresses/")
+        self.assertEqual(resp.status_code, status.HTTP_200_OK)
+        data = json.loads(resp.content)
+
+        self.assertIsNotNone(data[0]["targets"])
+        self.assertIsNotNone(data[0]["labels"])
+        self.assertEqual(len(data), 60)
+
+    def test_endpoint_service(self):
+        """Ensure service endpoint returns a valid response"""
+
+        for i in range(1, 61):
+            utils.build_vm_full(f"api-test-vm-{i}.example.com", i)
+
+        resp = self.client.get("/api/plugins/prometheus-sd/services/")
+        self.assertEqual(resp.status_code, status.HTTP_200_OK)
+        data = json.loads(resp.content)
+
+        self.assertIsNotNone(data[0]["targets"])
+        self.assertIsNotNone(data[0]["labels"])
+        self.assertEqual(len(data), 60)
+
+
+class ApiQueryCountTests(AuthenticatedApiTestCase):
+    """Regression tests for the N+1 queries reported in issue #265.
+
+    These endpoints are unpaginated, so a relation that is read by a serializer
+    but not prefetched costs one query per row. Rather than assert an exact
+    query count (which legitimately shifts between Netbox releases), assert that
+    the count does not grow when the number of objects grows -- that is the
+    property an N+1 breaks.
+    """
+
+    def assertQueryCountDoesNotScale(self, url, build, first=5, second=15):
+        for i in range(1, first + 1):
+            build(i)
+
+        # Warm up caches (content types, permissions) that are populated on the
+        # first request and would otherwise be counted only in the small run.
+        self.assertEqual(self.client.get(url).status_code, status.HTTP_200_OK)
+
+        with CaptureQueriesContext(connection) as few_objects:
+            self.assertEqual(self.client.get(url).status_code, status.HTTP_200_OK)
+
+        for i in range(first + 1, second + 1):
+            build(i)
+
+        with CaptureQueriesContext(connection) as many_objects:
+            self.assertEqual(self.client.get(url).status_code, status.HTTP_200_OK)
+
+        self.assertEqual(
+            len(few_objects),
+            len(many_objects),
+            f"Query count for {url} grew from {len(few_objects)} queries with "
+            f"{first} objects to {len(many_objects)} with {second}. A relation "
+            f"used by the serializer is likely missing from the queryset in "
+            f"api/views.py.",
+        )
+
+    def test_device_endpoint_query_count_does_not_scale(self):
+        self.assertQueryCountDoesNotScale(
+            "/api/plugins/prometheus-sd/devices/",
+            lambda i: utils.build_device_full(f"query-count-{i}.example.com", i),
+        )
+
+    def test_virtual_machine_endpoint_query_count_does_not_scale(self):
+        self.assertQueryCountDoesNotScale(
+            "/api/plugins/prometheus-sd/virtual-machines/",
+            lambda i: utils.build_vm_full(f"query-count-vm-{i}.example.com", i),
+        )
+
+    def test_service_endpoint_query_count_does_not_scale(self):
+        self.assertQueryCountDoesNotScale(
+            "/api/plugins/prometheus-sd/services/",
+            lambda i: utils.build_vm_full(f"query-count-svc-{i}.example.com", i),
+        )
+
+    def test_ip_address_endpoint_query_count_does_not_scale(self):
+        self.assertQueryCountDoesNotScale(
+            "/api/plugins/prometheus-sd/ip-addresses/",
+            lambda i: utils.build_full_ip(address=f"10.10.20.{i}/24"),
+        )

{netbox_plugin_prometheus_sd-1.3.0 → netbox_plugin_prometheus_sd-2.0.0}/netbox_prometheus_sd/tests/test_serializers.py

@@ -198,6 +198,32 @@ class PrometheusVirtualMachineSerializerTests(TestCase):
                     data["labels"],
                 )
             )
+            # Tags are compared as sets: the label is a joined list whose order
+            # is not guaranteed.
+            self.assertEqual(
+                set(data["labels"]["__meta_netbox_tags"].split(",")),
+                {"Tag1", "Tag 2"},
+            )
+            self.assertEqual(
+                set(data["labels"]["__meta_netbox_tag_slugs"].split(",")),
+                {"tag1", "tag-2"},
+            )
+            self.assertTrue(
+                utils.dictContainsSubset(
+                    {"__meta_netbox_services": "ssh"}, data["labels"]
+                )
+            )
+            self.assertTrue(
+                utils.dictContainsSubset(
+                    {
+                        "__meta_netbox_contact_primary_name": "Jane Doe",
+                        "__meta_netbox_contact_primary_email": "jane@example.com",
+                        "__meta_netbox_contact_primary_comments": "Primary on-call",
+                        "__meta_netbox_contact_primary_role": "On Call",
+                    },
+                    data["labels"],
+                )
+            )
 
 
 class PrometheusDeviceSerializerTests(TestCase):
@@ -356,6 +382,29 @@ class PrometheusDeviceSerializerTests(TestCase):
                 {"__meta_netbox_rack_u_position": "1.0"}, data["labels"]
             )
         )
+        # Tags are compared as sets: the label is a joined list whose order is
+        # not guaranteed.
+        self.assertEqual(
+            set(data["labels"]["__meta_netbox_tags"].split(",")), {"Tag1", "Tag 2"}
+        )
+        self.assertEqual(
+            set(data["labels"]["__meta_netbox_tag_slugs"].split(",")),
+            {"tag1", "tag-2"},
+        )
+        self.assertTrue(
+            utils.dictContainsSubset({"__meta_netbox_services": "ssh"}, data["labels"])
+        )
+        self.assertTrue(
+            utils.dictContainsSubset(
+                {
+                    "__meta_netbox_contact_primary_name": "Jane Doe",
+                    "__meta_netbox_contact_primary_email": "jane@example.com",
+                    "__meta_netbox_contact_primary_comments": "Primary on-call",
+                    "__meta_netbox_contact_primary_role": "On Call",
+                },
+                data["labels"],
+            )
+        )
 
 
 class PrometheusIPAddressSerializerTests(TestCase):
@@ -493,6 +542,11 @@ class PrometheusServiceSerializerTests(TestCase):
                     {"__meta_netbox_primary_ip6": "2001:db8:1701::2"}, data["labels"]
                 )
             )
+            self.assertTrue(
+                utils.dictContainsSubset(
+                    {"__meta_netbox_ipaddresses": "192.168.0.1"}, data["labels"]
+                )
+            )
 
     def test_vm_service_full_to_target(self):
         vm = utils.build_vm_full("vm-full-01.example.com")
@@ -576,3 +630,8 @@ class PrometheusServiceSerializerTests(TestCase):
                     {"__meta_netbox_primary_ip6": "2001:db8:1701::2"}, data["labels"]
                 )
             )
+            self.assertTrue(
+                utils.dictContainsSubset(
+                    {"__meta_netbox_ipaddresses": "192.168.0.1"}, data["labels"]
+                )
+            )

{netbox_plugin_prometheus_sd-1.3.0 → netbox_plugin_prometheus_sd-2.0.0}/netbox_prometheus_sd/tests/utils.py

@@ -7,7 +7,13 @@ from dcim.models import Device, DeviceRole, Platform, Rack
 from extras.models import ConfigContext, Tag
 
 from ipam.models import IPAddress, Service
-from tenancy.models import Tenant, TenantGroup
+from tenancy.models import (
+    Contact,
+    ContactAssignment,
+    ContactRole,
+    Tenant,
+    TenantGroup,
+)
 
 from virtualization.models import (
     Cluster,
@@ -53,6 +59,18 @@ def build_tenant():
     return Tenant.objects.get_or_create(name="Acme Corp.", slug="acme")[0]
 
 
+def build_contact_for(obj):
+    """Assign a contact to obj so extract_contacts() has something to render."""
+    contact = Contact.objects.get_or_create(
+        name="Jane Doe",
+        defaults={"email": "jane@example.com", "comments": "Primary on-call"},
+    )[0]
+    role = ContactRole.objects.get_or_create(name="On Call", slug="on-call")[0]
+    return ContactAssignment.objects.create(
+        object=obj, contact=contact, role=role, priority="primary"
+    )
+
+
 def build_custom_fields():
     """Build custom field definition with different kinds of custom values"""
     return {
@@ -114,15 +132,29 @@ def build_vm_full(name, ip_octet=1):
     vm.tags.add("Tag 2")
     vm.save()
 
-    try: # NetBox 4.2+
-        Service.objects.create(parent=vm, name="ssh", protocol="tcp", ports=[22])
-    except AttributeError: # NetBox <4.2
-        Service.objects.create(virtual_machine=vm, name="ssh", protocol="tcp", ports=[22])
+    build_contact_for(vm)
+    build_service_for(vm, name="ssh", protocol="tcp", ports=[22])
     return vm
 
 
+def build_service_for(parent, **kwargs):
+    """Create a service bound to parent, with the parent's primary IPv4 attached.
+
+    Netbox 4.3 replaced Service.device/Service.virtual_machine with a single
+    generic `parent` relation, which is read-only on older releases.
+    """
+    try: # NetBox 4.3+
+        service = Service.objects.create(parent=parent, **kwargs)
+    except AttributeError: # NetBox <4.3
+        field = "device" if isinstance(parent, Device) else "virtual_machine"
+        service = Service.objects.create(**{field: parent}, **kwargs)
+
+    if parent.primary_ip4 is not None:
+        service.ipaddresses.set([parent.primary_ip4])
+    return service
+
+
 def build_minimal_device(name):
-    role_attr = "role" if hasattr(Device, "role") else "device_role"
     return Device.objects.get_or_create(
         name=name,
         device_type=DeviceType.objects.get_or_create(
@@ -133,11 +165,7 @@ def build_minimal_device(name):
             )[0],
         )[0],
         site=Site.objects.get_or_create(name="Site", slug="site")[0],
-        **{
-            role_attr: DeviceRole.objects.get_or_create(
-                name="Firewall", slug="firewall"
-            )[0],
-        },
+        role=DeviceRole.objects.get_or_create(name="Firewall", slug="firewall")[0],
     )[0]
 
 
@@ -225,17 +253,20 @@ def build_device_full(name, ip_octet=1):
     )[0]
     device.oob_ip = IPAddress.objects.get_or_create(address=f"10.0.0.{ip_octet}/24")[0]
     device.rack = Rack.objects.get_or_create(
-        name="R01B01", site=Site.objects.get_or_create(name="Site", slug="site")[0]
+        name="R01B01",
+        site=Site.objects.get_or_create(name="Site", slug="site")[0],
+        defaults={"u_height": 100},
     )[0]
     device.site = Site.objects.get_or_create(name="Site", slug="site")[0]
+    # Rack position is unique per (rack, position, face), so it has to follow
+    # ip_octet like the addresses do -- otherwise callers building more than one
+    # device hit an IntegrityError.
+    device.position = float(ip_octet)
     device.tags.add("Tag1")
     device.tags.add("Tag 2")
     device.save()
-    device.position = 1.0
-    try: # NetBox 4.2+
-        Service.objects.create(parent=device, name="ssh", protocol="tcp", ports=[22])
-    except AttributeError: # NetBox <4.2
-        Service.objects.create(device=device, name="ssh", protocol="tcp", ports=[22])
+    build_contact_for(device)
+    build_service_for(device, name="ssh", protocol="tcp", ports=[22])
     return device
 
 

{netbox_plugin_prometheus_sd-1.3.0 → netbox_plugin_prometheus_sd-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "netbox-plugin-prometheus-sd"
-version = "v1.3.0" # placeholder
+version = "v2.0.0" # placeholder
 description = "A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery"
 authors = ["Felix Peters <felix.peters@breuninger.de>"]
 license = "MIT"
@@ -14,7 +14,7 @@ packages = [
 python = ">=3.10,<4.0"
 
 [tool.poetry.group.dev.dependencies]
-invoke = "^2.2.0"
+invoke = ">=2.2,<4.0"
 docker = "^7.1.0"
 testcontainers = {extras = ["postgres", "redis", "generic"], version = "^4.14.1"}
 python-semantic-release = "^10.5.3"

netbox_plugin_prometheus_sd-1.3.0/netbox_prometheus_sd/api/views.py

@@ -1,93 +0,0 @@
-from ipam.models import IPAddress, Service
-from virtualization.models import VirtualMachine
-from dcim.models.devices import Device
-
-from netbox.api.viewsets import BaseViewSet
-from netbox.api.viewsets.mixins import CustomFieldsMixin
-from rest_framework.mixins import ListModelMixin
-
-from .utils import NETBOX_RELEASE_CURRENT, NETBOX_RELEASE_41
-
-# Filtersets have been renamed, we support both
-# https://github.com/netbox-community/netbox/commit/1024782b9e0abb48f6da65f8248741227d53dbed#diff-d9224204dab475bbe888868c02235b8ef10f07c9201c45c90804d395dc161c40
-try:
-    from ipam.filtersets import IPAddressFilterSet
-    from dcim.filtersets import DeviceFilterSet
-    from virtualization.filtersets import VirtualMachineFilterSet
-except ImportError:
-    from ipam.filters import IPAddressFilterSet
-    from dcim.filters import DeviceFilterSet
-    from virtualization.filters import VirtualMachineFilterSet
-
-from ..filtersets import ServiceFilterSet
-from .serializers import (
-    PrometheusIPAddressSerializer,
-    PrometheusDeviceSerializer,
-    PrometheusVirtualMachineSerializer,
-    PrometheusServiceSerializer,
-)
-
-
-# Netbox MosdelViewSet with list only
-class NetboxPrometheusSDModelViewSet(CustomFieldsMixin, ListModelMixin, BaseViewSet):
-    pass
-
-
-class ServiceViewSet(NetboxPrometheusSDModelViewSet):
-    queryset = Service.objects.prefetch_related(
-        "device",
-        "virtual_machine",
-        "ipaddresses",
-        "tags",
-    )
-    filterset_class = ServiceFilterSet
-    serializer_class = PrometheusServiceSerializer
-    pagination_class = None
-
-
-class VirtualMachineViewSet(NetboxPrometheusSDModelViewSet):
-    if NETBOX_RELEASE_CURRENT > NETBOX_RELEASE_41:
-        cluster_scope = "cluster__scope"
-    else:
-        cluster_scope = "cluster__site"
-    queryset = VirtualMachine.objects.prefetch_related(
-        cluster_scope,
-        "role",
-        "tenant",
-        "platform",
-        "primary_ip4",
-        "primary_ip6",
-        "tags",
-        "services",
-        "contacts",
-    )
-    filterset_class = VirtualMachineFilterSet
-    serializer_class = PrometheusVirtualMachineSerializer
-    pagination_class = None
-
-
-class DeviceViewSet(NetboxPrometheusSDModelViewSet):
-    queryset = Device.objects.prefetch_related(
-        "device_type__manufacturer",
-        "role" if hasattr(Device, "role") else "device_role",
-        "tenant",
-        "platform",
-        "site",
-        "location",
-        "rack",
-        "parent_bay",
-        "virtual_chassis__master",
-        "primary_ip4__nat_outside",
-        "primary_ip6__nat_outside",
-        "tags",
-    )
-    filterset_class = DeviceFilterSet
-    serializer_class = PrometheusDeviceSerializer
-    pagination_class = None
-
-
-class IPAddressViewSet(NetboxPrometheusSDModelViewSet):
-    queryset = IPAddress.objects.prefetch_related("tenant", "tags")
-    serializer_class = PrometheusIPAddressSerializer
-    filterset_class = IPAddressFilterSet
-    pagination_class = None

netbox_plugin_prometheus_sd-1.3.0/netbox_prometheus_sd/tests/test_api.py

@@ -1,102 +0,0 @@
-import json
-
-try:
-    from users.models import ObjectPermission
-    from users.models import User
-    from core.models import ObjectType
-
-except ImportError:
-    # Fallback for old NetBox versions < 4.0
-    from django.contrib.contenttypes.models import ContentType as ObjectType
-    from django.contrib.auth.models import User
-
-from django.test import TestCase
-
-from rest_framework.test import APIClient
-from rest_framework import status
-
-from . import utils
-
-
-class ApiEndpointTests(TestCase):
-    """Test cases for ensuring API endpoint is working properly."""
-
-    def setUp(self):
-
-        self.client = APIClient()
-
-        # Create test user and view permissions
-        user = User.objects.create_user("username", "Pas$w0rd")
-        obj_perm = ObjectPermission(name="test", actions=["view"])
-        obj_perm.save()
-        obj_perm.users.add(user)
-        obj_perm.object_types.add(
-            ObjectType.objects.get(app_label="dcim", model="device")
-        )
-        obj_perm.object_types.add(
-            ObjectType.objects.get(app_label="ipam", model="ipaddress")
-        )
-        obj_perm.object_types.add(
-            ObjectType.objects.get(app_label="ipam", model="service")
-        )
-        obj_perm.object_types.add(
-            ObjectType.objects.get(app_label="virtualization", model="virtualmachine")
-        )
-        self.client.force_authenticate(user)
-
-    def test_endpoint_device(self):
-        """Ensure device endpoint returns a valid response"""
-
-        for i in range(1, 61):
-            utils.build_device_full(f"api-test-{i}.example.com", i)
-
-        resp = self.client.get("/api/plugins/prometheus-sd/devices/")
-        self.assertEqual(resp.status_code, status.HTTP_200_OK)
-        data = json.loads(resp.content)
-
-        self.assertIsNotNone(data[0]["targets"])
-        self.assertIsNotNone(data[0]["labels"])
-        self.assertEqual(len(data), 60)
-
-    def test_endpoint_virtual_machine(self):
-        """Ensure virtual machine endpoint returns a valid response"""
-
-        for i in range(1, 61):
-            utils.build_vm_full(f"api-test-vm-{i}.example.com", i)
-
-        resp = self.client.get("/api/plugins/prometheus-sd/virtual-machines/")
-        self.assertEqual(resp.status_code, status.HTTP_200_OK)
-        data = json.loads(resp.content)
-
-        self.assertIsNotNone(data[0]["targets"])
-        self.assertIsNotNone(data[0]["labels"])
-        # Full vm contains two entry in the config context so we have to double the number of vm
-        self.assertEqual(len(data), 120)
-
-    def test_endpoint_ip_address(self):
-        """Ensure ip address endpoint returns a valid response"""
-
-        for i in range(1, 61):
-            utils.build_full_ip(address=f"10.10.10.{i}/24")
-
-        resp = self.client.get("/api/plugins/prometheus-sd/ip-addresses/")
-        self.assertEqual(resp.status_code, status.HTTP_200_OK)
-        data = json.loads(resp.content)
-
-        self.assertIsNotNone(data[0]["targets"])
-        self.assertIsNotNone(data[0]["labels"])
-        self.assertEqual(len(data), 60)
-
-    def test_endpoint_service(self):
-        """Ensure service endpoint returns a valid response"""
-
-        for i in range(1, 61):
-            utils.build_vm_full(f"api-test-vm-{i}.example.com", i)
-
-        resp = self.client.get("/api/plugins/prometheus-sd/services/")
-        self.assertEqual(resp.status_code, status.HTTP_200_OK)
-        data = json.loads(resp.content)
-
-        self.assertIsNotNone(data[0]["targets"])
-        self.assertIsNotNone(data[0]["labels"])
-        self.assertEqual(len(data), 60)