Prefixes
diff --git a/netbox/templates/virtualization/clustergroup.html b/netbox/templates/virtualization/clustergroup.html
index 9b2085189..badb2b40c 100644
--- a/netbox/templates/virtualization/clustergroup.html
+++ b/netbox/templates/virtualization/clustergroup.html
@@ -47,7 +47,7 @@
{% include 'inc/table.html' with table=clusters_table %}
{% if perms.virtualization.add_cluster %}
diff --git a/netbox/tenancy/api/views.py b/netbox/tenancy/api/views.py
index 3b57e1a02..2e049135d 100644
--- a/netbox/tenancy/api/views.py
+++ b/netbox/tenancy/api/views.py
@@ -4,7 +4,7 @@ from circuits.models import Circuit
from dcim.models import Device, Rack, Site
from extras.api.views import CustomFieldModelViewSet
from ipam.models import IPAddress, Prefix, VLAN, VRF
-from tenancy import filters
+from tenancy import filtersets
from tenancy.models import Tenant, TenantGroup
from utilities.utils import count_related
from virtualization.models import VirtualMachine
@@ -32,7 +32,7 @@ class TenantGroupViewSet(CustomFieldModelViewSet):
cumulative=True
)
serializer_class = serializers.TenantGroupSerializer
- filterset_class = filters.TenantGroupFilterSet
+ filterset_class = filtersets.TenantGroupFilterSet
#
@@ -54,4 +54,4 @@ class TenantViewSet(CustomFieldModelViewSet):
vrf_count=count_related(VRF, 'tenant')
)
serializer_class = serializers.TenantSerializer
- filterset_class = filters.TenantFilterSet
+ filterset_class = filtersets.TenantFilterSet
diff --git a/netbox/tenancy/filters.py b/netbox/tenancy/filtersets.py
similarity index 86%
rename from netbox/tenancy/filters.py
rename to netbox/tenancy/filtersets.py
index 0581866a4..d00b78629 100644
--- a/netbox/tenancy/filters.py
+++ b/netbox/tenancy/filtersets.py
@@ -1,8 +1,9 @@
import django_filters
from django.db.models import Q
-from extras.filters import CustomFieldModelFilterSet, CreatedUpdatedFilterSet
-from utilities.filters import BaseFilterSet, NameSlugSearchFilterSet, TagFilter, TreeNodeMultipleChoiceFilter
+from extras.filters import TagFilter
+from netbox.filtersets import OrganizationalModelFilterSet, PrimaryModelFilterSet
+from utilities.filters import TreeNodeMultipleChoiceFilter
from .models import Tenant, TenantGroup
@@ -13,7 +14,7 @@ __all__ = (
)
-class TenantGroupFilterSet(BaseFilterSet, NameSlugSearchFilterSet, CreatedUpdatedFilterSet):
+class TenantGroupFilterSet(OrganizationalModelFilterSet):
parent_id = django_filters.ModelMultipleChoiceFilter(
queryset=TenantGroup.objects.all(),
label='Tenant group (ID)',
@@ -30,7 +31,7 @@ class TenantGroupFilterSet(BaseFilterSet, NameSlugSearchFilterSet, CreatedUpdate
fields = ['id', 'name', 'slug', 'description']
-class TenantFilterSet(BaseFilterSet, CustomFieldModelFilterSet, CreatedUpdatedFilterSet):
+class TenantFilterSet(PrimaryModelFilterSet):
q = django_filters.CharFilter(
method='search',
label='Search',
diff --git a/netbox/tenancy/models.py b/netbox/tenancy/models.py
index cad1b3c20..c9f55ec84 100644
--- a/netbox/tenancy/models.py
+++ b/netbox/tenancy/models.py
@@ -14,7 +14,7 @@ __all__ = (
)
-@extras_features('custom_fields', 'export_templates', 'webhooks')
+@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks')
class TenantGroup(NestedGroupModel):
"""
An arbitrary collection of Tenants.
diff --git a/netbox/tenancy/tests/test_filters.py b/netbox/tenancy/tests/test_filtersets.py
similarity index 88%
rename from netbox/tenancy/tests/test_filters.py
rename to netbox/tenancy/tests/test_filtersets.py
index c78b25083..fd4a0bd76 100644
--- a/netbox/tenancy/tests/test_filters.py
+++ b/netbox/tenancy/tests/test_filtersets.py
@@ -1,10 +1,11 @@
from django.test import TestCase
-from tenancy.filters import *
+from tenancy.filtersets import *
from tenancy.models import Tenant, TenantGroup
+from utilities.testing import ChangeLoggedFilterSetTests
-class TenantGroupTestCase(TestCase):
+class TenantGroupTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = TenantGroup.objects.all()
filterset = TenantGroupFilterSet
@@ -27,10 +28,6 @@ class TenantGroupTestCase(TestCase):
for tenantgroup in tenant_groups:
tenantgroup.save()
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Tenant Group 1', 'Tenant Group 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -51,7 +48,7 @@ class TenantGroupTestCase(TestCase):
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class TenantTestCase(TestCase):
+class TenantTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = Tenant.objects.all()
filterset = TenantFilterSet
@@ -73,10 +70,6 @@ class TenantTestCase(TestCase):
)
Tenant.objects.bulk_create(tenants)
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Tenant 1', 'Tenant 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py
index 206ff6c7a..b4a29a2e6 100644
--- a/netbox/tenancy/views.py
+++ b/netbox/tenancy/views.py
@@ -1,10 +1,10 @@
from circuits.models import Circuit
from dcim.models import Site, Rack, Device, RackReservation
-from ipam.models import IPAddress, Prefix, VLAN, VRF
+from ipam.models import Aggregate, IPAddress, Prefix, VLAN, VRF
from netbox.views import generic
from utilities.tables import paginate_table
from virtualization.models import VirtualMachine, Cluster
-from . import filters, forms, tables
+from . import filtersets, forms, tables
from .models import Tenant, TenantGroup
@@ -63,7 +63,7 @@ class TenantGroupBulkEditView(generic.BulkEditView):
'tenant_count',
cumulative=True
)
- filterset = filters.TenantGroupFilterSet
+ filterset = filtersets.TenantGroupFilterSet
table = tables.TenantGroupTable
form = forms.TenantGroupBulkEditForm
@@ -85,7 +85,7 @@ class TenantGroupBulkDeleteView(generic.BulkDeleteView):
class TenantListView(generic.ObjectListView):
queryset = Tenant.objects.all()
- filterset = filters.TenantFilterSet
+ filterset = filtersets.TenantFilterSet
filterset_form = forms.TenantFilterForm
table = tables.TenantTable
@@ -101,6 +101,7 @@ class TenantView(generic.ObjectView):
'device_count': Device.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
'vrf_count': VRF.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
'prefix_count': Prefix.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
+ 'aggregate_count': Aggregate.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
'ipaddress_count': IPAddress.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
'vlan_count': VLAN.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
'circuit_count': Circuit.objects.restrict(request.user, 'view').filter(tenant=instance).count(),
@@ -130,12 +131,12 @@ class TenantBulkImportView(generic.BulkImportView):
class TenantBulkEditView(generic.BulkEditView):
queryset = Tenant.objects.prefetch_related('group')
- filterset = filters.TenantFilterSet
+ filterset = filtersets.TenantFilterSet
table = tables.TenantTable
form = forms.TenantBulkEditForm
class TenantBulkDeleteView(generic.BulkDeleteView):
queryset = Tenant.objects.prefetch_related('group')
- filterset = filters.TenantFilterSet
+ filterset = filtersets.TenantFilterSet
table = tables.TenantTable
diff --git a/netbox/users/api/views.py b/netbox/users/api/views.py
index 7773e54f4..b0443b87e 100644
--- a/netbox/users/api/views.py
+++ b/netbox/users/api/views.py
@@ -6,7 +6,7 @@ from rest_framework.routers import APIRootView
from rest_framework.viewsets import ViewSet
from netbox.api.views import ModelViewSet
-from users import filters
+from users import filtersets
from users.models import ObjectPermission, UserConfig
from utilities.querysets import RestrictedQuerySet
from utilities.utils import deepmerge
@@ -28,13 +28,13 @@ class UsersRootView(APIRootView):
class UserViewSet(ModelViewSet):
queryset = RestrictedQuerySet(model=User).prefetch_related('groups').order_by('username')
serializer_class = serializers.UserSerializer
- filterset_class = filters.UserFilterSet
+ filterset_class = filtersets.UserFilterSet
class GroupViewSet(ModelViewSet):
queryset = RestrictedQuerySet(model=Group).annotate(user_count=Count('user')).order_by('name')
serializer_class = serializers.GroupSerializer
- filterset_class = filters.GroupFilterSet
+ filterset_class = filtersets.GroupFilterSet
#
@@ -44,7 +44,7 @@ class GroupViewSet(ModelViewSet):
class ObjectPermissionViewSet(ModelViewSet):
queryset = ObjectPermission.objects.prefetch_related('object_types', 'groups', 'users')
serializer_class = serializers.ObjectPermissionSerializer
- filterset_class = filters.ObjectPermissionFilterSet
+ filterset_class = filtersets.ObjectPermissionFilterSet
#
diff --git a/netbox/users/filters.py b/netbox/users/filtersets.py
similarity index 98%
rename from netbox/users/filters.py
rename to netbox/users/filtersets.py
index 359cf9cc7..6625cba36 100644
--- a/netbox/users/filters.py
+++ b/netbox/users/filtersets.py
@@ -2,8 +2,8 @@ import django_filters
from django.contrib.auth.models import Group, User
from django.db.models import Q
+from netbox.filtersets import BaseFilterSet
from users.models import ObjectPermission
-from utilities.filters import BaseFilterSet
__all__ = (
'GroupFilterSet',
diff --git a/netbox/users/tests/test_filters.py b/netbox/users/tests/test_filtersets.py
similarity index 89%
rename from netbox/users/tests/test_filters.py
rename to netbox/users/tests/test_filtersets.py
index c3774927c..32a6b6cd9 100644
--- a/netbox/users/tests/test_filters.py
+++ b/netbox/users/tests/test_filtersets.py
@@ -2,11 +2,12 @@ from django.contrib.auth.models import Group, User
from django.contrib.contenttypes.models import ContentType
from django.test import TestCase
-from users.filters import GroupFilterSet, ObjectPermissionFilterSet, UserFilterSet
+from users.filtersets import GroupFilterSet, ObjectPermissionFilterSet, UserFilterSet
from users.models import ObjectPermission
+from utilities.testing import BaseFilterSetTests
-class UserTestCase(TestCase):
+class UserTestCase(TestCase, BaseFilterSetTests):
queryset = User.objects.all()
filterset = UserFilterSet
@@ -59,10 +60,6 @@ class UserTestCase(TestCase):
users[1].groups.set([groups[1]])
users[2].groups.set([groups[2]])
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_username(self):
params = {'username': ['User1', 'User2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -95,7 +92,7 @@ class UserTestCase(TestCase):
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class GroupTestCase(TestCase):
+class GroupTestCase(TestCase, BaseFilterSetTests):
queryset = Group.objects.all()
filterset = GroupFilterSet
@@ -109,16 +106,12 @@ class GroupTestCase(TestCase):
)
Group.objects.bulk_create(groups)
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Group 1', 'Group 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class ObjectPermissionTestCase(TestCase):
+class ObjectPermissionTestCase(TestCase, BaseFilterSetTests):
queryset = ObjectPermission.objects.all()
filterset = ObjectPermissionFilterSet
@@ -160,10 +153,6 @@ class ObjectPermissionTestCase(TestCase):
permissions[i].users.set([users[i]])
permissions[i].object_types.set([object_types[i]])
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Permission 1', 'Permission 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/netbox/utilities/filters.py b/netbox/utilities/filters.py
index 6305c0bba..ed71afc1b 100644
--- a/netbox/utilities/filters.py
+++ b/netbox/utilities/filters.py
@@ -1,17 +1,9 @@
import django_filters
-from django_filters.constants import EMPTY_VALUES
-from copy import deepcopy
-from dcim.forms import MACAddressField
from django import forms
from django.conf import settings
-from django.db import models
-from django_filters.utils import get_model_field, resolve_field
+from django_filters.constants import EMPTY_VALUES
-from extras.models import Tag
-from utilities.constants import (
- FILTER_CHAR_BASED_LOOKUP_MAP, FILTER_NEGATION_LOOKUP_MAP, FILTER_TREENODE_NEGATION_LOOKUP_MAP,
- FILTER_NUMERIC_BASED_LOOKUP_MAP
-)
+from dcim.forms import MACAddressField
def multivalue_field_factory(field_class):
@@ -91,21 +83,6 @@ class NullableCharFieldFilter(django_filters.CharFilter):
return qs.distinct() if self.distinct else qs
-class TagFilter(django_filters.ModelMultipleChoiceFilter):
- """
- Match on one or more assigned tags. If multiple tags are specified (e.g. ?tag=foo&tag=bar), the queryset is filtered
- to objects matching all tags.
- """
- def __init__(self, *args, **kwargs):
-
- kwargs.setdefault('field_name', 'tags__slug')
- kwargs.setdefault('to_field_name', 'slug')
- kwargs.setdefault('conjoined', True)
- kwargs.setdefault('queryset', Tag.objects.all())
-
- super().__init__(*args, **kwargs)
-
-
class NumericArrayFilter(django_filters.NumberFilter):
"""
Filter based on the presence of an integer within an ArrayField.
@@ -134,182 +111,3 @@ class ContentTypeFilter(django_filters.CharFilter):
f'{self.field_name}__model': model
}
)
-
-
-#
-# FilterSets
-#
-
-class BaseFilterSet(django_filters.FilterSet):
- """
- A base filterset which provides common functionaly to all NetBox filtersets
- """
- FILTER_DEFAULTS = deepcopy(django_filters.filterset.FILTER_FOR_DBFIELD_DEFAULTS)
- FILTER_DEFAULTS.update({
- models.AutoField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.CharField: {
- 'filter_class': MultiValueCharFilter
- },
- models.DateField: {
- 'filter_class': MultiValueDateFilter
- },
- models.DateTimeField: {
- 'filter_class': MultiValueDateTimeFilter
- },
- models.DecimalField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.EmailField: {
- 'filter_class': MultiValueCharFilter
- },
- models.FloatField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.IntegerField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.PositiveIntegerField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.PositiveSmallIntegerField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.SlugField: {
- 'filter_class': MultiValueCharFilter
- },
- models.SmallIntegerField: {
- 'filter_class': MultiValueNumberFilter
- },
- models.TimeField: {
- 'filter_class': MultiValueTimeFilter
- },
- models.URLField: {
- 'filter_class': MultiValueCharFilter
- },
- MACAddressField: {
- 'filter_class': MultiValueMACAddressFilter
- },
- })
-
- @staticmethod
- def _get_filter_lookup_dict(existing_filter):
- # Choose the lookup expression map based on the filter type
- if isinstance(existing_filter, (
- MultiValueDateFilter,
- MultiValueDateTimeFilter,
- MultiValueNumberFilter,
- MultiValueTimeFilter
- )):
- lookup_map = FILTER_NUMERIC_BASED_LOOKUP_MAP
-
- elif isinstance(existing_filter, (
- TreeNodeMultipleChoiceFilter,
- )):
- # TreeNodeMultipleChoiceFilter only support negation but must maintain the `in` lookup expression
- lookup_map = FILTER_TREENODE_NEGATION_LOOKUP_MAP
-
- elif isinstance(existing_filter, (
- django_filters.ModelChoiceFilter,
- django_filters.ModelMultipleChoiceFilter,
- TagFilter
- )) or existing_filter.extra.get('choices'):
- # These filter types support only negation
- lookup_map = FILTER_NEGATION_LOOKUP_MAP
-
- elif isinstance(existing_filter, (
- django_filters.filters.CharFilter,
- django_filters.MultipleChoiceFilter,
- MultiValueCharFilter,
- MultiValueMACAddressFilter
- )):
- lookup_map = FILTER_CHAR_BASED_LOOKUP_MAP
-
- else:
- lookup_map = None
-
- return lookup_map
-
- @classmethod
- def get_filters(cls):
- """
- Override filter generation to support dynamic lookup expressions for certain filter types.
-
- For specific filter types, new filters are created based on defined lookup expressions in
- the form `
__`
- """
- filters = super().get_filters()
-
- new_filters = {}
- for existing_filter_name, existing_filter in filters.items():
- # Loop over existing filters to extract metadata by which to create new filters
-
- # If the filter makes use of a custom filter method or lookup expression skip it
- # as we cannot sanely handle these cases in a generic mannor
- if existing_filter.method is not None or existing_filter.lookup_expr not in ['exact', 'in']:
- continue
-
- # Choose the lookup expression map based on the filter type
- lookup_map = cls._get_filter_lookup_dict(existing_filter)
- if lookup_map is None:
- # Do not augment this filter type with more lookup expressions
- continue
-
- # Get properties of the existing filter for later use
- field_name = existing_filter.field_name
- field = get_model_field(cls._meta.model, field_name)
-
- # Create new filters for each lookup expression in the map
- for lookup_name, lookup_expr in lookup_map.items():
- new_filter_name = '{}__{}'.format(existing_filter_name, lookup_name)
-
- try:
- if existing_filter_name in cls.declared_filters:
- # The filter field has been explicity defined on the filterset class so we must manually
- # create the new filter with the same type because there is no guarantee the defined type
- # is the same as the default type for the field
- resolve_field(field, lookup_expr) # Will raise FieldLookupError if the lookup is invalid
- new_filter = type(existing_filter)(
- field_name=field_name,
- lookup_expr=lookup_expr,
- label=existing_filter.label,
- exclude=existing_filter.exclude,
- distinct=existing_filter.distinct,
- **existing_filter.extra
- )
- else:
- # The filter field is listed in Meta.fields so we can safely rely on default behaviour
- # Will raise FieldLookupError if the lookup is invalid
- new_filter = cls.filter_for_field(field, field_name, lookup_expr)
- except django_filters.exceptions.FieldLookupError:
- # The filter could not be created because the lookup expression is not supported on the field
- continue
-
- if lookup_name.startswith('n'):
- # This is a negation filter which requires a queryset.exclude() clause
- # Of course setting the negation of the existing filter's exclude attribute handles both cases
- new_filter.exclude = not existing_filter.exclude
-
- new_filters[new_filter_name] = new_filter
-
- filters.update(new_filters)
- return filters
-
-
-class NameSlugSearchFilterSet(django_filters.FilterSet):
- """
- A base class for adding the search method to models which only expose the `name` and `slug` fields
- """
- q = django_filters.CharFilter(
- method='search',
- label='Search',
- )
-
- def search(self, queryset, name, value):
- if not value.strip():
- return queryset
- return queryset.filter(
- models.Q(name__icontains=value) |
- models.Q(slug__icontains=value)
- )
diff --git a/netbox/utilities/testing/__init__.py b/netbox/utilities/testing/__init__.py
index c6634f22e..6a52d93f3 100644
--- a/netbox/utilities/testing/__init__.py
+++ b/netbox/utilities/testing/__init__.py
@@ -1,4 +1,5 @@
from .api import *
from .base import *
+from .filtersets import *
from .utils import *
from .views import *
diff --git a/netbox/utilities/testing/filtersets.py b/netbox/utilities/testing/filtersets.py
new file mode 100644
index 000000000..98bb0d1ac
--- /dev/null
+++ b/netbox/utilities/testing/filtersets.py
@@ -0,0 +1,35 @@
+from datetime import date, datetime, timezone
+
+
+__all__ = (
+ 'BaseFilterSetTests',
+ 'ChangeLoggedFilterSetTests',
+)
+
+
+class BaseFilterSetTests:
+ queryset = None
+ filterset = None
+
+ def test_id(self):
+ """
+ Test filtering for two PKs from a set of >2 objects.
+ """
+ params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
+ self.assertGreater(self.queryset.count(), 2)
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+
+class ChangeLoggedFilterSetTests(BaseFilterSetTests):
+
+ def test_created(self):
+ pk_list = self.queryset.values_list('pk', flat=True)[:2]
+ self.queryset.filter(pk__in=pk_list).update(created=date(2021, 1, 1))
+ params = {'created': '2021-01-01'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_last_updated(self):
+ pk_list = self.queryset.values_list('pk', flat=True)[:2]
+ self.queryset.filter(pk__in=pk_list).update(last_updated=datetime(2021, 1, 1, 0, 0, 0, tzinfo=timezone.utc))
+ params = {'last_updated': '2021-01-01T00:00:00'}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/netbox/utilities/tests/test_filters.py b/netbox/utilities/tests/test_filters.py
index 56eaabd4c..374167f1c 100644
--- a/netbox/utilities/tests/test_filters.py
+++ b/netbox/utilities/tests/test_filters.py
@@ -7,14 +7,16 @@ from taggit.managers import TaggableManager
from dcim.choices import *
from dcim.fields import MACAddressField
-from dcim.filters import DeviceFilterSet, SiteFilterSet
+from dcim.filtersets import DeviceFilterSet, SiteFilterSet
from dcim.models import (
Device, DeviceRole, DeviceType, Interface, Manufacturer, Platform, Rack, Region, Site
)
+from extras.filters import TagFilter
from extras.models import TaggedItem
+from netbox.filtersets import BaseFilterSet
from utilities.filters import (
- BaseFilterSet, MACAddressFilter, MultiValueCharFilter, MultiValueDateFilter, MultiValueDateTimeFilter,
- MultiValueNumberFilter, MultiValueTimeFilter, TagFilter, TreeNodeMultipleChoiceFilter,
+ MACAddressFilter, MultiValueCharFilter, MultiValueDateFilter, MultiValueDateTimeFilter, MultiValueNumberFilter,
+ MultiValueTimeFilter, TreeNodeMultipleChoiceFilter,
)
diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py
index 1c4371ed0..8eebd2120 100644
--- a/netbox/virtualization/api/views.py
+++ b/netbox/virtualization/api/views.py
@@ -3,7 +3,7 @@ from rest_framework.routers import APIRootView
from dcim.models import Device
from extras.api.views import ConfigContextQuerySetMixin, CustomFieldModelViewSet, ModelViewSet
from utilities.utils import count_related
-from virtualization import filters
+from virtualization import filtersets
from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface
from . import serializers
@@ -25,7 +25,7 @@ class ClusterTypeViewSet(CustomFieldModelViewSet):
cluster_count=count_related(Cluster, 'type')
)
serializer_class = serializers.ClusterTypeSerializer
- filterset_class = filters.ClusterTypeFilterSet
+ filterset_class = filtersets.ClusterTypeFilterSet
class ClusterGroupViewSet(CustomFieldModelViewSet):
@@ -33,7 +33,7 @@ class ClusterGroupViewSet(CustomFieldModelViewSet):
cluster_count=count_related(Cluster, 'group')
)
serializer_class = serializers.ClusterGroupSerializer
- filterset_class = filters.ClusterGroupFilterSet
+ filterset_class = filtersets.ClusterGroupFilterSet
class ClusterViewSet(CustomFieldModelViewSet):
@@ -44,7 +44,7 @@ class ClusterViewSet(CustomFieldModelViewSet):
virtualmachine_count=count_related(VirtualMachine, 'cluster')
)
serializer_class = serializers.ClusterSerializer
- filterset_class = filters.ClusterFilterSet
+ filterset_class = filtersets.ClusterFilterSet
#
@@ -55,7 +55,7 @@ class VirtualMachineViewSet(ConfigContextQuerySetMixin, CustomFieldModelViewSet)
queryset = VirtualMachine.objects.prefetch_related(
'cluster__site', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags'
)
- filterset_class = filters.VirtualMachineFilterSet
+ filterset_class = filtersets.VirtualMachineFilterSet
def get_serializer_class(self):
"""
@@ -83,5 +83,5 @@ class VMInterfaceViewSet(ModelViewSet):
'virtual_machine', 'parent', 'tags', 'tagged_vlans', 'ip_addresses'
)
serializer_class = serializers.VMInterfaceSerializer
- filterset_class = filters.VMInterfaceFilterSet
+ filterset_class = filtersets.VMInterfaceFilterSet
brief_prefetch_fields = ['virtual_machine']
diff --git a/netbox/virtualization/filters.py b/netbox/virtualization/filtersets.py
similarity index 90%
rename from netbox/virtualization/filters.py
rename to netbox/virtualization/filtersets.py
index 6d706b6cf..6d930b69e 100644
--- a/netbox/virtualization/filters.py
+++ b/netbox/virtualization/filtersets.py
@@ -2,12 +2,11 @@ import django_filters
from django.db.models import Q
from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup
-from extras.filters import CustomFieldModelFilterSet, CreatedUpdatedFilterSet, LocalConfigContextFilterSet
-from tenancy.filters import TenancyFilterSet
-from utilities.filters import (
- BaseFilterSet, MultiValueMACAddressFilter, NameSlugSearchFilterSet, TagFilter,
- TreeNodeMultipleChoiceFilter,
-)
+from extras.filters import TagFilter
+from extras.filtersets import LocalConfigContextFilterSet
+from netbox.filtersets import OrganizationalModelFilterSet, PrimaryModelFilterSet
+from tenancy.filtersets import TenancyFilterSet
+from utilities.filters import MultiValueMACAddressFilter, TreeNodeMultipleChoiceFilter
from .choices import *
from .models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface
@@ -20,21 +19,21 @@ __all__ = (
)
-class ClusterTypeFilterSet(BaseFilterSet, NameSlugSearchFilterSet, CreatedUpdatedFilterSet):
+class ClusterTypeFilterSet(OrganizationalModelFilterSet):
class Meta:
model = ClusterType
fields = ['id', 'name', 'slug', 'description']
-class ClusterGroupFilterSet(BaseFilterSet, NameSlugSearchFilterSet, CreatedUpdatedFilterSet):
+class ClusterGroupFilterSet(OrganizationalModelFilterSet):
class Meta:
model = ClusterGroup
fields = ['id', 'name', 'slug', 'description']
-class ClusterFilterSet(BaseFilterSet, TenancyFilterSet, CustomFieldModelFilterSet, CreatedUpdatedFilterSet):
+class ClusterFilterSet(PrimaryModelFilterSet, TenancyFilterSet):
q = django_filters.CharFilter(
method='search',
label='Search',
@@ -110,13 +109,7 @@ class ClusterFilterSet(BaseFilterSet, TenancyFilterSet, CustomFieldModelFilterSe
)
-class VirtualMachineFilterSet(
- BaseFilterSet,
- LocalConfigContextFilterSet,
- TenancyFilterSet,
- CustomFieldModelFilterSet,
- CreatedUpdatedFilterSet
-):
+class VirtualMachineFilterSet(PrimaryModelFilterSet, TenancyFilterSet, LocalConfigContextFilterSet):
q = django_filters.CharFilter(
method='search',
label='Search',
@@ -237,7 +230,7 @@ class VirtualMachineFilterSet(
return queryset.exclude(params)
-class VMInterfaceFilterSet(BaseFilterSet, CustomFieldModelFilterSet, CreatedUpdatedFilterSet):
+class VMInterfaceFilterSet(PrimaryModelFilterSet):
q = django_filters.CharFilter(
method='search',
label='Search',
diff --git a/netbox/virtualization/forms.py b/netbox/virtualization/forms.py
index 265674803..84a7728c2 100644
--- a/netbox/virtualization/forms.py
+++ b/netbox/virtualization/forms.py
@@ -646,7 +646,7 @@ class VMInterfaceForm(BootstrapMixin, InterfaceCommonForm, CustomFieldModelForm)
vm_id = self.initial.get('virtual_machine') or self.data.get('virtual_machine')
# Restrict parent interface assignment by VM
- self.fields['parent'].widget.add_query_param('virtualmachine_id', vm_id)
+ self.fields['parent'].widget.add_query_param('virtual_machine_id', vm_id)
# Limit VLAN choices by virtual machine
self.fields['untagged_vlan'].widget.add_query_param('available_on_virtualmachine', vm_id)
@@ -669,7 +669,7 @@ class VMInterfaceCreateForm(BootstrapMixin, InterfaceCommonForm):
required=False,
display_field='display_name',
query_params={
- 'virtualmachine_id': 'virtual_machine',
+ 'virtual_machine_id': '$virtual_machine',
}
)
mtu = forms.IntegerField(
@@ -712,9 +712,6 @@ class VMInterfaceCreateForm(BootstrapMixin, InterfaceCommonForm):
super().__init__(*args, **kwargs)
vm_id = self.initial.get('virtual_machine') or self.data.get('virtual_machine')
- # Restrict parent interface assignment by VM
- self.fields['parent'].widget.add_query_param('virtualmachine_id', vm_id)
-
# Limit VLAN choices by virtual machine
self.fields['untagged_vlan'].widget.add_query_param('available_on_virtualmachine', vm_id)
self.fields['tagged_vlans'].widget.add_query_param('available_on_virtualmachine', vm_id)
@@ -798,7 +795,7 @@ class VMInterfaceBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm):
vm_id = self.initial.get('virtual_machine')
# Restrict parent interface assignment by VM
- self.fields['parent'].widget.add_query_param('virtualmachine_id', vm_id)
+ self.fields['parent'].widget.add_query_param('virtual_machine_id', vm_id)
# Limit VLAN choices by virtual machine
self.fields['untagged_vlan'].widget.add_query_param('available_on_virtualmachine', vm_id)
diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py
index 76f7fe845..5aa43a869 100644
--- a/netbox/virtualization/models.py
+++ b/netbox/virtualization/models.py
@@ -30,7 +30,7 @@ __all__ = (
# Cluster types
#
-@extras_features('custom_fields', 'export_templates', 'webhooks')
+@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks')
class ClusterType(OrganizationalModel):
"""
A type of Cluster.
@@ -73,7 +73,7 @@ class ClusterType(OrganizationalModel):
# Cluster groups
#
-@extras_features('custom_fields', 'export_templates', 'webhooks')
+@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks')
class ClusterGroup(OrganizationalModel):
"""
An organizational group of Clusters.
diff --git a/netbox/virtualization/tests/test_filters.py b/netbox/virtualization/tests/test_filtersets.py
similarity index 94%
rename from netbox/virtualization/tests/test_filters.py
rename to netbox/virtualization/tests/test_filtersets.py
index c11423663..0ca6364a5 100644
--- a/netbox/virtualization/tests/test_filters.py
+++ b/netbox/virtualization/tests/test_filtersets.py
@@ -3,12 +3,13 @@ from django.test import TestCase
from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup
from ipam.models import IPAddress
from tenancy.models import Tenant, TenantGroup
+from utilities.testing import ChangeLoggedFilterSetTests
from virtualization.choices import *
-from virtualization.filters import *
+from virtualization.filtersets import *
from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface
-class ClusterTypeTestCase(TestCase):
+class ClusterTypeTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = ClusterType.objects.all()
filterset = ClusterTypeFilterSet
@@ -22,10 +23,6 @@ class ClusterTypeTestCase(TestCase):
)
ClusterType.objects.bulk_create(cluster_types)
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Cluster Type 1', 'Cluster Type 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -39,7 +36,7 @@ class ClusterTypeTestCase(TestCase):
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class ClusterGroupTestCase(TestCase):
+class ClusterGroupTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = ClusterGroup.objects.all()
filterset = ClusterGroupFilterSet
@@ -53,10 +50,6 @@ class ClusterGroupTestCase(TestCase):
)
ClusterGroup.objects.bulk_create(cluster_groups)
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Cluster Group 1', 'Cluster Group 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -70,7 +63,7 @@ class ClusterGroupTestCase(TestCase):
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class ClusterTestCase(TestCase):
+class ClusterTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = Cluster.objects.all()
filterset = ClusterFilterSet
@@ -136,10 +129,6 @@ class ClusterTestCase(TestCase):
)
Cluster.objects.bulk_create(clusters)
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Cluster 1', 'Cluster 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -194,7 +183,7 @@ class ClusterTestCase(TestCase):
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class VirtualMachineTestCase(TestCase):
+class VirtualMachineTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = VirtualMachine.objects.all()
filterset = VirtualMachineFilterSet
@@ -297,10 +286,6 @@ class VirtualMachineTestCase(TestCase):
VirtualMachine.objects.filter(pk=vms[0].pk).update(primary_ip4=ipaddresses[0])
VirtualMachine.objects.filter(pk=vms[1].pk).update(primary_ip4=ipaddresses[1])
- def test_id(self):
- params = {'id': self.queryset.values_list('pk', flat=True)[:2]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Virtual Machine 1', 'Virtual Machine 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
@@ -409,7 +394,7 @@ class VirtualMachineTestCase(TestCase):
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-class VMInterfaceTestCase(TestCase):
+class VMInterfaceTestCase(TestCase, ChangeLoggedFilterSetTests):
queryset = VMInterface.objects.all()
filterset = VMInterfaceFilterSet
@@ -444,11 +429,6 @@ class VMInterfaceTestCase(TestCase):
)
VMInterface.objects.bulk_create(interfaces)
- def test_id(self):
- id_list = self.queryset.values_list('id', flat=True)[:2]
- params = {'id': [str(id) for id in id_list]}
- self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
-
def test_name(self):
params = {'name': ['Interface 1', 'Interface 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py
index 6b316de0e..421278d6e 100644
--- a/netbox/virtualization/views.py
+++ b/netbox/virtualization/views.py
@@ -13,7 +13,7 @@ from netbox.views import generic
from secrets.models import Secret
from utilities.tables import paginate_table
from utilities.utils import count_related
-from . import filters, forms, tables
+from . import filtersets, forms, tables
from .models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface
@@ -64,7 +64,7 @@ class ClusterTypeBulkEditView(generic.BulkEditView):
queryset = ClusterType.objects.annotate(
cluster_count=count_related(Cluster, 'type')
)
- filterset = filters.ClusterTypeFilterSet
+ filterset = filtersets.ClusterTypeFilterSet
table = tables.ClusterTypeTable
form = forms.ClusterTypeBulkEditForm
@@ -125,7 +125,7 @@ class ClusterGroupBulkEditView(generic.BulkEditView):
queryset = ClusterGroup.objects.annotate(
cluster_count=count_related(Cluster, 'group')
)
- filterset = filters.ClusterGroupFilterSet
+ filterset = filtersets.ClusterGroupFilterSet
table = tables.ClusterGroupTable
form = forms.ClusterGroupBulkEditForm
@@ -148,7 +148,7 @@ class ClusterListView(generic.ObjectListView):
vm_count=count_related(VirtualMachine, 'cluster')
)
table = tables.ClusterTable
- filterset = filters.ClusterFilterSet
+ filterset = filtersets.ClusterFilterSet
filterset_form = forms.ClusterFilterForm
@@ -205,14 +205,14 @@ class ClusterBulkImportView(generic.BulkImportView):
class ClusterBulkEditView(generic.BulkEditView):
queryset = Cluster.objects.prefetch_related('type', 'group', 'site')
- filterset = filters.ClusterFilterSet
+ filterset = filtersets.ClusterFilterSet
table = tables.ClusterTable
form = forms.ClusterBulkEditForm
class ClusterBulkDeleteView(generic.BulkDeleteView):
queryset = Cluster.objects.prefetch_related('type', 'group', 'site')
- filterset = filters.ClusterFilterSet
+ filterset = filtersets.ClusterFilterSet
table = tables.ClusterTable
@@ -304,7 +304,7 @@ class ClusterRemoveDevicesView(generic.ObjectEditView):
class VirtualMachineListView(generic.ObjectListView):
queryset = VirtualMachine.objects.all()
- filterset = filters.VirtualMachineFilterSet
+ filterset = filtersets.VirtualMachineFilterSet
filterset_form = forms.VirtualMachineFilterForm
table = tables.VirtualMachineDetailTable
template_name = 'virtualization/virtualmachine_list.html'
@@ -388,14 +388,14 @@ class VirtualMachineBulkImportView(generic.BulkImportView):
class VirtualMachineBulkEditView(generic.BulkEditView):
queryset = VirtualMachine.objects.prefetch_related('cluster', 'tenant', 'role')
- filterset = filters.VirtualMachineFilterSet
+ filterset = filtersets.VirtualMachineFilterSet
table = tables.VirtualMachineTable
form = forms.VirtualMachineBulkEditForm
class VirtualMachineBulkDeleteView(generic.BulkDeleteView):
queryset = VirtualMachine.objects.prefetch_related('cluster', 'tenant', 'role')
- filterset = filters.VirtualMachineFilterSet
+ filterset = filtersets.VirtualMachineFilterSet
table = tables.VirtualMachineTable
@@ -405,7 +405,7 @@ class VirtualMachineBulkDeleteView(generic.BulkDeleteView):
class VMInterfaceListView(generic.ObjectListView):
queryset = VMInterface.objects.all()
- filterset = filters.VMInterfaceFilterSet
+ filterset = filtersets.VMInterfaceFilterSet
filterset_form = forms.VMInterfaceFilterForm
table = tables.VMInterfaceTable
action_buttons = ('export',)
@@ -500,7 +500,7 @@ class VirtualMachineBulkAddInterfaceView(generic.BulkComponentCreateView):
form = forms.VMInterfaceBulkCreateForm
queryset = VMInterface.objects.all()
model_form = forms.VMInterfaceForm
- filterset = filters.VirtualMachineFilterSet
+ filterset = filtersets.VirtualMachineFilterSet
table = tables.VirtualMachineTable
def get_required_permission(self):
diff --git a/requirements.txt b/requirements.txt
index a9e000bf3..f7ae8178d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,5 +1,5 @@
-Django==3.2
-django-cacheops==5.1
+Django==3.2.2
+django-cacheops==6.0
django-cors-headers==3.7.0
django-debug-toolbar==3.2.1
django-filter==2.4.0
+