From 9615dc0638829be293c0ca32ebddeabaaed2c18a Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Mon, 14 Dec 2020 16:30:10 -0600 Subject: [PATCH 001/302] Fixes: #5458 - Fix devicetype_component_table.html --- docs/release-notes/version-2.10.md | 6 ++++++ netbox/templates/dcim/inc/devicetype_component_table.html | 8 ++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 15ac1fc04..7cc15552e 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,5 +1,11 @@ # NetBox v2.10 +## v2.10.1 (Future Release) + +### Bug Fixes + +* [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception + ## v2.10.0 (2020-12-14) **NOTE:** This release completely removes support for embedded graphs. diff --git a/netbox/templates/dcim/inc/devicetype_component_table.html b/netbox/templates/dcim/inc/devicetype_component_table.html index a8e04e9dc..c0a2ff22a 100644 --- a/netbox/templates/dcim/inc/devicetype_component_table.html +++ b/netbox/templates/dcim/inc/devicetype_component_table.html @@ -9,18 +9,18 @@ {% include 'responsive_table.html' %}
{% if table.rows %} - - - {% endif %}
- + Add {{ title }} From 1f4954bf0ed8e6cb3eb9368ec70066995fcb73cc Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 15 Dec 2020 08:39:27 -0600 Subject: [PATCH 002/302] Fixes: #5461 - Assign object=rack in netbox/templates/dcim/rack_elevation_list.html --- docs/release-notes/version-2.10.md | 1 + netbox/templates/dcim/rack_elevation_list.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 7cc15552e..7584d8eae 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -5,6 +5,7 @@ ### Bug Fixes * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception +* [#5461](https://github.com/netbox-community/netbox/issues/5461) - Rack Elevations throw reverse match exception ## v2.10.0 (2020-12-14) diff --git a/netbox/templates/dcim/rack_elevation_list.html b/netbox/templates/dcim/rack_elevation_list.html index 081533ae9..1f4782847 100644 --- a/netbox/templates/dcim/rack_elevation_list.html +++ b/netbox/templates/dcim/rack_elevation_list.html @@ -35,7 +35,7 @@
{{ rack.facility_id }} {% endif %}
- {% include 'dcim/inc/rack_elevation.html' with face=rack_face %} + {% include 'dcim/inc/rack_elevation.html' with object=rack face=rack_face %}
{{ rack.name }} From 974500c2817719dbd1861d379ede300d54901a65 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 12:01:53 -0500 Subject: [PATCH 003/302] Add test for #5461 --- netbox/dcim/tests/test_views.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index 97a4f3705..91ec8776c 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -302,6 +302,14 @@ class RackTestCase(ViewTestCases.PrimaryObjectViewTestCase): 'comments': 'New comments', } + @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) + def test_list_rack_elevations(self): + """ + Test viewing the list of rack elevations. + """ + response = self.client.get(reverse('dcim:rack_elevation_list')) + self.assertHttpStatus(response, 200) + class ManufacturerTestCase(ViewTestCases.OrganizationalObjectViewTestCase): model = Manufacturer From 14a46f82ee346a8e5edb3a3dc91cee779ceec8a4 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 15 Dec 2020 12:30:42 -0600 Subject: [PATCH 004/302] Fixes: #5463 - Add check for ip_addresses attribute on circuittermination connected_endpoint --- docs/release-notes/version-2.10.md | 1 + netbox/circuits/views.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 7584d8eae..771fbbdbc 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -6,6 +6,7 @@ * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception * [#5461](https://github.com/netbox-community/netbox/issues/5461) - Rack Elevations throw reverse match exception +* [#5463](https://github.com/netbox-community/netbox/issues/5463) - Back-to-back Circuit Termination throws AttributeError exception ## v2.10.0 (2020-12-14) diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index 653c881a9..a237b8805 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -139,7 +139,7 @@ class CircuitView(generic.ObjectView): ).filter( circuit=instance, term_side=CircuitTerminationSideChoices.SIDE_A ).first() - if termination_a and termination_a.connected_endpoint: + if termination_a and termination_a.connected_endpoint and hasattr(termination_a.connected_endpoint, 'ip_addresses'): termination_a.ip_addresses = termination_a.connected_endpoint.ip_addresses.restrict(request.user, 'view') # Z-side termination @@ -148,7 +148,7 @@ class CircuitView(generic.ObjectView): ).filter( circuit=instance, term_side=CircuitTerminationSideChoices.SIDE_Z ).first() - if termination_z and termination_z.connected_endpoint: + if termination_z and termination_z.connected_endpoint and hasattr(termination_z.connected_endpoint, 'ip_addresses'): termination_z.ip_addresses = termination_z.connected_endpoint.ip_addresses.restrict(request.user, 'view') return { From 67f9e16905a25eb18b0dd50889d841dadbe88b44 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 13:37:02 -0500 Subject: [PATCH 005/302] Fixes #5453: Correct change log representation when creating a cable --- docs/release-notes/version-2.10.md | 5 ++++- netbox/dcim/models/cables.py | 3 ++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 771fbbdbc..d62646bc4 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,13 +1,16 @@ # NetBox v2.10 -## v2.10.1 (Future Release) +## v2.10.1 (FUTURE) ### Bug Fixes +* [#5453](https://github.com/netbox-community/netbox/issues/5453) - Correct change log representation when creating a cable * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception * [#5461](https://github.com/netbox-community/netbox/issues/5461) - Rack Elevations throw reverse match exception * [#5463](https://github.com/netbox-community/netbox/issues/5463) - Back-to-back Circuit Termination throws AttributeError exception +--- + ## v2.10.0 (2020-12-14) **NOTE:** This release completely removes support for embedded graphs. diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 7a9f2dc2c..6a530bb49 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -147,7 +147,8 @@ class Cable(ChangeLoggedModel, CustomFieldModel): return instance def __str__(self): - return self.label or '#{}'.format(self._pk) + pk = self.pk or self._pk + return self.label or f'#{pk}' def get_absolute_url(self): return reverse('dcim:cable', args=[self.pk]) From 3c2b2f26b903e13f26ba6b69511c7ef7fd2ca706 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 15 Dec 2020 12:50:28 -0600 Subject: [PATCH 006/302] Fixes: #5450 - Added Coalesce to viewsets for the _count functions --- docs/release-notes/version-2.10.md | 1 + netbox/circuits/api/views.py | 5 ++-- netbox/dcim/api/views.py | 39 +++++++++++++++--------------- netbox/extras/api/views.py | 3 ++- netbox/ipam/api/views.py | 15 ++++++------ netbox/secrets/api/views.py | 3 ++- netbox/tenancy/api/views.py | 15 ++++++------ netbox/virtualization/api/views.py | 9 ++++--- 8 files changed, 49 insertions(+), 41 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index d62646bc4..d5df2ae49 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5450](https://github.com/netbox-community/netbox/issues/5450) - API serializer foreign count fields do not have a default value * [#5453](https://github.com/netbox-community/netbox/issues/5453) - Correct change log representation when creating a cable * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception * [#5461](https://github.com/netbox-community/netbox/issues/5461) - Rack Elevations throw reverse match exception diff --git a/netbox/circuits/api/views.py b/netbox/circuits/api/views.py index ad497ee5f..ef5a944e2 100644 --- a/netbox/circuits/api/views.py +++ b/netbox/circuits/api/views.py @@ -1,4 +1,5 @@ from django.db.models import Prefetch +from django.db.models.functions import Coalesce from rest_framework.routers import APIRootView from circuits import filters @@ -24,7 +25,7 @@ class CircuitsRootView(APIRootView): class ProviderViewSet(CustomFieldModelViewSet): queryset = Provider.objects.prefetch_related('tags').annotate( - circuit_count=get_subquery(Circuit, 'provider') + circuit_count=Coalesce(get_subquery(Circuit, 'provider'), 0) ) serializer_class = serializers.ProviderSerializer filterset_class = filters.ProviderFilterSet @@ -36,7 +37,7 @@ class ProviderViewSet(CustomFieldModelViewSet): class CircuitTypeViewSet(ModelViewSet): queryset = CircuitType.objects.annotate( - circuit_count=get_subquery(Circuit, 'type') + circuit_count=Coalesce(get_subquery(Circuit, 'type'), 0) ) serializer_class = serializers.CircuitTypeSerializer filterset_class = filters.CircuitTypeFilterSet diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 071174c76..db36c3176 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -3,6 +3,7 @@ from collections import OrderedDict from django.conf import settings from django.db.models import F +from django.db.models.functions import Coalesce from django.http import HttpResponseForbidden, HttpResponse from django.shortcuts import get_object_or_404 from drf_yasg import openapi @@ -119,12 +120,12 @@ class SiteViewSet(CustomFieldModelViewSet): queryset = Site.objects.prefetch_related( 'region', 'tenant', 'tags' ).annotate( - device_count=get_subquery(Device, 'site'), - rack_count=get_subquery(Rack, 'site'), - prefix_count=get_subquery(Prefix, 'site'), - vlan_count=get_subquery(VLAN, 'site'), - circuit_count=get_subquery(Circuit, 'terminations__site'), - virtualmachine_count=get_subquery(VirtualMachine, 'cluster__site'), + device_count=Coalesce(get_subquery(Device, 'site'), 0), + rack_count=Coalesce(get_subquery(Rack, 'site'), 0), + prefix_count=Coalesce(get_subquery(Prefix, 'site'), 0), + vlan_count=Coalesce(get_subquery(VLAN, 'site'), 0), + circuit_count=Coalesce(get_subquery(Circuit, 'terminations__site'), 0), + virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'cluster__site'), 0), ) serializer_class = serializers.SiteSerializer filterset_class = filters.SiteFilterSet @@ -152,7 +153,7 @@ class RackGroupViewSet(ModelViewSet): class RackRoleViewSet(ModelViewSet): queryset = RackRole.objects.annotate( - rack_count=get_subquery(Rack, 'role') + rack_count=Coalesce(get_subquery(Rack, 'role'), 0) ) serializer_class = serializers.RackRoleSerializer filterset_class = filters.RackRoleFilterSet @@ -166,8 +167,8 @@ class RackViewSet(CustomFieldModelViewSet): queryset = Rack.objects.prefetch_related( 'site', 'group__site', 'role', 'tenant', 'tags' ).annotate( - device_count=get_subquery(Device, 'rack'), - powerfeed_count=get_subquery(PowerFeed, 'rack') + device_count=Coalesce(get_subquery(Device, 'rack'), 0), + powerfeed_count=Coalesce(get_subquery(PowerFeed, 'rack'), 0) ) serializer_class = serializers.RackSerializer filterset_class = filters.RackFilterSet @@ -240,9 +241,9 @@ class RackReservationViewSet(ModelViewSet): class ManufacturerViewSet(ModelViewSet): queryset = Manufacturer.objects.annotate( - devicetype_count=get_subquery(DeviceType, 'manufacturer'), - inventoryitem_count=get_subquery(InventoryItem, 'manufacturer'), - platform_count=get_subquery(Platform, 'manufacturer') + devicetype_count=Coalesce(get_subquery(DeviceType, 'manufacturer'), 0), + inventoryitem_count=Coalesce(get_subquery(InventoryItem, 'manufacturer'), 0), + platform_count=Coalesce(get_subquery(Platform, 'manufacturer'), 0) ) serializer_class = serializers.ManufacturerSerializer filterset_class = filters.ManufacturerFilterSet @@ -254,7 +255,7 @@ class ManufacturerViewSet(ModelViewSet): class DeviceTypeViewSet(CustomFieldModelViewSet): queryset = DeviceType.objects.prefetch_related('manufacturer', 'tags').annotate( - device_count=get_subquery(Device, 'device_type') + device_count=Coalesce(get_subquery(Device, 'device_type'), 0) ) serializer_class = serializers.DeviceTypeSerializer filterset_class = filters.DeviceTypeFilterSet @@ -318,8 +319,8 @@ class DeviceBayTemplateViewSet(ModelViewSet): class DeviceRoleViewSet(ModelViewSet): queryset = DeviceRole.objects.annotate( - device_count=get_subquery(Device, 'device_role'), - virtualmachine_count=get_subquery(VirtualMachine, 'role') + device_count=Coalesce(get_subquery(Device, 'device_role'), 0), + virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'role'), 0) ) serializer_class = serializers.DeviceRoleSerializer filterset_class = filters.DeviceRoleFilterSet @@ -331,8 +332,8 @@ class DeviceRoleViewSet(ModelViewSet): class PlatformViewSet(ModelViewSet): queryset = Platform.objects.annotate( - device_count=get_subquery(Device, 'platform'), - virtualmachine_count=get_subquery(VirtualMachine, 'platform') + device_count=Coalesce(get_subquery(Device, 'platform'), 0), + virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'platform'), 0) ) serializer_class = serializers.PlatformSerializer filterset_class = filters.PlatformFilterSet @@ -596,7 +597,7 @@ class CableViewSet(ModelViewSet): class VirtualChassisViewSet(ModelViewSet): queryset = VirtualChassis.objects.prefetch_related('tags').annotate( - member_count=get_subquery(Device, 'virtual_chassis') + member_count=Coalesce(get_subquery(Device, 'virtual_chassis'), 0) ) serializer_class = serializers.VirtualChassisSerializer filterset_class = filters.VirtualChassisFilterSet @@ -610,7 +611,7 @@ class PowerPanelViewSet(ModelViewSet): queryset = PowerPanel.objects.prefetch_related( 'site', 'rack_group' ).annotate( - powerfeed_count=get_subquery(PowerFeed, 'power_panel') + powerfeed_count=Coalesce(get_subquery(PowerFeed, 'power_panel'), 0) ) serializer_class = serializers.PowerPanelSerializer filterset_class = filters.PowerPanelFilterSet diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index 38077c89a..fcd9add7c 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -1,4 +1,5 @@ from django.contrib.contenttypes.models import ContentType +from django.db.models.functions import Coalesce from django.http import Http404 from django_rq.queues import get_connection from rest_framework import status @@ -102,7 +103,7 @@ class ExportTemplateViewSet(ModelViewSet): class TagViewSet(ModelViewSet): queryset = Tag.objects.annotate( - tagged_items=get_subquery(TaggedItem, 'tag') + tagged_items=Coalesce(get_subquery(TaggedItem, 'tag'), 0) ) serializer_class = serializers.TagSerializer filterset_class = filters.TagFilterSet diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index 9d09bbe03..fb38edf46 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -1,4 +1,5 @@ from django.conf import settings +from django.db.models.functions import Coalesce from django.shortcuts import get_object_or_404 from django_pglocks import advisory_lock from drf_yasg.utils import swagger_auto_schema @@ -32,8 +33,8 @@ class VRFViewSet(CustomFieldModelViewSet): queryset = VRF.objects.prefetch_related('tenant').prefetch_related( 'import_targets', 'export_targets', 'tags' ).annotate( - ipaddress_count=get_subquery(IPAddress, 'vrf'), - prefix_count=get_subquery(Prefix, 'vrf') + ipaddress_count=Coalesce(get_subquery(IPAddress, 'vrf'), 0), + prefix_count=Coalesce(get_subquery(Prefix, 'vrf'), 0) ) serializer_class = serializers.VRFSerializer filterset_class = filters.VRFFilterSet @@ -55,7 +56,7 @@ class RouteTargetViewSet(CustomFieldModelViewSet): class RIRViewSet(ModelViewSet): queryset = RIR.objects.annotate( - aggregate_count=get_subquery(Aggregate, 'rir') + aggregate_count=Coalesce(get_subquery(Aggregate, 'rir'), 0) ) serializer_class = serializers.RIRSerializer filterset_class = filters.RIRFilterSet @@ -77,8 +78,8 @@ class AggregateViewSet(CustomFieldModelViewSet): class RoleViewSet(ModelViewSet): queryset = Role.objects.annotate( - prefix_count=get_subquery(Prefix, 'role'), - vlan_count=get_subquery(VLAN, 'role') + prefix_count=Coalesce(get_subquery(Prefix, 'role'), 0), + vlan_count=Coalesce(get_subquery(VLAN, 'role'), 0) ) serializer_class = serializers.RoleSerializer filterset_class = filters.RoleFilterSet @@ -272,7 +273,7 @@ class IPAddressViewSet(CustomFieldModelViewSet): class VLANGroupViewSet(ModelViewSet): queryset = VLANGroup.objects.prefetch_related('site').annotate( - vlan_count=get_subquery(VLAN, 'group') + vlan_count=Coalesce(get_subquery(VLAN, 'group'), 0) ) serializer_class = serializers.VLANGroupSerializer filterset_class = filters.VLANGroupFilterSet @@ -286,7 +287,7 @@ class VLANViewSet(CustomFieldModelViewSet): queryset = VLAN.objects.prefetch_related( 'site', 'group', 'tenant', 'role', 'tags' ).annotate( - prefix_count=get_subquery(Prefix, 'vlan') + prefix_count=Coalesce(get_subquery(Prefix, 'vlan'), 0) ) serializer_class = serializers.VLANSerializer filterset_class = filters.VLANFilterSet diff --git a/netbox/secrets/api/views.py b/netbox/secrets/api/views.py index 1153b0508..617da5c6e 100644 --- a/netbox/secrets/api/views.py +++ b/netbox/secrets/api/views.py @@ -1,6 +1,7 @@ import base64 from Crypto.PublicKey import RSA +from django.db.models.functions import Coalesce from django.http import HttpResponseBadRequest from rest_framework.exceptions import ValidationError from rest_framework.permissions import IsAuthenticated @@ -35,7 +36,7 @@ class SecretsRootView(APIRootView): class SecretRoleViewSet(ModelViewSet): queryset = SecretRole.objects.annotate( - secret_count=get_subquery(Secret, 'role') + secret_count=Coalesce(get_subquery(Secret, 'role'), 0) ) serializer_class = serializers.SecretRoleSerializer filterset_class = filters.SecretRoleFilterSet diff --git a/netbox/tenancy/api/views.py b/netbox/tenancy/api/views.py index 34be4991e..142203b58 100644 --- a/netbox/tenancy/api/views.py +++ b/netbox/tenancy/api/views.py @@ -1,3 +1,4 @@ +from django.db.models.functions import Coalesce from rest_framework.routers import APIRootView from circuits.models import Circuit @@ -46,13 +47,13 @@ class TenantViewSet(CustomFieldModelViewSet): ).annotate( circuit_count=get_subquery(Circuit, 'tenant'), device_count=get_subquery(Device, 'tenant'), - ipaddress_count=get_subquery(IPAddress, 'tenant'), - prefix_count=get_subquery(Prefix, 'tenant'), - rack_count=get_subquery(Rack, 'tenant'), - site_count=get_subquery(Site, 'tenant'), - virtualmachine_count=get_subquery(VirtualMachine, 'tenant'), - vlan_count=get_subquery(VLAN, 'tenant'), - vrf_count=get_subquery(VRF, 'tenant') + ipaddress_count=Coalesce(get_subquery(IPAddress, 'tenant'), 0), + prefix_count=Coalesce(get_subquery(Prefix, 'tenant'), 0), + rack_count=Coalesce(get_subquery(Rack, 'tenant'), 0), + site_count=Coalesce(get_subquery(Site, 'tenant'), 0), + virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'tenant'), 0), + vlan_count=Coalesce(get_subquery(VLAN, 'tenant'), 0), + vrf_count=Coalesce(get_subquery(VRF, 'tenant'), 0) ) serializer_class = serializers.TenantSerializer filterset_class = filters.TenantFilterSet diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index 2a2a149d4..e2d3d5ea5 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -1,3 +1,4 @@ +from django.db.models.functions import Coalesce from rest_framework.routers import APIRootView from dcim.models import Device @@ -22,7 +23,7 @@ class VirtualizationRootView(APIRootView): class ClusterTypeViewSet(ModelViewSet): queryset = ClusterType.objects.annotate( - cluster_count=get_subquery(Cluster, 'type') + cluster_count=Coalesce(get_subquery(Cluster, 'type'), 0) ) serializer_class = serializers.ClusterTypeSerializer filterset_class = filters.ClusterTypeFilterSet @@ -30,7 +31,7 @@ class ClusterTypeViewSet(ModelViewSet): class ClusterGroupViewSet(ModelViewSet): queryset = ClusterGroup.objects.annotate( - cluster_count=get_subquery(Cluster, 'group') + cluster_count=Coalesce(get_subquery(Cluster, 'group'), 0) ) serializer_class = serializers.ClusterGroupSerializer filterset_class = filters.ClusterGroupFilterSet @@ -40,8 +41,8 @@ class ClusterViewSet(CustomFieldModelViewSet): queryset = Cluster.objects.prefetch_related( 'type', 'group', 'tenant', 'site', 'tags' ).annotate( - device_count=get_subquery(Device, 'cluster'), - virtualmachine_count=get_subquery(VirtualMachine, 'cluster') + device_count=Coalesce(get_subquery(Device, 'cluster'), 0), + virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'cluster'), 0) ) serializer_class = serializers.ClusterSerializer filterset_class = filters.ClusterFilterSet From 6a3dab01426af97140a8e0eb5cf1475d90a6542a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 13:52:35 -0500 Subject: [PATCH 007/302] Fixes #5465: Correct return URL when disconnecting a cable from a device --- docs/release-notes/version-2.10.md | 1 + netbox/templates/dcim/inc/cable_toggle_buttons.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index d5df2ae49..7667c92c9 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -9,6 +9,7 @@ * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception * [#5461](https://github.com/netbox-community/netbox/issues/5461) - Rack Elevations throw reverse match exception * [#5463](https://github.com/netbox-community/netbox/issues/5463) - Back-to-back Circuit Termination throws AttributeError exception +* [#5465](https://github.com/netbox-community/netbox/issues/5465) - Correct return URL when disconnecting a cable from a device --- diff --git a/netbox/templates/dcim/inc/cable_toggle_buttons.html b/netbox/templates/dcim/inc/cable_toggle_buttons.html index 74fb5eb36..98e4efd94 100644 --- a/netbox/templates/dcim/inc/cable_toggle_buttons.html +++ b/netbox/templates/dcim/inc/cable_toggle_buttons.html @@ -10,7 +10,7 @@ {% endif %} {% endif %} {% if perms.dcim.delete_cable %} - + {% endif %} From 34643f536ee3d1ba3a75ea76e09769d20ded26ca Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 15:56:42 -0500 Subject: [PATCH 008/302] Fixes #5466: Fix validation for required custom fields --- docs/release-notes/version-2.10.md | 1 + netbox/extras/forms.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 7667c92c9..9651cf6c4 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -10,6 +10,7 @@ * [#5461](https://github.com/netbox-community/netbox/issues/5461) - Rack Elevations throw reverse match exception * [#5463](https://github.com/netbox-community/netbox/issues/5463) - Back-to-back Circuit Termination throws AttributeError exception * [#5465](https://github.com/netbox-community/netbox/issues/5465) - Correct return URL when disconnecting a cable from a device +* [#5466](https://github.com/netbox-community/netbox/issues/5466) - Fix validation for required custom fields --- diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index eee54076b..932d07a4d 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -46,13 +46,13 @@ class CustomFieldModelForm(forms.ModelForm): # Annotate the field in the list of CustomField form fields self.custom_fields.append(field_name) - def save(self, commit=True): + def clean(self): # Save custom field data on instance for cf_name in self.custom_fields: self.instance.custom_field_data[cf_name[3:]] = self.cleaned_data.get(cf_name) - return super().save(commit) + return super().clean() class CustomFieldModelCSVForm(CSVModelForm, CustomFieldModelForm): From d64fc261e249371279ecf9a1e7ebc1de39498b07 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 16:00:18 -0500 Subject: [PATCH 009/302] Tweak validation for custom date fields --- netbox/extras/models/customfields.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index be06eea8a..6f4c5f9e1 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -1,6 +1,6 @@ import re from collections import OrderedDict -from datetime import datetime +from datetime import datetime, date from django import forms from django.contrib.contenttypes.models import ContentType @@ -317,10 +317,11 @@ class CustomField(models.Model): # Validate date if self.type == CustomFieldTypeChoices.TYPE_DATE: - try: - datetime.strptime(value, '%Y-%m-%d') - except ValueError: - raise ValidationError("Date values must be in the format YYYY-MM-DD.") + if type(value) is not date: + try: + datetime.strptime(value, '%Y-%m-%d') + except ValueError: + raise ValidationError("Date values must be in the format YYYY-MM-DD.") # Validate selected choice if self.type == CustomFieldTypeChoices.TYPE_SELECT: From 3c2ddf1f69d9ee2e2a48a9062dda434640e91ba3 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 16:17:52 -0500 Subject: [PATCH 010/302] Fixes #5444: Don't force overwriting of mgmt_only when bulk editing interfaces --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/forms.py | 7 ++++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 9651cf6c4..42da90f57 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5444](https://github.com/netbox-community/netbox/issues/5444) - Don't force overwriting of `mgmt_only` when bulk editing interfaces * [#5450](https://github.com/netbox-community/netbox/issues/5450) - API serializer foreign count fields do not have a default value * [#5453](https://github.com/netbox-community/netbox/issues/5453) - Correct change log representation when creating a cable * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index ca7602bf2..33872539b 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -2839,7 +2839,7 @@ class InterfaceBulkCreateForm( class InterfaceBulkEditForm( form_from_model(Interface, [ - 'label', 'type', 'enabled', 'lag', 'mac_address', 'mtu', 'mgmt_only', 'description', 'mode' + 'label', 'type', 'enabled', 'lag', 'mac_address', 'mtu', 'description', 'mode' ]), BootstrapMixin, AddRemoveTagsForm, @@ -2855,6 +2855,11 @@ class InterfaceBulkEditForm( disabled=True, widget=forms.HiddenInput() ) + mgmt_only = forms.NullBooleanField( + required=False, + widget=BulkEditNullBooleanSelect, + label='Management only' + ) untagged_vlan = DynamicModelChoiceField( queryset=VLAN.objects.all(), required=False, From e2d17b199907692fd10e99b31de2b697a3d29e8a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 16:52:58 -0500 Subject: [PATCH 011/302] #5444: Also fix the enabled field' --- docs/release-notes/version-2.10.md | 2 +- netbox/dcim/forms.py | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 42da90f57..6c4433e37 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,7 +4,7 @@ ### Bug Fixes -* [#5444](https://github.com/netbox-community/netbox/issues/5444) - Don't force overwriting of `mgmt_only` when bulk editing interfaces +* [#5444](https://github.com/netbox-community/netbox/issues/5444) - Don't force overwriting of boolean fields when bulk editing interfaces * [#5450](https://github.com/netbox-community/netbox/issues/5450) - API serializer foreign count fields do not have a default value * [#5453](https://github.com/netbox-community/netbox/issues/5453) - Correct change log representation when creating a cable * [#5458](https://github.com/netbox-community/netbox/issues/5458) - Creating a component template throws an exception diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 33872539b..cb2aa10e6 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -2839,7 +2839,7 @@ class InterfaceBulkCreateForm( class InterfaceBulkEditForm( form_from_model(Interface, [ - 'label', 'type', 'enabled', 'lag', 'mac_address', 'mtu', 'description', 'mode' + 'label', 'type', 'lag', 'mac_address', 'mtu', 'description', 'mode' ]), BootstrapMixin, AddRemoveTagsForm, @@ -2855,6 +2855,10 @@ class InterfaceBulkEditForm( disabled=True, widget=forms.HiddenInput() ) + enabled = forms.NullBooleanField( + required=False, + widget=BulkEditNullBooleanSelect + ) mgmt_only = forms.NullBooleanField( required=False, widget=BulkEditNullBooleanSelect, From c835ec5102b5ea01431bc017aea691f0939464e0 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 21:04:47 -0500 Subject: [PATCH 012/302] Fixes #5470: Fix exception when making OPTIONS request for a REST API list endpoint --- docs/release-notes/version-2.10.md | 1 + netbox/netbox/api/metadata.py | 37 +++++++++++++++++++++++++++++- netbox/netbox/settings.py | 1 + netbox/utilities/testing/api.py | 17 ++++++++++++++ 4 files changed, 55 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 6c4433e37..3cf2b0d09 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -12,6 +12,7 @@ * [#5463](https://github.com/netbox-community/netbox/issues/5463) - Back-to-back Circuit Termination throws AttributeError exception * [#5465](https://github.com/netbox-community/netbox/issues/5465) - Correct return URL when disconnecting a cable from a device * [#5466](https://github.com/netbox-community/netbox/issues/5466) - Fix validation for required custom fields +* [#5470](https://github.com/netbox-community/netbox/issues/5470) - Fix exception when making `OPTIONS` request for a REST API list endpoint --- diff --git a/netbox/netbox/api/metadata.py b/netbox/netbox/api/metadata.py index 1d0397e4d..bc4ecf871 100644 --- a/netbox/netbox/api/metadata.py +++ b/netbox/netbox/api/metadata.py @@ -1,10 +1,45 @@ +from django.core.exceptions import PermissionDenied +from django.http import Http404 from django.utils.encoding import force_str +from rest_framework import exceptions from rest_framework.metadata import SimpleMetadata +from rest_framework.request import clone_request from netbox.api import ContentTypeField -class ContentTypeMetadata(SimpleMetadata): +class BulkOperationMetadata(SimpleMetadata): + + def determine_actions(self, request, view): + """ + Replace the stock determine_actions() method to assess object permissions only + when viewing a specific object. This is necessary to support OPTIONS requests + with bulk update in place (see #5470). + """ + actions = {} + for method in {'PUT', 'POST'} & set(view.allowed_methods): + view.request = clone_request(request, method) + try: + # Test global permissions + if hasattr(view, 'check_permissions'): + view.check_permissions(view.request) + # Test object permissions (if viewing a specific object) + if method == 'PUT' and view.lookup_url_kwarg and hasattr(view, 'get_object'): + view.get_object() + except (exceptions.APIException, PermissionDenied, Http404): + pass + else: + # If user has appropriate permissions for the view, include + # appropriate metadata about the fields that should be supplied. + serializer = view.get_serializer() + actions[method] = self.get_serializer_info(serializer) + finally: + view.request = request + + return actions + + +class ContentTypeMetadata(BulkOperationMetadata): def get_field_info(self, field): field_info = super().get_field_info(field) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 8c3c992e2..6dbc61018 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -467,6 +467,7 @@ REST_FRAMEWORK = { 'DEFAULT_FILTER_BACKENDS': ( 'django_filters.rest_framework.DjangoFilterBackend', ), + 'DEFAULT_METADATA_CLASS': 'netbox.api.metadata.BulkOperationMetadata', 'DEFAULT_PAGINATION_CLASS': 'netbox.api.pagination.OptionalLimitOffsetPagination', 'DEFAULT_PERMISSION_CLASSES': ( 'netbox.api.authentication.TokenPermissions', diff --git a/netbox/utilities/testing/api.py b/netbox/utilities/testing/api.py index f81722fa8..f4f4ffefe 100644 --- a/netbox/utilities/testing/api.py +++ b/netbox/utilities/testing/api.py @@ -109,6 +109,15 @@ class APIViewTestCases: url = self._get_detail_url(instance2) self.assertHttpStatus(self.client.get(url, **self.header), status.HTTP_404_NOT_FOUND) + @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) + def test_options_object(self): + """ + Make an OPTIONS request for a single object. + """ + url = self._get_detail_url(self._get_queryset().first()) + response = self.client.options(url, **self.header) + self.assertHttpStatus(response, status.HTTP_200_OK) + class ListObjectsViewTestCase(APITestCase): brief_fields = [] @@ -174,6 +183,14 @@ class APIViewTestCases: self.assertHttpStatus(response, status.HTTP_200_OK) self.assertEqual(len(response.data['results']), 2) + @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) + def test_options_objects(self): + """ + Make an OPTIONS request for a list endpoint. + """ + response = self.client.options(self._get_list_url(), **self.header) + self.assertHttpStatus(response, status.HTTP_200_OK) + class CreateObjectViewTestCase(APITestCase): create_data = [] validation_excluded_fields = [] From 2dad44c93fd0e3d1f8138901965d7a000559bde5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 22:03:54 -0500 Subject: [PATCH 013/302] Release v2.10.1 --- docs/release-notes/version-2.10.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 3cf2b0d09..7cf199e21 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,6 +1,6 @@ # NetBox v2.10 -## v2.10.1 (FUTURE) +## v2.10.1 (2020-12-15) ### Bug Fixes diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 6dbc61018..b2269ca0e 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.1-dev' +VERSION = '2.10.1' # Hostname HOSTNAME = platform.node() From bd144c996a03bafd29c2b806f577a7796cd8d585 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 15 Dec 2020 22:16:26 -0500 Subject: [PATCH 014/302] PRVB --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index b2269ca0e..d496f9969 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.1' +VERSION = '2.10.2-dev' # Hostname HOSTNAME = platform.node() From 4ce7dfa55edc0ddc1229c22ad837bcb959c4ec60 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 16 Dec 2020 09:26:22 -0500 Subject: [PATCH 015/302] Fixes #5473: Fix alignment of rack names in elevations list --- docs/release-notes/version-2.10.md | 8 ++++++++ netbox/templates/dcim/rack.html | 4 ++++ netbox/templates/dcim/rack_elevation_list.html | 4 +++- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 7cf199e21..03e2858eb 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,5 +1,13 @@ # NetBox v2.10 +## v2.10.2 (FUTURE) + +### Bug Fixes + +* [#5473](https://github.com/netbox-community/netbox/issues/5473) - Fix alignment of rack names in elevations list + +--- + ## v2.10.1 (2020-12-15) ### Bug Fixes diff --git a/netbox/templates/dcim/rack.html b/netbox/templates/dcim/rack.html index 1e0813e5c..6a00308f3 100644 --- a/netbox/templates/dcim/rack.html +++ b/netbox/templates/dcim/rack.html @@ -330,12 +330,16 @@
+

Front

{% include 'dcim/inc/rack_elevation.html' with face='front' %} +
+

Rear

{% include 'dcim/inc/rack_elevation.html' with face='rear' %} +
diff --git a/netbox/templates/dcim/rack_elevation_list.html b/netbox/templates/dcim/rack_elevation_list.html index 1f4782847..a42610e35 100644 --- a/netbox/templates/dcim/rack_elevation_list.html +++ b/netbox/templates/dcim/rack_elevation_list.html @@ -25,7 +25,8 @@ {% if page %}
{% for rack in page %} -
+
+
{{ rack.name }} {% if rack.role %} @@ -43,6 +44,7 @@ ({{ rack.facility_id }}) {% endif %}
+
{% endfor %}
From 577c86fb80ca1b2bf35fcf2554b83591a22431a8 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 16 Dec 2020 10:38:09 -0500 Subject: [PATCH 016/302] Fixes #5478: Fix display of route target description --- docs/release-notes/version-2.10.md | 1 + netbox/templates/ipam/routetarget.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 03e2858eb..5c4f9f83b 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -5,6 +5,7 @@ ### Bug Fixes * [#5473](https://github.com/netbox-community/netbox/issues/5473) - Fix alignment of rack names in elevations list +* [#5478](https://github.com/netbox-community/netbox/issues/5478) - Fix display of route target description --- diff --git a/netbox/templates/ipam/routetarget.html b/netbox/templates/ipam/routetarget.html index 4fa8f4424..3443d0bf4 100644 --- a/netbox/templates/ipam/routetarget.html +++ b/netbox/templates/ipam/routetarget.html @@ -78,7 +78,7 @@ Description - {{ vrf.description|placeholder }} + {{ object.description|placeholder }}
From 2ffdc46f8105ad67f1cdde802bb81c1531f38403 Mon Sep 17 00:00:00 2001 From: Christian Loos Date: Thu, 22 Oct 2020 15:23:54 +0200 Subject: [PATCH 017/302] Fixes #5123: Add tests for custom field select changelog --- netbox/extras/tests/test_changelog.py | 40 +++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 5 deletions(-) diff --git a/netbox/extras/tests/test_changelog.py b/netbox/extras/tests/test_changelog.py index dbdbb5343..c0732649b 100644 --- a/netbox/extras/tests/test_changelog.py +++ b/netbox/extras/tests/test_changelog.py @@ -27,6 +27,16 @@ class ChangeLogViewTest(ModelViewTestCase): cf.save() cf.content_types.set([ct]) + # Create a select custom field on the Site model + cf_select = CustomField( + type=CustomFieldTypeChoices.TYPE_SELECT, + name='my_field_select', + required=False, + choices=['Bar', 'Foo'] + ) + cf_select.save() + cf_select.content_types.set([ct]) + def test_create_object(self): tags = self.create_tags('Tag 1', 'Tag 2') form_data = { @@ -34,6 +44,7 @@ class ChangeLogViewTest(ModelViewTestCase): 'slug': 'test-site-1', 'status': SiteStatusChoices.STATUS_ACTIVE, 'cf_my_field': 'ABC', + 'cf_my_field_select': 'Bar', 'tags': [tag.pk for tag in tags], } @@ -54,6 +65,7 @@ class ChangeLogViewTest(ModelViewTestCase): self.assertEqual(oc_list[0].changed_object, site) self.assertEqual(oc_list[0].action, ObjectChangeActionChoices.ACTION_CREATE) self.assertEqual(oc_list[0].object_data['custom_fields']['my_field'], form_data['cf_my_field']) + self.assertEqual(oc_list[0].object_data['custom_fields']['my_field_select'], form_data['cf_my_field_select']) self.assertEqual(oc_list[1].action, ObjectChangeActionChoices.ACTION_UPDATE) self.assertEqual(oc_list[1].object_data['tags'], ['Tag 1', 'Tag 2']) @@ -68,6 +80,7 @@ class ChangeLogViewTest(ModelViewTestCase): 'slug': 'test-site-x', 'status': SiteStatusChoices.STATUS_PLANNED, 'cf_my_field': 'DEF', + 'cf_my_field_select': 'Foo', 'tags': [tags[2].pk], } @@ -88,6 +101,7 @@ class ChangeLogViewTest(ModelViewTestCase): self.assertEqual(oc.changed_object, site) self.assertEqual(oc.action, ObjectChangeActionChoices.ACTION_UPDATE) self.assertEqual(oc.object_data['custom_fields']['my_field'], form_data['cf_my_field']) + self.assertEqual(oc.object_data['custom_fields']['my_field_select'], form_data['cf_my_field_select']) self.assertEqual(oc.object_data['tags'], ['Tag 3']) def test_delete_object(self): @@ -95,7 +109,8 @@ class ChangeLogViewTest(ModelViewTestCase): name='Test Site 1', slug='test-site-1', custom_field_data={ - 'my_field': 'ABC' + 'my_field': 'ABC', + 'my_field_select': 'Bar' } ) site.save() @@ -115,6 +130,7 @@ class ChangeLogViewTest(ModelViewTestCase): self.assertEqual(oc.object_repr, site.name) self.assertEqual(oc.action, ObjectChangeActionChoices.ACTION_DELETE) self.assertEqual(oc.object_data['custom_fields']['my_field'], 'ABC') + self.assertEqual(oc.object_data['custom_fields']['my_field_select'], 'Bar') self.assertEqual(oc.object_data['tags'], ['Tag 1', 'Tag 2']) @@ -133,6 +149,16 @@ class ChangeLogAPITest(APITestCase): cf.save() cf.content_types.set([ct]) + # Create a select custom field on the Site model + cf_select = CustomField( + type=CustomFieldTypeChoices.TYPE_SELECT, + name='my_field_select', + required=False, + choices=['Bar', 'Foo'] + ) + cf_select.save() + cf_select.content_types.set([ct]) + # Create some tags tags = ( Tag(name='Tag 1', slug='tag-1'), @@ -146,7 +172,8 @@ class ChangeLogAPITest(APITestCase): 'name': 'Test Site 1', 'slug': 'test-site-1', 'custom_fields': { - 'my_field': 'ABC' + 'my_field': 'ABC', + 'my_field_select': 'Bar', }, 'tags': [ {'name': 'Tag 1'}, @@ -180,7 +207,8 @@ class ChangeLogAPITest(APITestCase): 'name': 'Test Site X', 'slug': 'test-site-x', 'custom_fields': { - 'my_field': 'DEF' + 'my_field': 'DEF', + 'my_field_select': 'Foo', }, 'tags': [ {'name': 'Tag 3'} @@ -209,7 +237,8 @@ class ChangeLogAPITest(APITestCase): name='Test Site 1', slug='test-site-1', custom_field_data={ - 'my_field': 'ABC' + 'my_field': 'ABC', + 'my_field_select': 'Bar' } ) site.save() @@ -226,5 +255,6 @@ class ChangeLogAPITest(APITestCase): self.assertEqual(oc.changed_object, None) self.assertEqual(oc.object_repr, site.name) self.assertEqual(oc.action, ObjectChangeActionChoices.ACTION_DELETE) - self.assertEqual(oc.object_data['custom_fields'], {'my_field': 'ABC'}) + self.assertEqual(oc.object_data['custom_fields']['my_field'], 'ABC') + self.assertEqual(oc.object_data['custom_fields']['my_field_select'], 'Bar') self.assertEqual(oc.object_data['tags'], ['Tag 1', 'Tag 2']) From 52c9e3ecefbe04f5abf7f4d110cc6b3199b1eaca Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 16 Dec 2020 13:23:45 -0500 Subject: [PATCH 018/302] Run CI for pull requests --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d154f5017..9182457a0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,5 +1,5 @@ name: CI -on: push +on: [push, pull_request] jobs: build: runs-on: ubuntu-latest From 3c887b0dd90e79e507c5f40514d77ea3b0d99399 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 16 Dec 2020 13:48:44 -0500 Subject: [PATCH 019/302] Fixes #5468: Fix unlocking secrets from device/VM view --- docs/release-notes/version-2.10.md | 1 + netbox/templates/secrets/inc/assigned_secrets.html | 3 +++ netbox/templates/virtualization/virtualmachine.html | 1 + 3 files changed, 5 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 5c4f9f83b..d43f57ac5 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5468](https://github.com/netbox-community/netbox/issues/5468) - Fix unlocking secrets from device/VM view * [#5473](https://github.com/netbox-community/netbox/issues/5473) - Fix alignment of rack names in elevations list * [#5478](https://github.com/netbox-community/netbox/issues/5478) - Fix display of route target description diff --git a/netbox/templates/secrets/inc/assigned_secrets.html b/netbox/templates/secrets/inc/assigned_secrets.html index 2ff3e4ea2..594ab43f3 100644 --- a/netbox/templates/secrets/inc/assigned_secrets.html +++ b/netbox/templates/secrets/inc/assigned_secrets.html @@ -1,4 +1,7 @@ {% if secrets %} +
+ {% csrf_token %} +
{% for secret in secrets %} diff --git a/netbox/templates/virtualization/virtualmachine.html b/netbox/templates/virtualization/virtualmachine.html index 0f4a0416d..8baec6956 100644 --- a/netbox/templates/virtualization/virtualmachine.html +++ b/netbox/templates/virtualization/virtualmachine.html @@ -317,5 +317,6 @@ {% block javascript %} + {% endblock %} From 26426c143143623322ad2a6affb5fd9f5f71ce53 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Dec 2020 09:46:50 -0500 Subject: [PATCH 020/302] Fixes #5484: Fix "tagged" indication in VLAN members list --- docs/release-notes/version-2.10.md | 1 + netbox/ipam/tables.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index d43f57ac5..9fe23d253 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -7,6 +7,7 @@ * [#5468](https://github.com/netbox-community/netbox/issues/5468) - Fix unlocking secrets from device/VM view * [#5473](https://github.com/netbox-community/netbox/issues/5473) - Fix alignment of rack names in elevations list * [#5478](https://github.com/netbox-community/netbox/issues/5478) - Fix display of route target description +* [#5484](https://github.com/netbox-community/netbox/issues/5484) - Fix "tagged" indication in VLAN members list --- diff --git a/netbox/ipam/tables.py b/netbox/ipam/tables.py index 02196198c..868ba3105 100644 --- a/netbox/ipam/tables.py +++ b/netbox/ipam/tables.py @@ -104,7 +104,7 @@ VLANGROUP_ADD_VLAN = """ """ VLAN_MEMBER_TAGGED = """ -{% if record.untagged_vlan_id == vlan.pk %} +{% if record.untagged_vlan_id == object.pk %} {% else %} From dc6e7cd56c241a278a5c8d5854978a4ac5d5a719 Mon Sep 17 00:00:00 2001 From: Glenn Matthews Date: Thu, 17 Dec 2020 09:48:22 -0500 Subject: [PATCH 021/302] Django templating language is no longer supported for export templates --- docs/additional-features/export-templates.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/additional-features/export-templates.md b/docs/additional-features/export-templates.md index b7bbc9842..1e0611f06 100644 --- a/docs/additional-features/export-templates.md +++ b/docs/additional-features/export-templates.md @@ -4,10 +4,7 @@ NetBox allows users to define custom templates that can be used when exporting o Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. -Export templates may be written in Jinja2 or [Django's template language](https://docs.djangoproject.com/en/stable/ref/templates/language/), which is very similar to Jinja2. - -!!! warning - Support for Django's native templating logic will be removed in NetBox v2.10. +Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: From 202e7d0ebfa1dafc08f4211983200c768efdc1a5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Dec 2020 14:03:10 -0500 Subject: [PATCH 022/302] Fixes #5486: Optimize retrieval of config context data for device/VM REST API views --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/api/views.py | 2 +- netbox/virtualization/api/views.py | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 9fe23d253..719a982ad 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -8,6 +8,7 @@ * [#5473](https://github.com/netbox-community/netbox/issues/5473) - Fix alignment of rack names in elevations list * [#5478](https://github.com/netbox-community/netbox/issues/5478) - Fix display of route target description * [#5484](https://github.com/netbox-community/netbox/issues/5484) - Fix "tagged" indication in VLAN members list +* [#5486](https://github.com/netbox-community/netbox/issues/5486) - Optimize retrieval of config context data for device/VM REST API views --- diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index db36c3176..f5149b876 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -343,7 +343,7 @@ class PlatformViewSet(ModelViewSet): # Devices # -class DeviceViewSet(CustomFieldModelViewSet, ConfigContextQuerySetMixin): +class DeviceViewSet(ConfigContextQuerySetMixin, CustomFieldModelViewSet): queryset = Device.objects.prefetch_related( 'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'rack', 'parent_bay', 'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags', diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index e2d3d5ea5..82952ad9a 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -52,7 +52,7 @@ class ClusterViewSet(CustomFieldModelViewSet): # Virtual machines # -class VirtualMachineViewSet(CustomFieldModelViewSet, ConfigContextQuerySetMixin): +class VirtualMachineViewSet(ConfigContextQuerySetMixin, CustomFieldModelViewSet): queryset = VirtualMachine.objects.prefetch_related( 'cluster__site', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' ) From 91083fd6c52f11a4af163be1978b9a75d66ea639 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Dec 2020 14:45:50 -0500 Subject: [PATCH 023/302] Call Coalesce() inside get_queryset() --- netbox/circuits/api/views.py | 5 ++-- netbox/dcim/api/views.py | 39 +++++++++++++++--------------- netbox/extras/api/views.py | 3 +-- netbox/ipam/api/views.py | 15 ++++++------ netbox/secrets/api/views.py | 3 +-- netbox/tenancy/api/views.py | 15 ++++++------ netbox/utilities/utils.py | 3 ++- netbox/virtualization/api/views.py | 9 +++---- 8 files changed, 43 insertions(+), 49 deletions(-) diff --git a/netbox/circuits/api/views.py b/netbox/circuits/api/views.py index ef5a944e2..ad497ee5f 100644 --- a/netbox/circuits/api/views.py +++ b/netbox/circuits/api/views.py @@ -1,5 +1,4 @@ from django.db.models import Prefetch -from django.db.models.functions import Coalesce from rest_framework.routers import APIRootView from circuits import filters @@ -25,7 +24,7 @@ class CircuitsRootView(APIRootView): class ProviderViewSet(CustomFieldModelViewSet): queryset = Provider.objects.prefetch_related('tags').annotate( - circuit_count=Coalesce(get_subquery(Circuit, 'provider'), 0) + circuit_count=get_subquery(Circuit, 'provider') ) serializer_class = serializers.ProviderSerializer filterset_class = filters.ProviderFilterSet @@ -37,7 +36,7 @@ class ProviderViewSet(CustomFieldModelViewSet): class CircuitTypeViewSet(ModelViewSet): queryset = CircuitType.objects.annotate( - circuit_count=Coalesce(get_subquery(Circuit, 'type'), 0) + circuit_count=get_subquery(Circuit, 'type') ) serializer_class = serializers.CircuitTypeSerializer filterset_class = filters.CircuitTypeFilterSet diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index f5149b876..efb8e994d 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -3,7 +3,6 @@ from collections import OrderedDict from django.conf import settings from django.db.models import F -from django.db.models.functions import Coalesce from django.http import HttpResponseForbidden, HttpResponse from django.shortcuts import get_object_or_404 from drf_yasg import openapi @@ -120,12 +119,12 @@ class SiteViewSet(CustomFieldModelViewSet): queryset = Site.objects.prefetch_related( 'region', 'tenant', 'tags' ).annotate( - device_count=Coalesce(get_subquery(Device, 'site'), 0), - rack_count=Coalesce(get_subquery(Rack, 'site'), 0), - prefix_count=Coalesce(get_subquery(Prefix, 'site'), 0), - vlan_count=Coalesce(get_subquery(VLAN, 'site'), 0), - circuit_count=Coalesce(get_subquery(Circuit, 'terminations__site'), 0), - virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'cluster__site'), 0), + device_count=get_subquery(Device, 'site'), + rack_count=get_subquery(Rack, 'site'), + prefix_count=get_subquery(Prefix, 'site'), + vlan_count=get_subquery(VLAN, 'site'), + circuit_count=get_subquery(Circuit, 'terminations__site'), + virtualmachine_count=get_subquery(VirtualMachine, 'cluster__site') ) serializer_class = serializers.SiteSerializer filterset_class = filters.SiteFilterSet @@ -153,7 +152,7 @@ class RackGroupViewSet(ModelViewSet): class RackRoleViewSet(ModelViewSet): queryset = RackRole.objects.annotate( - rack_count=Coalesce(get_subquery(Rack, 'role'), 0) + rack_count=get_subquery(Rack, 'role') ) serializer_class = serializers.RackRoleSerializer filterset_class = filters.RackRoleFilterSet @@ -167,8 +166,8 @@ class RackViewSet(CustomFieldModelViewSet): queryset = Rack.objects.prefetch_related( 'site', 'group__site', 'role', 'tenant', 'tags' ).annotate( - device_count=Coalesce(get_subquery(Device, 'rack'), 0), - powerfeed_count=Coalesce(get_subquery(PowerFeed, 'rack'), 0) + device_count=get_subquery(Device, 'rack'), + powerfeed_count=get_subquery(PowerFeed, 'rack') ) serializer_class = serializers.RackSerializer filterset_class = filters.RackFilterSet @@ -241,9 +240,9 @@ class RackReservationViewSet(ModelViewSet): class ManufacturerViewSet(ModelViewSet): queryset = Manufacturer.objects.annotate( - devicetype_count=Coalesce(get_subquery(DeviceType, 'manufacturer'), 0), - inventoryitem_count=Coalesce(get_subquery(InventoryItem, 'manufacturer'), 0), - platform_count=Coalesce(get_subquery(Platform, 'manufacturer'), 0) + devicetype_count=get_subquery(DeviceType, 'manufacturer'), + inventoryitem_count=get_subquery(InventoryItem, 'manufacturer'), + platform_count=get_subquery(Platform, 'manufacturer') ) serializer_class = serializers.ManufacturerSerializer filterset_class = filters.ManufacturerFilterSet @@ -255,7 +254,7 @@ class ManufacturerViewSet(ModelViewSet): class DeviceTypeViewSet(CustomFieldModelViewSet): queryset = DeviceType.objects.prefetch_related('manufacturer', 'tags').annotate( - device_count=Coalesce(get_subquery(Device, 'device_type'), 0) + device_count=get_subquery(Device, 'device_type') ) serializer_class = serializers.DeviceTypeSerializer filterset_class = filters.DeviceTypeFilterSet @@ -319,8 +318,8 @@ class DeviceBayTemplateViewSet(ModelViewSet): class DeviceRoleViewSet(ModelViewSet): queryset = DeviceRole.objects.annotate( - device_count=Coalesce(get_subquery(Device, 'device_role'), 0), - virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'role'), 0) + device_count=get_subquery(Device, 'device_role'), + virtualmachine_count=get_subquery(VirtualMachine, 'role') ) serializer_class = serializers.DeviceRoleSerializer filterset_class = filters.DeviceRoleFilterSet @@ -332,8 +331,8 @@ class DeviceRoleViewSet(ModelViewSet): class PlatformViewSet(ModelViewSet): queryset = Platform.objects.annotate( - device_count=Coalesce(get_subquery(Device, 'platform'), 0), - virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'platform'), 0) + device_count=get_subquery(Device, 'platform'), + virtualmachine_count=get_subquery(VirtualMachine, 'platform') ) serializer_class = serializers.PlatformSerializer filterset_class = filters.PlatformFilterSet @@ -597,7 +596,7 @@ class CableViewSet(ModelViewSet): class VirtualChassisViewSet(ModelViewSet): queryset = VirtualChassis.objects.prefetch_related('tags').annotate( - member_count=Coalesce(get_subquery(Device, 'virtual_chassis'), 0) + member_count=get_subquery(Device, 'virtual_chassis') ) serializer_class = serializers.VirtualChassisSerializer filterset_class = filters.VirtualChassisFilterSet @@ -611,7 +610,7 @@ class PowerPanelViewSet(ModelViewSet): queryset = PowerPanel.objects.prefetch_related( 'site', 'rack_group' ).annotate( - powerfeed_count=Coalesce(get_subquery(PowerFeed, 'power_panel'), 0) + powerfeed_count=get_subquery(PowerFeed, 'power_panel') ) serializer_class = serializers.PowerPanelSerializer filterset_class = filters.PowerPanelFilterSet diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index fcd9add7c..38077c89a 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -1,5 +1,4 @@ from django.contrib.contenttypes.models import ContentType -from django.db.models.functions import Coalesce from django.http import Http404 from django_rq.queues import get_connection from rest_framework import status @@ -103,7 +102,7 @@ class ExportTemplateViewSet(ModelViewSet): class TagViewSet(ModelViewSet): queryset = Tag.objects.annotate( - tagged_items=Coalesce(get_subquery(TaggedItem, 'tag'), 0) + tagged_items=get_subquery(TaggedItem, 'tag') ) serializer_class = serializers.TagSerializer filterset_class = filters.TagFilterSet diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index fb38edf46..9d09bbe03 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -1,5 +1,4 @@ from django.conf import settings -from django.db.models.functions import Coalesce from django.shortcuts import get_object_or_404 from django_pglocks import advisory_lock from drf_yasg.utils import swagger_auto_schema @@ -33,8 +32,8 @@ class VRFViewSet(CustomFieldModelViewSet): queryset = VRF.objects.prefetch_related('tenant').prefetch_related( 'import_targets', 'export_targets', 'tags' ).annotate( - ipaddress_count=Coalesce(get_subquery(IPAddress, 'vrf'), 0), - prefix_count=Coalesce(get_subquery(Prefix, 'vrf'), 0) + ipaddress_count=get_subquery(IPAddress, 'vrf'), + prefix_count=get_subquery(Prefix, 'vrf') ) serializer_class = serializers.VRFSerializer filterset_class = filters.VRFFilterSet @@ -56,7 +55,7 @@ class RouteTargetViewSet(CustomFieldModelViewSet): class RIRViewSet(ModelViewSet): queryset = RIR.objects.annotate( - aggregate_count=Coalesce(get_subquery(Aggregate, 'rir'), 0) + aggregate_count=get_subquery(Aggregate, 'rir') ) serializer_class = serializers.RIRSerializer filterset_class = filters.RIRFilterSet @@ -78,8 +77,8 @@ class AggregateViewSet(CustomFieldModelViewSet): class RoleViewSet(ModelViewSet): queryset = Role.objects.annotate( - prefix_count=Coalesce(get_subquery(Prefix, 'role'), 0), - vlan_count=Coalesce(get_subquery(VLAN, 'role'), 0) + prefix_count=get_subquery(Prefix, 'role'), + vlan_count=get_subquery(VLAN, 'role') ) serializer_class = serializers.RoleSerializer filterset_class = filters.RoleFilterSet @@ -273,7 +272,7 @@ class IPAddressViewSet(CustomFieldModelViewSet): class VLANGroupViewSet(ModelViewSet): queryset = VLANGroup.objects.prefetch_related('site').annotate( - vlan_count=Coalesce(get_subquery(VLAN, 'group'), 0) + vlan_count=get_subquery(VLAN, 'group') ) serializer_class = serializers.VLANGroupSerializer filterset_class = filters.VLANGroupFilterSet @@ -287,7 +286,7 @@ class VLANViewSet(CustomFieldModelViewSet): queryset = VLAN.objects.prefetch_related( 'site', 'group', 'tenant', 'role', 'tags' ).annotate( - prefix_count=Coalesce(get_subquery(Prefix, 'vlan'), 0) + prefix_count=get_subquery(Prefix, 'vlan') ) serializer_class = serializers.VLANSerializer filterset_class = filters.VLANFilterSet diff --git a/netbox/secrets/api/views.py b/netbox/secrets/api/views.py index 617da5c6e..1153b0508 100644 --- a/netbox/secrets/api/views.py +++ b/netbox/secrets/api/views.py @@ -1,7 +1,6 @@ import base64 from Crypto.PublicKey import RSA -from django.db.models.functions import Coalesce from django.http import HttpResponseBadRequest from rest_framework.exceptions import ValidationError from rest_framework.permissions import IsAuthenticated @@ -36,7 +35,7 @@ class SecretsRootView(APIRootView): class SecretRoleViewSet(ModelViewSet): queryset = SecretRole.objects.annotate( - secret_count=Coalesce(get_subquery(Secret, 'role'), 0) + secret_count=get_subquery(Secret, 'role') ) serializer_class = serializers.SecretRoleSerializer filterset_class = filters.SecretRoleFilterSet diff --git a/netbox/tenancy/api/views.py b/netbox/tenancy/api/views.py index 142203b58..34be4991e 100644 --- a/netbox/tenancy/api/views.py +++ b/netbox/tenancy/api/views.py @@ -1,4 +1,3 @@ -from django.db.models.functions import Coalesce from rest_framework.routers import APIRootView from circuits.models import Circuit @@ -47,13 +46,13 @@ class TenantViewSet(CustomFieldModelViewSet): ).annotate( circuit_count=get_subquery(Circuit, 'tenant'), device_count=get_subquery(Device, 'tenant'), - ipaddress_count=Coalesce(get_subquery(IPAddress, 'tenant'), 0), - prefix_count=Coalesce(get_subquery(Prefix, 'tenant'), 0), - rack_count=Coalesce(get_subquery(Rack, 'tenant'), 0), - site_count=Coalesce(get_subquery(Site, 'tenant'), 0), - virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'tenant'), 0), - vlan_count=Coalesce(get_subquery(VLAN, 'tenant'), 0), - vrf_count=Coalesce(get_subquery(VRF, 'tenant'), 0) + ipaddress_count=get_subquery(IPAddress, 'tenant'), + prefix_count=get_subquery(Prefix, 'tenant'), + rack_count=get_subquery(Rack, 'tenant'), + site_count=get_subquery(Site, 'tenant'), + virtualmachine_count=get_subquery(VirtualMachine, 'tenant'), + vlan_count=get_subquery(VLAN, 'tenant'), + vrf_count=get_subquery(VRF, 'tenant') ) serializer_class = serializers.TenantSerializer filterset_class = filters.TenantFilterSet diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 52a951555..19e08dfd4 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -5,6 +5,7 @@ from itertools import count, groupby from django.core.serializers import serialize from django.db.models import Count, OuterRef, Subquery +from django.db.models.functions import Coalesce from jinja2 import Environment from dcim.choices import CableLengthUnitChoices @@ -79,7 +80,7 @@ def get_subquery(model, field): ).values('c') ) - return subquery + return Coalesce(subquery, 0) def serialize_object(obj, extra=None, exclude=None): diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index 82952ad9a..a3dea00df 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -1,4 +1,3 @@ -from django.db.models.functions import Coalesce from rest_framework.routers import APIRootView from dcim.models import Device @@ -23,7 +22,7 @@ class VirtualizationRootView(APIRootView): class ClusterTypeViewSet(ModelViewSet): queryset = ClusterType.objects.annotate( - cluster_count=Coalesce(get_subquery(Cluster, 'type'), 0) + cluster_count=get_subquery(Cluster, 'type') ) serializer_class = serializers.ClusterTypeSerializer filterset_class = filters.ClusterTypeFilterSet @@ -31,7 +30,7 @@ class ClusterTypeViewSet(ModelViewSet): class ClusterGroupViewSet(ModelViewSet): queryset = ClusterGroup.objects.annotate( - cluster_count=Coalesce(get_subquery(Cluster, 'group'), 0) + cluster_count=get_subquery(Cluster, 'group') ) serializer_class = serializers.ClusterGroupSerializer filterset_class = filters.ClusterGroupFilterSet @@ -41,8 +40,8 @@ class ClusterViewSet(CustomFieldModelViewSet): queryset = Cluster.objects.prefetch_related( 'type', 'group', 'tenant', 'site', 'tags' ).annotate( - device_count=Coalesce(get_subquery(Device, 'cluster'), 0), - virtualmachine_count=Coalesce(get_subquery(VirtualMachine, 'cluster'), 0) + device_count=get_subquery(Device, 'cluster'), + virtualmachine_count=get_subquery(VirtualMachine, 'cluster') ) serializer_class = serializers.ClusterSerializer filterset_class = filters.ClusterFilterSet From 4a066a191318799a48b4e5380feea6774e4ea8fe Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Dec 2020 14:47:49 -0500 Subject: [PATCH 024/302] Rename get_subquery() to count_related() --- netbox/circuits/api/views.py | 6 ++--- netbox/circuits/views.py | 12 ++++----- netbox/dcim/api/views.py | 40 +++++++++++++++--------------- netbox/dcim/views.py | 36 +++++++++++++-------------- netbox/extras/api/views.py | 4 +-- netbox/extras/views.py | 8 +++--- netbox/ipam/api/views.py | 16 ++++++------ netbox/ipam/views.py | 14 +++++------ netbox/netbox/constants.py | 12 ++++----- netbox/secrets/api/views.py | 4 +-- netbox/secrets/views.py | 6 ++--- netbox/tenancy/api/views.py | 20 +++++++-------- netbox/utilities/utils.py | 2 +- netbox/virtualization/api/views.py | 10 ++++---- netbox/virtualization/views.py | 14 +++++------ 15 files changed, 102 insertions(+), 102 deletions(-) diff --git a/netbox/circuits/api/views.py b/netbox/circuits/api/views.py index ad497ee5f..6968da61e 100644 --- a/netbox/circuits/api/views.py +++ b/netbox/circuits/api/views.py @@ -6,7 +6,7 @@ from circuits.models import Provider, CircuitTermination, CircuitType, Circuit from dcim.api.views import PathEndpointMixin from extras.api.views import CustomFieldModelViewSet from netbox.api.views import ModelViewSet -from utilities.utils import get_subquery +from utilities.utils import count_related from . import serializers @@ -24,7 +24,7 @@ class CircuitsRootView(APIRootView): class ProviderViewSet(CustomFieldModelViewSet): queryset = Provider.objects.prefetch_related('tags').annotate( - circuit_count=get_subquery(Circuit, 'provider') + circuit_count=count_related(Circuit, 'provider') ) serializer_class = serializers.ProviderSerializer filterset_class = filters.ProviderFilterSet @@ -36,7 +36,7 @@ class ProviderViewSet(CustomFieldModelViewSet): class CircuitTypeViewSet(ModelViewSet): queryset = CircuitType.objects.annotate( - circuit_count=get_subquery(Circuit, 'type') + circuit_count=count_related(Circuit, 'type') ) serializer_class = serializers.CircuitTypeSerializer filterset_class = filters.CircuitTypeFilterSet diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index a237b8805..9fea26652 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -6,7 +6,7 @@ from django_tables2 import RequestConfig from netbox.views import generic from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator, get_paginate_count -from utilities.utils import get_subquery +from utilities.utils import count_related from . import filters, forms, tables from .choices import CircuitTerminationSideChoices from .models import Circuit, CircuitTermination, CircuitType, Provider @@ -18,7 +18,7 @@ from .models import Circuit, CircuitTermination, CircuitType, Provider class ProviderListView(generic.ObjectListView): queryset = Provider.objects.annotate( - count_circuits=get_subquery(Circuit, 'provider') + count_circuits=count_related(Circuit, 'provider') ) filterset = filters.ProviderFilterSet filterset_form = forms.ProviderFilterForm @@ -67,7 +67,7 @@ class ProviderBulkImportView(generic.BulkImportView): class ProviderBulkEditView(generic.BulkEditView): queryset = Provider.objects.annotate( - count_circuits=get_subquery(Circuit, 'provider') + count_circuits=count_related(Circuit, 'provider') ) filterset = filters.ProviderFilterSet table = tables.ProviderTable @@ -76,7 +76,7 @@ class ProviderBulkEditView(generic.BulkEditView): class ProviderBulkDeleteView(generic.BulkDeleteView): queryset = Provider.objects.annotate( - count_circuits=get_subquery(Circuit, 'provider') + count_circuits=count_related(Circuit, 'provider') ) filterset = filters.ProviderFilterSet table = tables.ProviderTable @@ -88,7 +88,7 @@ class ProviderBulkDeleteView(generic.BulkDeleteView): class CircuitTypeListView(generic.ObjectListView): queryset = CircuitType.objects.annotate( - circuit_count=get_subquery(Circuit, 'type') + circuit_count=count_related(Circuit, 'type') ) table = tables.CircuitTypeTable @@ -110,7 +110,7 @@ class CircuitTypeBulkImportView(generic.BulkImportView): class CircuitTypeBulkDeleteView(generic.BulkDeleteView): queryset = CircuitType.objects.annotate( - circuit_count=get_subquery(Circuit, 'type') + circuit_count=count_related(Circuit, 'type') ) table = tables.CircuitTypeTable diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index efb8e994d..f9e8027b4 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -30,7 +30,7 @@ from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired from netbox.api.exceptions import ServiceUnavailable from netbox.api.metadata import ContentTypeMetadata from utilities.api import get_serializer_for_model -from utilities.utils import get_subquery +from utilities.utils import count_related from virtualization.models import VirtualMachine from . import serializers from .exceptions import MissingFilterException @@ -119,12 +119,12 @@ class SiteViewSet(CustomFieldModelViewSet): queryset = Site.objects.prefetch_related( 'region', 'tenant', 'tags' ).annotate( - device_count=get_subquery(Device, 'site'), - rack_count=get_subquery(Rack, 'site'), - prefix_count=get_subquery(Prefix, 'site'), - vlan_count=get_subquery(VLAN, 'site'), - circuit_count=get_subquery(Circuit, 'terminations__site'), - virtualmachine_count=get_subquery(VirtualMachine, 'cluster__site') + device_count=count_related(Device, 'site'), + rack_count=count_related(Rack, 'site'), + prefix_count=count_related(Prefix, 'site'), + vlan_count=count_related(VLAN, 'site'), + circuit_count=count_related(Circuit, 'terminations__site'), + virtualmachine_count=count_related(VirtualMachine, 'cluster__site') ) serializer_class = serializers.SiteSerializer filterset_class = filters.SiteFilterSet @@ -152,7 +152,7 @@ class RackGroupViewSet(ModelViewSet): class RackRoleViewSet(ModelViewSet): queryset = RackRole.objects.annotate( - rack_count=get_subquery(Rack, 'role') + rack_count=count_related(Rack, 'role') ) serializer_class = serializers.RackRoleSerializer filterset_class = filters.RackRoleFilterSet @@ -166,8 +166,8 @@ class RackViewSet(CustomFieldModelViewSet): queryset = Rack.objects.prefetch_related( 'site', 'group__site', 'role', 'tenant', 'tags' ).annotate( - device_count=get_subquery(Device, 'rack'), - powerfeed_count=get_subquery(PowerFeed, 'rack') + device_count=count_related(Device, 'rack'), + powerfeed_count=count_related(PowerFeed, 'rack') ) serializer_class = serializers.RackSerializer filterset_class = filters.RackFilterSet @@ -240,9 +240,9 @@ class RackReservationViewSet(ModelViewSet): class ManufacturerViewSet(ModelViewSet): queryset = Manufacturer.objects.annotate( - devicetype_count=get_subquery(DeviceType, 'manufacturer'), - inventoryitem_count=get_subquery(InventoryItem, 'manufacturer'), - platform_count=get_subquery(Platform, 'manufacturer') + devicetype_count=count_related(DeviceType, 'manufacturer'), + inventoryitem_count=count_related(InventoryItem, 'manufacturer'), + platform_count=count_related(Platform, 'manufacturer') ) serializer_class = serializers.ManufacturerSerializer filterset_class = filters.ManufacturerFilterSet @@ -254,7 +254,7 @@ class ManufacturerViewSet(ModelViewSet): class DeviceTypeViewSet(CustomFieldModelViewSet): queryset = DeviceType.objects.prefetch_related('manufacturer', 'tags').annotate( - device_count=get_subquery(Device, 'device_type') + device_count=count_related(Device, 'device_type') ) serializer_class = serializers.DeviceTypeSerializer filterset_class = filters.DeviceTypeFilterSet @@ -318,8 +318,8 @@ class DeviceBayTemplateViewSet(ModelViewSet): class DeviceRoleViewSet(ModelViewSet): queryset = DeviceRole.objects.annotate( - device_count=get_subquery(Device, 'device_role'), - virtualmachine_count=get_subquery(VirtualMachine, 'role') + device_count=count_related(Device, 'device_role'), + virtualmachine_count=count_related(VirtualMachine, 'role') ) serializer_class = serializers.DeviceRoleSerializer filterset_class = filters.DeviceRoleFilterSet @@ -331,8 +331,8 @@ class DeviceRoleViewSet(ModelViewSet): class PlatformViewSet(ModelViewSet): queryset = Platform.objects.annotate( - device_count=get_subquery(Device, 'platform'), - virtualmachine_count=get_subquery(VirtualMachine, 'platform') + device_count=count_related(Device, 'platform'), + virtualmachine_count=count_related(VirtualMachine, 'platform') ) serializer_class = serializers.PlatformSerializer filterset_class = filters.PlatformFilterSet @@ -596,7 +596,7 @@ class CableViewSet(ModelViewSet): class VirtualChassisViewSet(ModelViewSet): queryset = VirtualChassis.objects.prefetch_related('tags').annotate( - member_count=get_subquery(Device, 'virtual_chassis') + member_count=count_related(Device, 'virtual_chassis') ) serializer_class = serializers.VirtualChassisSerializer filterset_class = filters.VirtualChassisFilterSet @@ -610,7 +610,7 @@ class PowerPanelViewSet(ModelViewSet): queryset = PowerPanel.objects.prefetch_related( 'site', 'rack_group' ).annotate( - powerfeed_count=get_subquery(PowerFeed, 'power_panel') + powerfeed_count=count_related(PowerFeed, 'power_panel') ) serializer_class = serializers.PowerPanelSerializer filterset_class = filters.PowerPanelFilterSet diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 9f8e4c13f..b092be612 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -20,7 +20,7 @@ from secrets.models import Secret from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator, get_paginate_count from utilities.permissions import get_permission_for_model -from utilities.utils import csv_format, get_subquery +from utilities.utils import csv_format, count_related from utilities.views import GetReturnURLMixin, ObjectPermissionRequiredMixin from virtualization.models import VirtualMachine from . import filters, forms, tables @@ -254,7 +254,7 @@ class RackGroupBulkDeleteView(generic.BulkDeleteView): class RackRoleListView(generic.ObjectListView): queryset = RackRole.objects.annotate( - rack_count=get_subquery(Rack, 'role') + rack_count=count_related(Rack, 'role') ) table = tables.RackRoleTable @@ -276,7 +276,7 @@ class RackRoleBulkImportView(generic.BulkImportView): class RackRoleBulkDeleteView(generic.BulkDeleteView): queryset = RackRole.objects.annotate( - rack_count=get_subquery(Rack, 'role') + rack_count=count_related(Rack, 'role') ) table = tables.RackRoleTable @@ -289,7 +289,7 @@ class RackListView(generic.ObjectListView): queryset = Rack.objects.prefetch_related( 'site', 'group', 'tenant', 'role', 'devices__device_type' ).annotate( - device_count=get_subquery(Device, 'rack') + device_count=count_related(Device, 'rack') ) filterset = filters.RackFilterSet filterset_form = forms.RackFilterForm @@ -470,9 +470,9 @@ class RackReservationBulkDeleteView(generic.BulkDeleteView): class ManufacturerListView(generic.ObjectListView): queryset = Manufacturer.objects.annotate( - devicetype_count=get_subquery(DeviceType, 'manufacturer'), - inventoryitem_count=get_subquery(InventoryItem, 'manufacturer'), - platform_count=get_subquery(Platform, 'manufacturer') + devicetype_count=count_related(DeviceType, 'manufacturer'), + inventoryitem_count=count_related(InventoryItem, 'manufacturer'), + platform_count=count_related(Platform, 'manufacturer') ) table = tables.ManufacturerTable @@ -494,7 +494,7 @@ class ManufacturerBulkImportView(generic.BulkImportView): class ManufacturerBulkDeleteView(generic.BulkDeleteView): queryset = Manufacturer.objects.annotate( - devicetype_count=get_subquery(DeviceType, 'manufacturer') + devicetype_count=count_related(DeviceType, 'manufacturer') ) table = tables.ManufacturerTable @@ -505,7 +505,7 @@ class ManufacturerBulkDeleteView(generic.BulkDeleteView): class DeviceTypeListView(generic.ObjectListView): queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( - instance_count=get_subquery(Device, 'device_type') + instance_count=count_related(Device, 'device_type') ) filterset = filters.DeviceTypeFilterSet filterset_form = forms.DeviceTypeFilterForm @@ -612,7 +612,7 @@ class DeviceTypeImportView(generic.ObjectImportView): class DeviceTypeBulkEditView(generic.BulkEditView): queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( - instance_count=get_subquery(Device, 'device_type') + instance_count=count_related(Device, 'device_type') ) filterset = filters.DeviceTypeFilterSet table = tables.DeviceTypeTable @@ -621,7 +621,7 @@ class DeviceTypeBulkEditView(generic.BulkEditView): class DeviceTypeBulkDeleteView(generic.BulkDeleteView): queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( - instance_count=get_subquery(Device, 'device_type') + instance_count=count_related(Device, 'device_type') ) filterset = filters.DeviceTypeFilterSet table = tables.DeviceTypeTable @@ -913,8 +913,8 @@ class DeviceBayTemplateBulkDeleteView(generic.BulkDeleteView): class DeviceRoleListView(generic.ObjectListView): queryset = DeviceRole.objects.annotate( - device_count=get_subquery(Device, 'device_role'), - vm_count=get_subquery(VirtualMachine, 'role') + device_count=count_related(Device, 'device_role'), + vm_count=count_related(VirtualMachine, 'role') ) table = tables.DeviceRoleTable @@ -945,8 +945,8 @@ class DeviceRoleBulkDeleteView(generic.BulkDeleteView): class PlatformListView(generic.ObjectListView): queryset = Platform.objects.annotate( - device_count=get_subquery(Device, 'platform'), - vm_count=get_subquery(VirtualMachine, 'platform') + device_count=count_related(Device, 'platform'), + vm_count=count_related(VirtualMachine, 'platform') ) table = tables.PlatformTable @@ -2335,7 +2335,7 @@ class InterfaceConnectionsListView(generic.ObjectListView): class VirtualChassisListView(generic.ObjectListView): queryset = VirtualChassis.objects.prefetch_related('master').annotate( - member_count=get_subquery(Device, 'virtual_chassis') + member_count=count_related(Device, 'virtual_chassis') ) table = tables.VirtualChassisTable filterset = filters.VirtualChassisFilterSet @@ -2565,7 +2565,7 @@ class PowerPanelListView(generic.ObjectListView): queryset = PowerPanel.objects.prefetch_related( 'site', 'rack_group' ).annotate( - powerfeed_count=get_subquery(PowerFeed, 'power_panel') + powerfeed_count=count_related(PowerFeed, 'power_panel') ) filterset = filters.PowerPanelFilterSet filterset_form = forms.PowerPanelFilterForm @@ -2615,7 +2615,7 @@ class PowerPanelBulkDeleteView(generic.BulkDeleteView): queryset = PowerPanel.objects.prefetch_related( 'site', 'rack_group' ).annotate( - powerfeed_count=get_subquery(PowerFeed, 'power_panel') + powerfeed_count=count_related(PowerFeed, 'power_panel') ) filterset = filters.PowerPanelFilterSet table = tables.PowerPanelTable diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index 38077c89a..8ab7b0eea 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -21,7 +21,7 @@ from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired from netbox.api.metadata import ContentTypeMetadata from netbox.api.views import ModelViewSet from utilities.exceptions import RQWorkerNotRunningException -from utilities.utils import copy_safe_request, get_subquery +from utilities.utils import copy_safe_request, count_related from . import serializers @@ -102,7 +102,7 @@ class ExportTemplateViewSet(ModelViewSet): class TagViewSet(ModelViewSet): queryset = Tag.objects.annotate( - tagged_items=get_subquery(TaggedItem, 'tag') + tagged_items=count_related(TaggedItem, 'tag') ) serializer_class = serializers.TagSerializer filterset_class = filters.TagFilterSet diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 99295de1a..57483345c 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -12,7 +12,7 @@ from rq import Worker from netbox.views import generic from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator, get_paginate_count -from utilities.utils import copy_safe_request, get_subquery, shallow_compare_dict +from utilities.utils import copy_safe_request, count_related, shallow_compare_dict from utilities.views import ContentTypePermissionRequiredMixin from . import filters, forms, tables from .choices import JobResultStatusChoices @@ -27,7 +27,7 @@ from .scripts import get_scripts, run_script class TagListView(generic.ObjectListView): queryset = Tag.objects.annotate( - items=get_subquery(TaggedItem, 'tag') + items=count_related(TaggedItem, 'tag') ) filterset = filters.TagFilterSet filterset_form = forms.TagFilterForm @@ -52,7 +52,7 @@ class TagBulkImportView(generic.BulkImportView): class TagBulkEditView(generic.BulkEditView): queryset = Tag.objects.annotate( - items=get_subquery(TaggedItem, 'tag') + items=count_related(TaggedItem, 'tag') ) table = tables.TagTable form = forms.TagBulkEditForm @@ -60,7 +60,7 @@ class TagBulkEditView(generic.BulkEditView): class TagBulkDeleteView(generic.BulkDeleteView): queryset = Tag.objects.annotate( - items=get_subquery(TaggedItem, 'tag') + items=count_related(TaggedItem, 'tag') ) table = tables.TagTable diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index 9d09bbe03..d9eae69aa 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -12,7 +12,7 @@ from ipam import filters from ipam.models import Aggregate, IPAddress, Prefix, RIR, Role, RouteTarget, Service, VLAN, VLANGroup, VRF from netbox.api.views import ModelViewSet from utilities.constants import ADVISORY_LOCK_KEYS -from utilities.utils import get_subquery +from utilities.utils import count_related from . import serializers @@ -32,8 +32,8 @@ class VRFViewSet(CustomFieldModelViewSet): queryset = VRF.objects.prefetch_related('tenant').prefetch_related( 'import_targets', 'export_targets', 'tags' ).annotate( - ipaddress_count=get_subquery(IPAddress, 'vrf'), - prefix_count=get_subquery(Prefix, 'vrf') + ipaddress_count=count_related(IPAddress, 'vrf'), + prefix_count=count_related(Prefix, 'vrf') ) serializer_class = serializers.VRFSerializer filterset_class = filters.VRFFilterSet @@ -55,7 +55,7 @@ class RouteTargetViewSet(CustomFieldModelViewSet): class RIRViewSet(ModelViewSet): queryset = RIR.objects.annotate( - aggregate_count=get_subquery(Aggregate, 'rir') + aggregate_count=count_related(Aggregate, 'rir') ) serializer_class = serializers.RIRSerializer filterset_class = filters.RIRFilterSet @@ -77,8 +77,8 @@ class AggregateViewSet(CustomFieldModelViewSet): class RoleViewSet(ModelViewSet): queryset = Role.objects.annotate( - prefix_count=get_subquery(Prefix, 'role'), - vlan_count=get_subquery(VLAN, 'role') + prefix_count=count_related(Prefix, 'role'), + vlan_count=count_related(VLAN, 'role') ) serializer_class = serializers.RoleSerializer filterset_class = filters.RoleFilterSet @@ -272,7 +272,7 @@ class IPAddressViewSet(CustomFieldModelViewSet): class VLANGroupViewSet(ModelViewSet): queryset = VLANGroup.objects.prefetch_related('site').annotate( - vlan_count=get_subquery(VLAN, 'group') + vlan_count=count_related(VLAN, 'group') ) serializer_class = serializers.VLANGroupSerializer filterset_class = filters.VLANGroupFilterSet @@ -286,7 +286,7 @@ class VLANViewSet(CustomFieldModelViewSet): queryset = VLAN.objects.prefetch_related( 'site', 'group', 'tenant', 'role', 'tags' ).annotate( - prefix_count=get_subquery(Prefix, 'vlan') + prefix_count=count_related(Prefix, 'vlan') ) serializer_class = serializers.VLANSerializer filterset_class = filters.VLANFilterSet diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 1cbac27f6..36c225045 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -6,7 +6,7 @@ from django_tables2 import RequestConfig from dcim.models import Device, Interface from netbox.views import generic from utilities.paginator import EnhancedPaginator, get_paginate_count -from utilities.utils import get_subquery +from utilities.utils import count_related from virtualization.models import VirtualMachine, VMInterface from . import filters, forms, tables from .constants import * @@ -140,7 +140,7 @@ class RouteTargetBulkDeleteView(generic.BulkDeleteView): class RIRListView(generic.ObjectListView): queryset = RIR.objects.annotate( - aggregate_count=get_subquery(Aggregate, 'rir') + aggregate_count=count_related(Aggregate, 'rir') ) filterset = filters.RIRFilterSet filterset_form = forms.RIRFilterForm @@ -165,7 +165,7 @@ class RIRBulkImportView(generic.BulkImportView): class RIRBulkDeleteView(generic.BulkDeleteView): queryset = RIR.objects.annotate( - aggregate_count=get_subquery(Aggregate, 'rir') + aggregate_count=count_related(Aggregate, 'rir') ) filterset = filters.RIRFilterSet table = tables.RIRTable @@ -277,8 +277,8 @@ class AggregateBulkDeleteView(generic.BulkDeleteView): class RoleListView(generic.ObjectListView): queryset = Role.objects.annotate( - prefix_count=get_subquery(Prefix, 'role'), - vlan_count=get_subquery(VLAN, 'role') + prefix_count=count_related(Prefix, 'role'), + vlan_count=count_related(VLAN, 'role') ) table = tables.RoleTable @@ -633,7 +633,7 @@ class IPAddressBulkDeleteView(generic.BulkDeleteView): class VLANGroupListView(generic.ObjectListView): queryset = VLANGroup.objects.prefetch_related('site').annotate( - vlan_count=get_subquery(VLAN, 'group') + vlan_count=count_related(VLAN, 'group') ) filterset = filters.VLANGroupFilterSet filterset_form = forms.VLANGroupFilterForm @@ -657,7 +657,7 @@ class VLANGroupBulkImportView(generic.BulkImportView): class VLANGroupBulkDeleteView(generic.BulkDeleteView): queryset = VLANGroup.objects.prefetch_related('site').annotate( - vlan_count=get_subquery(VLAN, 'group') + vlan_count=count_related(VLAN, 'group') ) filterset = filters.VLANGroupFilterSet table = tables.VLANGroupTable diff --git a/netbox/netbox/constants.py b/netbox/netbox/constants.py index a074bde4e..4c6e3103a 100644 --- a/netbox/netbox/constants.py +++ b/netbox/netbox/constants.py @@ -23,7 +23,7 @@ from secrets.tables import SecretTable from tenancy.filters import TenantFilterSet from tenancy.models import Tenant from tenancy.tables import TenantTable -from utilities.utils import get_subquery +from utilities.utils import count_related from virtualization.filters import ClusterFilterSet, VirtualMachineFilterSet from virtualization.models import Cluster, VirtualMachine from virtualization.tables import ClusterTable, VirtualMachineDetailTable @@ -33,7 +33,7 @@ SEARCH_TYPES = OrderedDict(( # Circuits ('provider', { 'queryset': Provider.objects.annotate( - count_circuits=get_subquery(Circuit, 'provider') + count_circuits=count_related(Circuit, 'provider') ), 'filterset': ProviderFilterSet, 'table': ProviderTable, @@ -74,7 +74,7 @@ SEARCH_TYPES = OrderedDict(( }), ('devicetype', { 'queryset': DeviceType.objects.prefetch_related('manufacturer').annotate( - instance_count=get_subquery(Device, 'device_type') + instance_count=count_related(Device, 'device_type') ), 'filterset': DeviceTypeFilterSet, 'table': DeviceTypeTable, @@ -90,7 +90,7 @@ SEARCH_TYPES = OrderedDict(( }), ('virtualchassis', { 'queryset': VirtualChassis.objects.prefetch_related('master').annotate( - member_count=get_subquery(Device, 'virtual_chassis') + member_count=count_related(Device, 'virtual_chassis') ), 'filterset': VirtualChassisFilterSet, 'table': VirtualChassisTable, @@ -111,8 +111,8 @@ SEARCH_TYPES = OrderedDict(( # Virtualization ('cluster', { 'queryset': Cluster.objects.prefetch_related('type', 'group').annotate( - device_count=get_subquery(Device, 'cluster'), - vm_count=get_subquery(VirtualMachine, 'cluster') + device_count=count_related(Device, 'cluster'), + vm_count=count_related(VirtualMachine, 'cluster') ), 'filterset': ClusterFilterSet, 'table': ClusterTable, diff --git a/netbox/secrets/api/views.py b/netbox/secrets/api/views.py index 1153b0508..8c959f90d 100644 --- a/netbox/secrets/api/views.py +++ b/netbox/secrets/api/views.py @@ -12,7 +12,7 @@ from netbox.api.views import ModelViewSet from secrets import filters from secrets.exceptions import InvalidKey from secrets.models import Secret, SecretRole, SessionKey, UserKey -from utilities.utils import get_subquery +from utilities.utils import count_related from . import serializers ERR_USERKEY_MISSING = "No UserKey found for the current user." @@ -35,7 +35,7 @@ class SecretsRootView(APIRootView): class SecretRoleViewSet(ModelViewSet): queryset = SecretRole.objects.annotate( - secret_count=get_subquery(Secret, 'role') + secret_count=count_related(Secret, 'role') ) serializer_class = serializers.SecretRoleSerializer filterset_class = filters.SecretRoleFilterSet diff --git a/netbox/secrets/views.py b/netbox/secrets/views.py index 7bfa265d6..3fb8d1740 100644 --- a/netbox/secrets/views.py +++ b/netbox/secrets/views.py @@ -7,7 +7,7 @@ from django.utils.html import escape from django.utils.safestring import mark_safe from netbox.views import generic -from utilities.utils import get_subquery +from utilities.utils import count_related from . import filters, forms, tables from .models import SecretRole, Secret, SessionKey, UserKey @@ -28,7 +28,7 @@ def get_session_key(request): class SecretRoleListView(generic.ObjectListView): queryset = SecretRole.objects.annotate( - secret_count=get_subquery(Secret, 'role') + secret_count=count_related(Secret, 'role') ) table = tables.SecretRoleTable @@ -50,7 +50,7 @@ class SecretRoleBulkImportView(generic.BulkImportView): class SecretRoleBulkDeleteView(generic.BulkDeleteView): queryset = SecretRole.objects.annotate( - secret_count=get_subquery(Secret, 'role') + secret_count=count_related(Secret, 'role') ) table = tables.SecretRoleTable diff --git a/netbox/tenancy/api/views.py b/netbox/tenancy/api/views.py index 34be4991e..2b7ae8365 100644 --- a/netbox/tenancy/api/views.py +++ b/netbox/tenancy/api/views.py @@ -7,7 +7,7 @@ from ipam.models import IPAddress, Prefix, VLAN, VRF from netbox.api.views import ModelViewSet from tenancy import filters from tenancy.models import Tenant, TenantGroup -from utilities.utils import get_subquery +from utilities.utils import count_related from virtualization.models import VirtualMachine from . import serializers @@ -44,15 +44,15 @@ class TenantViewSet(CustomFieldModelViewSet): queryset = Tenant.objects.prefetch_related( 'group', 'tags' ).annotate( - circuit_count=get_subquery(Circuit, 'tenant'), - device_count=get_subquery(Device, 'tenant'), - ipaddress_count=get_subquery(IPAddress, 'tenant'), - prefix_count=get_subquery(Prefix, 'tenant'), - rack_count=get_subquery(Rack, 'tenant'), - site_count=get_subquery(Site, 'tenant'), - virtualmachine_count=get_subquery(VirtualMachine, 'tenant'), - vlan_count=get_subquery(VLAN, 'tenant'), - vrf_count=get_subquery(VRF, 'tenant') + circuit_count=count_related(Circuit, 'tenant'), + device_count=count_related(Device, 'tenant'), + ipaddress_count=count_related(IPAddress, 'tenant'), + prefix_count=count_related(Prefix, 'tenant'), + rack_count=count_related(Rack, 'tenant'), + site_count=count_related(Site, 'tenant'), + virtualmachine_count=count_related(VirtualMachine, 'tenant'), + vlan_count=count_related(VLAN, 'tenant'), + vrf_count=count_related(VRF, 'tenant') ) serializer_class = serializers.TenantSerializer filterset_class = filters.TenantFilterSet diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 19e08dfd4..d76b469b2 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -66,7 +66,7 @@ def dynamic_import(name): return mod -def get_subquery(model, field): +def count_related(model, field): """ Return a Subquery suitable for annotating a child object count. """ diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index a3dea00df..ce5cb9f2c 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -2,7 +2,7 @@ from rest_framework.routers import APIRootView from dcim.models import Device from extras.api.views import ConfigContextQuerySetMixin, CustomFieldModelViewSet, ModelViewSet -from utilities.utils import get_subquery +from utilities.utils import count_related from virtualization import filters from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface from . import serializers @@ -22,7 +22,7 @@ class VirtualizationRootView(APIRootView): class ClusterTypeViewSet(ModelViewSet): queryset = ClusterType.objects.annotate( - cluster_count=get_subquery(Cluster, 'type') + cluster_count=count_related(Cluster, 'type') ) serializer_class = serializers.ClusterTypeSerializer filterset_class = filters.ClusterTypeFilterSet @@ -30,7 +30,7 @@ class ClusterTypeViewSet(ModelViewSet): class ClusterGroupViewSet(ModelViewSet): queryset = ClusterGroup.objects.annotate( - cluster_count=get_subquery(Cluster, 'group') + cluster_count=count_related(Cluster, 'group') ) serializer_class = serializers.ClusterGroupSerializer filterset_class = filters.ClusterGroupFilterSet @@ -40,8 +40,8 @@ class ClusterViewSet(CustomFieldModelViewSet): queryset = Cluster.objects.prefetch_related( 'type', 'group', 'tenant', 'site', 'tags' ).annotate( - device_count=get_subquery(Device, 'cluster'), - virtualmachine_count=get_subquery(VirtualMachine, 'cluster') + device_count=count_related(Device, 'cluster'), + virtualmachine_count=count_related(VirtualMachine, 'cluster') ) serializer_class = serializers.ClusterSerializer filterset_class = filters.ClusterFilterSet diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py index 05fe32679..9ef4a0863 100644 --- a/netbox/virtualization/views.py +++ b/netbox/virtualization/views.py @@ -11,7 +11,7 @@ from ipam.models import IPAddress, Service from ipam.tables import InterfaceIPAddressTable, InterfaceVLANTable from netbox.views import generic from secrets.models import Secret -from utilities.utils import get_subquery +from utilities.utils import count_related from . import filters, forms, tables from .models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface @@ -22,7 +22,7 @@ from .models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterf class ClusterTypeListView(generic.ObjectListView): queryset = ClusterType.objects.annotate( - cluster_count=get_subquery(Cluster, 'type') + cluster_count=count_related(Cluster, 'type') ) table = tables.ClusterTypeTable @@ -44,7 +44,7 @@ class ClusterTypeBulkImportView(generic.BulkImportView): class ClusterTypeBulkDeleteView(generic.BulkDeleteView): queryset = ClusterType.objects.annotate( - cluster_count=get_subquery(Cluster, 'type') + cluster_count=count_related(Cluster, 'type') ) table = tables.ClusterTypeTable @@ -55,7 +55,7 @@ class ClusterTypeBulkDeleteView(generic.BulkDeleteView): class ClusterGroupListView(generic.ObjectListView): queryset = ClusterGroup.objects.annotate( - cluster_count=get_subquery(Cluster, 'group') + cluster_count=count_related(Cluster, 'group') ) table = tables.ClusterGroupTable @@ -77,7 +77,7 @@ class ClusterGroupBulkImportView(generic.BulkImportView): class ClusterGroupBulkDeleteView(generic.BulkDeleteView): queryset = ClusterGroup.objects.annotate( - cluster_count=get_subquery(Cluster, 'group') + cluster_count=count_related(Cluster, 'group') ) table = tables.ClusterGroupTable @@ -89,8 +89,8 @@ class ClusterGroupBulkDeleteView(generic.BulkDeleteView): class ClusterListView(generic.ObjectListView): permission_required = 'virtualization.view_cluster' queryset = Cluster.objects.annotate( - device_count=get_subquery(Device, 'cluster'), - vm_count=get_subquery(VirtualMachine, 'cluster') + device_count=count_related(Device, 'cluster'), + vm_count=count_related(VirtualMachine, 'cluster') ) table = tables.ClusterTable filterset = filters.ClusterFilterSet From af2777c580bb90deb17254dd42968ee8ad71fc04 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Dec 2020 15:50:47 -0500 Subject: [PATCH 025/302] Fixes #5487: Support filtering rack type/width with multiple values --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/filters.py | 10 ++++++++-- netbox/dcim/tests/test_filters.py | 10 ++++------ 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 719a982ad..42a6a094e 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -9,6 +9,7 @@ * [#5478](https://github.com/netbox-community/netbox/issues/5478) - Fix display of route target description * [#5484](https://github.com/netbox-community/netbox/issues/5484) - Fix "tagged" indication in VLAN members list * [#5486](https://github.com/netbox-community/netbox/issues/5486) - Optimize retrieval of config context data for device/VM REST API views +* [#5487](https://github.com/netbox-community/netbox/issues/5487) - Support filtering rack type/width with multiple values --- diff --git a/netbox/dcim/filters.py b/netbox/dcim/filters.py index 3f104ef18..f4e3fa09e 100644 --- a/netbox/dcim/filters.py +++ b/netbox/dcim/filters.py @@ -224,6 +224,12 @@ class RackFilterSet(BaseFilterSet, TenancyFilterSet, CustomFieldModelFilterSet, choices=RackStatusChoices, null_value=None ) + type = django_filters.MultipleChoiceFilter( + choices=RackTypeChoices + ) + width = django_filters.MultipleChoiceFilter( + choices=RackWidthChoices + ) role_id = django_filters.ModelMultipleChoiceFilter( queryset=RackRole.objects.all(), label='Role (ID)', @@ -242,8 +248,8 @@ class RackFilterSet(BaseFilterSet, TenancyFilterSet, CustomFieldModelFilterSet, class Meta: model = Rack fields = [ - 'id', 'name', 'facility_id', 'asset_tag', 'type', 'width', 'u_height', 'desc_units', - 'outer_width', 'outer_depth', 'outer_unit', + 'id', 'name', 'facility_id', 'asset_tag', 'u_height', 'desc_units', 'outer_width', 'outer_depth', + 'outer_unit', ] def search(self, queryset, name, value): diff --git a/netbox/dcim/tests/test_filters.py b/netbox/dcim/tests/test_filters.py index f209cd1f4..724aaf1fa 100644 --- a/netbox/dcim/tests/test_filters.py +++ b/netbox/dcim/tests/test_filters.py @@ -329,7 +329,7 @@ class RackTestCase(TestCase): racks = ( Rack(name='Rack 1', facility_id='rack-1', site=sites[0], group=rack_groups[0], tenant=tenants[0], status=RackStatusChoices.STATUS_ACTIVE, role=rack_roles[0], serial='ABC', asset_tag='1001', type=RackTypeChoices.TYPE_2POST, width=RackWidthChoices.WIDTH_19IN, u_height=42, desc_units=False, outer_width=100, outer_depth=100, outer_unit=RackDimensionUnitChoices.UNIT_MILLIMETER), - Rack(name='Rack 2', facility_id='rack-2', site=sites[1], group=rack_groups[1], tenant=tenants[1], status=RackStatusChoices.STATUS_PLANNED, role=rack_roles[1], serial='DEF', asset_tag='1002', type=RackTypeChoices.TYPE_4POST, width=RackWidthChoices.WIDTH_19IN, u_height=43, desc_units=False, outer_width=200, outer_depth=200, outer_unit=RackDimensionUnitChoices.UNIT_MILLIMETER), + Rack(name='Rack 2', facility_id='rack-2', site=sites[1], group=rack_groups[1], tenant=tenants[1], status=RackStatusChoices.STATUS_PLANNED, role=rack_roles[1], serial='DEF', asset_tag='1002', type=RackTypeChoices.TYPE_4POST, width=RackWidthChoices.WIDTH_21IN, u_height=43, desc_units=False, outer_width=200, outer_depth=200, outer_unit=RackDimensionUnitChoices.UNIT_MILLIMETER), Rack(name='Rack 3', facility_id='rack-3', site=sites[2], group=rack_groups[2], tenant=tenants[2], status=RackStatusChoices.STATUS_RESERVED, role=rack_roles[2], serial='GHI', asset_tag='1003', type=RackTypeChoices.TYPE_CABINET, width=RackWidthChoices.WIDTH_23IN, u_height=44, desc_units=True, outer_width=300, outer_depth=300, outer_unit=RackDimensionUnitChoices.UNIT_INCH), ) Rack.objects.bulk_create(racks) @@ -351,13 +351,11 @@ class RackTestCase(TestCase): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_type(self): - # TODO: Test for multiple values - params = {'type': RackTypeChoices.TYPE_2POST} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + params = {'type': [RackTypeChoices.TYPE_2POST, RackTypeChoices.TYPE_4POST]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_width(self): - # TODO: Test for multiple values - params = {'width': RackWidthChoices.WIDTH_19IN} + params = {'width': [RackWidthChoices.WIDTH_19IN, RackWidthChoices.WIDTH_21IN]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_u_height(self): From 34a0e2e72d1dd6fc432f0b73a928f7bc80c99b8f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Dec 2020 15:55:22 -0500 Subject: [PATCH 026/302] Closes #5489: Add filters for type and width to racks list --- docs/release-notes/version-2.10.md | 4 ++++ netbox/dcim/forms.py | 10 ++++++++++ 2 files changed, 14 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 42a6a094e..a7404ab3c 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -2,6 +2,10 @@ ## v2.10.2 (FUTURE) +### Enhancements + +* [#5489](https://github.com/netbox-community/netbox/issues/5489) - Add filters for type and width to racks list + ### Bug Fixes * [#5468](https://github.com/netbox-community/netbox/issues/5468) - Fix unlocking secrets from device/VM view diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index cb2aa10e6..930ac166b 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -690,6 +690,16 @@ class RackFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilterForm): required=False, widget=StaticSelect2Multiple() ) + type = forms.MultipleChoiceField( + choices=RackTypeChoices, + required=False, + widget=StaticSelect2Multiple() + ) + width = forms.MultipleChoiceField( + choices=RackWidthChoices, + required=False, + widget=StaticSelect2Multiple() + ) role = DynamicModelMultipleChoiceField( queryset=RackRole.objects.all(), to_field_name='slug', From dac93b9840300ef96499354ddee0ca4e4a2dacaa Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Thu, 17 Dec 2020 16:11:16 -0600 Subject: [PATCH 027/302] Fixes #5254 - Require plugin authors to set zip_safe=False --- docs/plugins/development.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/plugins/development.md b/docs/plugins/development.md index d65e7d830..f008da2fb 100644 --- a/docs/plugins/development.md +++ b/docs/plugins/development.md @@ -63,11 +63,15 @@ setup( install_requires=[], packages=find_packages(), include_package_data=True, + zip_safe=False, ) ``` Many of these are self-explanatory, but for more information, see the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html). +!!! note + `zip_safe=False` is **required** as the current plugin iteration is not zip safe due to upstream python issue [issue19699](https://bugs.python.org/issue19699) + ### Define a PluginConfig The `PluginConfig` class is a NetBox-specific wrapper around Django's built-in [`AppConfig`](https://docs.djangoproject.com/en/stable/ref/applications/) class. It is used to declare NetBox plugin functionality within a Python package. Each plugin should provide its own subclass, defining its name, metadata, and default and required configuration parameters. An example is below: From 6ca9e2a777850ca5b9a3c0b734c5aba884f7b364 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 18 Dec 2020 12:09:41 -0500 Subject: [PATCH 028/302] Closes #5496: Add form field to filter rack reservation by user --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/forms.py | 13 +++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index a7404ab3c..2534d2403 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -5,6 +5,7 @@ ### Enhancements * [#5489](https://github.com/netbox-community/netbox/issues/5489) - Add filters for type and width to racks list +* [#5496](https://github.com/netbox-community/netbox/issues/5496) - Add form field to filter rack reservation by user ### Bug Fixes diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 930ac166b..7ecd4efd8 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -21,7 +21,7 @@ from ipam.models import IPAddress, VLAN from tenancy.forms import TenancyFilterForm, TenancyForm from tenancy.models import Tenant, TenantGroup from utilities.forms import ( - APISelect, add_blank_choice, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect, + APISelect, APISelectMultiple, add_blank_choice, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect, ColorSelect, CommentField, CSVChoiceField, CSVContentTypeField, CSVModelChoiceField, CSVModelForm, DynamicModelChoiceField, DynamicModelMultipleChoiceField, ExpandableNameField, form_from_model, JSONField, NumericArrayField, SelectWithPK, SmallTextarea, SlugField, StaticSelect2, StaticSelect2Multiple, TagFilterField, @@ -860,7 +860,7 @@ class RackReservationBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditFor class RackReservationFilterForm(BootstrapMixin, TenancyFilterForm): model = RackReservation - field_order = ['q', 'region', 'site', 'group_id', 'tenant_group', 'tenant'] + field_order = ['q', 'region', 'site', 'group_id', 'user_id', 'tenant_group', 'tenant'] q = forms.CharField( required=False, label='Search' @@ -884,6 +884,15 @@ class RackReservationFilterForm(BootstrapMixin, TenancyFilterForm): label='Rack group', null_option='None' ) + user_id = DynamicModelMultipleChoiceField( + queryset=User.objects.all(), + required=False, + display_field='username', + label='User', + widget=APISelectMultiple( + api_url='/api/users/users/', + ) + ) tag = TagFilterField(model) From b1402f3bae74d4e2fcf45868e5bb83751650fb77 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 18 Dec 2020 12:18:59 -0500 Subject: [PATCH 029/302] Fixes #5498: Fix filtering rack reservations by username --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/filters.py | 2 +- netbox/dcim/tests/test_filters.py | 5 ++--- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 2534d2403..2d5b4f390 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -15,6 +15,7 @@ * [#5484](https://github.com/netbox-community/netbox/issues/5484) - Fix "tagged" indication in VLAN members list * [#5486](https://github.com/netbox-community/netbox/issues/5486) - Optimize retrieval of config context data for device/VM REST API views * [#5487](https://github.com/netbox-community/netbox/issues/5487) - Support filtering rack type/width with multiple values +* [#5498](https://github.com/netbox-community/netbox/issues/5498) - Fix filtering rack reservations by username --- diff --git a/netbox/dcim/filters.py b/netbox/dcim/filters.py index f4e3fa09e..3046a0f33 100644 --- a/netbox/dcim/filters.py +++ b/netbox/dcim/filters.py @@ -302,7 +302,7 @@ class RackReservationFilterSet(BaseFilterSet, TenancyFilterSet): label='User (ID)', ) user = django_filters.ModelMultipleChoiceFilter( - field_name='user', + field_name='user__username', queryset=User.objects.all(), to_field_name='username', label='User (name)', diff --git a/netbox/dcim/tests/test_filters.py b/netbox/dcim/tests/test_filters.py index 724aaf1fa..c701c47cf 100644 --- a/netbox/dcim/tests/test_filters.py +++ b/netbox/dcim/tests/test_filters.py @@ -514,9 +514,8 @@ class RackReservationTestCase(TestCase): users = User.objects.all()[:2] params = {'user_id': [users[0].pk, users[1].pk]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) - # TODO: Filtering by username is broken - # params = {'user': [users[0].username, users[1].username]} - # self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'user': [users[0].username, users[1].username]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_tenant(self): tenants = Tenant.objects.all()[:2] From f2d028ba29c2994a49618cf65396d5cd9e4a538c Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Fri, 18 Dec 2020 11:33:28 -0600 Subject: [PATCH 030/302] Update version-2.10.md --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 2d5b4f390..1580b9077 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -9,6 +9,7 @@ ### Bug Fixes +* [#5254](https://github.com/netbox-community/netbox/issues/5254) - Require plugin authors to set zip_safe=False * [#5468](https://github.com/netbox-community/netbox/issues/5468) - Fix unlocking secrets from device/VM view * [#5473](https://github.com/netbox-community/netbox/issues/5473) - Fix alignment of rack names in elevations list * [#5478](https://github.com/netbox-community/netbox/issues/5478) - Fix display of route target description From 442dee72b59f727109ab993db5f17b64f61e649f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 18 Dec 2020 15:02:52 -0500 Subject: [PATCH 031/302] Fixes #5499: Fix filtering of displayed device/VM interfaces by regex --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/tables/devices.py | 3 ++- netbox/project-static/js/interface_filtering.js | 7 +++---- netbox/virtualization/tables.py | 3 +++ 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 1580b9077..ca53d0cbf 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -17,6 +17,7 @@ * [#5486](https://github.com/netbox-community/netbox/issues/5486) - Optimize retrieval of config context data for device/VM REST API views * [#5487](https://github.com/netbox-community/netbox/issues/5487) - Support filtering rack type/width with multiple values * [#5498](https://github.com/netbox-community/netbox/issues/5498) - Fix filtering rack reservations by username +* [#5499](https://github.com/netbox-community/netbox/issues/5499) - Fix filtering of displayed device/VM interfaces by regex --- diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index 536be66d9..663206505 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -447,7 +447,8 @@ class DeviceInterfaceTable(InterfaceTable): 'connection', 'actions', ) row_attrs = { - 'class': lambda record: record.cable.get_status_class() if record.cable else '' + 'class': lambda record: record.cable.get_status_class() if record.cable else '', + 'data-name': lambda record: record.name, } diff --git a/netbox/project-static/js/interface_filtering.js b/netbox/project-static/js/interface_filtering.js index fecb156f4..51ac70198 100644 --- a/netbox/project-static/js/interface_filtering.js +++ b/netbox/project-static/js/interface_filtering.js @@ -1,11 +1,10 @@ // Inteface filtering $('input.interface-filter').on('input', function() { - var filter = new RegExp(this.value); - var interface; + let filter = new RegExp(this.value); + let interface; for (interface of $('table > tbody > tr')) { - // Slice off 'interface_' at the start of the ID - if (filter.test(interface.id.slice(10))) { + if (filter.test(interface.getAttribute('data-name'))) { // Match the toggle in case the filter now matches the interface $(interface).find('input:checkbox[name=pk]').prop('checked', $('input.toggle').prop('checked')); $(interface).show(); diff --git a/netbox/virtualization/tables.py b/netbox/virtualization/tables.py index 97e1d6e36..34a070623 100644 --- a/netbox/virtualization/tables.py +++ b/netbox/virtualization/tables.py @@ -183,3 +183,6 @@ class VirtualMachineVMInterfaceTable(VMInterfaceTable): default_columns = ( 'pk', 'name', 'enabled', 'mac_address', 'mtu', 'mode', 'description', 'ip_addresses', 'actions', ) + row_attrs = { + 'data-name': lambda record: record.name, + } From 1e5778e6db1b08dc052c9abc1ad7e6dfe3fb9708 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 18 Dec 2020 15:43:15 -0500 Subject: [PATCH 032/302] Clean up prefix hierarchy annotation --- netbox/ipam/tables.py | 12 +++++------- netbox/utilities/templatetags/helpers.py | 8 ++++++++ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/netbox/ipam/tables.py b/netbox/ipam/tables.py index 868ba3105..bea8ec255 100644 --- a/netbox/ipam/tables.py +++ b/netbox/ipam/tables.py @@ -18,13 +18,11 @@ UTILIZATION_GRAPH = """ """ PREFIX_LINK = """ -{% if record.children %} - -{% else %} - -{% endif %} - {{ record.prefix }} - +{% load helpers %} +{% for i in record.parents|as_range %} + +{% endfor %} +{{ record.prefix }} """ PREFIX_ROLE_LINK = """ diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index f095af58f..a93abe1a5 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -208,6 +208,14 @@ def split(string, sep=','): return string.split(sep) +@register.filter() +def as_range(n): + """ + Return a range of n items. + """ + return range(n) + + # # Tags # From 158ed5765bd04633c273452aa06c1f77264cb56f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Dec 2020 09:43:15 -0500 Subject: [PATCH 033/302] Fixes #5507: Fix custom field data assignment via UI for IP addresses, secrets --- docs/release-notes/version-2.10.md | 1 + netbox/ipam/forms.py | 1 + netbox/secrets/forms.py | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index ca53d0cbf..4c643a23a 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -18,6 +18,7 @@ * [#5487](https://github.com/netbox-community/netbox/issues/5487) - Support filtering rack type/width with multiple values * [#5498](https://github.com/netbox-community/netbox/issues/5498) - Fix filtering rack reservations by username * [#5499](https://github.com/netbox-community/netbox/issues/5499) - Fix filtering of displayed device/VM interfaces by regex +* [#5507](https://github.com/netbox-community/netbox/issues/5507) - Fix custom field data assignment via UI for IP addresses, secrets --- diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 29a6d295e..e2cb51417 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -774,6 +774,7 @@ class IPAddressForm(BootstrapMixin, TenancyForm, ReturnURLForm, CustomFieldModel self.initial['primary_for_parent'] = True def clean(self): + super().clean() # Cannot select both a device interface and a VM interface if self.cleaned_data.get('interface') and self.cleaned_data.get('vminterface'): diff --git a/netbox/secrets/forms.py b/netbox/secrets/forms.py index 8e976c8ea..cdd843e2d 100644 --- a/netbox/secrets/forms.py +++ b/netbox/secrets/forms.py @@ -122,6 +122,7 @@ class SecretForm(BootstrapMixin, CustomFieldModelForm): self.fields['plaintext'].required = True def clean(self): + super().clean() if not self.cleaned_data['device'] and not self.cleaned_data['virtual_machine']: raise forms.ValidationError("Secrets must be assigned to a device or virtual machine.") From b09112941a8120a08b17992854daad957f2c1ecc Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Dec 2020 11:47:11 -0500 Subject: [PATCH 034/302] Fixes #5510: Fix filtering by boolean custom fields --- docs/release-notes/version-2.10.md | 1 + netbox/extras/filters.py | 28 +++---- netbox/extras/tests/test_customfields.py | 100 +++++++++++++++++++++++ 3 files changed, 114 insertions(+), 15 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 4c643a23a..daa5c0eae 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -19,6 +19,7 @@ * [#5498](https://github.com/netbox-community/netbox/issues/5498) - Fix filtering rack reservations by username * [#5499](https://github.com/netbox-community/netbox/issues/5499) - Fix filtering of displayed device/VM interfaces by regex * [#5507](https://github.com/netbox-community/netbox/issues/5507) - Fix custom field data assignment via UI for IP addresses, secrets +* [#5510](https://github.com/netbox-community/netbox/issues/5510) - Fix filtering by boolean custom fields --- diff --git a/netbox/extras/filters.py b/netbox/extras/filters.py index 7b341f74d..e3c313735 100644 --- a/netbox/extras/filters.py +++ b/netbox/extras/filters.py @@ -2,6 +2,7 @@ import django_filters from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType from django.db.models import Q +from django.forms import DateField, IntegerField, NullBooleanField from dcim.models import DeviceRole, Platform, Region, Site from tenancy.models import Tenant, TenantGroup @@ -38,24 +39,21 @@ class CustomFieldFilter(django_filters.Filter): """ def __init__(self, custom_field, *args, **kwargs): self.custom_field = custom_field + + if custom_field.type == CustomFieldTypeChoices.TYPE_INTEGER: + self.field_class = IntegerField + elif custom_field.type == CustomFieldTypeChoices.TYPE_BOOLEAN: + self.field_class = NullBooleanField + elif custom_field.type == CustomFieldTypeChoices.TYPE_DATE: + self.field_class = DateField + super().__init__(*args, **kwargs) - def filter(self, queryset, value): + self.field_name = f'custom_field_data__{self.field_name}' - # Skip filter on empty value - if value is None or not value.strip(): - return queryset - - # Apply the assigned filter logic (exact or loose) - if ( - self.custom_field.type in EXACT_FILTER_TYPES or - self.custom_field.filter_logic == CustomFieldFilterLogicChoices.FILTER_EXACT - ): - kwargs = {f'custom_field_data__{self.field_name}': value} - else: - kwargs = {f'custom_field_data__{self.field_name}__icontains': value} - - return queryset.filter(**kwargs) + if custom_field.type not in EXACT_FILTER_TYPES: + if custom_field.filter_logic == CustomFieldFilterLogicChoices.FILTER_LOOSE: + self.lookup_expr = 'icontains' class CustomFieldModelFilterSet(django_filters.FilterSet): diff --git a/netbox/extras/tests/test_customfields.py b/netbox/extras/tests/test_customfields.py index fe56027dc..4f7a67676 100644 --- a/netbox/extras/tests/test_customfields.py +++ b/netbox/extras/tests/test_customfields.py @@ -3,6 +3,7 @@ from django.core.exceptions import ValidationError from django.urls import reverse from rest_framework import status +from dcim.filters import SiteFilterSet from dcim.forms import SiteCSVForm from dcim.models import Site, Rack from extras.choices import * @@ -597,3 +598,102 @@ class CustomFieldModelTest(TestCase): site.cf['baz'] = 'def' site.clean() + + +class CustomFieldFilterTest(TestCase): + queryset = Site.objects.all() + filterset = SiteFilterSet + + @classmethod + def setUpTestData(cls): + obj_type = ContentType.objects.get_for_model(Site) + + # Integer filtering + cf = CustomField(name='cf1', type=CustomFieldTypeChoices.TYPE_INTEGER) + cf.save() + cf.content_types.set([obj_type]) + + # Boolean filtering + cf = CustomField(name='cf2', type=CustomFieldTypeChoices.TYPE_BOOLEAN) + cf.save() + cf.content_types.set([obj_type]) + + # Exact text filtering + cf = CustomField(name='cf3', type=CustomFieldTypeChoices.TYPE_TEXT, + filter_logic=CustomFieldFilterLogicChoices.FILTER_EXACT) + cf.save() + cf.content_types.set([obj_type]) + + # Loose text filtering + cf = CustomField(name='cf4', type=CustomFieldTypeChoices.TYPE_TEXT, + filter_logic=CustomFieldFilterLogicChoices.FILTER_LOOSE) + cf.save() + cf.content_types.set([obj_type]) + + # Date filtering + cf = CustomField(name='cf5', type=CustomFieldTypeChoices.TYPE_DATE) + cf.save() + cf.content_types.set([obj_type]) + + # Exact URL filtering + cf = CustomField(name='cf6', type=CustomFieldTypeChoices.TYPE_URL, + filter_logic=CustomFieldFilterLogicChoices.FILTER_EXACT) + cf.save() + cf.content_types.set([obj_type]) + + # Loose URL filtering + cf = CustomField(name='cf7', type=CustomFieldTypeChoices.TYPE_URL, + filter_logic=CustomFieldFilterLogicChoices.FILTER_LOOSE) + cf.save() + cf.content_types.set([obj_type]) + + # Selection filtering + cf = CustomField(name='cf8', type=CustomFieldTypeChoices.TYPE_URL, choices=['Foo', 'Bar', 'Baz']) + cf.save() + cf.content_types.set([obj_type]) + + Site.objects.bulk_create([ + Site(name='Site 1', slug='site-1', custom_field_data={ + 'cf1': 100, + 'cf2': True, + 'cf3': 'foo', + 'cf4': 'foo', + 'cf5': '2016-06-26', + 'cf6': 'http://foo.example.com/', + 'cf7': 'http://foo.example.com/', + 'cf8': 'Foo', + }), + Site(name='Site 2', slug='site-2', custom_field_data={ + 'cf1': 200, + 'cf2': False, + 'cf3': 'foobar', + 'cf4': 'foobar', + 'cf5': '2016-06-27', + 'cf6': 'http://bar.example.com/', + 'cf7': 'http://bar.example.com/', + 'cf8': 'Bar', + }), + Site(name='Site 3', slug='site-3', custom_field_data={ + }), + ]) + + def test_filter_integer(self): + self.assertEqual(self.filterset({'cf_cf1': 100}, self.queryset).qs.count(), 1) + + def test_filter_boolean(self): + self.assertEqual(self.filterset({'cf_cf2': True}, self.queryset).qs.count(), 1) + self.assertEqual(self.filterset({'cf_cf2': False}, self.queryset).qs.count(), 1) + + def test_filter_text(self): + self.assertEqual(self.filterset({'cf_cf3': 'foo'}, self.queryset).qs.count(), 1) + self.assertEqual(self.filterset({'cf_cf4': 'foo'}, self.queryset).qs.count(), 2) + + def test_filter_date(self): + self.assertEqual(self.filterset({'cf_cf5': '2016-06-26'}, self.queryset).qs.count(), 1) + + def test_filter_url(self): + self.assertEqual(self.filterset({'cf_cf6': 'http://foo.example.com/'}, self.queryset).qs.count(), 1) + self.assertEqual(self.filterset({'cf_cf7': 'example.com'}, self.queryset).qs.count(), 2) + + def test_filter_select(self): + self.assertEqual(self.filterset({'cf_cf8': 'Foo'}, self.queryset).qs.count(), 1) From 278c88105942e4505c0596812101a6a7491f7749 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Dec 2020 11:54:35 -0500 Subject: [PATCH 035/302] as_range: Catch TypeErrors --- netbox/utilities/templatetags/helpers.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index a93abe1a5..29c920d4f 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -213,6 +213,10 @@ def as_range(n): """ Return a range of n items. """ + try: + int(n) + except TypeError: + return list() return range(n) From c5a265e8286daf119de48d6f10b3ffbca8276e9c Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Mon, 21 Dec 2020 18:02:30 +0100 Subject: [PATCH 036/302] Use HTTPS URL schema everywhere (#5505) * Use HTTPS everywhere (mechanical edit using util from https-everywhere) ```Shell node ~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js . git checkout netbox/project-static/ ``` A few additional changes where reset manually before the commit. * Use HTTPS everywhere (mechanical edit using util from opening_hours.js) ```Shell make -f ~/src/opening-hours/opening_hours.js/Makefile qa-https-everywhere git checkout netbox/project-static/ git checkout netbox/*/tests ``` --- README.md | 6 +++--- docs/configuration/optional-settings.md | 4 ++-- docs/installation/5-http-server.md | 2 +- docs/installation/6-ldap.md | 2 +- docs/release-notes/version-2.1.md | 2 +- docs/release-notes/version-2.2.md | 2 +- docs/rest-api/overview.md | 2 +- netbox/netbox/configuration.example.py | 4 ++-- netbox/templates/base.html | 2 +- netbox/templates/dcim/site.html | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0b9531df0..68927463d 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. NetBox runs as a web application atop the [Django](https://www.djangoproject.com/) -Python framework with a [PostgreSQL](http://www.postgresql.org/) database. For a +Python framework with a [PostgreSQL](https://www.postgresql.org/) database. For a complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/netbox-community/netbox). -The complete documentation for NetBox can be found at [Read the Docs](http://netbox.readthedocs.io/en/stable/). +The complete documentation for NetBox can be found at [Read the Docs](https://netbox.readthedocs.io/en/stable/). Questions? Comments? Please start a [discussion on GitHub](https://github.com/netbox-community/netbox/discussions), or join us in the **#netbox** Slack channel on [NetworkToCode](https://networktocode.slack.com/)! @@ -36,7 +36,7 @@ or join us in the **#netbox** Slack channel on [NetworkToCode](https://networkto ## Installation -Please see [the documentation](http://netbox.readthedocs.io/en/stable/) for +Please see [the documentation](https://netbox.readthedocs.io/en/stable/) for instructions on installing NetBox. To upgrade NetBox, please download the [latest release](https://github.com/netbox-community/netbox/releases) and run `upgrade.sh`. diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index fe43f0483..91c0e7597 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -44,7 +44,7 @@ This defines custom content to be displayed on the login page above the login fo Default: None -The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at http://example.com/netbox/, set: +The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: ```python BASE_PATH = 'netbox/' @@ -318,7 +318,7 @@ NetBox will use these credentials when authenticating to remote devices via the ## NAPALM_ARGS -A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](http://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example: +A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](https://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example: ```python NAPALM_ARGS = { diff --git a/docs/installation/5-http-server.md b/docs/installation/5-http-server.md index eba0db21b..907964554 100644 --- a/docs/installation/5-http-server.md +++ b/docs/installation/5-http-server.md @@ -1,6 +1,6 @@ # HTTP Server Setup -This documentation provides example configurations for both [nginx](https://www.nginx.com/resources/wiki/) and [Apache](http://httpd.apache.org/docs/current/), though any HTTP server which supports WSGI should be compatible. +This documentation provides example configurations for both [nginx](https://www.nginx.com/resources/wiki/) and [Apache](https://httpd.apache.org/docs/current/), though any HTTP server which supports WSGI should be compatible. !!! info For the sake of brevity, only Ubuntu 20.04 instructions are provided here. These tasks are not unique to NetBox and should carry over to other distributions with minimal changes. Please consult your distribution's documentation for assistance if needed. diff --git a/docs/installation/6-ldap.md b/docs/installation/6-ldap.md index ce6262531..25f9c8f2b 100644 --- a/docs/installation/6-ldap.md +++ b/docs/installation/6-ldap.md @@ -41,7 +41,7 @@ First, enable the LDAP authentication backend in `configuration.py`. (Be sure to REMOTE_AUTH_BACKEND = 'netbox.authentication.LDAPBackend' ``` -Next, create a file in the same directory as `configuration.py` (typically `/opt/netbox/netbox/netbox/`) named `ldap_config.py`. Define all of the parameters required below in `ldap_config.py`. Complete documentation of all `django-auth-ldap` configuration options is included in the project's [official documentation](http://django-auth-ldap.readthedocs.io/). +Next, create a file in the same directory as `configuration.py` (typically `/opt/netbox/netbox/netbox/`) named `ldap_config.py`. Define all of the parameters required below in `ldap_config.py`. Complete documentation of all `django-auth-ldap` configuration options is included in the project's [official documentation](https://django-auth-ldap.readthedocs.io/). ### General Server Configuration diff --git a/docs/release-notes/version-2.1.md b/docs/release-notes/version-2.1.md index 59f23c090..e5fa41d82 100644 --- a/docs/release-notes/version-2.1.md +++ b/docs/release-notes/version-2.1.md @@ -121,7 +121,7 @@ A new API endpoint has been added at `/api/ipam/prefixes//available-ips/`. A #### NAPALM Integration ([#1348](https://github.com/netbox-community/netbox/issues/1348)) -The [NAPALM automation](https://napalm-automation.net/) library provides an abstracted interface for pulling live data (e.g. uptime, software version, running config, LLDP neighbors, etc.) from network devices. The NetBox API has been extended to support executing read-only NAPALM methods on devices defined in NetBox. To enable this functionality, ensure that NAPALM has been installed (`pip install napalm`) and the `NETBOX_USERNAME` and `NETBOX_PASSWORD` [configuration parameters](http://netbox.readthedocs.io/en/stable/configuration/optional-settings/#netbox_username) have been set in configuration.py. +The [NAPALM automation](https://napalm-automation.net/) library provides an abstracted interface for pulling live data (e.g. uptime, software version, running config, LLDP neighbors, etc.) from network devices. The NetBox API has been extended to support executing read-only NAPALM methods on devices defined in NetBox. To enable this functionality, ensure that NAPALM has been installed (`pip install napalm`) and the `NETBOX_USERNAME` and `NETBOX_PASSWORD` [configuration parameters](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#netbox_username) have been set in configuration.py. ### Enhancements diff --git a/docs/release-notes/version-2.2.md b/docs/release-notes/version-2.2.md index 905b7a8d1..e13c4fe69 100644 --- a/docs/release-notes/version-2.2.md +++ b/docs/release-notes/version-2.2.md @@ -196,7 +196,7 @@ Our second-most popular feature request has arrived! NetBox now supports the cre #### Custom Validation Reports ([#1511](https://github.com/netbox-community/netbox/issues/1511)) -Users can now create custom reports which are run to validate data in NetBox. Reports work very similar to Python unit tests: Each report inherits from NetBox's Report class and contains one or more test method. Reports can be run and retrieved via the web UI, API, or CLI. See [the docs](http://netbox.readthedocs.io/en/stable/miscellaneous/reports/) for more info. +Users can now create custom reports which are run to validate data in NetBox. Reports work very similar to Python unit tests: Each report inherits from NetBox's Report class and contains one or more test method. Reports can be run and retrieved via the web UI, API, or CLI. See [the docs](https://netbox.readthedocs.io/en/stable/miscellaneous/reports/) for more info. ### Enhancements diff --git a/docs/rest-api/overview.md b/docs/rest-api/overview.md index a3c8143eb..290343aa6 100644 --- a/docs/rest-api/overview.md +++ b/docs/rest-api/overview.md @@ -2,7 +2,7 @@ ## What is a REST API? -REST stands for [representational state transfer](https://en.wikipedia.org/wiki/Representational_state_transfer). It's a particular type of API which employs HTTP requests and [JavaScript Object Notation (JSON)](http://www.json.org/) to facilitate create, retrieve, update, and delete (CRUD) operations on objects within an application. Each type of operation is associated with a particular HTTP verb: +REST stands for [representational state transfer](https://en.wikipedia.org/wiki/Representational_state_transfer). It's a particular type of API which employs HTTP requests and [JavaScript Object Notation (JSON)](https://www.json.org/) to facilitate create, retrieve, update, and delete (CRUD) operations on objects within an application. Each type of operation is associated with a particular HTTP verb: * `GET`: Retrieve an object or list of objects * `POST`: Create an object diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index 51c73bccc..b7a72a504 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -79,7 +79,7 @@ BANNER_BOTTOM = '' # Text to include on the login page above the login form. HTML is allowed. BANNER_LOGIN = '' -# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set: +# Base URL path if accessing NetBox within a directory. For example, if installed at https://example.com/netbox/, set: # BASE_PATH = 'netbox/' BASE_PATH = '' @@ -183,7 +183,7 @@ NAPALM_PASSWORD = '' # NAPALM timeout (in seconds). (Default: 30) NAPALM_TIMEOUT = 30 -# NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must +# NAPALM optional arguments (see https://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must # be provided as a dictionary. NAPALM_ARGS = {} diff --git a/netbox/templates/base.html b/netbox/templates/base.html index 86b582b3e..f3129d7dd 100644 --- a/netbox/templates/base.html +++ b/netbox/templates/base.html @@ -71,7 +71,7 @@

- Docs · + Docs · API · Code · Help diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index a2479ca1f..a0e713fcf 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -137,7 +137,7 @@

{% if object.physical_address %}
- + Map it
@@ -156,7 +156,7 @@ 		{% if object.latitude and object.longitude %}
- + Map it
From 23f334e5dfadfc7e8e1b1c0e28076bc033298a15 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Dec 2020 15:30:34 -0500 Subject: [PATCH 037/302] Fixes #5488: Fix caching error when viewing cable trace after toggling cable status --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/signals.py | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index daa5c0eae..00ac081d7 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -16,6 +16,7 @@ * [#5484](https://github.com/netbox-community/netbox/issues/5484) - Fix "tagged" indication in VLAN members list * [#5486](https://github.com/netbox-community/netbox/issues/5486) - Optimize retrieval of config context data for device/VM REST API views * [#5487](https://github.com/netbox-community/netbox/issues/5487) - Support filtering rack type/width with multiple values +* [#5488](https://github.com/netbox-community/netbox/issues/5488) - Fix caching error when viewing cable trace after toggling cable status * [#5498](https://github.com/netbox-community/netbox/issues/5498) - Fix filtering rack reservations by username * [#5499](https://github.com/netbox-community/netbox/issues/5499) - Fix filtering of displayed device/VM interfaces by regex * [#5507](https://github.com/netbox-community/netbox/issues/5507) - Fix custom field data assignment via UI for IP addresses, secrets diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 4a5340748..33c4b461c 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -1,5 +1,6 @@ import logging +from cacheops import invalidate_obj from django.contrib.contenttypes.models import ContentType from django.db.models.signals import post_save, post_delete, pre_delete from django.db import transaction @@ -30,6 +31,7 @@ def rebuild_paths(obj): with transaction.atomic(): for cp in cable_paths: + invalidate_obj(cp.origin) cp.delete() create_cablepath(cp.origin) From e196d82e767ebeb015e1b0da403593efac3603e5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Dec 2020 16:03:43 -0500 Subject: [PATCH 038/302] Release v2.10.2 --- docs/release-notes/version-2.10.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 00ac081d7..27965090b 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,6 +1,6 @@ # NetBox v2.10 -## v2.10.2 (FUTURE) +## v2.10.2 (2020-12-21) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index d496f9969..3a6dc473f 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.2-dev' +VERSION = '2.10.2' # Hostname HOSTNAME = platform.node() From 5fe5fd71b5058767cb8346cc10bccd2dc127f032 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 21 Dec 2020 16:19:40 -0500 Subject: [PATCH 039/302] PRVB --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 3a6dc473f..987452255 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.2' +VERSION = '2.10.3-dev' # Hostname HOSTNAME = platform.node() From 8f4197c0207dd9467dc09b8e89dfcd896b2c8a79 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 22 Dec 2020 10:28:09 -0500 Subject: [PATCH 040/302] Fixes #5518: Fix persistent vertical scrollbar --- docs/release-notes/version-2.10.md | 8 ++++++++ netbox/project-static/css/base.css | 6 +++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 27965090b..91a65fbfe 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,5 +1,13 @@ # NetBox v2.10 +## v2.10.3 (FUTURE) + +### Bug Fixes + +* [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar + +--- + ## v2.10.2 (2020-12-21) ### Enhancements diff --git a/netbox/project-static/css/base.css b/netbox/project-static/css/base.css index 681565b9e..94bd74a46 100644 --- a/netbox/project-static/css/base.css +++ b/netbox/project-static/css/base.css @@ -14,21 +14,21 @@ body { .wrapper { min-height: 100%; height: auto !important; - margin: 0 auto -61px; /* the bottom margin is the negative value of the footer's height */ + margin: 0 auto -48px; /* the bottom margin is the negative value of the footer's height */ padding-bottom: 30px; } .navbar-brand { padding: 12px 15px 8px; } .footer, .push { - height: 60px; /* .push must be the same height as .footer */ + height: 48px; /* .push must be the same height as .footer */ } .footer { background-color: #f5f5f5; border-top: 1px solid #d0d0d0; } footer p { - margin: 20px 0; + margin: 12px 0; } #navbar_search { padding: 0 8px; From dc6dbdf3c4ed42470b3b62bc00da621b57d5d10e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 22 Dec 2020 13:12:38 -0500 Subject: [PATCH 041/302] Update documentation to reference the feature branch --- docs/development/getting-started.md | 6 +++--- docs/development/release-checklist.md | 5 +---- docs/installation/3-netbox.md | 2 +- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/development/getting-started.md b/docs/development/getting-started.md index 8745825ab..9b2249653 100644 --- a/docs/development/getting-started.md +++ b/docs/development/getting-started.md @@ -27,13 +27,13 @@ base_requirements.txt contrib docs mkdocs.yml NOTICE requ CHANGELOG.md CONTRIBUTING.md LICENSE.txt netbox README.md scripts ``` -The NetBox project utilizes three long-term branches: +The NetBox project utilizes three persistent git branches to track work: * `master` - Serves as a snapshot of the current stable release * `develop` - All development on the upcoming stable release occurs here -* `develop-x.y` - Tracks work on an upcoming major release +* `feature` - Tracks work on an upcoming major release -Typically, you'll base pull requests off of the `develop` branch, or off of `develop-x.y` if you're working on a new major release. **Never** base pull requests off of the master branch, which receives merged only from the `develop` branch. +Typically, you'll base pull requests off of the `develop` branch, or off of `feature` if you're working on a new major release. **Never** merge pull requests into the `master` branch, which receives merged only from the `develop` branch. ### Enable Pre-Commit Hooks diff --git a/docs/development/release-checklist.md b/docs/development/release-checklist.md index 22fa6f1e8..f3338ffd3 100644 --- a/docs/development/release-checklist.md +++ b/docs/development/release-checklist.md @@ -52,10 +52,7 @@ Close the release milestone on GitHub after ensuring there are no remaining open ### Merge the Release Branch -Submit a pull request to merge the release branch `develop-x.y` into the `develop` branch in preparation for its releases. - -!!! warning - No further releases for the current major version can be published once this pull request is merged. +Submit a pull request to merge the `feature` branch into the `develop` branch in preparation for its release. --- diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 39189bbd1..9745df1f3 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -83,7 +83,7 @@ Checking connectivity... done. ``` !!! note - Installation via git also allows you to easily try out development versions of NetBox. The `develop` branch contains all work underway for the next minor release, and the `develop-x.y` branch (if present) tracks progress on the next major release. + Installation via git also allows you to easily try out development versions of NetBox. The `develop` branch contains all work underway for the next minor release, and the `feature` branch tracks progress on the next major release. ## Create the NetBox System User From 09633ee11b8e9974e12a5155656c8b8fb0ed0871 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 22 Dec 2020 13:51:58 -0500 Subject: [PATCH 042/302] Move rack group field directly beneath site --- netbox/templates/dcim/rack_edit.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/templates/dcim/rack_edit.html b/netbox/templates/dcim/rack_edit.html index 94456ac73..9ce242191 100644 --- a/netbox/templates/dcim/rack_edit.html +++ b/netbox/templates/dcim/rack_edit.html @@ -7,9 +7,9 @@
{% render_field form.region %} {% render_field form.site %} + {% render_field form.group %} {% render_field form.name %} {% render_field form.facility_id %} - {% render_field form.group %} {% render_field form.status %} {% render_field form.role %} {% render_field form.serial %} From e4f22bc4941ecea0e3828c71b29ac91bfe213f65 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 22 Dec 2020 15:22:53 -0500 Subject: [PATCH 043/302] Employ signals to update child objects when RackGroup/Rack site assignment changes --- netbox/dcim/models/racks.py | 16 --------- netbox/dcim/signals.py | 42 +++++++++++++++++++++- netbox/dcim/tests/test_models.py | 61 ++++++++++++++++++++++++++++++++ 3 files changed, 102 insertions(+), 17 deletions(-) diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index cad20241b..de9021f35 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -326,22 +326,6 @@ class Rack(ChangeLoggedModel, CustomFieldModel): 'group': "Rack group must be from the same site, {}.".format(self.site) }) - def save(self, *args, **kwargs): - - # Record the original site assignment for this rack. - _site_id = None - if self.pk: - _site_id = Rack.objects.get(pk=self.pk).site_id - - super().save(*args, **kwargs) - - # Update racked devices if the assigned Site has been changed. - if _site_id is not None and self.site_id != _site_id: - devices = Device.objects.filter(rack=self) - for device in devices: - device.site = self.site - device.save() - def to_csv(self): return ( self.site.name, diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 33c4b461c..380c0aec0 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -2,12 +2,13 @@ import logging from cacheops import invalidate_obj from django.contrib.contenttypes.models import ContentType +from django.db.models import Q from django.db.models.signals import post_save, post_delete, pre_delete from django.db import transaction from django.dispatch import receiver from .choices import CableStatusChoices -from .models import Cable, CablePath, Device, PathEndpoint, VirtualChassis +from .models import Cable, CablePath, Device, PathEndpoint, Rack, RackGroup, VirtualChassis def create_cablepath(node): @@ -36,6 +37,40 @@ def rebuild_paths(obj): create_cablepath(cp.origin) +# +# Site/rack/device assignment +# + +@receiver(post_save, sender=RackGroup) +def handle_rackgroup_site_change(instance, created, **kwargs): + """ + Update child RackGroups and Racks if Site assignment has changed. We intentionally recurse through each child + object instead of calling update() on the QuerySet to ensure the proper change records get created for each. + """ + if not created: + for rackgroup in instance.get_children(): + rackgroup.site = instance.site + rackgroup.save() + for rack in Rack.objects.filter(group=instance).exclude(site=instance.site): + rack.site = instance.site + rack.save() + + +@receiver(post_save, sender=Rack) +def handle_rack_site_change(instance, created, **kwargs): + """ + Update child Devices if Site assignment has changed. + """ + if not created: + for device in Device.objects.filter(rack=instance).exclude(site=instance.site): + device.site = instance.site + device.save() + + +# +# Virtual chassis +# + @receiver(post_save, sender=VirtualChassis) def assign_virtualchassis_master(instance, created, **kwargs): """ @@ -60,6 +95,11 @@ def clear_virtualchassis_members(instance, **kwargs): device.save() +# +# Cables +# + + @receiver(post_save, sender=Cable) def update_connected_endpoints(instance, created, raw=False, **kwargs): """ diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index b20e21102..a372bb099 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -7,6 +7,39 @@ from dcim.models import * from tenancy.models import Tenant +class RackGroupTestCase(TestCase): + + def test_change_rackgroup_site(self): + """ + Check that all child RackGroups and Racks get updated when a RackGroup is moved to a new Site. Topology: + Site A + - RackGroup A1 + - RackGroup A2 + - Rack 2 + - Rack 1 + """ + site_a = Site.objects.create(name='Site A', slug='site-a') + site_b = Site.objects.create(name='Site B', slug='site-b') + + rackgroup_a1 = RackGroup(site=site_a, name='RackGroup A1', slug='rackgroup-a1') + rackgroup_a1.save() + rackgroup_a2 = RackGroup(site=site_a, parent=rackgroup_a1, name='RackGroup A2', slug='rackgroup-a2') + rackgroup_a2.save() + + rack1 = Rack.objects.create(site=site_a, group=rackgroup_a1, name='Rack 1') + rack2 = Rack.objects.create(site=site_a, group=rackgroup_a2, name='Rack 2') + + # Move RackGroup A1 to Site B + rackgroup_a1.site = site_b + rackgroup_a1.save() + + # Check that all objects within RackGroup A1 now belong to Site B + self.assertEqual(RackGroup.objects.get(pk=rackgroup_a1.pk).site, site_b) + self.assertEqual(RackGroup.objects.get(pk=rackgroup_a2.pk).site, site_b) + self.assertEqual(Rack.objects.get(pk=rack1.pk).site, site_b) + self.assertEqual(Rack.objects.get(pk=rack2.pk).site, site_b) + + class RackTestCase(TestCase): def setUp(self): @@ -154,6 +187,34 @@ class RackTestCase(TestCase): ) self.assertTrue(pdu) + def test_change_rack_site(self): + """ + Check that child Devices get updated when a Rack is moved to a new Site. + """ + site_a = Site.objects.create(name='Site A', slug='site-a') + site_b = Site.objects.create(name='Site B', slug='site-b') + + manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') + device_type = DeviceType.objects.create( + manufacturer=manufacturer, model='Device Type 1', slug='device-type-1' + ) + device_role = DeviceRole.objects.create( + name='Device Role 1', slug='device-role-1', color='ff0000' + ) + + # Create Rack1 in Site A + rack1 = Rack.objects.create(site=site_a, name='Rack 1') + + # Create Device1 in Rack1 + device1 = Device.objects.create(site=site_a, rack=rack1, device_type=device_type, device_role=device_role) + + # Move Rack1 to Site B + rack1.site = site_b + rack1.save() + + # Check that Device1 is now assigned to Site B + self.assertEqual(Device.objects.get(pk=device1.pk).site, site_b) + class DeviceTestCase(TestCase): From ddd10ba8af5f619f485245d08bdcf1b2e82d74be Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 22 Dec 2020 16:14:16 -0500 Subject: [PATCH 044/302] Clean up hierarchical table columns --- netbox/dcim/tables/template_code.py | 11 ++++------- netbox/tenancy/tables.py | 11 ++++------- 2 files changed, 8 insertions(+), 14 deletions(-) diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 4a5aedb29..ee1dc091b 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -57,13 +57,10 @@ INTERFACE_TAGGED_VLANS = """ """ MPTT_LINK = """ -{% if record.get_children %} - -{% else %} - -{% endif %} - {{ record.name }} - +{% for i in record.get_ancestors %} + +{% endfor %} +{{ record.name }} """ POWERFEED_CABLE = """ diff --git a/netbox/tenancy/tables.py b/netbox/tenancy/tables.py index 8abca2bb8..7a3d20e12 100644 --- a/netbox/tenancy/tables.py +++ b/netbox/tenancy/tables.py @@ -4,13 +4,10 @@ from utilities.tables import BaseTable, ButtonsColumn, LinkedCountColumn, TagCol from .models import Tenant, TenantGroup MPTT_LINK = """ -{% if record.get_children %} - -{% else %} - -{% endif %} - {{ record.name }} - +{% for i in record.get_ancestors %} + +{% endfor %} +{{ record.name }} """ COL_TENANT = """ From 8d9d4cec051c8b0e5433db538b2ae0a5debb92ea Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 23 Dec 2020 14:02:05 -0500 Subject: [PATCH 045/302] Extend handle_rackgroup_site_change() receiver to update power panels --- netbox/dcim/signals.py | 6 ++++-- netbox/dcim/tests/test_models.py | 3 +++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 380c0aec0..277e3f060 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -2,13 +2,12 @@ import logging from cacheops import invalidate_obj from django.contrib.contenttypes.models import ContentType -from django.db.models import Q from django.db.models.signals import post_save, post_delete, pre_delete from django.db import transaction from django.dispatch import receiver from .choices import CableStatusChoices -from .models import Cable, CablePath, Device, PathEndpoint, Rack, RackGroup, VirtualChassis +from .models import Cable, CablePath, Device, PathEndpoint, PowerPanel, Rack, RackGroup, VirtualChassis def create_cablepath(node): @@ -54,6 +53,9 @@ def handle_rackgroup_site_change(instance, created, **kwargs): for rack in Rack.objects.filter(group=instance).exclude(site=instance.site): rack.site = instance.site rack.save() + for powerpanel in PowerPanel.objects.filter(rack_group=instance).exclude(site=instance.site): + powerpanel.site = instance.site + powerpanel.save() @receiver(post_save, sender=Rack) diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index a372bb099..184681e90 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -29,6 +29,8 @@ class RackGroupTestCase(TestCase): rack1 = Rack.objects.create(site=site_a, group=rackgroup_a1, name='Rack 1') rack2 = Rack.objects.create(site=site_a, group=rackgroup_a2, name='Rack 2') + powerpanel1 = PowerPanel.objects.create(site=site_a, rack_group=rackgroup_a1, name='Power Panel 1') + # Move RackGroup A1 to Site B rackgroup_a1.site = site_b rackgroup_a1.save() @@ -38,6 +40,7 @@ class RackGroupTestCase(TestCase): self.assertEqual(RackGroup.objects.get(pk=rackgroup_a2.pk).site, site_b) self.assertEqual(Rack.objects.get(pk=rack1.pk).site, site_b) self.assertEqual(Rack.objects.get(pk=rack2.pk).site, site_b) + self.assertEqual(PowerPanel.objects.get(pk=powerpanel1.pk).site, site_b) class RackTestCase(TestCase): From 396b0dace8631cb7ac53ee3a841b3cc80a783873 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 23 Dec 2020 14:26:43 -0500 Subject: [PATCH 046/302] Changelog for #5311 --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 91a65fbfe..ba1d241d3 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5311](https://github.com/netbox-community/netbox/issues/5311) - Update child objects when a rack group is moved to a new site * [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar --- From fce61295c9336fb8c82796d8a0d9571521b22146 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 23 Dec 2020 16:21:26 -0500 Subject: [PATCH 047/302] Fixes #5301: Fix misleading error when racking a device with invalid parameters --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/forms.py | 39 +++++++++--------------------- netbox/dcim/models/devices.py | 10 ++++---- netbox/dcim/tests/test_forms.py | 18 ++++++++++++-- 4 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index ba1d241d3..8cca1f1bf 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5301](https://github.com/netbox-community/netbox/issues/5301) - Fix misleading error when racking a device with invalid parameters * [#5311](https://github.com/netbox-community/netbox/issues/5311) - Update child objects when a rack group is moved to a new site * [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 7ecd4efd8..4cc1a532b 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -1781,9 +1781,8 @@ class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'group_id': '$rack_group', } ) - position = forms.TypedChoiceField( + position = forms.IntegerField( required=False, - empty_value=None, help_text="The lowest-numbered unit occupied by the device", widget=APISelect( api_url='/api/dcim/racks/{{rack}}/elevation/', @@ -1856,6 +1855,7 @@ class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): "config context", } widgets = { + 'face': StaticSelect2(), 'status': StaticSelect2(), 'primary_ip4': StaticSelect2(), 'primary_ip6': StaticSelect2(), @@ -1902,6 +1902,13 @@ class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): Q(manufacturer__isnull=True) | Q(manufacturer=self.instance.device_type.manufacturer) ) + # Disable rack assignment if this is a child device installed in a parent device + if self.instance.device_type.is_child_device and hasattr(self.instance, 'parent_bay'): + self.fields['site'].disabled = True + self.fields['rack'].disabled = True + self.initial['site'] = self.instance.parent_bay.device.site_id + self.initial['rack'] = self.instance.parent_bay.device.rack_id + else: # An object that doesn't exist yet can't have any IPs assigned to it @@ -1911,31 +1918,9 @@ class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): self.fields['primary_ip6'].widget.attrs['readonly'] = True # Rack position - pk = self.instance.pk if self.instance.pk else None - try: - if self.is_bound and self.data.get('rack') and str(self.data.get('face')): - position_choices = Rack.objects.get(pk=self.data['rack']) \ - .get_rack_units(face=self.data.get('face'), exclude=pk) - elif self.initial.get('rack') and str(self.initial.get('face')): - position_choices = Rack.objects.get(pk=self.initial['rack']) \ - .get_rack_units(face=self.initial.get('face'), exclude=pk) - else: - position_choices = [] - except Rack.DoesNotExist: - position_choices = [] - self.fields['position'].choices = [('', '---------')] + [ - (p['id'], { - 'label': p['name'], - 'disabled': bool(p['device'] and p['id'] != self.initial.get('position')), - }) for p in position_choices - ] - - # Disable rack assignment if this is a child device installed in a parent device - if pk and self.instance.device_type.is_child_device and hasattr(self.instance, 'parent_bay'): - self.fields['site'].disabled = True - self.fields['rack'].disabled = True - self.initial['site'] = self.instance.parent_bay.device.site_id - self.initial['rack'] = self.instance.parent_bay.device.rack_id + position = self.data.get('position') or self.initial.get('position') + if position: + self.fields['position'].widget.choices = [(position, f'U{position}')] class BaseDeviceCSVForm(CustomFieldModelCSVForm): diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index 5b685057e..29818ab98 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -640,7 +640,7 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): # Validate site/rack combination if self.rack and self.site != self.rack.site: raise ValidationError({ - 'rack': "Rack {} does not belong to site {}.".format(self.rack, self.site), + 'rack': f"Rack {self.rack} does not belong to site {self.site}.", }) if self.rack is None: @@ -650,7 +650,7 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): }) if self.position: raise ValidationError({ - 'face': "Cannot select a rack position without assigning a rack.", + 'position': "Cannot select a rack position without assigning a rack.", }) # Validate position/face combination @@ -662,7 +662,7 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): # Prevent 0U devices from being assigned to a specific position if self.position and self.device_type.u_height == 0: raise ValidationError({ - 'position': "A U0 device type ({}) cannot be assigned to a rack position.".format(self.device_type) + 'position': f"A U0 device type ({self.device_type}) cannot be assigned to a rack position." }) if self.rack: @@ -688,8 +688,8 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): ) if self.position and self.position not in available_units: raise ValidationError({ - 'position': "U{} is already occupied or does not have sufficient space to accommodate a(n) " - "{} ({}U).".format(self.position, self.device_type, self.device_type.u_height) + 'position': f"U{self.position} is already occupied or does not have sufficient space to " + f"accommodate this device type: {self.device_type} ({self.device_type.u_height}U)" }) except DeviceType.DoesNotExist: diff --git a/netbox/dcim/tests/test_forms.py b/netbox/dcim/tests/test_forms.py index e8cb73fe4..6eeffbc96 100644 --- a/netbox/dcim/tests/test_forms.py +++ b/netbox/dcim/tests/test_forms.py @@ -82,7 +82,7 @@ class DeviceTestCase(TestCase): self.assertTrue(form.is_valid()) self.assertTrue(form.save()) - def test_non_racked_device_with_face_position(self): + def test_non_racked_device_with_face(self): form = DeviceForm(data={ 'name': 'New Device', 'device_role': DeviceRole.objects.first().pk, @@ -92,12 +92,26 @@ class DeviceTestCase(TestCase): 'site': Site.objects.first().pk, 'rack': None, 'face': DeviceFaceChoices.FACE_REAR, - 'position': 10, 'platform': None, 'status': DeviceStatusChoices.STATUS_ACTIVE, }) self.assertFalse(form.is_valid()) self.assertIn('face', form.errors) + + def test_non_racked_device_with_position(self): + form = DeviceForm(data={ + 'name': 'New Device', + 'device_role': DeviceRole.objects.first().pk, + 'tenant': None, + 'manufacturer': Manufacturer.objects.first().pk, + 'device_type': DeviceType.objects.first().pk, + 'site': Site.objects.first().pk, + 'rack': None, + 'position': 10, + 'platform': None, + 'status': DeviceStatusChoices.STATUS_ACTIVE, + }) + self.assertFalse(form.is_valid()) self.assertIn('position', form.errors) From 1fe585741167c09b405c5749cee43108f79cad9c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 28 Dec 2020 10:45:23 -0500 Subject: [PATCH 048/302] Fixes #5543: Fix rendering of config contexts with cluster assignment for devices --- docs/release-notes/version-2.10.md | 1 + netbox/extras/querysets.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 8cca1f1bf..8e2703d10 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -7,6 +7,7 @@ * [#5301](https://github.com/netbox-community/netbox/issues/5301) - Fix misleading error when racking a device with invalid parameters * [#5311](https://github.com/netbox-community/netbox/issues/5311) - Update child objects when a rack group is moved to a new site * [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar +* [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices --- diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index 8276787db..fbe7fe903 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -89,6 +89,8 @@ class ConfigContextModelQuerySet(RestrictedQuerySet): } base_query = Q( Q(platforms=OuterRef('platform')) | Q(platforms=None), + Q(cluster_groups=OuterRef('cluster__group')) | Q(cluster_groups=None), + Q(clusters=OuterRef('cluster')) | Q(clusters=None), Q(tenant_groups=OuterRef('tenant__group')) | Q(tenant_groups=None), Q(tenants=OuterRef('tenant')) | Q(tenants=None), Q( @@ -111,8 +113,6 @@ class ConfigContextModelQuerySet(RestrictedQuerySet): elif self.model._meta.model_name == 'virtualmachine': base_query.add((Q(roles=OuterRef('role')) | Q(roles=None)), Q.AND) - base_query.add((Q(cluster_groups=OuterRef('cluster__group')) | Q(cluster_groups=None)), Q.AND) - base_query.add((Q(clusters=OuterRef('cluster')) | Q(clusters=None)), Q.AND) base_query.add((Q(sites=OuterRef('cluster__site')) | Q(sites=None)), Q.AND) region_field = 'cluster__site__region' From 6f39e6599dfe46b8448001f82a29724a7365dafc Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 28 Dec 2020 10:48:50 -0500 Subject: [PATCH 049/302] Fixes #5540: Fix exception when viewing a provider with one or more tags assigned --- docs/release-notes/version-2.10.md | 1 + netbox/templates/circuits/provider.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 8e2703d10..0db155df5 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -7,6 +7,7 @@ * [#5301](https://github.com/netbox-community/netbox/issues/5301) - Fix misleading error when racking a device with invalid parameters * [#5311](https://github.com/netbox-community/netbox/issues/5311) - Update child objects when a rack group is moved to a new site * [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar +* [#5540](https://github.com/netbox-community/netbox/issues/5540) - Fix exception when viewing a provider with one or more tags assigned * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices --- diff --git a/netbox/templates/circuits/provider.html b/netbox/templates/circuits/provider.html index e96d5abcb..8778c3ac2 100644 --- a/netbox/templates/circuits/provider.html +++ b/netbox/templates/circuits/provider.html @@ -100,7 +100,7 @@
{% include 'inc/custom_fields_panel.html' %} - {% include 'extras/inc/tags_panel.html' with tags=object.tags.all url='circuits:object_list' %} + {% include 'extras/inc/tags_panel.html' with tags=object.tags.all url='circuits:provider_list' %}
Comments From cc1a43e5d9a3d30d45ccf49a428b7d3f093373ba Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 28 Dec 2020 11:10:27 -0500 Subject: [PATCH 050/302] Fixes #5533: Fix bulk editing of objects with required custom fields --- docs/release-notes/version-2.10.md | 1 + netbox/netbox/views/generic.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 0db155df5..82e4a07e0 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -7,6 +7,7 @@ * [#5301](https://github.com/netbox-community/netbox/issues/5301) - Fix misleading error when racking a device with invalid parameters * [#5311](https://github.com/netbox-community/netbox/issues/5311) - Update child objects when a rack group is moved to a new site * [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar +* [#5533](https://github.com/netbox-community/netbox/issues/5533) - Fix bulk editing of objects with required custom fields * [#5540](https://github.com/netbox-community/netbox/issues/5540) - Fix exception when viewing a provider with one or more tags assigned * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices diff --git a/netbox/netbox/views/generic.py b/netbox/netbox/views/generic.py index eb7b2542f..bd21d469c 100644 --- a/netbox/netbox/views/generic.py +++ b/netbox/netbox/views/generic.py @@ -798,8 +798,8 @@ class BulkEditView(GetReturnURLMixin, ObjectPermissionRequiredMixin, View): # Update custom fields for name in custom_fields: if name in form.nullable_fields and name in nullified_fields: - obj.custom_field_data.pop(name, None) - else: + obj.custom_field_data[name] = None + elif form.cleaned_data.get(name) not in (None, ''): obj.custom_field_data[name] = form.cleaned_data[name] obj.full_clean() From b2e05aafc1a99d14fea2ab9c446a8dd7b4cd6375 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 28 Dec 2020 12:54:42 -0500 Subject: [PATCH 051/302] Closes #5531: Ensure consistent calls to parent clean() methods for models, forms --- netbox/dcim/forms.py | 5 +++++ netbox/dcim/models/device_component_templates.py | 2 ++ netbox/dcim/models/device_components.py | 6 ++++++ netbox/dcim/models/racks.py | 1 + netbox/extras/models/customfields.py | 4 ++++ netbox/extras/models/models.py | 6 +++++- netbox/users/admin.py | 2 ++ netbox/utilities/forms/forms.py | 2 ++ netbox/virtualization/models.py | 1 + 9 files changed, 28 insertions(+), 1 deletion(-) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 4cc1a532b..b75f9ba9a 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -134,6 +134,7 @@ class ComponentForm(BootstrapMixin, forms.Form): ) def clean(self): + super().clean() # Validate that the number of components being created from both the name_pattern and label_pattern are equal if self.cleaned_data['label_pattern']: @@ -1438,6 +1439,7 @@ class FrontPortTemplateCreateForm(ComponentTemplateCreateForm): self.fields['rear_port_set'].choices = choices def clean(self): + super().clean() # Validate that the number of ports being created equals the number of selected (rear port, position) tuples front_port_count = len(self.cleaned_data['name_pattern']) @@ -2929,6 +2931,7 @@ class InterfaceBulkEditForm( self.fields['lag'].widget.attrs['disabled'] = True def clean(self): + super().clean() # Untagged interfaces cannot be assigned tagged VLANs if self.cleaned_data['mode'] == InterfaceModeChoices.MODE_ACCESS and self.cleaned_data['tagged_vlans']: @@ -3077,6 +3080,7 @@ class FrontPortCreateForm(ComponentCreateForm): self.fields['rear_port_set'].choices = choices def clean(self): + super().clean() # Validate that the number of ports being created equals the number of selected (rear port, position) tuples front_port_count = len(self.cleaned_data['name_pattern']) @@ -3909,6 +3913,7 @@ class CableBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm): ] def clean(self): + super().clean() # Validate length/unit length = self.cleaned_data.get('length') diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index 7a94b3e1b..fe819d310 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -193,6 +193,7 @@ class PowerOutletTemplate(ComponentTemplateModel): unique_together = ('device_type', 'name') def clean(self): + super().clean() # Validate power port assignment if self.power_port and self.power_port.device_type != self.device_type: @@ -278,6 +279,7 @@ class FrontPortTemplate(ComponentTemplateModel): ) def clean(self): + super().clean() # Validate rear port assignment if self.rear_port.device_type != self.device_type: diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 5d5825f5f..21ca92da8 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -316,6 +316,7 @@ class PowerPort(CableTermination, PathEndpoint, ComponentModel): ) def clean(self): + super().clean() if self.maximum_draw is not None and self.allocated_draw is not None: if self.allocated_draw > self.maximum_draw: @@ -425,6 +426,7 @@ class PowerOutlet(CableTermination, PathEndpoint, ComponentModel): ) def clean(self): + super().clean() # Validate power port assignment if self.power_port and self.power_port.device != self.device: @@ -555,6 +557,7 @@ class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): ) def clean(self): + super().clean() # Virtual interfaces cannot be connected if self.type in NONCONNECTABLE_IFACE_TYPES and ( @@ -668,6 +671,7 @@ class FrontPort(CableTermination, ComponentModel): ) def clean(self): + super().clean() # Validate rear port assignment if self.rear_port.device != self.device: @@ -711,6 +715,7 @@ class RearPort(CableTermination, ComponentModel): return reverse('dcim:rearport', kwargs={'pk': self.pk}) def clean(self): + super().clean() # Check that positions count is greater than or equal to the number of associated FrontPorts frontport_count = self.frontports.count() @@ -768,6 +773,7 @@ class DeviceBay(ComponentModel): ) def clean(self): + super().clean() # Validate that the parent Device can have DeviceBays if not self.device.device_type.is_parent_device: diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index de9021f35..ccc775954 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -109,6 +109,7 @@ class RackGroup(MPTTModel, ChangeLoggedModel): ) def clean(self): + super().clean() # Parent RackGroup (if any) must belong to the same Site if self.parent and self.parent.site != self.site: diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 6f4c5f9e1..693158bc5 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -47,6 +47,8 @@ class CustomFieldModel(models.Model): ]) def clean(self): + super().clean() + custom_fields = {cf.name: cf for cf in CustomField.objects.get_for_model(self)} # Validate all field values @@ -172,6 +174,8 @@ class CustomField(models.Model): obj.save() def clean(self): + super().clean() + # Validate the field's default value (if any) if self.default is not None: try: diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index 8934d9732..4917a7e44 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -117,11 +117,15 @@ class Webhook(models.Model): return self.name def clean(self): + super().clean() + + # At least one action type must be selected if not self.type_create and not self.type_delete and not self.type_update: raise ValidationError( "You must select at least one type: create, update, and/or delete." ) + # CA file path requires SSL verification enabled if not self.ssl_verification and self.ca_file_path: raise ValidationError({ 'ca_file_path': 'Do not specify a CA certificate file if SSL verification is disabled.' @@ -436,6 +440,7 @@ class ConfigContext(ChangeLoggedModel): return reverse('extras:configcontext', kwargs={'pk': self.pk}) def clean(self): + super().clean() # Verify that JSON data is provided as an object if type(self.data) is not dict: @@ -482,7 +487,6 @@ class ConfigContextModel(models.Model): return data def clean(self): - super().clean() # Verify that JSON data is provided as an object diff --git a/netbox/users/admin.py b/netbox/users/admin.py index c03e6f740..f2fe4a0b4 100644 --- a/netbox/users/admin.py +++ b/netbox/users/admin.py @@ -169,6 +169,8 @@ class ObjectPermissionForm(forms.ModelForm): self.instance.actions.remove(action) def clean(self): + super().clean() + object_types = self.cleaned_data.get('object_types') constraints = self.cleaned_data.get('constraints') diff --git a/netbox/utilities/forms/forms.py b/netbox/utilities/forms/forms.py index f259f6b6d..e674afdf7 100644 --- a/netbox/utilities/forms/forms.py +++ b/netbox/utilities/forms/forms.py @@ -82,6 +82,7 @@ class BulkRenameForm(forms.Form): ) def clean(self): + super().clean() # Validate regular expression in "find" field if self.cleaned_data['use_regex']: @@ -124,6 +125,7 @@ class ImportForm(BootstrapMixin, forms.Form): ) def clean(self): + super().clean() data = self.cleaned_data['data'] format = self.cleaned_data['format'] diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index cf7737340..edca7e1fe 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -444,6 +444,7 @@ class VMInterface(BaseInterface): ) def clean(self): + super().clean() # Validate untagged VLAN if self.untagged_vlan and self.untagged_vlan.site not in [self.virtual_machine.site, None]: From 8ae3331d04dab7ad8dee285ad0913ac9dfde49ad Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 29 Dec 2020 11:41:44 -0500 Subject: [PATCH 052/302] Closes #5549: Eliminate extraneous database queries when using brief API calls --- netbox/circuits/api/views.py | 1 + netbox/dcim/api/views.py | 11 ++++++++ netbox/extras/api/views.py | 9 +++---- netbox/netbox/api/views.py | 40 ++++++++++++++++++------------ netbox/virtualization/api/views.py | 1 + 5 files changed, 41 insertions(+), 21 deletions(-) diff --git a/netbox/circuits/api/views.py b/netbox/circuits/api/views.py index 6968da61e..736871a73 100644 --- a/netbox/circuits/api/views.py +++ b/netbox/circuits/api/views.py @@ -65,3 +65,4 @@ class CircuitTerminationViewSet(PathEndpointMixin, ModelViewSet): ) serializer_class = serializers.CircuitTerminationSerializer filterset_class = filters.CircuitTerminationFilterSet + brief_prefetch_fields = ['circuit'] diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index f9e8027b4..ae39f6ad0 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -258,6 +258,7 @@ class DeviceTypeViewSet(CustomFieldModelViewSet): ) serializer_class = serializers.DeviceTypeSerializer filterset_class = filters.DeviceTypeFilterSet + brief_prefetch_fields = ['manufacturer'] # @@ -493,6 +494,7 @@ class ConsolePortViewSet(PathEndpointMixin, ModelViewSet): queryset = ConsolePort.objects.prefetch_related('device', '_path__destination', 'cable', '_cable_peer', 'tags') serializer_class = serializers.ConsolePortSerializer filterset_class = filters.ConsolePortFilterSet + brief_prefetch_fields = ['device'] class ConsoleServerPortViewSet(PathEndpointMixin, ModelViewSet): @@ -501,18 +503,21 @@ class ConsoleServerPortViewSet(PathEndpointMixin, ModelViewSet): ) serializer_class = serializers.ConsoleServerPortSerializer filterset_class = filters.ConsoleServerPortFilterSet + brief_prefetch_fields = ['device'] class PowerPortViewSet(PathEndpointMixin, ModelViewSet): queryset = PowerPort.objects.prefetch_related('device', '_path__destination', 'cable', '_cable_peer', 'tags') serializer_class = serializers.PowerPortSerializer filterset_class = filters.PowerPortFilterSet + brief_prefetch_fields = ['device'] class PowerOutletViewSet(PathEndpointMixin, ModelViewSet): queryset = PowerOutlet.objects.prefetch_related('device', '_path__destination', 'cable', '_cable_peer', 'tags') serializer_class = serializers.PowerOutletSerializer filterset_class = filters.PowerOutletFilterSet + brief_prefetch_fields = ['device'] class InterfaceViewSet(PathEndpointMixin, ModelViewSet): @@ -521,30 +526,35 @@ class InterfaceViewSet(PathEndpointMixin, ModelViewSet): ) serializer_class = serializers.InterfaceSerializer filterset_class = filters.InterfaceFilterSet + brief_prefetch_fields = ['device'] class FrontPortViewSet(PassThroughPortMixin, ModelViewSet): queryset = FrontPort.objects.prefetch_related('device__device_type__manufacturer', 'rear_port', 'cable', 'tags') serializer_class = serializers.FrontPortSerializer filterset_class = filters.FrontPortFilterSet + brief_prefetch_fields = ['device'] class RearPortViewSet(PassThroughPortMixin, ModelViewSet): queryset = RearPort.objects.prefetch_related('device__device_type__manufacturer', 'cable', 'tags') serializer_class = serializers.RearPortSerializer filterset_class = filters.RearPortFilterSet + brief_prefetch_fields = ['device'] class DeviceBayViewSet(ModelViewSet): queryset = DeviceBay.objects.prefetch_related('installed_device').prefetch_related('tags') serializer_class = serializers.DeviceBaySerializer filterset_class = filters.DeviceBayFilterSet + brief_prefetch_fields = ['device'] class InventoryItemViewSet(ModelViewSet): queryset = InventoryItem.objects.prefetch_related('device', 'manufacturer').prefetch_related('tags') serializer_class = serializers.InventoryItemSerializer filterset_class = filters.InventoryItemFilterSet + brief_prefetch_fields = ['device'] # @@ -600,6 +610,7 @@ class VirtualChassisViewSet(ModelViewSet): ) serializer_class = serializers.VirtualChassisSerializer filterset_class = filters.VirtualChassisFilterSet + brief_prefetch_fields = ['master'] # diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index 8ab7b0eea..1067ac0d3 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -39,7 +39,6 @@ class ConfigContextQuerySetMixin: Provides a get_queryset() method which deals with adding the config context data annotation or not. """ - def get_queryset(self): """ Build the proper queryset based on the request context @@ -49,11 +48,11 @@ class ConfigContextQuerySetMixin: Else, return the queryset annotated with config context data """ - + queryset = super().get_queryset() request = self.get_serializer_context()['request'] - if request.query_params.get('brief') or 'config_context' in request.query_params.get('exclude', []): - return self.queryset - return self.queryset.annotate_config_context_data() + if self.brief or 'config_context' in request.query_params.get('exclude', []): + return queryset + return queryset.annotate_config_context_data() # diff --git a/netbox/netbox/api/views.py b/netbox/netbox/api/views.py index 881effd71..991a8892d 100644 --- a/netbox/netbox/api/views.py +++ b/netbox/netbox/api/views.py @@ -9,11 +9,11 @@ from django.core.exceptions import ObjectDoesNotExist, PermissionDenied from django.db import transaction from django.db.models import ProtectedError from django_rq.queues import get_connection -from rest_framework import mixins, status +from rest_framework import status from rest_framework.response import Response from rest_framework.reverse import reverse from rest_framework.views import APIView -from rest_framework.viewsets import GenericViewSet +from rest_framework.viewsets import ModelViewSet as ModelViewSet_ from rq.worker import Worker from netbox.api import BulkOperationSerializer @@ -120,17 +120,13 @@ class BulkDestroyModelMixin: # Viewsets # -class ModelViewSet(mixins.CreateModelMixin, - mixins.RetrieveModelMixin, - mixins.UpdateModelMixin, - mixins.DestroyModelMixin, - mixins.ListModelMixin, - BulkUpdateModelMixin, - BulkDestroyModelMixin, - GenericViewSet): +class ModelViewSet(BulkUpdateModelMixin, BulkDestroyModelMixin, ModelViewSet_): """ - Accept either a single object or a list of objects to create. + Extend DRF's ModelViewSet to support bulk update and delete functions. """ + brief = False + brief_prefetch_fields = [] + def get_serializer(self, *args, **kwargs): # If a list of objects has been provided, initialize the serializer with many=True @@ -142,22 +138,34 @@ class ModelViewSet(mixins.CreateModelMixin, def get_serializer_class(self): logger = logging.getLogger('netbox.api.views.ModelViewSet') - # If 'brief' has been passed as a query param, find and return the nested serializer for this model, if one - # exists - request = self.get_serializer_context()['request'] - if request.query_params.get('brief'): + # If using 'brief' mode, find and return the nested serializer for this model, if one exists + if self.brief: logger.debug("Request is for 'brief' format; initializing nested serializer") try: serializer = get_serializer_for_model(self.queryset.model, prefix='Nested') logger.debug(f"Using serializer {serializer}") return serializer except SerializerNotFound: - pass + logger.debug(f"Nested serializer for {self.queryset.model} not found!") # Fall back to the hard-coded serializer class logger.debug(f"Using serializer {self.serializer_class}") return self.serializer_class + def get_queryset(self): + # If using brief mode, clear all prefetches from the queryset and append only brief_prefetch_fields (if any) + if self.brief: + return super().get_queryset().prefetch_related(None).prefetch_related(*self.brief_prefetch_fields) + + return super().get_queryset() + + def initialize_request(self, request, *args, **kwargs): + # Check if brief=True has been passed + if request.method == 'GET' and request.GET.get('brief'): + self.brief = True + + return super().initialize_request(request, *args, **kwargs) + def initial(self, request, *args, **kwargs): super().initial(request, *args, **kwargs) diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index ce5cb9f2c..586ad5028 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -84,3 +84,4 @@ class VMInterfaceViewSet(ModelViewSet): ) serializer_class = serializers.VMInterfaceSerializer filterset_class = filters.VMInterfaceFilterSet + brief_prefetch_fields = ['virtual_machine'] From 249948e17426989464b401023988c16529175fd8 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 29 Dec 2020 11:55:31 -0500 Subject: [PATCH 053/302] Fixes #5546: Add custom field bulk edit support for cables, power panels, rack reservations, and virtual chassis --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/forms.py | 12 +++++------- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 82e4a07e0..b5a81be9b 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -10,6 +10,7 @@ * [#5533](https://github.com/netbox-community/netbox/issues/5533) - Fix bulk editing of objects with required custom fields * [#5540](https://github.com/netbox-community/netbox/issues/5540) - Fix exception when viewing a provider with one or more tags assigned * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices +* [#5546](https://github.com/netbox-community/netbox/issues/5546) - Add custom field bulk edit support for cables, power panels, rack reservations, and virtual chassis --- diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index b75f9ba9a..7ba6a4541 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -834,7 +834,7 @@ class RackReservationCSVForm(CSVModelForm): self.fields['rack'].queryset = self.fields['rack'].queryset.filter(**params) -class RackReservationBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm): +class RackReservationBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField( queryset=RackReservation.objects.all(), widget=forms.MultipleHiddenInput() @@ -3870,7 +3870,7 @@ class CableCSVForm(CSVModelForm): return length_unit if length_unit is not None else '' -class CableBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm): +class CableBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField( queryset=Cable.objects.all(), widget=forms.MultipleHiddenInput @@ -4257,7 +4257,7 @@ class VCMemberSelectForm(BootstrapMixin, forms.Form): return device -class VirtualChassisBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm): +class VirtualChassisBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField( queryset=VirtualChassis.objects.all(), widget=forms.MultipleHiddenInput() @@ -4384,7 +4384,7 @@ class PowerPanelCSVForm(CSVModelForm): self.fields['rack_group'].queryset = self.fields['rack_group'].queryset.filter(**params) -class PowerPanelBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm): +class PowerPanelBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm): pk = forms.ModelMultipleChoiceField( queryset=PowerPanel.objects.all(), widget=forms.MultipleHiddenInput @@ -4412,9 +4412,7 @@ class PowerPanelBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm): ) class Meta: - nullable_fields = ( - 'rack_group', - ) + nullable_fields = ['rack_group'] class PowerPanelFilterForm(BootstrapMixin, CustomFieldFilterForm): From d989ce2b706bed864dd4aeee20a86c2ac565a252 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 29 Dec 2020 12:43:52 -0500 Subject: [PATCH 054/302] Fixes #5547: Add custom field bulk import support for cables, power panels, rack reservations, and virtual chassis --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/forms.py | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index b5a81be9b..9bc10416a 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -11,6 +11,7 @@ * [#5540](https://github.com/netbox-community/netbox/issues/5540) - Fix exception when viewing a provider with one or more tags assigned * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices * [#5546](https://github.com/netbox-community/netbox/issues/5546) - Add custom field bulk edit support for cables, power panels, rack reservations, and virtual chassis +* [#5547](https://github.com/netbox-community/netbox/issues/5547) - Add custom field bulk import support for cables, power panels, rack reservations, and virtual chassis --- diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 7ba6a4541..f7eb510ec 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -784,7 +784,7 @@ class RackReservationForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): ] -class RackReservationCSVForm(CSVModelForm): +class RackReservationCSVForm(CustomFieldModelCSVForm): site = CSVModelChoiceField( queryset=Site.objects.all(), to_field_name='name', @@ -3775,7 +3775,7 @@ class CableForm(BootstrapMixin, CustomFieldModelForm): } -class CableCSVForm(CSVModelForm): +class CableCSVForm(CustomFieldModelCSVForm): # Termination A side_a_device = CSVModelChoiceField( queryset=Device.objects.all(), @@ -4271,7 +4271,7 @@ class VirtualChassisBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldB nullable_fields = ['domain'] -class VirtualChassisCSVForm(CSVModelForm): +class VirtualChassisCSVForm(CustomFieldModelCSVForm): master = CSVModelChoiceField( queryset=Device.objects.all(), to_field_name='name', @@ -4358,7 +4358,7 @@ class PowerPanelForm(BootstrapMixin, CustomFieldModelForm): ] -class PowerPanelCSVForm(CSVModelForm): +class PowerPanelCSVForm(CustomFieldModelCSVForm): site = CSVModelChoiceField( queryset=Site.objects.all(), to_field_name='name', From 7873952e7a3b95e479274415c5325eeb33dbaa7f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 30 Dec 2020 15:30:31 -0500 Subject: [PATCH 055/302] Avoid wrapping text in hierarchical table columns --- netbox/dcim/tables/racks.py | 3 ++- netbox/dcim/tables/sites.py | 3 ++- netbox/ipam/tables.py | 2 +- netbox/tenancy/tables.py | 3 ++- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/tables/racks.py b/netbox/dcim/tables/racks.py index 85943dd0d..775e90076 100644 --- a/netbox/dcim/tables/racks.py +++ b/netbox/dcim/tables/racks.py @@ -26,7 +26,8 @@ class RackGroupTable(BaseTable): pk = ToggleColumn() name = tables.TemplateColumn( template_code=MPTT_LINK, - orderable=False + orderable=False, + attrs={'td': {'class': 'text-nowrap'}} ) site = tables.LinkColumn( viewname='dcim:site', diff --git a/netbox/dcim/tables/sites.py b/netbox/dcim/tables/sites.py index 76f30f507..50a5e5ec7 100644 --- a/netbox/dcim/tables/sites.py +++ b/netbox/dcim/tables/sites.py @@ -19,7 +19,8 @@ class RegionTable(BaseTable): pk = ToggleColumn() name = tables.TemplateColumn( template_code=MPTT_LINK, - orderable=False + orderable=False, + attrs={'td': {'class': 'text-nowrap'}} ) site_count = tables.Column( verbose_name='Sites' diff --git a/netbox/ipam/tables.py b/netbox/ipam/tables.py index bea8ec255..86d7e21eb 100644 --- a/netbox/ipam/tables.py +++ b/netbox/ipam/tables.py @@ -270,7 +270,7 @@ class PrefixTable(BaseTable): pk = ToggleColumn() prefix = tables.TemplateColumn( template_code=PREFIX_LINK, - attrs={'th': {'style': 'padding-left: 17px'}} + attrs={'td': {'class': 'text-nowrap'}} ) status = ChoiceFieldColumn( default=AVAILABLE_LABEL diff --git a/netbox/tenancy/tables.py b/netbox/tenancy/tables.py index 7a3d20e12..9e8be6b18 100644 --- a/netbox/tenancy/tables.py +++ b/netbox/tenancy/tables.py @@ -27,7 +27,8 @@ class TenantGroupTable(BaseTable): pk = ToggleColumn() name = tables.TemplateColumn( template_code=MPTT_LINK, - orderable=False + orderable=False, + attrs={'td': {'class': 'text-nowrap'}} ) tenant_count = LinkedCountColumn( viewname='tenancy:tenant_list', From af3c4905ea1a4ed24ad23b342f489013a18c252d Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 31 Dec 2020 10:21:01 -0500 Subject: [PATCH 056/302] Fixes #5558: Fix regex validation support for custom URL fields --- docs/release-notes/version-2.10.md | 1 + netbox/extras/models/customfields.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 9bc10416a..69e31606f 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -12,6 +12,7 @@ * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices * [#5546](https://github.com/netbox-community/netbox/issues/5546) - Add custom field bulk edit support for cables, power panels, rack reservations, and virtual chassis * [#5547](https://github.com/netbox-community/netbox/issues/5547) - Add custom field bulk import support for cables, power panels, rack reservations, and virtual chassis +* [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields --- diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 693158bc5..a69816d21 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -196,7 +196,8 @@ class CustomField(models.Model): }) # Regex validation can be set only for text fields - if self.validation_regex and self.type != CustomFieldTypeChoices.TYPE_TEXT: + regex_types = (CustomFieldTypeChoices.TYPE_TEXT, CustomFieldTypeChoices.TYPE_URL) + if self.validation_regex and self.type not in regex_types: raise ValidationError({ 'validation_regex': "Regular expression validation is supported only for text and URL fields" }) From 39e6872288fdf7296dbe451150f25c536ae76b3d Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 31 Dec 2020 10:32:40 -0500 Subject: [PATCH 057/302] Fixes #5557: Fix VRF route target assignment via REST API --- docs/release-notes/version-2.10.md | 1 + netbox/ipam/api/serializers.py | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 69e31606f..241004f22 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -12,6 +12,7 @@ * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices * [#5546](https://github.com/netbox-community/netbox/issues/5546) - Add custom field bulk edit support for cables, power panels, rack reservations, and virtual chassis * [#5547](https://github.com/netbox-community/netbox/issues/5547) - Add custom field bulk import support for cables, power panels, rack reservations, and virtual chassis +* [#5557](https://github.com/netbox-community/netbox/issues/5557) - Fix VRF route target assignment via REST API * [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields --- diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 7552ae0d2..9b8d36590 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -25,8 +25,18 @@ from .nested_serializers import * class VRFSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:vrf-detail') tenant = NestedTenantSerializer(required=False, allow_null=True) - import_targets = NestedRouteTargetSerializer(required=False, allow_null=True, many=True) - export_targets = NestedRouteTargetSerializer(required=False, allow_null=True, many=True) + import_targets = SerializedPKRelatedField( + queryset=RouteTarget.objects.all(), + serializer=NestedRouteTargetSerializer, + required=False, + many=True + ) + export_targets = SerializedPKRelatedField( + queryset=RouteTarget.objects.all(), + serializer=NestedRouteTargetSerializer, + required=False, + many=True + ) ipaddress_count = serializers.IntegerField(read_only=True) prefix_count = serializers.IntegerField(read_only=True) From e73c22596546e0232135ae20b7132c02529ffff7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 31 Dec 2020 10:38:47 -0500 Subject: [PATCH 058/302] Fixes #5551: Restore missing import button on services list --- docs/release-notes/version-2.10.md | 1 + netbox/ipam/views.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 241004f22..b3b71657c 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -12,6 +12,7 @@ * [#5543](https://github.com/netbox-community/netbox/issues/5543) - Fix rendering of config contexts with cluster assignment for devices * [#5546](https://github.com/netbox-community/netbox/issues/5546) - Add custom field bulk edit support for cables, power panels, rack reservations, and virtual chassis * [#5547](https://github.com/netbox-community/netbox/issues/5547) - Add custom field bulk import support for cables, power panels, rack reservations, and virtual chassis +* [#5551](https://github.com/netbox-community/netbox/issues/5551) - Restore missing import button on services list * [#5557](https://github.com/netbox-community/netbox/issues/5557) - Fix VRF route target assignment via REST API * [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 36c225045..39a840f7f 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -804,7 +804,7 @@ class ServiceListView(generic.ObjectListView): filterset = filters.ServiceFilterSet filterset_form = forms.ServiceFilterForm table = tables.ServiceTable - action_buttons = ('export',) + action_buttons = ('import', 'export') class ServiceView(generic.ObjectView): From a9a2509d397e780669c7908f62867eb218f3070f Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 5 Jan 2021 08:48:55 -0600 Subject: [PATCH 059/302] Fixes: #5049 - Account for chassis neighbors in lldp_neighbors template --- docs/release-notes/version-2.10.md | 1 + netbox/templates/dcim/device/lldp_neighbors.html | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index b3b71657c..85279eb24 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5049](https://github.com/netbox-community/netbox/issues/5049) - Add check for LLDP neighbor chassis name to lldp_neighbors * [#5301](https://github.com/netbox-community/netbox/issues/5301) - Fix misleading error when racking a device with invalid parameters * [#5311](https://github.com/netbox-community/netbox/issues/5311) - Update child objects when a rack group is moved to a new site * [#5518](https://github.com/netbox-community/netbox/issues/5518) - Fix persistent vertical scrollbar diff --git a/netbox/templates/dcim/device/lldp_neighbors.html b/netbox/templates/dcim/device/lldp_neighbors.html index 3216b3791..a2baa6322 100644 --- a/netbox/templates/dcim/device/lldp_neighbors.html +++ b/netbox/templates/dcim/device/lldp_neighbors.html @@ -23,7 +23,7 @@ {{ iface }} {% if iface.connected_endpoint.device %} - + {{ iface.connected_endpoint.device }} @@ -61,6 +61,7 @@ $(document).ready(function() { // Glean configured hostnames/interfaces from the DOM var configured_device = row.children('td.configured_device').attr('data'); + var configured_chassis = row.children('td.configured_device').attr('data-chassis'); var configured_interface = row.children('td.configured_interface').attr('data'); var configured_interface_short = null; if (configured_interface) { @@ -81,9 +82,9 @@ $(document).ready(function() { // Apply colors to rows if (!configured_device && lldp_device) { row.addClass('info'); - } else if (configured_device == lldp_device && configured_interface == lldp_interface) { + } else if ((configured_device == lldp_device || configured_chassis == lldp_device) && configured_interface == lldp_interface) { row.addClass('success'); - } else if (configured_device == lldp_device && configured_interface_short == lldp_interface) { + } else if ((configured_device == lldp_device || configured_chassis == lldp_device) && configured_interface_short == lldp_interface) { row.addClass('success'); } else { row.addClass('danger'); From 359ae5d116f983039b87b4b694b822116a32e652 Mon Sep 17 00:00:00 2001 From: Brian Candler Date: Tue, 5 Jan 2021 15:05:17 +0000 Subject: [PATCH 060/302] Raise exceptions for other inconsistencies when migrating custom field data Fixes #5573 --- netbox/extras/migrations/0051_migrate_customfields.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/extras/migrations/0051_migrate_customfields.py b/netbox/extras/migrations/0051_migrate_customfields.py index 2c992c700..41b2febe7 100644 --- a/netbox/extras/migrations/0051_migrate_customfields.py +++ b/netbox/extras/migrations/0051_migrate_customfields.py @@ -67,7 +67,7 @@ def migrate_customfieldvalues(apps, schema_editor): cf_data = model.objects.filter(pk=cfv.obj_id).values('custom_field_data').first() try: cf_data['custom_field_data'][cfv.field.name] = deserialize_value(cfv.field, cfv.serialized_value) - except ValueError as e: + except Exception as e: print(f'{cfv.field.name} ({cfv.field.type}): {cfv.serialized_value} ({cfv.pk})') raise e model.objects.filter(pk=cfv.obj_id).update(**cf_data) From d16a7e108ca3040fde3d97b97f992242efbd7b61 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 5 Jan 2021 09:22:10 -0600 Subject: [PATCH 061/302] Fixes: #5563 - Fix power feed cable trace --- docs/release-notes/version-2.10.md | 1 + netbox/templates/dcim/powerfeed.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 85279eb24..b9a3685cc 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -16,6 +16,7 @@ * [#5551](https://github.com/netbox-community/netbox/issues/5551) - Restore missing import button on services list * [#5557](https://github.com/netbox-community/netbox/issues/5557) - Fix VRF route target assignment via REST API * [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields +* [#5563](https://github.com/netbox-community/netbox/issues/5563) - Fix power feed cable trace link --- diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index eded66fec..be7e03ec5 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -165,7 +165,7 @@ Cable {{ object.cable }} - + From 3441216aca619c18872f55fbb4e8369739701356 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 5 Jan 2021 09:52:11 -0600 Subject: [PATCH 062/302] Fixes: #5564 - Raise validation error if a PowerPortTemplate's draw exceeds maximum --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/models/device_component_templates.py | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index b9a3685cc..4b762f1ae 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -17,6 +17,7 @@ * [#5557](https://github.com/netbox-community/netbox/issues/5557) - Fix VRF route target assignment via REST API * [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields * [#5563](https://github.com/netbox-community/netbox/issues/5563) - Fix power feed cable trace link +* [#5564](https://github.com/netbox-community/netbox/issues/5564) - Raise validation error if a power port template's `allocated_draw` exceeds its `maximum_draw` --- diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index fe819d310..58233f3bf 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -164,6 +164,15 @@ class PowerPortTemplate(ComponentTemplateModel): allocated_draw=self.allocated_draw ) + def clean(self): + super().clean() + + if self.maximum_draw is not None and self.allocated_draw is not None: + if self.allocated_draw > self.maximum_draw: + raise ValidationError({ + 'allocated_draw': f"Allocated draw cannot exceed the maximum draw ({self.maximum_draw}W)." + }) + class PowerOutletTemplate(ComponentTemplateModel): """ From aa10430c7b2f484c9fc74e994a2a15239f06ce33 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 5 Jan 2021 15:06:15 -0500 Subject: [PATCH 063/302] Changelog for #5573 --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 4b762f1ae..d46782f8f 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -18,6 +18,7 @@ * [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields * [#5563](https://github.com/netbox-community/netbox/issues/5563) - Fix power feed cable trace link * [#5564](https://github.com/netbox-community/netbox/issues/5564) - Raise validation error if a power port template's `allocated_draw` exceeds its `maximum_draw` +* [#5573](https://github.com/netbox-community/netbox/issues/5573) - Report inconsistent values when migrating custom field data --- From 0accaedad01def9cf0a9f3907ed4c61d9030798a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 5 Jan 2021 15:15:36 -0500 Subject: [PATCH 064/302] Fixes #5569: Ensure consistent labeling of interface mgmt_only field --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/models/device_components.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index d46782f8f..03ac644da 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -18,6 +18,7 @@ * [#5558](https://github.com/netbox-community/netbox/issues/5558) - Fix regex validation support for custom URL fields * [#5563](https://github.com/netbox-community/netbox/issues/5563) - Fix power feed cable trace link * [#5564](https://github.com/netbox-community/netbox/issues/5564) - Raise validation error if a power port template's `allocated_draw` exceeds its `maximum_draw` +* [#5569](https://github.com/netbox-community/netbox/issues/5569) - Ensure consistent labeling of interface `mgmt_only` field * [#5573](https://github.com/netbox-community/netbox/issues/5573) - Report inconsistent values when migrating custom field data --- diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 21ca92da8..452aacb56 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -505,7 +505,7 @@ class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): ) mgmt_only = models.BooleanField( default=False, - verbose_name='OOB Management', + verbose_name='Management only', help_text='This interface is used only for out-of-band management' ) untagged_vlan = models.ForeignKey( From 4a2d2882c66782d994564556501015e23de8ef9c Mon Sep 17 00:00:00 2001 From: Brandon Bennett Date: Tue, 5 Jan 2021 15:51:03 -0700 Subject: [PATCH 065/302] Fixes #5579: mark `ie` and `nie` filter exprs as insensitive In the documentation the `ie` and `nie` filter expressions are incorrectly marked as senstive matches when they are in fact insensitive. --- docs/rest-api/filtering.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/rest-api/filtering.md b/docs/rest-api/filtering.md index 1ec6752a4..b77513297 100644 --- a/docs/rest-api/filtering.md +++ b/docs/rest-api/filtering.md @@ -78,8 +78,8 @@ String based (char) fields (Name, Address, etc) support these lookup expressions - `nisw` - negated case insensitive starts with - `iew` - case insensitive ends with - `niew` - negated case insensitive ends with -- `ie` - case sensitive exact match -- `nie` - negated case sensitive exact match +- `ie` - case insensitive exact match +- `nie` - negated case insensitive exact match ### Foreign Keys & Other Fields From 601cbd2306a61c65a392b8e07bb1da2b4e9c86b5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 5 Jan 2021 20:33:46 -0500 Subject: [PATCH 066/302] Release v2.10.3 --- docs/release-notes/version-2.10.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 03ac644da..a3ab5968c 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,6 +1,6 @@ # NetBox v2.10 -## v2.10.3 (FUTURE) +## v2.10.3 (2021-01-05) ### Bug Fixes diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 987452255..4c36332fc 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.3-dev' +VERSION = '2.10.3' # Hostname HOSTNAME = platform.node() From c8f09f28b16979e84b32dca7b859cb9d5f4dd952 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 5 Jan 2021 21:10:58 -0500 Subject: [PATCH 067/302] PRVB --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 4c36332fc..ed1f9c732 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.3' +VERSION = '2.10.4-dev' # Hostname HOSTNAME = platform.node() From 47b7ec8d00905dd82a44945691b526750d1467ac Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 7 Jan 2021 11:19:11 -0500 Subject: [PATCH 068/302] Fixes #5584: Restore power utilization panel under device view --- docs/release-notes/version-2.10.md | 8 ++++++++ netbox/templates/dcim/device.html | 8 ++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index a3ab5968c..9773ec1b7 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,5 +1,13 @@ # NetBox v2.10 +## v2.10.4 (FUTURE) + +### Bug Fixes + +* [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view + +--- + ## v2.10.3 (2021-01-05) ### Bug Fixes diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index 97f7c8953..55be343ac 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -204,7 +204,7 @@ {% plugin_left_page object %}
- {% if power_ports and poweroutlets %} + {% if object.powerports.exists and object.poweroutlets.exists %}
Power Utilization @@ -217,10 +217,10 @@ Available Utilization - {% for pp in power_ports %} - {% with utilization=pp.get_power_draw powerfeed=pp.connected_endpoint %} + {% for powerport in object.powerports.all %} + {% with utilization=powerport.get_power_draw powerfeed=powerport.connected_endpoint %} - {{ pp }} + {{ powerport }} {{ utilization.outlet_count }} {{ utilization.allocated }}VA {% if powerfeed.available_power %} From e9d888bf6330f1107f38aaa2458b7c04a34fc9fb Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 7 Jan 2021 11:29:59 -0500 Subject: [PATCH 069/302] Closes #5570: Add "management only" filter widget for interfaces list --- docs/release-notes/version-2.10.md | 4 ++++ netbox/dcim/forms.py | 6 ++++++ netbox/dcim/tables/devices.py | 1 + 3 files changed, 11 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 9773ec1b7..f9dee5dec 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -2,6 +2,10 @@ ## v2.10.4 (FUTURE) +### Enhancements + +* [#5570](https://github.com/netbox-community/netbox/issues/5570) - Add "management only" filter widget for interfaces list + ### Bug Fixes * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index f7eb510ec..18fdbdb40 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -2687,6 +2687,12 @@ class InterfaceFilterForm(DeviceComponentFilterForm): choices=BOOLEAN_WITH_BLANK_CHOICES ) ) + mgmt_only = forms.NullBooleanField( + required=False, + widget=StaticSelect2( + choices=BOOLEAN_WITH_BLANK_CHOICES + ) + ) mac_address = forms.CharField( required=False, label='MAC address' diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index 663206505..2b067a69d 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -406,6 +406,7 @@ class BaseInterfaceTable(BaseTable): class InterfaceTable(DeviceComponentTable, BaseInterfaceTable, PathEndpointTable): + mgmt_only = BooleanColumn() tags = TagColumn( url_name='dcim:interface_list' ) From c51d2a56ac09eb4b34882a3af0eaec9a9c0a6a31 Mon Sep 17 00:00:00 2001 From: Mikhail Yohman Date: Fri, 8 Jan 2021 19:30:27 -0700 Subject: [PATCH 070/302] Closes 5586: Adds name, master, and master_id filtering --- netbox/dcim/filters.py | 12 +++++++++++- netbox/dcim/tests/test_filters.py | 17 ++++++++++++++--- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/filters.py b/netbox/dcim/filters.py index 3046a0f33..05ae08923 100644 --- a/netbox/dcim/filters.py +++ b/netbox/dcim/filters.py @@ -1016,6 +1016,16 @@ class VirtualChassisFilterSet(BaseFilterSet): method='search', label='Search', ) + master_id = django_filters.ModelMultipleChoiceFilter( + queryset=Device.objects.all(), + label='Master (ID)', + ) + master = django_filters.ModelMultipleChoiceFilter( + field_name='master__name', + queryset=Device.objects.all(), + to_field_name='name', + label='Master (name)', + ) region_id = TreeNodeMultipleChoiceFilter( queryset=Region.objects.all(), field_name='master__site__region', @@ -1055,7 +1065,7 @@ class VirtualChassisFilterSet(BaseFilterSet): class Meta: model = VirtualChassis - fields = ['id', 'domain'] + fields = ['id', 'domain', 'name'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/dcim/tests/test_filters.py b/netbox/dcim/tests/test_filters.py index c701c47cf..a76788e65 100644 --- a/netbox/dcim/tests/test_filters.py +++ b/netbox/dcim/tests/test_filters.py @@ -2399,9 +2399,9 @@ class VirtualChassisTestCase(TestCase): Device.objects.bulk_create(devices) virtual_chassis = ( - VirtualChassis(master=devices[0], domain='Domain 1'), - VirtualChassis(master=devices[2], domain='Domain 2'), - VirtualChassis(master=devices[4], domain='Domain 3'), + VirtualChassis(name='VC 1', master=devices[0], domain='Domain 1'), + VirtualChassis(name='VC 2', master=devices[2], domain='Domain 2'), + VirtualChassis(name='VC 3', master=devices[4], domain='Domain 3'), ) VirtualChassis.objects.bulk_create(virtual_chassis) @@ -2417,6 +2417,17 @@ class VirtualChassisTestCase(TestCase): params = {'domain': ['Domain 1', 'Domain 2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_master(self): + masters = Device.objects.all() + params = {'master_id': [masters[0].pk, masters[2].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'master': [masters[0].name, masters[2].name]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_name(self): + params = {'name': ['VC 1', 'VC 2']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_region(self): regions = Region.objects.all()[:2] params = {'region_id': [regions[0].pk, regions[1].pk]} From 1e1e2d5f54a3c5ff60e15deb7a71a81fb4ddc8fb Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 11 Jan 2021 11:28:03 -0500 Subject: [PATCH 071/302] Fixes #5597: Fix ordering devices by primary IP address --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/tables/devices.py | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index f9dee5dec..870a11890 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -9,6 +9,7 @@ ### Bug Fixes * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view +* [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address --- diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index 2b067a69d..edd9e7a43 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -129,6 +129,7 @@ class DeviceTable(BaseTable): ) primary_ip = tables.Column( linkify=True, + order_by=('primary_ip6', 'primary_ip4'), verbose_name='IP Address' ) primary_ip4 = tables.Column( From e13d96a6f24ad45fdfd354a47f22947b005b7acc Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Sun, 17 Jan 2021 14:08:59 -0500 Subject: [PATCH 072/302] Don't pin Ubuntu installations to Python 3.6 --- docs/installation/3-netbox.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 9745df1f3..f2461b40d 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -7,12 +7,12 @@ This section of the documentation discusses installing and configuring the NetBo Begin by installing all system packages required by NetBox and its dependencies. !!! note - NetBox v2.8.0 and later require Python 3.6, 3.7, or 3.8. This documentation assumes Python 3.6. + NetBox v2.8.0 and later require Python 3.6, 3.7, or 3.8. ### Ubuntu ```no-highlight -sudo apt install -y python3.6 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev +sudo apt install -y python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev ``` ### CentOS From d838a76461771f71144c8b9ae75eef55aa71e8ca Mon Sep 17 00:00:00 2001 From: Janek Bevendorff Date: Mon, 18 Jan 2021 14:06:28 +0100 Subject: [PATCH 073/302] Add choices for GG45 and TERA connectors and Cat7a/Cat8 cables Fixes #5612 --- netbox/dcim/choices.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index d8f8e3e27..d4cc0ecf4 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -873,6 +873,10 @@ class PortTypeChoices(ChoiceSet): TYPE_8P6C = '8p6c' TYPE_8P4C = '8p4c' TYPE_8P2C = '8p2c' + TYPE_GG45 = 'gg45' + TYPE_TERA4P = 'tera-4p' + TYPE_TERA2P = 'tera-2p' + TYPE_TERA1P = 'tera-1p' TYPE_110_PUNCH = '110-punch' TYPE_BNC = 'bnc' TYPE_MRJ21 = 'mrj21' @@ -898,6 +902,10 @@ class PortTypeChoices(ChoiceSet): (TYPE_8P6C, '8P6C'), (TYPE_8P4C, '8P4C'), (TYPE_8P2C, '8P2C'), + (TYPE_GG45, 'GG45'), + (TYPE_TERA4P, 'TERA 4P'), + (TYPE_TERA2P, 'TERA 2P'), + (TYPE_TERA1P, 'TERA 1P'), (TYPE_110_PUNCH, '110 Punch'), (TYPE_BNC, 'BNC'), (TYPE_MRJ21, 'MRJ21'), @@ -936,6 +944,8 @@ class CableTypeChoices(ChoiceSet): TYPE_CAT6 = 'cat6' TYPE_CAT6A = 'cat6a' TYPE_CAT7 = 'cat7' + TYPE_CAT7A = 'cat7a' + TYPE_CAT8 = 'cat8' TYPE_DAC_ACTIVE = 'dac-active' TYPE_DAC_PASSIVE = 'dac-passive' TYPE_MRJ21_TRUNK = 'mrj21-trunk' @@ -960,6 +970,8 @@ class CableTypeChoices(ChoiceSet): (TYPE_CAT6, 'CAT6'), (TYPE_CAT6A, 'CAT6a'), (TYPE_CAT7, 'CAT7'), + (TYPE_CAT7A, 'CAT7a'), + (TYPE_CAT8, 'CAT8'), (TYPE_DAC_ACTIVE, 'Direct Attach Copper (Active)'), (TYPE_DAC_PASSIVE, 'Direct Attach Copper (Passive)'), (TYPE_MRJ21_TRUNK, 'MRJ21 Trunk'), From 69bf451b209087b7a4025571c816551eee47538a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 19 Jan 2021 09:41:49 -0500 Subject: [PATCH 074/302] Changelog for #5586 and #5612 --- docs/release-notes/version-2.10.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 870a11890..63eec8083 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -5,6 +5,8 @@ ### Enhancements * [#5570](https://github.com/netbox-community/netbox/issues/5570) - Add "management only" filter widget for interfaces list +* [#5586](https://github.com/netbox-community/netbox/issues/5586) - Allow filtering virtual chassis by name and master +* [#5612](https://github.com/netbox-community/netbox/issues/5612) - Add GG45 and TERA port types, and CAT7a and CAT8 cable types ### Bug Fixes From a0e82e181701159012882c6ba1378a6b2f3453e1 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 19 Jan 2021 10:49:56 -0500 Subject: [PATCH 075/302] Fixes #5574: Restrict the creation of device bay templates on non-parent device types --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/models/device_component_templates.py | 6 ++++++ netbox/dcim/tests/test_api.py | 5 ++++- netbox/dcim/tests/test_views.py | 5 +++-- 4 files changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 63eec8083..a653173f9 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -10,6 +10,7 @@ ### Bug Fixes +* [#5574](https://github.com/netbox-community/netbox/issues/5574) - Restrict the creation of device bay templates on non-parent device types * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view * [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index 58233f3bf..e52fe2602 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -363,3 +363,9 @@ class DeviceBayTemplate(ComponentTemplateModel): name=self.name, label=self.label ) + + def clean(self): + if self.device_type and self.device_type.subdevice_role != SubdeviceRoleChoices.ROLE_PARENT: + raise ValidationError( + f"Subdevice role of device type ({self.device_type}) must be set to \"parent\" to allow device bays." + ) diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index 77c3b4786..ad1ca930c 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -740,7 +740,10 @@ class DeviceBayTemplateTest(APIViewTestCases.APIViewTestCase): def setUpTestData(cls): manufacturer = Manufacturer.objects.create(name='Test Manufacturer 1', slug='test-manufacturer-1') devicetype = DeviceType.objects.create( - manufacturer=manufacturer, model='Device Type 1', slug='device-type-1' + manufacturer=manufacturer, + model='Device Type 1', + slug='device-type-1', + subdevice_role=SubdeviceRoleChoices.ROLE_PARENT ) device_bay_templates = ( diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index 91ec8776c..86518af84 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -396,6 +396,7 @@ manufacturer: Generic model: TEST-1000 slug: test-1000 u_height: 2 +subdevice_role: parent comments: test comment console-ports: - name: Console Port 1 @@ -831,8 +832,8 @@ class DeviceBayTemplateTestCase(ViewTestCases.DeviceComponentTemplateViewTestCas def setUpTestData(cls): manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') devicetypes = ( - DeviceType(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1'), - DeviceType(manufacturer=manufacturer, model='Device Type 2', slug='device-type-2'), + DeviceType(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1', subdevice_role=SubdeviceRoleChoices.ROLE_PARENT), + DeviceType(manufacturer=manufacturer, model='Device Type 2', slug='device-type-2', subdevice_role=SubdeviceRoleChoices.ROLE_PARENT), ) DeviceType.objects.bulk_create(devicetypes) From 3c9be8cd0806c29445310e01957ab09afbe24818 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 19 Jan 2021 11:24:34 -0500 Subject: [PATCH 076/302] Fixes #5639: Fix filtering connection lists by device name --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/filters.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index a653173f9..f3cf87764 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -13,6 +13,7 @@ * [#5574](https://github.com/netbox-community/netbox/issues/5574) - Restrict the creation of device bay templates on non-parent device types * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view * [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address +* [#5639](https://github.com/netbox-community/netbox/issues/5639) - Fix filtering connection lists by device name --- diff --git a/netbox/dcim/filters.py b/netbox/dcim/filters.py index 05ae08923..03deca2a4 100644 --- a/netbox/dcim/filters.py +++ b/netbox/dcim/filters.py @@ -1152,7 +1152,7 @@ class ConnectionFilterSet: def filter_device(self, queryset, name, value): if not value: return queryset - return queryset.filter(device_id__in=value) + return queryset.filter(**{f'{name}__in': value}) class ConsoleConnectionFilterSet(ConnectionFilterSet, BaseFilterSet): From f469920759f8711c8443de9ee0892e042a895fd3 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 20 Jan 2021 15:18:13 -0500 Subject: [PATCH 077/302] Fixes #5640: Fix permissions assessment when adding VM interfaces in bulk --- docs/release-notes/version-2.10.md | 1 + netbox/templates/virtualization/virtualmachine_list.html | 2 +- netbox/virtualization/views.py | 3 +++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index f3cf87764..0ef5f2a0f 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -14,6 +14,7 @@ * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view * [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address * [#5639](https://github.com/netbox-community/netbox/issues/5639) - Fix filtering connection lists by device name +* [#5640](https://github.com/netbox-community/netbox/issues/5640) - Fix permissions assessment when adding VM interfaces in bulk --- diff --git a/netbox/templates/virtualization/virtualmachine_list.html b/netbox/templates/virtualization/virtualmachine_list.html index 9d8c1720f..245e55092 100644 --- a/netbox/templates/virtualization/virtualmachine_list.html +++ b/netbox/templates/virtualization/virtualmachine_list.html @@ -7,7 +7,7 @@ Add Components
    - {% if perms.dcim.add_interface %}
  • Interfaces
    • {% endif %} + {% if perms.virtualization.add_vminterface %}
  • Interfaces
    • {% endif %}
{% endif %} diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py index 9ef4a0863..dcf9ebcda 100644 --- a/netbox/virtualization/views.py +++ b/netbox/virtualization/views.py @@ -396,3 +396,6 @@ class VirtualMachineBulkAddInterfaceView(generic.BulkComponentCreateView): model_form = forms.VMInterfaceForm filterset = filters.VirtualMachineFilterSet table = tables.VirtualMachineTable + + def get_required_permission(self): + return f'virtualization.add_vminterface' From 0994719b9124cfc10626598eebb7cee459903d2a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 20 Jan 2021 15:36:04 -0500 Subject: [PATCH 078/302] Add NetBox installation video to docs --- docs/installation/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/installation/index.md b/docs/installation/index.md index 730176e0c..71e669295 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -11,6 +11,10 @@ The following sections detail how to set up a new instance of NetBox: 5. [HTTP server](5-http-server.md) 6. [LDAP authentication](6-ldap.md) (optional) +The video below demonstrates the installation of NetBox v2.10.3 on Ubuntu 20.04 for your reference. + + + ## Requirements | Dependency | Minimum Version | From e739d6aa057750d17af01d4f9b772027d47183c5 Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Wed, 20 Jan 2021 23:52:54 +0000 Subject: [PATCH 079/302] Fix white cables --- netbox/templates/dcim/trace/cable.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/templates/dcim/trace/cable.html b/netbox/templates/dcim/trace/cable.html index 4235768a6..7a7fbcf55 100644 --- a/netbox/templates/dcim/trace/cable.html +++ b/netbox/templates/dcim/trace/cable.html @@ -1,6 +1,6 @@ {% load helpers %} -
+
{% if cable.label %}{{ cable.label }}{% else %}Cable #{{ cable.pk }}{% endif %} From fefc6233436a3df4d2b106aac4f7d059aae6f951 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 20 Jan 2021 20:48:24 -0500 Subject: [PATCH 080/302] Changelog for #5603 --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 0ef5f2a0f..16d48dba7 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -13,6 +13,7 @@ * [#5574](https://github.com/netbox-community/netbox/issues/5574) - Restrict the creation of device bay templates on non-parent device types * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view * [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address +* [#5603](https://github.com/netbox-community/netbox/issues/5603) - Fix display of white cables in trace view * [#5639](https://github.com/netbox-community/netbox/issues/5639) - Fix filtering connection lists by device name * [#5640](https://github.com/netbox-community/netbox/issues/5640) - Fix permissions assessment when adding VM interfaces in bulk From 5e962719ca84a250f24d61a5d999e9e6c8e91ad0 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 20 Jan 2021 21:29:23 -0500 Subject: [PATCH 081/302] Closes #5542: Show cable trace lengths in both meters and feet --- docs/release-notes/version-2.10.md | 1 + netbox/templates/dcim/cable_trace.html | 3 ++- netbox/utilities/templatetags/helpers.py | 8 ++++++++ 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 16d48dba7..27d9fef49 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Enhancements +* [#5542](https://github.com/netbox-community/netbox/issues/5542) - Show cable trace lengths in both meters and feet * [#5570](https://github.com/netbox-community/netbox/issues/5570) - Add "management only" filter widget for interfaces list * [#5586](https://github.com/netbox-community/netbox/issues/5586) - Allow filtering virtual chassis by name and master * [#5612](https://github.com/netbox-community/netbox/issues/5612) - Add GG45 and TERA port types, and CAT7a and CAT8 cable types diff --git a/netbox/templates/dcim/cable_trace.html b/netbox/templates/dcim/cable_trace.html index a36922612..a39ada1ce 100644 --- a/netbox/templates/dcim/cable_trace.html +++ b/netbox/templates/dcim/cable_trace.html @@ -69,7 +69,8 @@
Total segments: {{ traced_path|length }}
Total length: {% if total_length %} - {{ total_length|floatformat:"-2" }} Meters + {{ total_length|floatformat:"-2" }} Meters / + {{ total_length|meters_to_feet|floatformat:"-2" }} Feet {% else %} N/A {% endif %} diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index 29c920d4f..01dce8479 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -220,6 +220,14 @@ def as_range(n): return range(n) +@register.filter() +def meters_to_feet(n): + """ + Convert a length from meters to feet. + """ + return float(n) * 3.28084 + + # # Tags # From 02e8979178783d562cc8a47cd6df097403b5fb6b Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Fri, 22 Jan 2021 16:45:08 +0000 Subject: [PATCH 082/302] Changes to template, view and CablePath class to indicate to users whether the cable length is accurate or not. --- netbox/dcim/models/cables.py | 8 ++++++-- netbox/dcim/views.py | 6 +++++- netbox/templates/dcim/cable_trace.html | 2 +- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 6a530bb49..898e73b4c 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -480,13 +480,17 @@ class CablePath(models.Model): def get_total_length(self): """ - Return the sum of the length of each cable in the path. + Return a tuple containing the sum of the length of each cable in the path + and a flag indicating whether the length is definitive. """ cable_ids = [ # Starting from the first element, every third element in the path should be a Cable decompile_path_node(self.path[i])[1] for i in range(0, len(self.path), 3) ] - return Cable.objects.filter(id__in=cable_ids).aggregate(total=Sum('_abs_length'))['total'] + cables = Cable.objects.filter(id__in=cable_ids, _abs_length__isnull=False) + total_length = cables.aggregate(total=Sum('_abs_length'))['total'] + is_definitive = len(cables) == len(cable_ids) + return (total_length, is_definitive) def get_split_nodes(self): """ diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index b092be612..faec98cb7 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2134,10 +2134,14 @@ class PathTraceView(generic.ObjectView): else: path = related_paths.first() + # Get the total length of the cable and whether the length is definitive (fully defined) + total_length, is_definitive = path.get_total_length if path else (None, False) + return { 'path': path, 'related_paths': related_paths, - 'total_length': path.get_total_length() if path else None, + 'total_length': total_length, + 'is_definitive': is_definitive } diff --git a/netbox/templates/dcim/cable_trace.html b/netbox/templates/dcim/cable_trace.html index a39ada1ce..060fe2076 100644 --- a/netbox/templates/dcim/cable_trace.html +++ b/netbox/templates/dcim/cable_trace.html @@ -69,7 +69,7 @@
Total segments: {{ traced_path|length }}
Total length: {% if total_length %} - {{ total_length|floatformat:"-2" }} Meters / + {% if not is_definitive %}>{% endif %}{{ total_length|floatformat:"-2" }} Meters / {{ total_length|meters_to_feet|floatformat:"-2" }} Feet {% else %} N/A From 3de04094fb4f5f53ed5319d831e099e135a2446b Mon Sep 17 00:00:00 2001 From: Riley Littlefield Date: Sat, 23 Jan 2021 13:41:48 -0500 Subject: [PATCH 083/302] Fixes typo --- docs/configuration/required-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/required-settings.md b/docs/configuration/required-settings.md index 2edf6c7c7..f03745930 100644 --- a/docs/configuration/required-settings.md +++ b/docs/configuration/required-settings.md @@ -5,7 +5,7 @@ This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same as the hostname for the NetBox server, but can also be different; for example, when using a reverse proxy serving the NetBox website under a different FQDN than the hostname of the NetBox server. To help guard against [HTTP Host header attackes](https://docs.djangoproject.com/en/3.0/topics/security/#host-headers-virtual-hosting), NetBox will not permit access to the server via any other hostnames (or IPs). !!! note - This parameter must always be defined as a list or tuple, even if only value is provided. + This parameter must always be defined as a list or tuple, even if only a single value is provided. The value of this option is also used to set `CSRF_TRUSTED_ORIGINS`, which restricts POST requests to the same set of hosts (more about this [here](https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS)). Keep in mind that NetBox, by default, sets `USE_X_FORWARDED_HOST` to true, which means that if you're using a reverse proxy, it's the FQDN used to reach that reverse proxy which needs to be in this list (more about this [here](https://docs.djangoproject.com/en/stable/ref/settings/#allowed-hosts)). From 9eb64dc6a47ba6400b92e02125bd0251b7bf74e1 Mon Sep 17 00:00:00 2001 From: Riley Littlefield Date: Sat, 23 Jan 2021 13:54:44 -0500 Subject: [PATCH 084/302] Fixes another typo --- docs/configuration/required-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/required-settings.md b/docs/configuration/required-settings.md index f03745930..dba8cdc8c 100644 --- a/docs/configuration/required-settings.md +++ b/docs/configuration/required-settings.md @@ -101,7 +101,7 @@ REDIS = { If you are using [Redis Sentinel](https://redis.io/topics/sentinel) for high-availability purposes, there is minimal configuration necessary to convert NetBox to recognize it. It requires the removal of the `HOST` and `PORT` keys from -above and the addition of two new keys. +above and the addition of three new keys. * `SENTINELS`: List of tuples or tuple of tuples with each inner tuple containing the name or IP address of the Redis server and port for each sentinel instance to connect to From 60baa5e59e1d5f3f71f1cb8c051c700dc27ba5c6 Mon Sep 17 00:00:00 2001 From: Riley Littlefield Date: Sat, 23 Jan 2021 14:06:48 -0500 Subject: [PATCH 085/302] Fixes small typo in optional settings --- docs/configuration/optional-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 91c0e7597..4af83493e 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -56,7 +56,7 @@ BASE_PATH = 'netbox/' Default: 900 -The number of seconds to cache entries will be retained before expiring. +The number of seconds that cache entries will be retained before expiring. --- From b6e532f01d852738f40eb8bedc89f5c056b2f62c Mon Sep 17 00:00:00 2001 From: Thomas Fargeix Date: Sun, 24 Jan 2021 21:20:55 +0100 Subject: [PATCH 086/302] Fix how SECRET_KEY is generated Use secrets.choice instead of random.sample to generate the secret key. --- netbox/generate_secret_key.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/netbox/generate_secret_key.py b/netbox/generate_secret_key.py index 3c88aa710..c3de29cee 100755 --- a/netbox/generate_secret_key.py +++ b/netbox/generate_secret_key.py @@ -1,7 +1,6 @@ #!/usr/bin/env python # This script will generate a random 50-character string suitable for use as a SECRET_KEY. -import random +import secrets charset = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*(-_=+)' -secure_random = random.SystemRandom() -print(''.join(secure_random.sample(charset, 50))) +print(''.join(secrets.choice(charset) for _ in range(50))) From 87c600aa7cc3da60019a34b2c75162baefa4e40f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 25 Jan 2021 14:19:32 -0500 Subject: [PATCH 087/302] Fixes #5665: Validate rack group is assigned to same site when creating a rack --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/models/racks.py | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 27d9fef49..98595ff4a 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -17,6 +17,7 @@ * [#5603](https://github.com/netbox-community/netbox/issues/5603) - Fix display of white cables in trace view * [#5639](https://github.com/netbox-community/netbox/issues/5639) - Fix filtering connection lists by device name * [#5640](https://github.com/netbox-community/netbox/issues/5640) - Fix permissions assessment when adding VM interfaces in bulk +* [#5665](https://github.com/netbox-community/netbox/issues/5665) - Validate rack group is assigned to same site when creating a rack --- diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index ccc775954..dfaf7da61 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -299,6 +299,10 @@ class Rack(ChangeLoggedModel, CustomFieldModel): def clean(self): super().clean() + # Validate group/site assignment + if self.site and self.group and self.group.site != self.site: + raise ValidationError(f"Assigned rack group must belong to parent site ({self.site}).") + # Validate outer dimensions and unit if (self.outer_width is not None or self.outer_depth is not None) and not self.outer_unit: raise ValidationError("Must specify a unit when setting an outer width/depth") From 137aa9da2c2e71b352c287341bfcdd80d56d706c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 25 Jan 2021 14:29:03 -0500 Subject: [PATCH 088/302] Fixes #5648: Include VC member interfaces on interfaces tab count when viewing VC master --- docs/release-notes/version-2.10.md | 1 + netbox/templates/dcim/device/base.html | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 98595ff4a..05b48a896 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -17,6 +17,7 @@ * [#5603](https://github.com/netbox-community/netbox/issues/5603) - Fix display of white cables in trace view * [#5639](https://github.com/netbox-community/netbox/issues/5639) - Fix filtering connection lists by device name * [#5640](https://github.com/netbox-community/netbox/issues/5640) - Fix permissions assessment when adding VM interfaces in bulk +* [#5648](https://github.com/netbox-community/netbox/issues/5648) - Include VC member interfaces on interfaces tab count when viewing VC master * [#5665](https://github.com/netbox-community/netbox/issues/5665) - Validate rack group is assigned to same site when creating a rack --- diff --git a/netbox/templates/dcim/device/base.html b/netbox/templates/dcim/device/base.html index 631abde89..8f488b284 100644 --- a/netbox/templates/dcim/device/base.html +++ b/netbox/templates/dcim/device/base.html @@ -90,7 +90,7 @@ - {% with interface_count=object.interfaces.count %} + {% with interface_count=object.vc_interfaces.count %} {% if interface_count %}
- {% with rack=object.rack %} -
-
-
-

Front

-
- {% include 'dcim/inc/rack_elevation.html' with face='front' %} -
-
-
-

Rear

-
- {% include 'dcim/inc/rack_elevation.html' with face='rear' %} +
+
+
+

Front

+ {% include 'dcim/inc/rack_elevation.html' with object=object.rack face='front' %}
- {% endwith %} +
+
+

Rear

+
+ {% include 'dcim/inc/rack_elevation.html' with object=object.rack face='rear' %} +
+
{% plugin_right_page object %}
From 90e8f26cd4e34d9ea3364fa15a961f47298d0e05 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 26 Jan 2021 10:17:58 -0500 Subject: [PATCH 090/302] Closes #5678: Show available type choices for all device component import forms --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/forms.py | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 1d954d383..02897b614 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -8,6 +8,7 @@ * [#5570](https://github.com/netbox-community/netbox/issues/5570) - Add "management only" filter widget for interfaces list * [#5586](https://github.com/netbox-community/netbox/issues/5586) - Allow filtering virtual chassis by name and master * [#5612](https://github.com/netbox-community/netbox/issues/5612) - Add GG45 and TERA port types, and CAT7a and CAT8 cable types +* [#5678](https://github.com/netbox-community/netbox/issues/5678) - Show available type choices for all device component import forms ### Bug Fixes diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 18fdbdb40..fd533b6ac 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -2352,6 +2352,10 @@ class ConsolePortCSVForm(CSVModelForm): queryset=Device.objects.all(), to_field_name='name' ) + type = CSVChoiceField( + choices=ConsolePortTypeChoices, + help_text='Port type' + ) class Meta: model = ConsolePort @@ -2425,6 +2429,10 @@ class ConsoleServerPortCSVForm(CSVModelForm): queryset=Device.objects.all(), to_field_name='name' ) + type = CSVChoiceField( + choices=ConsolePortTypeChoices, + help_text='Port type' + ) class Meta: model = ConsoleServerPort @@ -2510,6 +2518,10 @@ class PowerPortCSVForm(CSVModelForm): queryset=Device.objects.all(), to_field_name='name' ) + type = CSVChoiceField( + choices=PowerPortTypeChoices, + help_text='Port type' + ) class Meta: model = PowerPort @@ -2630,6 +2642,10 @@ class PowerOutletCSVForm(CSVModelForm): queryset=Device.objects.all(), to_field_name='name' ) + type = CSVChoiceField( + choices=PowerOutletTypeChoices, + help_text='Outlet type' + ) power_port = CSVModelChoiceField( queryset=PowerPort.objects.all(), required=False, From d5a0e12283d4dadf8b36f4826faeeafe4cccb2a5 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 26 Jan 2021 10:35:03 -0500 Subject: [PATCH 091/302] Certain component types are optional --- netbox/dcim/forms.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index fd533b6ac..40c16d59f 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -2354,6 +2354,7 @@ class ConsolePortCSVForm(CSVModelForm): ) type = CSVChoiceField( choices=ConsolePortTypeChoices, + required=False, help_text='Port type' ) @@ -2431,6 +2432,7 @@ class ConsoleServerPortCSVForm(CSVModelForm): ) type = CSVChoiceField( choices=ConsolePortTypeChoices, + required=False, help_text='Port type' ) @@ -2520,6 +2522,7 @@ class PowerPortCSVForm(CSVModelForm): ) type = CSVChoiceField( choices=PowerPortTypeChoices, + required=False, help_text='Port type' ) @@ -2644,6 +2647,7 @@ class PowerOutletCSVForm(CSVModelForm): ) type = CSVChoiceField( choices=PowerOutletTypeChoices, + required=False, help_text='Outlet type' ) power_port = CSVModelChoiceField( From edc015d9bf1312f0925d17ccdd7590c44045859e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 26 Jan 2021 11:20:06 -0500 Subject: [PATCH 092/302] Emphasize use of GitHub discussions in README --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 68927463d..a12daa783 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,7 @@ complete list of requirements, see `requirements.txt`. The code is available [on The complete documentation for NetBox can be found at [Read the Docs](https://netbox.readthedocs.io/en/stable/). -Questions? Comments? Please start a [discussion on GitHub](https://github.com/netbox-community/netbox/discussions), -or join us in the **#netbox** Slack channel on [NetworkToCode](https://networktocode.slack.com/)! +Questions? Comments? Start by perusing our [GitHub discussions](https://github.com/netbox-community/netbox/discussions) for the topic you have in mind. ### Build Status From a23ff4e5191836005ee59f8484641c6043b0ef8f Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 26 Jan 2021 10:34:07 -0600 Subject: [PATCH 093/302] Fixes: #5232 - Corrects swagger definition --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 02897b614..9be3f22d1 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -12,6 +12,7 @@ ### Bug Fixes +* [#5232](https://github.com/netbox-community/netbox/issues/5232) - Correct swagger definition for ip_prefixes_available-ips_create API * [#5574](https://github.com/netbox-community/netbox/issues/5574) - Restrict the creation of device bay templates on non-parent device types * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view * [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address From aabc1a82655ad680e99c76ef1b86280e8cb97170 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 26 Jan 2021 10:34:07 -0600 Subject: [PATCH 094/302] Fixes: #5232 - Corrects swagger definition --- docs/release-notes/version-2.10.md | 1 + netbox/ipam/api/views.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 02897b614..9be3f22d1 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -12,6 +12,7 @@ ### Bug Fixes +* [#5232](https://github.com/netbox-community/netbox/issues/5232) - Correct swagger definition for ip_prefixes_available-ips_create API * [#5574](https://github.com/netbox-community/netbox/issues/5574) - Restrict the creation of device bay templates on non-parent device types * [#5584](https://github.com/netbox-community/netbox/issues/5584) - Restore power utilization panel under device view * [#5597](https://github.com/netbox-community/netbox/issues/5597) - Fix ordering devices by primary IP address diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index d9eae69aa..c322c249d 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -178,7 +178,7 @@ class PrefixViewSet(CustomFieldModelViewSet): @swagger_auto_schema(method='get', responses={200: serializers.AvailableIPSerializer(many=True)}) @swagger_auto_schema(method='post', responses={201: serializers.AvailableIPSerializer(many=True)}, - request_body=serializers.AvailableIPSerializer(many=False)) + request_body=serializers.AvailableIPSerializer(many=True)) @action(detail=True, url_path='available-ips', methods=['get', 'post'], queryset=IPAddress.objects.all()) @advisory_lock(ADVISORY_LOCK_KEYS['available-ips']) def available_ips(self, request, pk=None): From 0680b01a96e3ed2cec2b377e5831603eb4ffc534 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 26 Jan 2021 11:47:33 -0600 Subject: [PATCH 095/302] update python package name At least on ubuntu 20.04, the python3 package is now 3.8, but the package 'python3' points to the current best version of python available without needing to specialize a minor version and should require fewer changes to the document. --- docs/installation/3-netbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 9745df1f3..7698be4ad 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -12,7 +12,7 @@ Begin by installing all system packages required by NetBox and its dependencies. ### Ubuntu ```no-highlight -sudo apt install -y python3.6 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev +sudo apt install -y python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev ``` ### CentOS From 03e48161a152ed0c6029b1834a7dc44c55f98fcc Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 26 Jan 2021 13:06:29 -0500 Subject: [PATCH 096/302] Release v2.10.4 --- docs/release-notes/version-2.10.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 9be3f22d1..b6bc33229 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,6 +1,6 @@ # NetBox v2.10 -## v2.10.4 (FUTURE) +## v2.10.4 (2021-01-26) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index ed1f9c732..3dd780b26 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.4-dev' +VERSION = '2.10.4' # Hostname HOSTNAME = platform.node() From fc8f02c180dc8dd9ec6d6b3226432382f22e6f69 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 26 Jan 2021 14:03:46 -0600 Subject: [PATCH 097/302] Corrects error with ListSerializer as request_body --- netbox/utilities/custom_inspectors.py | 51 ++++++++++++++++----------- 1 file changed, 30 insertions(+), 21 deletions(-) diff --git a/netbox/utilities/custom_inspectors.py b/netbox/utilities/custom_inspectors.py index 95c647fb8..b110a9123 100644 --- a/netbox/utilities/custom_inspectors.py +++ b/netbox/utilities/custom_inspectors.py @@ -28,29 +28,38 @@ class NetBoxSwaggerAutoSchema(SwaggerAutoSchema): serializer = super().get_request_serializer() if serializer is not None and self.method in self.implicit_body_methods: - properties = {} - for child_name, child in serializer.fields.items(): - if isinstance(child, (ChoiceField, WritableNestedSerializer)): - properties[child_name] = None - elif isinstance(child, ManyRelatedField) and isinstance(child.child_relation, SerializedPKRelatedField): - properties[child_name] = None - - if properties: - if type(serializer) not in self.writable_serializers: - writable_name = 'Writable' + type(serializer).__name__ - meta_class = getattr(type(serializer), 'Meta', None) - if meta_class: - ref_name = 'Writable' + get_serializer_ref_name(serializer) - writable_meta = type('Meta', (meta_class,), {'ref_name': ref_name}) - properties['Meta'] = writable_meta - - self.writable_serializers[type(serializer)] = type(writable_name, (type(serializer),), properties) - - writable_class = self.writable_serializers[type(serializer)] - serializer = writable_class() - + writable_class = self.get_writable_class(serializer) + if writable_class is not None: + if hasattr(serializer, 'child'): + child_serializer = self.get_writable_class(serializer.child) + serializer = writable_class(child=child_serializer) + else: + serializer = writable_class() return serializer + def get_writable_class(self, serializer): + properties = {} + fields = {} if hasattr(serializer, 'child') else serializer.fields + for child_name, child in fields.items(): + if isinstance(child, (ChoiceField, WritableNestedSerializer)): + properties[child_name] = None + elif isinstance(child, ManyRelatedField) and isinstance(child.child_relation, SerializedPKRelatedField): + properties[child_name] = None + + if properties: + if type(serializer) not in self.writable_serializers: + writable_name = 'Writable' + type(serializer).__name__ + meta_class = getattr(type(serializer), 'Meta', None) + if meta_class: + ref_name = 'Writable' + get_serializer_ref_name(serializer) + writable_meta = type('Meta', (meta_class,), {'ref_name': ref_name}) + properties['Meta'] = writable_meta + + self.writable_serializers[type(serializer)] = type(writable_name, (type(serializer),), properties) + + writable_class = self.writable_serializers[type(serializer)] + return writable_class + class SerializedPKRelatedFieldInspector(FieldInspector): def field_to_swagger_object(self, field, swagger_object_type, use_references, **kwargs): From 196407307219fd29e3540965f0500bf4331f5876 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 26 Jan 2021 16:02:14 -0500 Subject: [PATCH 098/302] PRVB --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 3dd780b26..af5b01adc 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.4' +VERSION = '2.10.5-dev' # Hostname HOSTNAME = platform.node() From f28474d86ee2f29cbf6e761b25cf1d464dc329c0 Mon Sep 17 00:00:00 2001 From: Brian Candler Date: Tue, 2 Feb 2021 08:16:35 +0000 Subject: [PATCH 099/302] Fix sample report in documentation Raised in #5729 --- docs/additional-features/reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/additional-features/reports.md b/docs/additional-features/reports.md index 9d60f797e..1266c22ec 100644 --- a/docs/additional-features/reports.md +++ b/docs/additional-features/reports.md @@ -66,7 +66,7 @@ class DeviceConnectionsReport(Report): for power_port in PowerPort.objects.filter(device=device): if power_port.connected_endpoint is not None: connected_ports += 1 - if not power_port.connection_status: + if not power_port.path.is_active: self.log_warning( device, "Power connection for {} marked as planned".format(power_port.name) From b4ba5cbb7a3e365f8c1d145b0b2ce05850323ca1 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 2 Feb 2021 11:49:38 -0500 Subject: [PATCH 100/302] Fixes #5716: Fix filtering rack reservations by custom field --- docs/release-notes/version-2.10.md | 8 ++++++++ netbox/dcim/filters.py | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index b6bc33229..49f80d897 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,5 +1,13 @@ # NetBox v2.10 +## v2.10.5 (FUTURE) + +### Bug Fixes + +* [#5716](https://github.com/netbox-community/netbox/issues/5716) - Fix filtering rack reservations by custom field + +--- + ## v2.10.4 (2021-01-26) ### Enhancements diff --git a/netbox/dcim/filters.py b/netbox/dcim/filters.py index 03deca2a4..41363c261 100644 --- a/netbox/dcim/filters.py +++ b/netbox/dcim/filters.py @@ -264,7 +264,7 @@ class RackFilterSet(BaseFilterSet, TenancyFilterSet, CustomFieldModelFilterSet, ) -class RackReservationFilterSet(BaseFilterSet, TenancyFilterSet): +class RackReservationFilterSet(BaseFilterSet, TenancyFilterSet, CustomFieldModelFilterSet): q = django_filters.CharFilter( method='search', label='Search', From be1b6b6aa3c0ad0880f72a69da70a8c31e9bc295 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Blot?= Date: Thu, 4 Feb 2021 16:50:07 +0100 Subject: [PATCH 101/302] fix: add missing password when using redis in sentinel mode --- netbox/netbox/settings.py | 1 + 1 file changed, 1 insertion(+) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index af5b01adc..1e77619b8 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -391,6 +391,7 @@ if CACHING_REDIS_USING_SENTINEL: 'locations': CACHING_REDIS_SENTINELS, 'service_name': CACHING_REDIS_SENTINEL_SERVICE, 'db': CACHING_REDIS_DATABASE, + 'password': CACHING_REDIS_PASSWORD, } else: if CACHING_REDIS_SSL: From e3e928f1c4dbd45a66b35328dfb2252d3b512417 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 4 Feb 2021 13:01:55 -0500 Subject: [PATCH 102/302] Fixes #5718: Fix bulk editing of services when no port(s) are defined --- docs/release-notes/version-2.10.md | 1 + netbox/netbox/views/generic.py | 2 +- netbox/utilities/forms/widgets.py | 5 ++++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 49f80d897..fccd86abd 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -5,6 +5,7 @@ ### Bug Fixes * [#5716](https://github.com/netbox-community/netbox/issues/5716) - Fix filtering rack reservations by custom field +* [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined --- diff --git a/netbox/netbox/views/generic.py b/netbox/netbox/views/generic.py index bd21d469c..216b50759 100644 --- a/netbox/netbox/views/generic.py +++ b/netbox/netbox/views/generic.py @@ -792,7 +792,7 @@ class BulkEditView(GetReturnURLMixin, ObjectPermissionRequiredMixin, View): if form.cleaned_data[name]: getattr(obj, name).set(form.cleaned_data[name]) # Normal fields - elif form.cleaned_data[name] not in (None, ''): + elif form.cleaned_data[name] not in (None, '', []): setattr(obj, name, form.cleaned_data[name]) # Update custom fields diff --git a/netbox/utilities/forms/widgets.py b/netbox/utilities/forms/widgets.py index cd6fb0fbb..1c456c74c 100644 --- a/netbox/utilities/forms/widgets.py +++ b/netbox/utilities/forms/widgets.py @@ -114,7 +114,10 @@ class ContentTypeSelect(StaticSelect2): class NumericArrayField(SimpleArrayField): def to_python(self, value): - value = ','.join([str(n) for n in parse_numeric_range(value)]) + if not value: + return [] + if isinstance(value, str): + value = ','.join([str(n) for n in parse_numeric_range(value)]) return super().to_python(value) From 1430c0a6e6444b06581dae6e6deb4a0434dd95ee Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 4 Feb 2021 13:19:42 -0500 Subject: [PATCH 103/302] Fixes #5738: Fix redirect to device components view after disconnecting a cable --- docs/release-notes/version-2.10.md | 1 + netbox/dcim/tables/template_code.py | 35 +++++++++++++++++++ .../dcim/inc/cable_toggle_buttons.html | 5 --- 3 files changed, 36 insertions(+), 5 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index fccd86abd..94b80ef1c 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -6,6 +6,7 @@ * [#5716](https://github.com/netbox-community/netbox/issues/5716) - Fix filtering rack reservations by custom field * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined +* [#5738](https://github.com/netbox-community/netbox/issues/5738) - Fix redirect to device components view after disconnecting a cable --- diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index ee1dc091b..7a52b85b0 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -95,6 +95,11 @@ CONSOLEPORT_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif perms.dcim.add_cable %} @@ -115,6 +120,11 @@ CONSOLESERVERPORT_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif perms.dcim.add_cable %} @@ -135,6 +145,11 @@ POWERPORT_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif perms.dcim.add_cable %} @@ -154,6 +169,11 @@ POWEROUTLET_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif perms.dcim.add_cable %} @@ -172,6 +192,11 @@ INTERFACE_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif record.is_connectable and perms.dcim.add_cable %} @@ -193,6 +218,11 @@ FRONTPORT_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif perms.dcim.add_cable %} @@ -216,6 +246,11 @@ REARPORT_BUTTONS = """ {% if record.cable %} {% include 'dcim/inc/cable_toggle_buttons.html' with cable=record.cable %} + {% if perms.dcim.delete_cable %} + + + + {% endif %} {% elif perms.dcim.add_cable %} diff --git a/netbox/templates/dcim/inc/cable_toggle_buttons.html b/netbox/templates/dcim/inc/cable_toggle_buttons.html index 98e4efd94..e3eb318ac 100644 --- a/netbox/templates/dcim/inc/cable_toggle_buttons.html +++ b/netbox/templates/dcim/inc/cable_toggle_buttons.html @@ -9,8 +9,3 @@ {% endif %} {% endif %} -{% if perms.dcim.delete_cable %} - - - -{% endif %} From 5fbe766a0a3e887298ce4c993b282525c0df3a93 Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Thu, 4 Feb 2021 21:36:06 +0100 Subject: [PATCH 104/302] NetBox should always be referred to as NetBox Fix all instances of "Netbox" except the one that is used as an example how not to write it. Ref: docs/development/style-guide.md --- docs/additional-features/prometheus-metrics.md | 2 +- docs/installation/6-ldap.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/additional-features/prometheus-metrics.md b/docs/additional-features/prometheus-metrics.md index 048eb68b3..56365e336 100644 --- a/docs/additional-features/prometheus-metrics.md +++ b/docs/additional-features/prometheus-metrics.md @@ -26,4 +26,4 @@ For the exhaustive list of exposed metrics, visit the `/metrics` endpoint on you When deploying NetBox in a multiprocess manner (e.g. running multiple Gunicorn workers) the Prometheus client library requires the use of a shared directory to collect metrics from all worker processes. To configure this, first create or designate a local directory to which the worker processes have read and write access, and then configure your WSGI service (e.g. Gunicorn) to define this path as the `prometheus_multiproc_dir` environment variable. !!! warning - If having accurate long-term metrics in a multiprocess environment is crucial to your deployment, it's recommended you use the `uwsgi` library instead of `gunicorn`. The issue lies in the way `gunicorn` tracks worker processes (vs `uwsgi`) which helps manage the metrics files created by the above configurations. If you're using Netbox with gunicorn in a containerized enviroment following the one-process-per-container methodology, then you will likely not need to change to `uwsgi`. More details can be found in [issue #3779](https://github.com/netbox-community/netbox/issues/3779#issuecomment-590547562). \ No newline at end of file + If having accurate long-term metrics in a multiprocess environment is crucial to your deployment, it's recommended you use the `uwsgi` library instead of `gunicorn`. The issue lies in the way `gunicorn` tracks worker processes (vs `uwsgi`) which helps manage the metrics files created by the above configurations. If you're using NetBox with gunicorn in a containerized enviroment following the one-process-per-container methodology, then you will likely not need to change to `uwsgi`. More details can be found in [issue #3779](https://github.com/netbox-community/netbox/issues/3779#issuecomment-590547562). diff --git a/docs/installation/6-ldap.md b/docs/installation/6-ldap.md index 25f9c8f2b..1c5424595 100644 --- a/docs/installation/6-ldap.md +++ b/docs/installation/6-ldap.md @@ -140,7 +140,7 @@ AUTH_LDAP_CACHE_TIMEOUT = 3600 ## Troubleshooting LDAP -`systemctl restart netbox` restarts the Netbox service, and initiates any changes made to `ldap_config.py`. If there are syntax errors present, the NetBox process will not spawn an instance, and errors should be logged to `/var/log/messages`. +`systemctl restart netbox` restarts the NetBox service, and initiates any changes made to `ldap_config.py`. If there are syntax errors present, the NetBox process will not spawn an instance, and errors should be logged to `/var/log/messages`. For troubleshooting LDAP user/group queries, add or merge the following [logging](/configuration/optional-settings.md#logging) configuration to `configuration.py`: From 713f02ca3fe7d05a005ef8f0975c62f6bb812052 Mon Sep 17 00:00:00 2001 From: root Date: Sun, 7 Feb 2021 10:31:56 +0000 Subject: [PATCH 105/302] Fixes #5735: enforcement of duplicate IP address detection with roles --- netbox/ipam/models.py | 11 +++++------ netbox/ipam/tests/test_models.py | 12 ++++++++++++ 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/netbox/ipam/models.py b/netbox/ipam/models.py index 0ae9db7b2..e8b3dff0a 100644 --- a/netbox/ipam/models.py +++ b/netbox/ipam/models.py @@ -734,13 +734,12 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): }) # Enforce unique IP space (if applicable) - if self.role not in IPADDRESS_ROLES_NONUNIQUE and (( - self.vrf is None and settings.ENFORCE_GLOBAL_UNIQUE - ) or ( - self.vrf and self.vrf.enforce_unique - )): + if (self.vrf is None and settings.ENFORCE_GLOBAL_UNIQUE) or (self.vrf and self.vrf.enforce_unique): duplicate_ips = self.get_duplicates() - if duplicate_ips: + if duplicate_ips and ( + self.role not in IPADDRESS_ROLES_NONUNIQUE or + any(dip.role not in IPADDRESS_ROLES_NONUNIQUE for dip in duplicate_ips) + ): raise ValidationError({ 'address': "Duplicate IP address found in {}: {}".format( "VRF {}".format(self.vrf) if self.vrf else "global table", diff --git a/netbox/ipam/tests/test_models.py b/netbox/ipam/tests/test_models.py index 6091aa70e..a47862165 100644 --- a/netbox/ipam/tests/test_models.py +++ b/netbox/ipam/tests/test_models.py @@ -259,6 +259,18 @@ class TestIPAddress(TestCase): duplicate_ip = IPAddress(vrf=vrf, address=netaddr.IPNetwork('192.0.2.1/24')) self.assertRaises(ValidationError, duplicate_ip.clean) + @override_settings(ENFORCE_GLOBAL_UNIQUE=True) + def test_duplicate_nonunique_nonrole_role(self): + IPAddress.objects.create(address=netaddr.IPNetwork('192.0.2.1/24')) + duplicate_ip = IPAddress(address=netaddr.IPNetwork('192.0.2.1/24'), role=IPAddressRoleChoices.ROLE_VIP) + self.assertRaises(ValidationError, duplicate_ip.clean) + + @override_settings(ENFORCE_GLOBAL_UNIQUE=True) + def test_duplicate_nonunique_role_nonrole(self): + IPAddress.objects.create(address=netaddr.IPNetwork('192.0.2.1/24'), role=IPAddressRoleChoices.ROLE_VIP) + duplicate_ip = IPAddress(address=netaddr.IPNetwork('192.0.2.1/24')) + self.assertRaises(ValidationError, duplicate_ip.clean) + @override_settings(ENFORCE_GLOBAL_UNIQUE=True) def test_duplicate_nonunique_role(self): IPAddress.objects.create(address=netaddr.IPNetwork('192.0.2.1/24'), role=IPAddressRoleChoices.ROLE_VIP) From 3b53cf5e8458c770e92d1a0477843b9c0d8b5ec6 Mon Sep 17 00:00:00 2001 From: Brian Candler Date: Sun, 7 Feb 2021 19:46:30 +0000 Subject: [PATCH 106/302] Update docs to to create database explicitly with UTF8 encoding. Fixes #5760 --- docs/installation/1-postgresql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/1-postgresql.md b/docs/installation/1-postgresql.md index bcc670e2b..4ac1104d7 100644 --- a/docs/installation/1-postgresql.md +++ b/docs/installation/1-postgresql.md @@ -51,7 +51,7 @@ $ sudo -u postgres psql psql (12.5 (Ubuntu 12.5-0ubuntu0.20.04.1)) Type "help" for help. -postgres=# CREATE DATABASE netbox; +postgres=# CREATE DATABASE netbox ENCODING 'UTF8' LC_COLLATE='C.UTF-8' LC_CTYPE='C.UTF-8'; CREATE DATABASE postgres=# CREATE USER netbox WITH PASSWORD 'J5brHrAXFLQSif0K'; CREATE ROLE From 6c676d21c3d3eed26b330e71eb9ed3bf81c1f9f6 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 8 Feb 2021 15:09:20 -0500 Subject: [PATCH 107/302] Changelog for #5735 --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 94b80ef1c..caf37b1ce 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -6,6 +6,7 @@ * [#5716](https://github.com/netbox-community/netbox/issues/5716) - Fix filtering rack reservations by custom field * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined +* [#5735](https://github.com/netbox-community/netbox/issues/5735) - Ensure consistent treatment of duplicate IP addresses * [#5738](https://github.com/netbox-community/netbox/issues/5738) - Fix redirect to device components view after disconnecting a cable --- From 3d90e3aee9e14875c6caa25f22a62baafa7e065c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 8 Feb 2021 16:44:04 -0500 Subject: [PATCH 108/302] Fixes #5626: Fix REST API representation for circuit terminations connected to non-interface endpoints --- docs/release-notes/version-2.10.md | 1 + netbox/circuits/api/serializers.py | 8 +++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index caf37b1ce..320217a74 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5626](https://github.com/netbox-community/netbox/issues/5626) - Fix REST API representation for circuit terminations connected to non-interface endpoints * [#5716](https://github.com/netbox-community/netbox/issues/5716) - Fix filtering rack reservations by custom field * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined * [#5735](https://github.com/netbox-community/netbox/issues/5735) - Ensure consistent treatment of duplicate IP addresses diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 88890bf95..12ec9ba7f 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -40,14 +40,16 @@ class CircuitTypeSerializer(ValidatedModelSerializer): fields = ['id', 'url', 'name', 'slug', 'description', 'circuit_count'] -class CircuitCircuitTerminationSerializer(WritableNestedSerializer): +class CircuitCircuitTerminationSerializer(WritableNestedSerializer, ConnectedEndpointSerializer): url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittermination-detail') site = NestedSiteSerializer() - connected_endpoint = NestedInterfaceSerializer() class Meta: model = CircuitTermination - fields = ['id', 'url', 'site', 'connected_endpoint', 'port_speed', 'upstream_speed', 'xconnect_id'] + fields = [ + 'id', 'url', 'site', 'port_speed', 'upstream_speed', 'xconnect_id', 'connected_endpoint', + 'connected_endpoint_type', 'connected_endpoint_reachable', + ] class CircuitSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): From 8640f500d1439f3d2deddb4edbe3069ee9594b62 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 9 Feb 2021 13:32:29 -0500 Subject: [PATCH 109/302] Closes #5776: Upgrade pip when running upgrade.sh --- upgrade.sh | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/upgrade.sh b/upgrade.sh index 2e35a02f9..648f825a0 100755 --- a/upgrade.sh +++ b/upgrade.sh @@ -29,19 +29,25 @@ eval $COMMAND || { # Activate the virtual environment source "${VIRTUALENV}/bin/activate" +# Upgrade pip +COMMAND="pip install --upgrade pip" +echo "Updating pip ($COMMAND)..." +eval $COMMAND || exit 1 +pip -V + # Install necessary system packages -COMMAND="pip3 install wheel" +COMMAND="pip install wheel" echo "Installing Python system packages ($COMMAND)..." eval $COMMAND || exit 1 # Install required Python packages -COMMAND="pip3 install -r requirements.txt" +COMMAND="pip install -r requirements.txt" echo "Installing core dependencies ($COMMAND)..." eval $COMMAND || exit 1 # Install optional packages (if any) if [ -s "local_requirements.txt" ]; then - COMMAND="pip3 install -r local_requirements.txt" + COMMAND="pip install -r local_requirements.txt" echo "Installing local dependencies ($COMMAND)..." eval $COMMAND || exit 1 elif [ -f "local_requirements.txt" ]; then From efbda6d5afa9929148a346bbaf5b31011bb08a63 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 9 Feb 2021 15:15:49 -0500 Subject: [PATCH 110/302] Apply stale rules to PRs --- .github/stale.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/stale.yml b/.github/stale.yml index fdfb1d590..92da07e6a 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -1,8 +1,5 @@ # Configuration for Stale (https://github.com/apps/stale) -# Pull requests are exempt from being marked as stale -only: issues - # Number of days of inactivity before an issue becomes stale daysUntilStale: 45 From fa3199d41cd884a7137d612915054b3da5e63935 Mon Sep 17 00:00:00 2001 From: pgnuta Date: Thu, 11 Feb 2021 11:49:57 +1300 Subject: [PATCH 111/302] Update serializers.py Group should be nullable via API to match frontend functionality and Swagger documentation. --- netbox/tenancy/api/serializers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/tenancy/api/serializers.py b/netbox/tenancy/api/serializers.py index 05e83853e..4c2f9faee 100644 --- a/netbox/tenancy/api/serializers.py +++ b/netbox/tenancy/api/serializers.py @@ -24,7 +24,7 @@ class TenantGroupSerializer(ValidatedModelSerializer): class TenantSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='tenancy-api:tenant-detail') - group = NestedTenantGroupSerializer(required=False) + group = NestedTenantGroupSerializer(required=False, allow_null=True) circuit_count = serializers.IntegerField(read_only=True) device_count = serializers.IntegerField(read_only=True) ipaddress_count = serializers.IntegerField(read_only=True) From 3d3748d6f54cd2bd168554b141b5f3541a0b88ac Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Fri, 12 Feb 2021 10:53:40 -0600 Subject: [PATCH 112/302] Fixes: #5315 - Make "null_option" on DynamicModelChoiceField also null the value on the model. (#5704) Fixes: #5315 - Fix site unassignment from VLAN when using "None" option --- docs/release-notes/version-2.10.md | 1 + netbox/utilities/forms/fields.py | 11 ++++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 320217a74..bc3d0e1a5 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -4,6 +4,7 @@ ### Bug Fixes +* [#5315](https://github.com/netbox-community/netbox/issues/5315) - Fix site unassignment from VLAN when using "None" option * [#5626](https://github.com/netbox-community/netbox/issues/5626) - Fix REST API representation for circuit terminations connected to non-interface endpoints * [#5716](https://github.com/netbox-community/netbox/issues/5716) - Fix filtering rack reservations by custom field * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined diff --git a/netbox/utilities/forms/fields.py b/netbox/utilities/forms/fields.py index a5b76fd8d..5f1e06c3b 100644 --- a/netbox/utilities/forms/fields.py +++ b/netbox/utilities/forms/fields.py @@ -5,6 +5,7 @@ from io import StringIO import django_filters from django import forms +from django.conf import settings from django.forms.fields import JSONField as _JSONField, InvalidJSONInput from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist from django.db.models import Count @@ -355,7 +356,15 @@ class DynamicModelChoiceField(DynamicModelChoiceMixin, forms.ModelChoiceField): Override get_bound_field() to avoid pre-populating field choices with a SQL query. The field will be rendered only with choices set via bound data. Choices are populated on-demand via the APISelect widget. """ - pass + + def clean(self, value): + """ + When null option is enabled and "None" is sent as part of a form to be submitted, it is sent as the + string 'null'. This will check for that condition and gracefully handle the conversion to a NoneType. + """ + if self.null_option is not None and value == settings.FILTERS_NULL_CHOICE_VALUE: + return None + return super().clean(value) class DynamicModelMultipleChoiceField(DynamicModelChoiceMixin, forms.ModelMultipleChoiceField): From 4c7c2edf9a2e905bf8b513df3bc030e750e29c70 Mon Sep 17 00:00:00 2001 From: Chris Mills Date: Mon, 22 Feb 2021 23:23:33 +0000 Subject: [PATCH 113/302] Fixes: #5847 - Provide custom CSS for pagination chevrons --- netbox/project-static/css/base.css | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/project-static/css/base.css b/netbox/project-static/css/base.css index 94bd74a46..efdca81be 100644 --- a/netbox/project-static/css/base.css +++ b/netbox/project-static/css/base.css @@ -177,6 +177,10 @@ nav ul.pagination { margin-top: 0; margin-bottom: 8px !important; } +.pagination > li > a > .mdi::before { + top: 0; + font-size: 14px; +} /* Devices */ table.component-list td.subtable { From b392502b9b3ac33669a8fb22213dbad9b4585959 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 14:21:42 -0500 Subject: [PATCH 114/302] Fixes #5841: Disallow the creation of available prefixes/IP addresses in violation of assigned permission constraints --- docs/release-notes/version-2.10.md | 1 + netbox/ipam/api/views.py | 16 ++++++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index bc3d0e1a5..f42522194 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -10,6 +10,7 @@ * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined * [#5735](https://github.com/netbox-community/netbox/issues/5735) - Ensure consistent treatment of duplicate IP addresses * [#5738](https://github.com/netbox-community/netbox/issues/5738) - Fix redirect to device components view after disconnecting a cable +* [#5841](https://github.com/netbox-community/netbox/issues/5841) - Disallow the creation of available prefixes/IP addresses in violation of assigned permission constraints --- diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index c322c249d..16db8f04f 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -1,4 +1,6 @@ from django.conf import settings +from django.core.exceptions import ObjectDoesNotExist, PermissionDenied +from django.db import transaction from django.shortcuts import get_object_or_404 from django_pglocks import advisory_lock from drf_yasg.utils import swagger_auto_schema @@ -162,7 +164,12 @@ class PrefixViewSet(CustomFieldModelViewSet): # Create the new Prefix(es) if serializer.is_valid(): - serializer.save() + try: + with transaction.atomic(): + created = serializer.save() + self._validate_objects(created) + except ObjectDoesNotExist: + raise PermissionDenied() return Response(serializer.data, status=status.HTTP_201_CREATED) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) @@ -225,7 +232,12 @@ class PrefixViewSet(CustomFieldModelViewSet): # Create the new IP address(es) if serializer.is_valid(): - serializer.save() + try: + with transaction.atomic(): + created = serializer.save() + self._validate_objects(created) + except ObjectDoesNotExist: + raise PermissionDenied() return Response(serializer.data, status=status.HTTP_201_CREATED) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) From 04a6e2de9df26e900afeb48b34f677af3e6f9f23 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 14:39:09 -0500 Subject: [PATCH 115/302] Changelog and test for #5786 --- docs/release-notes/version-2.10.md | 1 + netbox/tenancy/tests/test_api.py | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index f42522194..1817edb56 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -10,6 +10,7 @@ * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined * [#5735](https://github.com/netbox-community/netbox/issues/5735) - Ensure consistent treatment of duplicate IP addresses * [#5738](https://github.com/netbox-community/netbox/issues/5738) - Fix redirect to device components view after disconnecting a cable +* [#5786](https://github.com/netbox-community/netbox/issues/5786) - Allow setting null tenant group on tenant via REST API * [#5841](https://github.com/netbox-community/netbox/issues/5841) - Disallow the creation of available prefixes/IP addresses in violation of assigned permission constraints --- diff --git a/netbox/tenancy/tests/test_api.py b/netbox/tenancy/tests/test_api.py index 7af3c8d79..c512ff688 100644 --- a/netbox/tenancy/tests/test_api.py +++ b/netbox/tenancy/tests/test_api.py @@ -56,6 +56,7 @@ class TenantTest(APIViewTestCases.APIViewTestCase): model = Tenant brief_fields = ['id', 'name', 'slug', 'url'] bulk_update_data = { + 'group': None, 'description': 'New description', } From a40f52ee6245df3bae406d39befd9bf82ee83a4b Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 15:02:13 -0500 Subject: [PATCH 116/302] Changelog for #5753 --- docs/release-notes/version-2.10.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 1817edb56..9d086789e 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -10,6 +10,7 @@ * [#5718](https://github.com/netbox-community/netbox/issues/5718) - Fix bulk editing of services when no port(s) are defined * [#5735](https://github.com/netbox-community/netbox/issues/5735) - Ensure consistent treatment of duplicate IP addresses * [#5738](https://github.com/netbox-community/netbox/issues/5738) - Fix redirect to device components view after disconnecting a cable +* [#5753](https://github.com/netbox-community/netbox/issues/5753) - Fix Redis Sentinel password application for caching * [#5786](https://github.com/netbox-community/netbox/issues/5786) - Allow setting null tenant group on tenant via REST API * [#5841](https://github.com/netbox-community/netbox/issues/5841) - Disallow the creation of available prefixes/IP addresses in violation of assigned permission constraints From db781437fc72b19c64cd0b55196d574bf08f3b14 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 15:15:33 -0500 Subject: [PATCH 117/302] Release v2.10.5 --- docs/release-notes/version-2.10.md | 2 +- netbox/netbox/settings.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-2.10.md b/docs/release-notes/version-2.10.md index 9d086789e..2f7079f03 100644 --- a/docs/release-notes/version-2.10.md +++ b/docs/release-notes/version-2.10.md @@ -1,6 +1,6 @@ # NetBox v2.10 -## v2.10.5 (FUTURE) +## v2.10.5 (2021-02-24) ### Bug Fixes diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 1e77619b8..af5f5521b 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.5-dev' +VERSION = '2.10.5' # Hostname HOSTNAME = platform.node() From b1cd634ab4ee0a399075b21031e9f0b559991807 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 15:38:36 -0500 Subject: [PATCH 118/302] PRVB --- netbox/netbox/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index af5f5521b..604b755d8 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -16,7 +16,7 @@ from django.core.validators import URLValidator # Environment setup # -VERSION = '2.10.5' +VERSION = '2.10.6-dev' # Hostname HOSTNAME = platform.node() From 0a6ebdee487d10702123de49646317bd0a28a0e7 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 19:00:14 -0500 Subject: [PATCH 119/302] Upgrade Django to 3.2b1 --- netbox/extras/querysets.py | 5 +++-- netbox/ipam/tests/test_views.py | 1 + netbox/netbox/settings.py | 2 ++ netbox/utilities/query_functions.py | 12 +----------- requirements.txt | 2 +- 5 files changed, 8 insertions(+), 14 deletions(-) diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index fbe7fe903..3710bec46 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -1,7 +1,8 @@ +from django.contrib.postgres.aggregates import JSONBAgg from django.db.models import OuterRef, Subquery, Q from extras.models.tags import TaggedItem -from utilities.query_functions import EmptyGroupByJSONBAgg, OrderableJSONBAgg +from utilities.query_functions import EmptyGroupByJSONBAgg from utilities.querysets import RestrictedQuerySet @@ -47,7 +48,7 @@ class ConfigContextQuerySet(RestrictedQuerySet): if aggregate_data: return queryset.aggregate( - config_context_data=OrderableJSONBAgg('data', ordering=['weight', 'name']) + config_context_data=JSONBAgg('data', ordering=['weight', 'name']) )['config_context_data'] return queryset diff --git a/netbox/ipam/tests/test_views.py b/netbox/ipam/tests/test_views.py index db96bb896..b105ea7d9 100644 --- a/netbox/ipam/tests/test_views.py +++ b/netbox/ipam/tests/test_views.py @@ -210,6 +210,7 @@ class PrefixTestCase(ViewTestCases.PrimaryObjectViewTestCase): Role(name='Role 1', slug='role-1'), Role(name='Role 2', slug='role-2'), ) + Role.objects.bulk_create(roles) Prefix.objects.bulk_create([ Prefix(prefix=IPNetwork('10.1.0.0/16'), vrf=vrfs[0], site=sites[0], role=roles[0]), diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 604b755d8..c1447808e 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -375,6 +375,8 @@ LOGIN_URL = '/{}login/'.format(BASE_PATH) CSRF_TRUSTED_ORIGINS = ALLOWED_HOSTS +DEFAULT_AUTO_FIELD = 'django.db.models.AutoField' + # Exclude potentially sensitive models from wildcard view exemption. These may still be exempted # by specifying the model individually in the EXEMPT_VIEW_PERMISSIONS configuration parameter. EXEMPT_EXCLUDE_MODELS = ( diff --git a/netbox/utilities/query_functions.py b/netbox/utilities/query_functions.py index abdc61b6b..8ad7ceead 100644 --- a/netbox/utilities/query_functions.py +++ b/netbox/utilities/query_functions.py @@ -1,5 +1,4 @@ from django.contrib.postgres.aggregates import JSONBAgg -from django.contrib.postgres.aggregates.mixins import OrderableAggMixin from django.db.models import F, Func @@ -11,19 +10,10 @@ class CollateAsChar(Func): template = '(%(expressions)s) COLLATE "%(function)s"' -class OrderableJSONBAgg(OrderableAggMixin, JSONBAgg): - """ - TODO in Django 3.2 ordering is supported natively on JSONBAgg so this is no longer needed. - """ - template = '%(function)s(%(distinct)s%(expressions)s %(ordering)s)' - - -class EmptyGroupByJSONBAgg(OrderableJSONBAgg): +class EmptyGroupByJSONBAgg(JSONBAgg): """ JSONBAgg is a builtin aggregation function which means it includes the use of a GROUP BY clause. When used as an annotation for collecting config context data objects, the GROUP BY is incorrect. This subclass overrides the Django ORM aggregation control to remove the GROUP BY. - - TODO in Django 3.2 ordering is supported natively on JSONBAgg so we only need to inherit from JSONBAgg. """ contains_aggregate = False diff --git a/requirements.txt b/requirements.txt index 18ce530fd..f9e616c5e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -Django==3.1.3 +Django==3.2b1 django-cacheops==5.1 django-cors-headers==3.5.0 django-debug-toolbar==3.1.1 From bec7ea7072364d7e99b28968a5e197050b0e5c54 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 21:01:16 -0500 Subject: [PATCH 120/302] Standardize model types based on function --- .../migrations/0025_standardize_models.py | 37 ++ netbox/circuits/models.py | 12 +- .../migrations/0123_standardize_models.py | 462 ++++++++++++++++++ netbox/dcim/models/cables.py | 7 +- .../dcim/models/device_component_templates.py | 12 +- netbox/dcim/models/device_components.py | 21 +- netbox/dcim/models/devices.py | 19 +- netbox/dcim/models/power.py | 7 +- netbox/dcim/models/racks.py | 33 +- netbox/dcim/models/sites.py | 28 +- .../migrations/0054_standardize_models.py | 67 +++ netbox/extras/models/__init__.py | 3 +- netbox/extras/models/change_logging.py | 42 +- netbox/extras/models/customfields.py | 5 +- netbox/extras/models/models.py | 14 +- netbox/extras/models/tags.py | 6 +- .../migrations/0044_standardize_models.py | 77 +++ netbox/ipam/models/__init__.py | 17 + netbox/ipam/{models.py => models/ip.py} | 435 +---------------- netbox/ipam/models/services.py | 109 +++++ netbox/ipam/models/vlans.py | 202 ++++++++ netbox/ipam/models/vrfs.py | 139 ++++++ netbox/netbox/models.py | 184 +++++++ .../migrations/0013_standardize_models.py | 37 ++ netbox/secrets/models.py | 12 +- .../migrations/0012_standardize_models.py | 27 + netbox/tenancy/models.py | 24 +- .../migrations/0011_standardize_models.py | 26 + netbox/users/models.py | 7 +- .../migrations/0020_standardize_models.py | 62 +++ netbox/virtualization/models.py | 15 +- 31 files changed, 1569 insertions(+), 579 deletions(-) create mode 100644 netbox/circuits/migrations/0025_standardize_models.py create mode 100644 netbox/dcim/migrations/0123_standardize_models.py create mode 100644 netbox/extras/migrations/0054_standardize_models.py create mode 100644 netbox/ipam/migrations/0044_standardize_models.py create mode 100644 netbox/ipam/models/__init__.py rename netbox/ipam/{models.py => models/ip.py} (64%) create mode 100644 netbox/ipam/models/services.py create mode 100644 netbox/ipam/models/vlans.py create mode 100644 netbox/ipam/models/vrfs.py create mode 100644 netbox/netbox/models.py create mode 100644 netbox/secrets/migrations/0013_standardize_models.py create mode 100644 netbox/tenancy/migrations/0012_standardize_models.py create mode 100644 netbox/users/migrations/0011_standardize_models.py create mode 100644 netbox/virtualization/migrations/0020_standardize_models.py diff --git a/netbox/circuits/migrations/0025_standardize_models.py b/netbox/circuits/migrations/0025_standardize_models.py new file mode 100644 index 000000000..2b1d2664e --- /dev/null +++ b/netbox/circuits/migrations/0025_standardize_models.py @@ -0,0 +1,37 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('circuits', '0024_standardize_name_length'), + ] + + operations = [ + migrations.AddField( + model_name='circuittype', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AlterField( + model_name='circuit', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='circuittermination', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='circuittype', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='provider', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/circuits/models.py b/netbox/circuits/models.py index 3d6d5d232..e371df547 100644 --- a/netbox/circuits/models.py +++ b/netbox/circuits/models.py @@ -4,8 +4,9 @@ from taggit.managers import TaggableManager from dcim.fields import ASNField from dcim.models import CableTermination, PathEndpoint -from extras.models import ChangeLoggedModel, CustomFieldModel, ObjectChange, TaggedItem +from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features +from netbox.models import BigIDModel, OrganizationalModel, PrimaryModel from utilities.querysets import RestrictedQuerySet from utilities.utils import serialize_object from .choices import * @@ -21,7 +22,7 @@ __all__ = ( @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Provider(ChangeLoggedModel, CustomFieldModel): +class Provider(PrimaryModel): """ Each Circuit belongs to a Provider. This is usually a telecommunications company or similar organization. This model stores information pertinent to the user's relationship with the Provider. @@ -93,7 +94,8 @@ class Provider(ChangeLoggedModel, CustomFieldModel): ) -class CircuitType(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class CircuitType(OrganizationalModel): """ Circuits can be organized by their functional role. For example, a user might wish to define CircuitTypes named "Long Haul," "Metro," or "Out-of-Band". @@ -133,7 +135,7 @@ class CircuitType(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Circuit(ChangeLoggedModel, CustomFieldModel): +class Circuit(PrimaryModel): """ A communications circuit connects two points. Each Circuit belongs to a Provider; Providers may have multiple circuits. Each circuit is also assigned a CircuitType and a Site. Circuit port speed and commit rate are measured @@ -233,7 +235,7 @@ class Circuit(ChangeLoggedModel, CustomFieldModel): return self._get_termination('Z') -class CircuitTermination(PathEndpoint, CableTermination): +class CircuitTermination(BigIDModel, PathEndpoint, CableTermination): circuit = models.ForeignKey( to='circuits.Circuit', on_delete=models.CASCADE, diff --git a/netbox/dcim/migrations/0123_standardize_models.py b/netbox/dcim/migrations/0123_standardize_models.py new file mode 100644 index 000000000..5050e1a26 --- /dev/null +++ b/netbox/dcim/migrations/0123_standardize_models.py @@ -0,0 +1,462 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0122_standardize_name_length'), + ] + + operations = [ + migrations.AddField( + model_name='consoleport', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='consoleport', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='consoleport', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='consoleporttemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='consoleporttemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='consoleporttemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='consoleserverport', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='consoleserverport', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='consoleserverport', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='consoleserverporttemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='consoleserverporttemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='consoleserverporttemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='devicebay', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='devicebay', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='devicebay', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='devicebaytemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='devicebaytemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='devicebaytemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='devicerole', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='frontport', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='frontport', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='frontport', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='frontporttemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='frontporttemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='frontporttemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='interface', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='interface', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='interface', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='interfacetemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='interfacetemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='interfacetemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='inventoryitem', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='inventoryitem', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='inventoryitem', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='manufacturer', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='platform', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='poweroutlet', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='poweroutlet', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='poweroutlet', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='poweroutlettemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='poweroutlettemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='poweroutlettemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='powerport', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='powerport', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='powerport', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='powerporttemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='powerporttemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='powerporttemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='rackgroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='rackrole', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='rearport', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='rearport', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='rearport', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='rearporttemplate', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='rearporttemplate', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='rearporttemplate', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AddField( + model_name='region', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AlterField( + model_name='cable', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='cablepath', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='consoleport', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='consoleporttemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='consoleserverport', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='consoleserverporttemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='device', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='devicebay', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='devicebaytemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='devicerole', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='devicetype', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='frontport', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='frontporttemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='interface', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='interfacetemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='inventoryitem', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='manufacturer', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='platform', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='powerfeed', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='poweroutlet', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='poweroutlettemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='powerpanel', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='powerport', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='powerporttemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rack', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rackgroup', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rackreservation', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rackrole', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rearport', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rearporttemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='region', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='site', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='virtualchassis', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 6a530bb49..06ae150d4 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -12,8 +12,9 @@ from dcim.choices import * from dcim.constants import * from dcim.fields import PathField from dcim.utils import decompile_path_node, object_to_path_node, path_node_to_object -from extras.models import ChangeLoggedModel, CustomFieldModel, TaggedItem +from extras.models import TaggedItem from extras.utils import extras_features +from netbox.models import BigIDModel, PrimaryModel from utilities.fields import ColorField from utilities.querysets import RestrictedQuerySet from utilities.utils import to_meters @@ -32,7 +33,7 @@ __all__ = ( # @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Cable(ChangeLoggedModel, CustomFieldModel): +class Cable(PrimaryModel): """ A physical connection between two endpoints. """ @@ -305,7 +306,7 @@ class Cable(ChangeLoggedModel, CustomFieldModel): return COMPATIBLE_TERMINATION_TYPES[self.termination_a._meta.model_name] -class CablePath(models.Model): +class CablePath(BigIDModel): """ A CablePath instance represents the physical path from an origin to a destination, including all intermediate elements in the path. Every instance must specify an `origin`, whereas `destination` may be null (for paths which do diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index e52fe2602..7b718936d 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -5,6 +5,8 @@ from django.db import models from dcim.choices import * from dcim.constants import * from extras.models import ObjectChange +from extras.utils import extras_features +from netbox.models import PrimaryModel from utilities.fields import NaturalOrderingField from utilities.querysets import RestrictedQuerySet from utilities.ordering import naturalize_interface @@ -26,7 +28,7 @@ __all__ = ( ) -class ComponentTemplateModel(models.Model): +class ComponentTemplateModel(PrimaryModel): device_type = models.ForeignKey( to='dcim.DeviceType', on_delete=models.CASCADE, @@ -82,6 +84,7 @@ class ComponentTemplateModel(models.Model): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class ConsolePortTemplate(ComponentTemplateModel): """ A template for a ConsolePort to be created for a new Device. @@ -105,6 +108,7 @@ class ConsolePortTemplate(ComponentTemplateModel): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class ConsoleServerPortTemplate(ComponentTemplateModel): """ A template for a ConsoleServerPort to be created for a new Device. @@ -128,6 +132,7 @@ class ConsoleServerPortTemplate(ComponentTemplateModel): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class PowerPortTemplate(ComponentTemplateModel): """ A template for a PowerPort to be created for a new Device. @@ -174,6 +179,7 @@ class PowerPortTemplate(ComponentTemplateModel): }) +@extras_features('custom_fields', 'export_templates', 'webhooks') class PowerOutletTemplate(ComponentTemplateModel): """ A template for a PowerOutlet to be created for a new Device. @@ -225,6 +231,7 @@ class PowerOutletTemplate(ComponentTemplateModel): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class InterfaceTemplate(ComponentTemplateModel): """ A template for a physical data interface on a new Device. @@ -259,6 +266,7 @@ class InterfaceTemplate(ComponentTemplateModel): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class FrontPortTemplate(ComponentTemplateModel): """ Template for a pass-through port on the front of a new Device. @@ -319,6 +327,7 @@ class FrontPortTemplate(ComponentTemplateModel): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class RearPortTemplate(ComponentTemplateModel): """ Template for a pass-through port on the rear of a new Device. @@ -349,6 +358,7 @@ class RearPortTemplate(ComponentTemplateModel): ) +@extras_features('custom_fields', 'export_templates', 'webhooks') class DeviceBayTemplate(ComponentTemplateModel): """ A template for a DeviceBay to be created for a new parent Device. diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 452aacb56..f78363ba9 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -13,6 +13,7 @@ from dcim.constants import * from dcim.fields import MACAddressField from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features +from netbox.models import PrimaryModel from utilities.fields import NaturalOrderingField from utilities.mptt import TreeManager from utilities.ordering import naturalize_interface @@ -37,7 +38,7 @@ __all__ = ( ) -class ComponentModel(models.Model): +class ComponentModel(PrimaryModel): """ An abstract model inherited by any model which has a parent Device. """ @@ -198,7 +199,7 @@ class PathEndpoint(models.Model): # Console ports # -@extras_features('export_templates', 'webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class ConsolePort(CableTermination, PathEndpoint, ComponentModel): """ A physical console port within a Device. ConsolePorts connect to ConsoleServerPorts. @@ -234,7 +235,7 @@ class ConsolePort(CableTermination, PathEndpoint, ComponentModel): # Console server ports # -@extras_features('webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel): """ A physical port within a Device (typically a designated console server) which provides access to ConsolePorts. @@ -270,7 +271,7 @@ class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel): # Power ports # -@extras_features('export_templates', 'webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class PowerPort(CableTermination, PathEndpoint, ComponentModel): """ A physical power supply (intake) port within a Device. PowerPorts connect to PowerOutlets. @@ -379,7 +380,7 @@ class PowerPort(CableTermination, PathEndpoint, ComponentModel): # Power outlets # -@extras_features('webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class PowerOutlet(CableTermination, PathEndpoint, ComponentModel): """ A physical power outlet (output) within a Device which provides power to a PowerPort. @@ -479,7 +480,7 @@ class BaseInterface(models.Model): return super().save(*args, **kwargs) -@extras_features('export_templates', 'webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): """ A network interface within a Device. A physical Interface can connect to exactly one other Interface. @@ -624,7 +625,7 @@ class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): # Pass-through ports # -@extras_features('webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class FrontPort(CableTermination, ComponentModel): """ A pass-through port on the front of a Device. @@ -687,7 +688,7 @@ class FrontPort(CableTermination, ComponentModel): }) -@extras_features('webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class RearPort(CableTermination, ComponentModel): """ A pass-through port on the rear of a Device. @@ -740,7 +741,7 @@ class RearPort(CableTermination, ComponentModel): # Device bays # -@extras_features('webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class DeviceBay(ComponentModel): """ An empty space within a Device which can house a child device @@ -800,7 +801,7 @@ class DeviceBay(ComponentModel): # Inventory items # -@extras_features('export_templates', 'webhooks') +@extras_features('custom_fields', 'export_templates', 'webhooks') class InventoryItem(MPTTModel, ComponentModel): """ An InventoryItem represents a serialized piece of hardware within a Device, such as a line card or power supply. diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index 29818ab98..e73e4e73c 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -13,9 +13,10 @@ from taggit.managers import TaggableManager from dcim.choices import * from dcim.constants import * -from extras.models import ChangeLoggedModel, ConfigContextModel, CustomFieldModel, TaggedItem +from extras.models import ConfigContextModel, TaggedItem from extras.querysets import ConfigContextModelQuerySet from extras.utils import extras_features +from netbox.models import OrganizationalModel, PrimaryModel from utilities.choices import ColorChoices from utilities.fields import ColorField, NaturalOrderingField from utilities.querysets import RestrictedQuerySet @@ -36,8 +37,8 @@ __all__ = ( # Device Types # -@extras_features('export_templates', 'webhooks') -class Manufacturer(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class Manufacturer(OrganizationalModel): """ A Manufacturer represents a company which produces hardware devices; for example, Juniper or Dell. """ @@ -76,7 +77,7 @@ class Manufacturer(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class DeviceType(ChangeLoggedModel, CustomFieldModel): +class DeviceType(PrimaryModel): """ A DeviceType represents a particular make (Manufacturer) and model of device. It specifies rack height and depth, as well as high-level functional role(s). @@ -338,7 +339,8 @@ class DeviceType(ChangeLoggedModel, CustomFieldModel): # Devices # -class DeviceRole(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class DeviceRole(OrganizationalModel): """ Devices are organized by functional role; for example, "Core Switch" or "File Server". Each DeviceRole is assigned a color to be used when displaying rack elevations. The vm_role field determines whether the role is applicable to @@ -385,7 +387,8 @@ class DeviceRole(ChangeLoggedModel): ) -class Platform(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class Platform(OrganizationalModel): """ Platform refers to the software or firmware running on a Device. For example, "Cisco IOS-XR" or "Juniper Junos". NetBox uses Platforms to determine how to interact with devices when pulling inventory data or other information by @@ -449,7 +452,7 @@ class Platform(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): +class Device(PrimaryModel, ConfigContextModel): """ A Device represents a piece of physical hardware mounted within a Rack. Each Device is assigned a DeviceType, DeviceRole, and (optionally) a Platform. Device names are not required, however if one is set it must be unique. @@ -882,7 +885,7 @@ class Device(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): # @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class VirtualChassis(ChangeLoggedModel, CustomFieldModel): +class VirtualChassis(PrimaryModel): """ A collection of Devices which operate with a shared control plane (e.g. a switch stack). """ diff --git a/netbox/dcim/models/power.py b/netbox/dcim/models/power.py index 1215ced4c..25b13f10b 100644 --- a/netbox/dcim/models/power.py +++ b/netbox/dcim/models/power.py @@ -6,8 +6,9 @@ from taggit.managers import TaggableManager from dcim.choices import * from dcim.constants import * -from extras.models import ChangeLoggedModel, CustomFieldModel, TaggedItem +from extras.models import TaggedItem from extras.utils import extras_features +from netbox.models import PrimaryModel from utilities.querysets import RestrictedQuerySet from utilities.validators import ExclusionValidator from .device_components import CableTermination, PathEndpoint @@ -23,7 +24,7 @@ __all__ = ( # @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class PowerPanel(ChangeLoggedModel, CustomFieldModel): +class PowerPanel(PrimaryModel): """ A distribution point for electrical power; e.g. a data center RPP. """ @@ -74,7 +75,7 @@ class PowerPanel(ChangeLoggedModel, CustomFieldModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class PowerFeed(ChangeLoggedModel, PathEndpoint, CableTermination, CustomFieldModel): +class PowerFeed(PrimaryModel, PathEndpoint, CableTermination): """ An electrical circuit delivered from a PowerPanel. """ diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index dfaf7da61..c4ec76525 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -10,14 +10,15 @@ from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models from django.db.models import Count, Sum from django.urls import reverse -from mptt.models import MPTTModel, TreeForeignKey +from mptt.models import TreeForeignKey from taggit.managers import TaggableManager from dcim.choices import * from dcim.constants import * from dcim.elevations import RackElevationSVG -from extras.models import ChangeLoggedModel, CustomFieldModel, ObjectChange, TaggedItem +from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features +from netbox.models import NestedGroupModel, OrganizationalModel, PrimaryModel from utilities.choices import ColorChoices from utilities.fields import ColorField, NaturalOrderingField from utilities.querysets import RestrictedQuerySet @@ -39,8 +40,8 @@ __all__ = ( # Racks # -@extras_features('export_templates') -class RackGroup(MPTTModel, ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class RackGroup(NestedGroupModel): """ Racks can be grouped as subsets within a Site. The scope of a group will depend on how Sites are defined. For example, if a Site spans a corporate campus, a RackGroup might be defined to represent each building within that @@ -70,8 +71,6 @@ class RackGroup(MPTTModel, ChangeLoggedModel): blank=True ) - objects = TreeManager() - csv_headers = ['site', 'parent', 'name', 'slug', 'description'] class Meta: @@ -81,12 +80,6 @@ class RackGroup(MPTTModel, ChangeLoggedModel): ['site', 'slug'], ] - class MPTTMeta: - order_insertion_by = ['name'] - - def __str__(self): - return self.name - def get_absolute_url(self): return "{}?group_id={}".format(reverse('dcim:rack_list'), self.pk) @@ -99,15 +92,6 @@ class RackGroup(MPTTModel, ChangeLoggedModel): self.description, ) - def to_objectchange(self, action): - # Remove MPTT-internal fields - return ObjectChange( - changed_object=self, - object_repr=str(self), - action=action, - object_data=serialize_object(self, exclude=['level', 'lft', 'rght', 'tree_id']) - ) - def clean(self): super().clean() @@ -116,7 +100,8 @@ class RackGroup(MPTTModel, ChangeLoggedModel): raise ValidationError(f"Parent rack group ({self.parent}) must belong to the same site ({self.site})") -class RackRole(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class RackRole(OrganizationalModel): """ Racks can be organized by functional role, similar to Devices. """ @@ -159,7 +144,7 @@ class RackRole(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Rack(ChangeLoggedModel, CustomFieldModel): +class Rack(PrimaryModel): """ Devices are housed within Racks. Each rack has a defined height measured in rack units, and a front and rear face. Each Rack is assigned to a Site and (optionally) a RackGroup. @@ -550,7 +535,7 @@ class Rack(ChangeLoggedModel, CustomFieldModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class RackReservation(ChangeLoggedModel, CustomFieldModel): +class RackReservation(PrimaryModel): """ One or more reserved units within a Rack. """ diff --git a/netbox/dcim/models/sites.py b/netbox/dcim/models/sites.py index 923b33124..92d8e1b26 100644 --- a/netbox/dcim/models/sites.py +++ b/netbox/dcim/models/sites.py @@ -1,15 +1,16 @@ from django.contrib.contenttypes.fields import GenericRelation from django.db import models from django.urls import reverse -from mptt.models import MPTTModel, TreeForeignKey +from mptt.models import TreeForeignKey from taggit.managers import TaggableManager from timezone_field import TimeZoneField from dcim.choices import * from dcim.constants import * from dcim.fields import ASNField -from extras.models import ChangeLoggedModel, CustomFieldModel, ObjectChange, TaggedItem +from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features +from netbox.models import NestedGroupModel, PrimaryModel from utilities.fields import NaturalOrderingField from utilities.querysets import RestrictedQuerySet from utilities.mptt import TreeManager @@ -25,8 +26,8 @@ __all__ = ( # Regions # -@extras_features('export_templates', 'webhooks') -class Region(MPTTModel, ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class Region(NestedGroupModel): """ Sites can be grouped within geographic Regions. """ @@ -51,16 +52,8 @@ class Region(MPTTModel, ChangeLoggedModel): blank=True ) - objects = TreeManager() - csv_headers = ['name', 'slug', 'parent', 'description'] - class MPTTMeta: - order_insertion_by = ['name'] - - def __str__(self): - return self.name - def get_absolute_url(self): return "{}?region={}".format(reverse('dcim:site_list'), self.slug) @@ -78,22 +71,13 @@ class Region(MPTTModel, ChangeLoggedModel): Q(region__in=self.get_descendants()) ).count() - def to_objectchange(self, action): - # Remove MPTT-internal fields - return ObjectChange( - changed_object=self, - object_repr=str(self), - action=action, - object_data=serialize_object(self, exclude=['level', 'lft', 'rght', 'tree_id']) - ) - # # Sites # @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Site(ChangeLoggedModel, CustomFieldModel): +class Site(PrimaryModel): """ A Site represents a geographic location within a network; typically a building or campus. The optional facility field can be used to include an external designation, such as a data center name (e.g. Equinix SV6). diff --git a/netbox/extras/migrations/0054_standardize_models.py b/netbox/extras/migrations/0054_standardize_models.py new file mode 100644 index 000000000..a836f365f --- /dev/null +++ b/netbox/extras/migrations/0054_standardize_models.py @@ -0,0 +1,67 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0053_rename_webhook_obj_type'), + ] + + operations = [ + migrations.AddField( + model_name='configcontext', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AlterField( + model_name='configcontext', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='customfield', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='customlink', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='exporttemplate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='imageattachment', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='jobresult', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='objectchange', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='tag', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='taggeditem', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='webhook', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/extras/models/__init__.py b/netbox/extras/models/__init__.py index c6191bbd2..daeed8223 100644 --- a/netbox/extras/models/__init__.py +++ b/netbox/extras/models/__init__.py @@ -1,4 +1,4 @@ -from .change_logging import ChangeLoggedModel, ObjectChange +from .change_logging import ObjectChange from .customfields import CustomField, CustomFieldModel from .models import ( ConfigContext, ConfigContextModel, CustomLink, ExportTemplate, ImageAttachment, JobResult, Report, Script, @@ -7,7 +7,6 @@ from .models import ( from .tags import Tag, TaggedItem __all__ = ( - 'ChangeLoggedModel', 'ConfigContext', 'ConfigContextModel', 'CustomField', diff --git a/netbox/extras/models/change_logging.py b/netbox/extras/models/change_logging.py index 52ffd38f9..a06043e7b 100644 --- a/netbox/extras/models/change_logging.py +++ b/netbox/extras/models/change_logging.py @@ -4,48 +4,12 @@ from django.contrib.contenttypes.models import ContentType from django.db import models from django.urls import reverse -from utilities.querysets import RestrictedQuerySet -from utilities.utils import serialize_object from extras.choices import * +from netbox.models import BigIDModel +from utilities.querysets import RestrictedQuerySet -# -# Change logging -# - -class ChangeLoggedModel(models.Model): - """ - An abstract model which adds fields to store the creation and last-updated times for an object. Both fields can be - null to facilitate adding these fields to existing instances via a database migration. - """ - created = models.DateField( - auto_now_add=True, - blank=True, - null=True - ) - last_updated = models.DateTimeField( - auto_now=True, - blank=True, - null=True - ) - - class Meta: - abstract = True - - def to_objectchange(self, action): - """ - Return a new ObjectChange representing a change made to this object. This will typically be called automatically - by ChangeLoggingMiddleware. - """ - return ObjectChange( - changed_object=self, - object_repr=str(self), - action=action, - object_data=serialize_object(self) - ) - - -class ObjectChange(models.Model): +class ObjectChange(BigIDModel): """ Record a change to an object and the user account associated with that change. A change record may optionally indicate an object related to the one being changed. For example, a change to an interface may also indicate the diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index a69816d21..05ac2a222 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -12,12 +12,13 @@ from django.utils.safestring import mark_safe from extras.choices import * from extras.utils import FeatureQuery +from netbox.models import BigIDModel from utilities.forms import CSVChoiceField, DatePicker, LaxURLField, StaticSelect2, add_blank_choice from utilities.querysets import RestrictedQuerySet from utilities.validators import validate_regex -class CustomFieldModel(models.Model): +class CustomFieldModel(BigIDModel): """ Abstract class for any model which may have custom fields associated with it. """ @@ -77,7 +78,7 @@ class CustomFieldManager(models.Manager.from_queryset(RestrictedQuerySet)): return self.get_queryset().filter(content_types=content_type) -class CustomField(models.Model): +class CustomField(BigIDModel): content_types = models.ManyToManyField( to=ContentType, related_name='custom_fields', diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index 4917a7e44..d60a2cc96 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -14,9 +14,9 @@ from rest_framework.utils.encoders import JSONEncoder from extras.choices import * from extras.constants import * -from extras.models import ChangeLoggedModel from extras.querysets import ConfigContextQuerySet from extras.utils import extras_features, FeatureQuery, image_upload +from netbox.models import BigIDModel, PrimaryModel from utilities.querysets import RestrictedQuerySet from utilities.utils import deepmerge, render_jinja2 @@ -25,7 +25,7 @@ from utilities.utils import deepmerge, render_jinja2 # Webhooks # -class Webhook(models.Model): +class Webhook(BigIDModel): """ A Webhook defines a request that will be sent to a remote application when an object is created, updated, and/or delete in NetBox. The request will contain a representation of the object, which the remote application can act on. @@ -158,7 +158,7 @@ class Webhook(models.Model): # Custom links # -class CustomLink(models.Model): +class CustomLink(BigIDModel): """ A custom link to an external representation of a NetBox object. The link text and URL fields accept Jinja2 template code to be rendered with an object as context. @@ -210,7 +210,7 @@ class CustomLink(models.Model): # Export templates # -class ExportTemplate(models.Model): +class ExportTemplate(BigIDModel): content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, @@ -285,7 +285,7 @@ class ExportTemplate(models.Model): # Image attachments # -class ImageAttachment(models.Model): +class ImageAttachment(BigIDModel): """ An uploaded image which is associated with an object. """ @@ -361,7 +361,7 @@ class ImageAttachment(models.Model): # Config contexts # -class ConfigContext(ChangeLoggedModel): +class ConfigContext(PrimaryModel): """ A ConfigContext represents a set of arbitrary data available to any Device or VirtualMachine matching its assigned qualifiers (region, site, etc.). For example, the data stored in a ConfigContext assigned to site A and tenant B @@ -526,7 +526,7 @@ class Report(models.Model): # Job results # -class JobResult(models.Model): +class JobResult(BigIDModel): """ This model stores the results from running a user-defined report. """ diff --git a/netbox/extras/models/tags.py b/netbox/extras/models/tags.py index 4b5acdc76..22e9815a9 100644 --- a/netbox/extras/models/tags.py +++ b/netbox/extras/models/tags.py @@ -2,7 +2,7 @@ from django.db import models from django.utils.text import slugify from taggit.models import TagBase, GenericTaggedItemBase -from extras.models import ChangeLoggedModel +from netbox.models import BigIDModel, CoreModel from utilities.choices import ColorChoices from utilities.fields import ColorField from utilities.querysets import RestrictedQuerySet @@ -12,7 +12,7 @@ from utilities.querysets import RestrictedQuerySet # Tags # -class Tag(TagBase, ChangeLoggedModel): +class Tag(TagBase, CoreModel): color = ColorField( default=ColorChoices.COLOR_GREY ) @@ -44,7 +44,7 @@ class Tag(TagBase, ChangeLoggedModel): ) -class TaggedItem(GenericTaggedItemBase): +class TaggedItem(BigIDModel, GenericTaggedItemBase): tag = models.ForeignKey( to=Tag, related_name="%(app_label)s_%(class)s_items", diff --git a/netbox/ipam/migrations/0044_standardize_models.py b/netbox/ipam/migrations/0044_standardize_models.py new file mode 100644 index 000000000..2762c9973 --- /dev/null +++ b/netbox/ipam/migrations/0044_standardize_models.py @@ -0,0 +1,77 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('ipam', '0043_add_tenancy_to_aggregates'), + ] + + operations = [ + migrations.AddField( + model_name='rir', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='role', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='vlangroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AlterField( + model_name='aggregate', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='ipaddress', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='prefix', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='rir', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='role', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='routetarget', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='service', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='vlan', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='vlangroup', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='vrf', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/ipam/models/__init__.py b/netbox/ipam/models/__init__.py new file mode 100644 index 000000000..7eecf8cfc --- /dev/null +++ b/netbox/ipam/models/__init__.py @@ -0,0 +1,17 @@ +from .ip import * +from .services import * +from .vlans import * +from .vrfs import * + +__all__ = ( + 'Aggregate', + 'IPAddress', + 'Prefix', + 'RIR', + 'Role', + 'RouteTarget', + 'Service', + 'VLAN', + 'VLANGroup', + 'VRF', +) diff --git a/netbox/ipam/models.py b/netbox/ipam/models/ip.py similarity index 64% rename from netbox/ipam/models.py rename to netbox/ipam/models/ip.py index e8b3dff0a..d8d118a99 100644 --- a/netbox/ipam/models.py +++ b/netbox/ipam/models/ip.py @@ -2,26 +2,25 @@ import netaddr from django.conf import settings from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType -from django.contrib.postgres.fields import ArrayField from django.core.exceptions import ValidationError -from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models from django.db.models import F from django.urls import reverse from taggit.managers import TaggableManager -from dcim.models import Device, Interface -from extras.models import ChangeLoggedModel, CustomFieldModel, ObjectChange, TaggedItem +from dcim.models import Device +from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features +from netbox.models import OrganizationalModel, PrimaryModel +from ipam.choices import * +from ipam.constants import * +from ipam.fields import IPNetworkField, IPAddressField +from ipam.managers import IPAddressManager +from ipam.querysets import PrefixQuerySet +from ipam.validators import DNSValidator from utilities.querysets import RestrictedQuerySet -from utilities.utils import array_to_string, serialize_object -from virtualization.models import VirtualMachine, VMInterface -from .choices import * -from .constants import * -from .fields import IPNetworkField, IPAddressField -from .managers import IPAddressManager -from .querysets import PrefixQuerySet -from .validators import DNSValidator +from utilities.utils import serialize_object +from virtualization.models import VirtualMachine __all__ = ( @@ -30,139 +29,11 @@ __all__ = ( 'Prefix', 'RIR', 'Role', - 'RouteTarget', - 'Service', - 'VLAN', - 'VLANGroup', - 'VRF', ) -@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class VRF(ChangeLoggedModel, CustomFieldModel): - """ - A virtual routing and forwarding (VRF) table represents a discrete layer three forwarding domain (e.g. a routing - table). Prefixes and IPAddresses can optionally be assigned to VRFs. (Prefixes and IPAddresses not assigned to a VRF - are said to exist in the "global" table.) - """ - name = models.CharField( - max_length=100 - ) - rd = models.CharField( - max_length=VRF_RD_MAX_LENGTH, - unique=True, - blank=True, - null=True, - verbose_name='Route distinguisher', - help_text='Unique route distinguisher (as defined in RFC 4364)' - ) - tenant = models.ForeignKey( - to='tenancy.Tenant', - on_delete=models.PROTECT, - related_name='vrfs', - blank=True, - null=True - ) - enforce_unique = models.BooleanField( - default=True, - verbose_name='Enforce unique space', - help_text='Prevent duplicate prefixes/IP addresses within this VRF' - ) - description = models.CharField( - max_length=200, - blank=True - ) - import_targets = models.ManyToManyField( - to='ipam.RouteTarget', - related_name='importing_vrfs', - blank=True - ) - export_targets = models.ManyToManyField( - to='ipam.RouteTarget', - related_name='exporting_vrfs', - blank=True - ) - tags = TaggableManager(through=TaggedItem) - - objects = RestrictedQuerySet.as_manager() - - csv_headers = ['name', 'rd', 'tenant', 'enforce_unique', 'description'] - clone_fields = [ - 'tenant', 'enforce_unique', 'description', - ] - - class Meta: - ordering = ('name', 'rd', 'pk') # (name, rd) may be non-unique - verbose_name = 'VRF' - verbose_name_plural = 'VRFs' - - def __str__(self): - return self.display_name or super().__str__() - - def get_absolute_url(self): - return reverse('ipam:vrf', args=[self.pk]) - - def to_csv(self): - return ( - self.name, - self.rd, - self.tenant.name if self.tenant else None, - self.enforce_unique, - self.description, - ) - - @property - def display_name(self): - if self.rd: - return f'{self.name} ({self.rd})' - return self.name - - -@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class RouteTarget(ChangeLoggedModel, CustomFieldModel): - """ - A BGP extended community used to control the redistribution of routes among VRFs, as defined in RFC 4364. - """ - name = models.CharField( - max_length=VRF_RD_MAX_LENGTH, # Same format options as VRF RD (RFC 4360 section 4) - unique=True, - help_text='Route target value (formatted in accordance with RFC 4360)' - ) - description = models.CharField( - max_length=200, - blank=True - ) - tenant = models.ForeignKey( - to='tenancy.Tenant', - on_delete=models.PROTECT, - related_name='route_targets', - blank=True, - null=True - ) - tags = TaggableManager(through=TaggedItem) - - objects = RestrictedQuerySet.as_manager() - - csv_headers = ['name', 'description', 'tenant'] - - class Meta: - ordering = ['name'] - - def __str__(self): - return self.name - - def get_absolute_url(self): - return reverse('ipam:routetarget', args=[self.pk]) - - def to_csv(self): - return ( - self.name, - self.description, - self.tenant.name if self.tenant else None, - ) - - -class RIR(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class RIR(OrganizationalModel): """ A Regional Internet Registry (RIR) is responsible for the allocation of a large portion of the global IP address space. This can be an organization like ARIN or RIPE, or a governing standard such as RFC 1918. @@ -210,7 +81,7 @@ class RIR(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Aggregate(ChangeLoggedModel, CustomFieldModel): +class Aggregate(PrimaryModel): """ An aggregate exists at the root level of the IP address space hierarchy in NetBox. Aggregates are used to organize the hierarchy and track the overall utilization of available address space. Each Aggregate is assigned to a RIR. @@ -317,7 +188,8 @@ class Aggregate(ChangeLoggedModel, CustomFieldModel): return int(float(child_prefixes.size) / self.prefix.size * 100) -class Role(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class Role(OrganizationalModel): """ A Role represents the functional role of a Prefix or VLAN; for example, "Customer," "Infrastructure," or "Management." @@ -358,7 +230,7 @@ class Role(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Prefix(ChangeLoggedModel, CustomFieldModel): +class Prefix(PrimaryModel): """ A Prefix represents an IPv4 or IPv6 network, including mask length. Prefixes can optionally be assigned to Sites and VRFs. A Prefix must be assigned a status and may optionally be assigned a used-define Role. A Prefix can also be @@ -616,7 +488,7 @@ class Prefix(ChangeLoggedModel, CustomFieldModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class IPAddress(ChangeLoggedModel, CustomFieldModel): +class IPAddress(PrimaryModel): """ An IPAddress represents an individual IPv4 or IPv6 address and its mask. The mask length should match what is configured in the real world. (Typically, only loopback interfaces are configured with /32 or /128 masks.) Like @@ -831,274 +703,3 @@ class IPAddress(ChangeLoggedModel, CustomFieldModel): def get_role_class(self): return IPAddressRoleChoices.CSS_CLASSES.get(self.role) - - -class VLANGroup(ChangeLoggedModel): - """ - A VLAN group is an arbitrary collection of VLANs within which VLAN IDs and names must be unique. - """ - name = models.CharField( - max_length=100 - ) - slug = models.SlugField( - max_length=100 - ) - site = models.ForeignKey( - to='dcim.Site', - on_delete=models.PROTECT, - related_name='vlan_groups', - blank=True, - null=True - ) - description = models.CharField( - max_length=200, - blank=True - ) - - objects = RestrictedQuerySet.as_manager() - - csv_headers = ['name', 'slug', 'site', 'description'] - - class Meta: - ordering = ('site', 'name', 'pk') # (site, name) may be non-unique - unique_together = [ - ['site', 'name'], - ['site', 'slug'], - ] - verbose_name = 'VLAN group' - verbose_name_plural = 'VLAN groups' - - def __str__(self): - return self.name - - def get_absolute_url(self): - return reverse('ipam:vlangroup_vlans', args=[self.pk]) - - def to_csv(self): - return ( - self.name, - self.slug, - self.site.name if self.site else None, - self.description, - ) - - def get_next_available_vid(self): - """ - Return the first available VLAN ID (1-4094) in the group. - """ - vlan_ids = VLAN.objects.filter(group=self).values_list('vid', flat=True) - for i in range(1, 4095): - if i not in vlan_ids: - return i - return None - - -@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class VLAN(ChangeLoggedModel, CustomFieldModel): - """ - A VLAN is a distinct layer two forwarding domain identified by a 12-bit integer (1-4094). Each VLAN must be assigned - to a Site, however VLAN IDs need not be unique within a Site. A VLAN may optionally be assigned to a VLANGroup, - within which all VLAN IDs and names but be unique. - - Like Prefixes, each VLAN is assigned an operational status and optionally a user-defined Role. A VLAN can have zero - or more Prefixes assigned to it. - """ - site = models.ForeignKey( - to='dcim.Site', - on_delete=models.PROTECT, - related_name='vlans', - blank=True, - null=True - ) - group = models.ForeignKey( - to='ipam.VLANGroup', - on_delete=models.PROTECT, - related_name='vlans', - blank=True, - null=True - ) - vid = models.PositiveSmallIntegerField( - verbose_name='ID', - validators=[MinValueValidator(1), MaxValueValidator(4094)] - ) - name = models.CharField( - max_length=64 - ) - tenant = models.ForeignKey( - to='tenancy.Tenant', - on_delete=models.PROTECT, - related_name='vlans', - blank=True, - null=True - ) - status = models.CharField( - max_length=50, - choices=VLANStatusChoices, - default=VLANStatusChoices.STATUS_ACTIVE - ) - role = models.ForeignKey( - to='ipam.Role', - on_delete=models.SET_NULL, - related_name='vlans', - blank=True, - null=True - ) - description = models.CharField( - max_length=200, - blank=True - ) - tags = TaggableManager(through=TaggedItem) - - objects = RestrictedQuerySet.as_manager() - - csv_headers = ['site', 'group', 'vid', 'name', 'tenant', 'status', 'role', 'description'] - clone_fields = [ - 'site', 'group', 'tenant', 'status', 'role', 'description', - ] - - class Meta: - ordering = ('site', 'group', 'vid', 'pk') # (site, group, vid) may be non-unique - unique_together = [ - ['group', 'vid'], - ['group', 'name'], - ] - verbose_name = 'VLAN' - verbose_name_plural = 'VLANs' - - def __str__(self): - return self.display_name or super().__str__() - - def get_absolute_url(self): - return reverse('ipam:vlan', args=[self.pk]) - - def clean(self): - super().clean() - - # Validate VLAN group - if self.group and self.group.site != self.site: - raise ValidationError({ - 'group': "VLAN group must belong to the assigned site ({}).".format(self.site) - }) - - def to_csv(self): - return ( - self.site.name if self.site else None, - self.group.name if self.group else None, - self.vid, - self.name, - self.tenant.name if self.tenant else None, - self.get_status_display(), - self.role.name if self.role else None, - self.description, - ) - - @property - def display_name(self): - return f'{self.name} ({self.vid})' - - def get_status_class(self): - return VLANStatusChoices.CSS_CLASSES.get(self.status) - - def get_interfaces(self): - # Return all device interfaces assigned to this VLAN - return Interface.objects.filter( - Q(untagged_vlan_id=self.pk) | - Q(tagged_vlans=self.pk) - ).distinct() - - def get_vminterfaces(self): - # Return all VM interfaces assigned to this VLAN - return VMInterface.objects.filter( - Q(untagged_vlan_id=self.pk) | - Q(tagged_vlans=self.pk) - ).distinct() - - -@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Service(ChangeLoggedModel, CustomFieldModel): - """ - A Service represents a layer-four service (e.g. HTTP or SSH) running on a Device or VirtualMachine. A Service may - optionally be tied to one or more specific IPAddresses belonging to its parent. - """ - device = models.ForeignKey( - to='dcim.Device', - on_delete=models.CASCADE, - related_name='services', - verbose_name='device', - null=True, - blank=True - ) - virtual_machine = models.ForeignKey( - to='virtualization.VirtualMachine', - on_delete=models.CASCADE, - related_name='services', - null=True, - blank=True - ) - name = models.CharField( - max_length=100 - ) - protocol = models.CharField( - max_length=50, - choices=ServiceProtocolChoices - ) - ports = ArrayField( - base_field=models.PositiveIntegerField( - validators=[ - MinValueValidator(SERVICE_PORT_MIN), - MaxValueValidator(SERVICE_PORT_MAX) - ] - ), - verbose_name='Port numbers' - ) - ipaddresses = models.ManyToManyField( - to='ipam.IPAddress', - related_name='services', - blank=True, - verbose_name='IP addresses' - ) - description = models.CharField( - max_length=200, - blank=True - ) - tags = TaggableManager(through=TaggedItem) - - objects = RestrictedQuerySet.as_manager() - - csv_headers = ['device', 'virtual_machine', 'name', 'protocol', 'ports', 'description'] - - class Meta: - ordering = ('protocol', 'ports', 'pk') # (protocol, port) may be non-unique - - def __str__(self): - return f'{self.name} ({self.get_protocol_display()}/{self.port_list})' - - def get_absolute_url(self): - return reverse('ipam:service', args=[self.pk]) - - @property - def parent(self): - return self.device or self.virtual_machine - - def clean(self): - super().clean() - - # A Service must belong to a Device *or* to a VirtualMachine - if self.device and self.virtual_machine: - raise ValidationError("A service cannot be associated with both a device and a virtual machine.") - if not self.device and not self.virtual_machine: - raise ValidationError("A service must be associated with either a device or a virtual machine.") - - def to_csv(self): - return ( - self.device.name if self.device else None, - self.virtual_machine.name if self.virtual_machine else None, - self.name, - self.get_protocol_display(), - self.ports, - self.description, - ) - - @property - def port_list(self): - return array_to_string(self.ports) diff --git a/netbox/ipam/models/services.py b/netbox/ipam/models/services.py new file mode 100644 index 000000000..57338cce0 --- /dev/null +++ b/netbox/ipam/models/services.py @@ -0,0 +1,109 @@ +from django.contrib.postgres.fields import ArrayField +from django.core.exceptions import ValidationError +from django.core.validators import MaxValueValidator, MinValueValidator +from django.db import models +from django.urls import reverse +from taggit.managers import TaggableManager + +from extras.models import TaggedItem +from extras.utils import extras_features +from ipam.choices import * +from ipam.constants import * +from netbox.models import PrimaryModel +from utilities.querysets import RestrictedQuerySet +from utilities.utils import array_to_string + + +__all__ = ( + 'Service', +) + + +@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') +class Service(PrimaryModel): + """ + A Service represents a layer-four service (e.g. HTTP or SSH) running on a Device or VirtualMachine. A Service may + optionally be tied to one or more specific IPAddresses belonging to its parent. + """ + device = models.ForeignKey( + to='dcim.Device', + on_delete=models.CASCADE, + related_name='services', + verbose_name='device', + null=True, + blank=True + ) + virtual_machine = models.ForeignKey( + to='virtualization.VirtualMachine', + on_delete=models.CASCADE, + related_name='services', + null=True, + blank=True + ) + name = models.CharField( + max_length=100 + ) + protocol = models.CharField( + max_length=50, + choices=ServiceProtocolChoices + ) + ports = ArrayField( + base_field=models.PositiveIntegerField( + validators=[ + MinValueValidator(SERVICE_PORT_MIN), + MaxValueValidator(SERVICE_PORT_MAX) + ] + ), + verbose_name='Port numbers' + ) + ipaddresses = models.ManyToManyField( + to='ipam.IPAddress', + related_name='services', + blank=True, + verbose_name='IP addresses' + ) + description = models.CharField( + max_length=200, + blank=True + ) + tags = TaggableManager(through=TaggedItem) + + objects = RestrictedQuerySet.as_manager() + + csv_headers = ['device', 'virtual_machine', 'name', 'protocol', 'ports', 'description'] + + class Meta: + ordering = ('protocol', 'ports', 'pk') # (protocol, port) may be non-unique + + def __str__(self): + return f'{self.name} ({self.get_protocol_display()}/{self.port_list})' + + def get_absolute_url(self): + return reverse('ipam:service', args=[self.pk]) + + @property + def parent(self): + return self.device or self.virtual_machine + + def clean(self): + super().clean() + + # A Service must belong to a Device *or* to a VirtualMachine + if self.device and self.virtual_machine: + raise ValidationError("A service cannot be associated with both a device and a virtual machine.") + if not self.device and not self.virtual_machine: + raise ValidationError("A service must be associated with either a device or a virtual machine.") + + def to_csv(self): + return ( + self.device.name if self.device else None, + self.virtual_machine.name if self.virtual_machine else None, + self.name, + self.get_protocol_display(), + self.ports, + self.description, + ) + + @property + def port_list(self): + return array_to_string(self.ports) diff --git a/netbox/ipam/models/vlans.py b/netbox/ipam/models/vlans.py new file mode 100644 index 000000000..131212564 --- /dev/null +++ b/netbox/ipam/models/vlans.py @@ -0,0 +1,202 @@ +from django.core.exceptions import ValidationError +from django.core.validators import MaxValueValidator, MinValueValidator +from django.db import models +from django.urls import reverse +from taggit.managers import TaggableManager + +from dcim.models import Interface +from extras.models import TaggedItem +from extras.utils import extras_features +from ipam.choices import * +from ipam.constants import * +from netbox.models import OrganizationalModel, PrimaryModel +from utilities.querysets import RestrictedQuerySet +from virtualization.models import VMInterface + + +__all__ = ( + 'VLAN', + 'VLANGroup', +) + + +@extras_features('custom_fields', 'export_templates', 'webhooks') +class VLANGroup(OrganizationalModel): + """ + A VLAN group is an arbitrary collection of VLANs within which VLAN IDs and names must be unique. + """ + name = models.CharField( + max_length=100 + ) + slug = models.SlugField( + max_length=100 + ) + site = models.ForeignKey( + to='dcim.Site', + on_delete=models.PROTECT, + related_name='vlan_groups', + blank=True, + null=True + ) + description = models.CharField( + max_length=200, + blank=True + ) + + objects = RestrictedQuerySet.as_manager() + + csv_headers = ['name', 'slug', 'site', 'description'] + + class Meta: + ordering = ('site', 'name', 'pk') # (site, name) may be non-unique + unique_together = [ + ['site', 'name'], + ['site', 'slug'], + ] + verbose_name = 'VLAN group' + verbose_name_plural = 'VLAN groups' + + def __str__(self): + return self.name + + def get_absolute_url(self): + return reverse('ipam:vlangroup_vlans', args=[self.pk]) + + def to_csv(self): + return ( + self.name, + self.slug, + self.site.name if self.site else None, + self.description, + ) + + def get_next_available_vid(self): + """ + Return the first available VLAN ID (1-4094) in the group. + """ + vlan_ids = VLAN.objects.filter(group=self).values_list('vid', flat=True) + for i in range(1, 4095): + if i not in vlan_ids: + return i + return None + + +@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') +class VLAN(PrimaryModel): + """ + A VLAN is a distinct layer two forwarding domain identified by a 12-bit integer (1-4094). Each VLAN must be assigned + to a Site, however VLAN IDs need not be unique within a Site. A VLAN may optionally be assigned to a VLANGroup, + within which all VLAN IDs and names but be unique. + + Like Prefixes, each VLAN is assigned an operational status and optionally a user-defined Role. A VLAN can have zero + or more Prefixes assigned to it. + """ + site = models.ForeignKey( + to='dcim.Site', + on_delete=models.PROTECT, + related_name='vlans', + blank=True, + null=True + ) + group = models.ForeignKey( + to='ipam.VLANGroup', + on_delete=models.PROTECT, + related_name='vlans', + blank=True, + null=True + ) + vid = models.PositiveSmallIntegerField( + verbose_name='ID', + validators=[MinValueValidator(1), MaxValueValidator(4094)] + ) + name = models.CharField( + max_length=64 + ) + tenant = models.ForeignKey( + to='tenancy.Tenant', + on_delete=models.PROTECT, + related_name='vlans', + blank=True, + null=True + ) + status = models.CharField( + max_length=50, + choices=VLANStatusChoices, + default=VLANStatusChoices.STATUS_ACTIVE + ) + role = models.ForeignKey( + to='ipam.Role', + on_delete=models.SET_NULL, + related_name='vlans', + blank=True, + null=True + ) + description = models.CharField( + max_length=200, + blank=True + ) + tags = TaggableManager(through=TaggedItem) + + objects = RestrictedQuerySet.as_manager() + + csv_headers = ['site', 'group', 'vid', 'name', 'tenant', 'status', 'role', 'description'] + clone_fields = [ + 'site', 'group', 'tenant', 'status', 'role', 'description', + ] + + class Meta: + ordering = ('site', 'group', 'vid', 'pk') # (site, group, vid) may be non-unique + unique_together = [ + ['group', 'vid'], + ['group', 'name'], + ] + verbose_name = 'VLAN' + verbose_name_plural = 'VLANs' + + def __str__(self): + return self.display_name or super().__str__() + + def get_absolute_url(self): + return reverse('ipam:vlan', args=[self.pk]) + + def clean(self): + super().clean() + + # Validate VLAN group + if self.group and self.group.site != self.site: + raise ValidationError({ + 'group': "VLAN group must belong to the assigned site ({}).".format(self.site) + }) + + def to_csv(self): + return ( + self.site.name if self.site else None, + self.group.name if self.group else None, + self.vid, + self.name, + self.tenant.name if self.tenant else None, + self.get_status_display(), + self.role.name if self.role else None, + self.description, + ) + + @property + def display_name(self): + return f'{self.name} ({self.vid})' + + def get_status_class(self): + return VLANStatusChoices.CSS_CLASSES.get(self.status) + + def get_interfaces(self): + # Return all device interfaces assigned to this VLAN + return Interface.objects.filter( + Q(untagged_vlan_id=self.pk) | + Q(tagged_vlans=self.pk) + ).distinct() + + def get_vminterfaces(self): + # Return all VM interfaces assigned to this VLAN + return VMInterface.objects.filter( + Q(untagged_vlan_id=self.pk) | + Q(tagged_vlans=self.pk) + ).distinct() diff --git a/netbox/ipam/models/vrfs.py b/netbox/ipam/models/vrfs.py new file mode 100644 index 000000000..bcd5a456a --- /dev/null +++ b/netbox/ipam/models/vrfs.py @@ -0,0 +1,139 @@ +from django.db import models +from django.urls import reverse +from taggit.managers import TaggableManager + +from extras.models import TaggedItem +from extras.utils import extras_features +from ipam.constants import * +from netbox.models import PrimaryModel +from utilities.querysets import RestrictedQuerySet + + +__all__ = ( + 'RouteTarget', + 'VRF', +) + + +@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') +class VRF(PrimaryModel): + """ + A virtual routing and forwarding (VRF) table represents a discrete layer three forwarding domain (e.g. a routing + table). Prefixes and IPAddresses can optionally be assigned to VRFs. (Prefixes and IPAddresses not assigned to a VRF + are said to exist in the "global" table.) + """ + name = models.CharField( + max_length=100 + ) + rd = models.CharField( + max_length=VRF_RD_MAX_LENGTH, + unique=True, + blank=True, + null=True, + verbose_name='Route distinguisher', + help_text='Unique route distinguisher (as defined in RFC 4364)' + ) + tenant = models.ForeignKey( + to='tenancy.Tenant', + on_delete=models.PROTECT, + related_name='vrfs', + blank=True, + null=True + ) + enforce_unique = models.BooleanField( + default=True, + verbose_name='Enforce unique space', + help_text='Prevent duplicate prefixes/IP addresses within this VRF' + ) + description = models.CharField( + max_length=200, + blank=True + ) + import_targets = models.ManyToManyField( + to='ipam.RouteTarget', + related_name='importing_vrfs', + blank=True + ) + export_targets = models.ManyToManyField( + to='ipam.RouteTarget', + related_name='exporting_vrfs', + blank=True + ) + tags = TaggableManager(through=TaggedItem) + + objects = RestrictedQuerySet.as_manager() + + csv_headers = ['name', 'rd', 'tenant', 'enforce_unique', 'description'] + clone_fields = [ + 'tenant', 'enforce_unique', 'description', + ] + + class Meta: + ordering = ('name', 'rd', 'pk') # (name, rd) may be non-unique + verbose_name = 'VRF' + verbose_name_plural = 'VRFs' + + def __str__(self): + return self.display_name or super().__str__() + + def get_absolute_url(self): + return reverse('ipam:vrf', args=[self.pk]) + + def to_csv(self): + return ( + self.name, + self.rd, + self.tenant.name if self.tenant else None, + self.enforce_unique, + self.description, + ) + + @property + def display_name(self): + if self.rd: + return f'{self.name} ({self.rd})' + return self.name + + +@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') +class RouteTarget(PrimaryModel): + """ + A BGP extended community used to control the redistribution of routes among VRFs, as defined in RFC 4364. + """ + name = models.CharField( + max_length=VRF_RD_MAX_LENGTH, # Same format options as VRF RD (RFC 4360 section 4) + unique=True, + help_text='Route target value (formatted in accordance with RFC 4360)' + ) + description = models.CharField( + max_length=200, + blank=True + ) + tenant = models.ForeignKey( + to='tenancy.Tenant', + on_delete=models.PROTECT, + related_name='route_targets', + blank=True, + null=True + ) + tags = TaggableManager(through=TaggedItem) + + objects = RestrictedQuerySet.as_manager() + + csv_headers = ['name', 'description', 'tenant'] + + class Meta: + ordering = ['name'] + + def __str__(self): + return self.name + + def get_absolute_url(self): + return reverse('ipam:routetarget', args=[self.pk]) + + def to_csv(self): + return ( + self.name, + self.description, + self.tenant.name if self.tenant else None, + ) diff --git a/netbox/netbox/models.py b/netbox/netbox/models.py new file mode 100644 index 000000000..c0b0ce7ae --- /dev/null +++ b/netbox/netbox/models.py @@ -0,0 +1,184 @@ +from collections import OrderedDict + +from django.core.serializers.json import DjangoJSONEncoder +from django.core.validators import ValidationError +from django.db import models +from mptt.models import MPTTModel, TreeForeignKey + +from utilities.mptt import TreeManager +from utilities.utils import serialize_object + +__all__ = ( + 'BigIDModel', + 'NestedGroupModel', + 'OrganizationalModel', + 'PrimaryModel', +) + + +class BigIDModel(models.Model): + """ + Abstract base model for all Schematic data objects. Ensures the use of a 64-bit PK. + """ + id = models.BigAutoField( + primary_key=True + ) + + class Meta: + abstract = True + + +class CoreModel(BigIDModel): + """ + Base class for all core objects. Provides the following: + - Change logging + - Custom field support + """ + created = models.DateField( + auto_now_add=True, + blank=True, + null=True + ) + last_updated = models.DateTimeField( + auto_now=True, + blank=True, + null=True + ) + + class Meta: + abstract = True + + def to_objectchange(self, action): + """ + Return a new ObjectChange representing a change made to this object. This will typically be called automatically + by ChangeLoggingMiddleware. + """ + from extras.models import ObjectChange + return ObjectChange( + changed_object=self, + object_repr=str(self), + action=action, + object_data=serialize_object(self) + ) + + +class PrimaryModel(CoreModel): + """ + Primary models represent real objects within the infrastructure being modeled. + """ + custom_field_data = models.JSONField( + encoder=DjangoJSONEncoder, + blank=True, + default=dict + ) + + class Meta: + abstract = True + + @property + def cf(self): + """ + Convenience wrapper for custom field data. + """ + return self.custom_field_data + + def get_custom_fields(self): + """ + Return a dictionary of custom fields for a single object in the form {: value}. + """ + from extras.models import CustomField + + fields = CustomField.objects.get_for_model(self) + return OrderedDict([ + (field, self.custom_field_data.get(field.name)) for field in fields + ]) + + def clean(self): + super().clean() + from extras.models import CustomField + + custom_fields = {cf.name: cf for cf in CustomField.objects.get_for_model(self)} + + # Validate all field values + for field_name, value in self.custom_field_data.items(): + if field_name not in custom_fields: + raise ValidationError(f"Unknown field name '{field_name}' in custom field data.") + try: + custom_fields[field_name].validate(value) + except ValidationError as e: + raise ValidationError(f"Invalid value for custom field '{field_name}': {e.message}") + + # Check for missing required values + for cf in custom_fields.values(): + if cf.required and cf.name not in self.custom_field_data: + raise ValidationError(f"Missing required custom field '{cf.name}'.") + + +class NestedGroupModel(PrimaryModel, MPTTModel): + """ + Base model for objects which are used to form a hierarchy (regions, locations, etc.). These models nest + recursively using MPTT. Within each parent, each child instance must have a unique name. + """ + parent = TreeForeignKey( + to='self', + on_delete=models.CASCADE, + related_name='children', + blank=True, + null=True, + db_index=True + ) + name = models.CharField( + max_length=100 + ) + description = models.CharField( + max_length=200, + blank=True + ) + + objects = TreeManager() + + class Meta: + abstract = True + + class MPTTMeta: + order_insertion_by = ('name',) + + def __str__(self): + return self.name + + def to_objectchange(self, action): + # Remove MPTT-internal fields + from extras.models import ObjectChange + return ObjectChange( + changed_object=self, + object_repr=str(self), + action=action, + object_data=serialize_object(self, exclude=['level', 'lft', 'rght', 'tree_id']) + ) + + +class OrganizationalModel(PrimaryModel): + """ + Organizational models are those which are used solely to categorize and qualify other objects, and do not convey + any real information about the infrastructure being modeled (for example, functional device roles). Organizational + models provide the following standard attributes: + - Unique name + - Unique slug (automatically derived from name) + - Optional description + """ + name = models.CharField( + max_length=100, + unique=True + ) + slug = models.SlugField( + max_length=100, + unique=True + ) + description = models.CharField( + max_length=200, + blank=True + ) + + class Meta: + abstract = True + ordering = ('name',) diff --git a/netbox/secrets/migrations/0013_standardize_models.py b/netbox/secrets/migrations/0013_standardize_models.py new file mode 100644 index 000000000..9de8dec95 --- /dev/null +++ b/netbox/secrets/migrations/0013_standardize_models.py @@ -0,0 +1,37 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('secrets', '0012_standardize_name_length'), + ] + + operations = [ + migrations.AddField( + model_name='secretrole', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AlterField( + model_name='secret', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='secretrole', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='sessionkey', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='userkey', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/secrets/models.py b/netbox/secrets/models.py index 0fa6fd04e..091b67cc6 100644 --- a/netbox/secrets/models.py +++ b/netbox/secrets/models.py @@ -14,8 +14,9 @@ from django.urls import reverse from django.utils.encoding import force_bytes from taggit.managers import TaggableManager -from extras.models import ChangeLoggedModel, CustomFieldModel, TaggedItem +from extras.models import TaggedItem from extras.utils import extras_features +from netbox.models import BigIDModel, OrganizationalModel, PrimaryModel from utilities.querysets import RestrictedQuerySet from .exceptions import InvalidKey from .hashers import SecretValidationHasher @@ -31,7 +32,7 @@ __all__ = ( ) -class UserKey(models.Model): +class UserKey(BigIDModel): """ A UserKey stores a user's personal RSA (public) encryption key, which is used to generate their unique encrypted copy of the master encryption key. The encrypted instance of the master key can be decrypted only with the user's @@ -164,7 +165,7 @@ class UserKey(models.Model): self.save() -class SessionKey(models.Model): +class SessionKey(BigIDModel): """ A SessionKey stores a User's temporary key to be used for the encryption and decryption of secrets. """ @@ -234,7 +235,8 @@ class SessionKey(models.Model): return session_key -class SecretRole(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class SecretRole(OrganizationalModel): """ A SecretRole represents an arbitrary functional classification of Secrets. For example, a user might define roles such as "Login Credentials" or "SNMP Communities." @@ -274,7 +276,7 @@ class SecretRole(ChangeLoggedModel): @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Secret(ChangeLoggedModel, CustomFieldModel): +class Secret(PrimaryModel): """ A Secret stores an AES256-encrypted copy of sensitive data, such as passwords or secret keys. An irreversible SHA-256 hash is stored along with the ciphertext for validation upon decryption. Each Secret is assigned to exactly diff --git a/netbox/tenancy/migrations/0012_standardize_models.py b/netbox/tenancy/migrations/0012_standardize_models.py new file mode 100644 index 000000000..7ce55cf42 --- /dev/null +++ b/netbox/tenancy/migrations/0012_standardize_models.py @@ -0,0 +1,27 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('tenancy', '0011_standardize_name_length'), + ] + + operations = [ + migrations.AddField( + model_name='tenantgroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AlterField( + model_name='tenant', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='tenantgroup', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/tenancy/models.py b/netbox/tenancy/models.py index 3ba644c09..e83f4bdd2 100644 --- a/netbox/tenancy/models.py +++ b/netbox/tenancy/models.py @@ -3,11 +3,11 @@ from django.urls import reverse from mptt.models import MPTTModel, TreeForeignKey from taggit.managers import TaggableManager -from extras.models import ChangeLoggedModel, CustomFieldModel, ObjectChange, TaggedItem +from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features +from netbox.models import NestedGroupModel, PrimaryModel from utilities.mptt import TreeManager from utilities.querysets import RestrictedQuerySet -from utilities.utils import serialize_object __all__ = ( @@ -16,7 +16,8 @@ __all__ = ( ) -class TenantGroup(MPTTModel, ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class TenantGroup(NestedGroupModel): """ An arbitrary collection of Tenants. """ @@ -48,12 +49,6 @@ class TenantGroup(MPTTModel, ChangeLoggedModel): class Meta: ordering = ['name'] - class MPTTMeta: - order_insertion_by = ['name'] - - def __str__(self): - return self.name - def get_absolute_url(self): return "{}?group={}".format(reverse('tenancy:tenant_list'), self.slug) @@ -65,18 +60,9 @@ class TenantGroup(MPTTModel, ChangeLoggedModel): self.description, ) - def to_objectchange(self, action): - # Remove MPTT-internal fields - return ObjectChange( - changed_object=self, - object_repr=str(self), - action=action, - object_data=serialize_object(self, exclude=['level', 'lft', 'rght', 'tree_id']) - ) - @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Tenant(ChangeLoggedModel, CustomFieldModel): +class Tenant(PrimaryModel): """ A Tenant represents an organization served by the NetBox owner. This is typically a customer or an internal department. diff --git a/netbox/users/migrations/0011_standardize_models.py b/netbox/users/migrations/0011_standardize_models.py new file mode 100644 index 000000000..abfbd8702 --- /dev/null +++ b/netbox/users/migrations/0011_standardize_models.py @@ -0,0 +1,26 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('users', '0010_update_jsonfield'), + ] + + operations = [ + migrations.AlterField( + model_name='objectpermission', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='token', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='userconfig', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/users/models.py b/netbox/users/models.py index b25a75134..529732e65 100644 --- a/netbox/users/models.py +++ b/netbox/users/models.py @@ -11,6 +11,7 @@ from django.db.models.signals import post_save from django.dispatch import receiver from django.utils import timezone +from netbox.models import BigIDModel from utilities.querysets import RestrictedQuerySet from utilities.utils import flatten_dict @@ -50,7 +51,7 @@ class AdminUser(User): # User preferences # -class UserConfig(models.Model): +class UserConfig(BigIDModel): """ This model stores arbitrary user-specific preferences in a JSON data structure. """ @@ -175,7 +176,7 @@ def create_userconfig(instance, created, **kwargs): # REST API # -class Token(models.Model): +class Token(BigIDModel): """ An API token used for user authentication. This extends the stock model to allow each user to have multiple tokens. It also supports setting an expiration time and toggling write ability. @@ -233,7 +234,7 @@ class Token(models.Model): # Permissions # -class ObjectPermission(models.Model): +class ObjectPermission(BigIDModel): """ A mapping of view, add, change, and/or delete permission for users and/or groups to an arbitrary set of objects identified by ORM query parameters. diff --git a/netbox/virtualization/migrations/0020_standardize_models.py b/netbox/virtualization/migrations/0020_standardize_models.py new file mode 100644 index 000000000..15585100d --- /dev/null +++ b/netbox/virtualization/migrations/0020_standardize_models.py @@ -0,0 +1,62 @@ +import django.core.serializers.json +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('virtualization', '0019_standardize_name_length'), + ] + + operations = [ + migrations.AddField( + model_name='clustergroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='clustertype', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='vminterface', + name='created', + field=models.DateField(auto_now_add=True, null=True), + ), + migrations.AddField( + model_name='vminterface', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='vminterface', + name='last_updated', + field=models.DateTimeField(auto_now=True, null=True), + ), + migrations.AlterField( + model_name='cluster', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='clustergroup', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='clustertype', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='virtualmachine', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + migrations.AlterField( + model_name='vminterface', + name='id', + field=models.BigAutoField(primary_key=True, serialize=False), + ), + ] diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index edca7e1fe..a6a63ab3b 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -6,9 +6,10 @@ from django.urls import reverse from taggit.managers import TaggableManager from dcim.models import BaseInterface, Device -from extras.models import ChangeLoggedModel, ConfigContextModel, CustomFieldModel, ObjectChange, TaggedItem +from extras.models import ConfigContextModel, ObjectChange, TaggedItem from extras.querysets import ConfigContextModelQuerySet from extras.utils import extras_features +from netbox.models import OrganizationalModel, PrimaryModel from utilities.fields import NaturalOrderingField from utilities.ordering import naturalize_interface from utilities.query_functions import CollateAsChar @@ -30,7 +31,8 @@ __all__ = ( # Cluster types # -class ClusterType(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class ClusterType(OrganizationalModel): """ A type of Cluster. """ @@ -72,7 +74,8 @@ class ClusterType(ChangeLoggedModel): # Cluster groups # -class ClusterGroup(ChangeLoggedModel): +@extras_features('custom_fields', 'export_templates', 'webhooks') +class ClusterGroup(OrganizationalModel): """ An organizational group of Clusters. """ @@ -115,7 +118,7 @@ class ClusterGroup(ChangeLoggedModel): # @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class Cluster(ChangeLoggedModel, CustomFieldModel): +class Cluster(PrimaryModel): """ A cluster of VirtualMachines. Each Cluster may optionally be associated with one or more Devices. """ @@ -199,7 +202,7 @@ class Cluster(ChangeLoggedModel, CustomFieldModel): # @extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks') -class VirtualMachine(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): +class VirtualMachine(PrimaryModel, ConfigContextModel): """ A virtual machine which runs inside a Cluster. """ @@ -371,7 +374,7 @@ class VirtualMachine(ChangeLoggedModel, ConfigContextModel, CustomFieldModel): # @extras_features('export_templates', 'webhooks') -class VMInterface(BaseInterface): +class VMInterface(PrimaryModel, BaseInterface): virtual_machine = models.ForeignKey( to='virtualization.VirtualMachine', on_delete=models.CASCADE, From 3208c8317d0cac095cd8486d5fb8d087688d64c1 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 24 Feb 2021 21:21:17 -0500 Subject: [PATCH 121/302] Switch docs to mkdocs-material --- docs/installation/1-postgresql.md | 25 +++++++------- docs/installation/2-redis.md | 20 ++++++------ docs/installation/3-netbox.md | 54 +++++++++++++++---------------- docs/requirements.txt | 2 +- mkdocs.yml | 7 ++-- 5 files changed, 55 insertions(+), 53 deletions(-) diff --git a/docs/installation/1-postgresql.md b/docs/installation/1-postgresql.md index 4ac1104d7..88e152193 100644 --- a/docs/installation/1-postgresql.md +++ b/docs/installation/1-postgresql.md @@ -7,23 +7,24 @@ This section entails the installation and configuration of a local PostgreSQL da ## Installation -#### Ubuntu +## Installation -Install the PostgreSQL server and client development libraries using `apt`. +=== "Ubuntu" -```no-highlight -sudo apt update -sudo apt install -y postgresql libpq-dev -``` + ```no-highlight + sudo apt update + sudo apt install -y postgresql libpq-dev + ``` -#### CentOS +=== "CentOS" -PostgreSQL 9.6 and later are available natively on CentOS 8.2. If using an earlier CentOS release, you may need to [install it from an RPM](https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/). + ```no-highlight + sudo yum install -y postgresql-server libpq-devel + sudo postgresql-setup --initdb + ``` -```no-highlight -sudo yum install -y postgresql-server libpq-devel -sudo postgresql-setup --initdb -``` + !!! info + PostgreSQL 9.6 and later are available natively on CentOS 8.2. If using an earlier CentOS release, you may need to [install it from an RPM](https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/). CentOS configures ident host-based authentication for PostgreSQL by default. Because NetBox will need to authenticate using a username and password, modify `/var/lib/pgsql/data/pg_hba.conf` to support MD5 authentication by changing `ident` to `md5` for the lines below: diff --git a/docs/installation/2-redis.md b/docs/installation/2-redis.md index 19ec9073e..e31873d2b 100644 --- a/docs/installation/2-redis.md +++ b/docs/installation/2-redis.md @@ -7,19 +7,19 @@ !!! note NetBox v2.9.0 and later require Redis v4.0 or higher. If your distribution does not offer a recent enough release, you will need to build Redis from source. Please see [the Redis installation documentation](https://github.com/redis/redis) for further details. -### Ubuntu +=== "Ubuntu" -```no-highlight -sudo apt install -y redis-server -``` + ```no-highlight + sudo apt install -y redis-server + ``` -### CentOS +=== "CentOS" -```no-highlight -sudo yum install -y redis -sudo systemctl start redis -sudo systemctl enable redis -``` + ```no-highlight + sudo yum install -y redis + sudo systemctl start redis + sudo systemctl enable redis + ``` You may wish to modify the Redis configuration at `/etc/redis.conf` or `/etc/redis/redis.conf`, however in most cases the default configuration is sufficient. diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index f2461b40d..03e224e1f 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -9,17 +9,17 @@ Begin by installing all system packages required by NetBox and its dependencies. !!! note NetBox v2.8.0 and later require Python 3.6, 3.7, or 3.8. -### Ubuntu +=== Ubuntu -```no-highlight -sudo apt install -y python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev -``` + ```no-highlight + sudo apt install -y python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev + ``` -### CentOS +=== CentOS -```no-highlight -sudo yum install -y gcc python36 python36-devel python3-pip libxml2-devel libxslt-devel libffi-devel openssl-devel redhat-rpm-config -``` + ```no-highlight + sudo yum install -y gcc python36 python36-devel python3-pip libxml2-devel libxslt-devel libffi-devel openssl-devel redhat-rpm-config + ``` Before continuing with either platform, update pip (Python's package management tool) to its latest release: @@ -57,17 +57,17 @@ sudo mkdir -p /opt/netbox/ && cd /opt/netbox/ If `git` is not already installed, install it: -#### Ubuntu +=== Ubuntu -```no-highlight -sudo apt install -y git -``` + ```no-highlight + sudo apt install -y git + ``` -#### CentOS +=== CentOS -```no-highlight -sudo yum install -y git -``` + ```no-highlight + sudo yum install -y git + ``` Next, clone the **master** branch of the NetBox GitHub repository into the current directory. (This branch always holds the current stable release.) @@ -89,20 +89,20 @@ Checking connectivity... done. Create a system user account named `netbox`. We'll configure the WSGI and HTTP services to run under this account. We'll also assign this user ownership of the media directory. This ensures that NetBox will be able to save uploaded files. -#### Ubuntu +=== Ubuntu -``` -sudo adduser --system --group netbox -sudo chown --recursive netbox /opt/netbox/netbox/media/ -``` + ``` + sudo adduser --system --group netbox + sudo chown --recursive netbox /opt/netbox/netbox/media/ + ``` -#### CentOS +=== CentOS -``` -sudo groupadd --system netbox -sudo adduser --system -g netbox netbox -sudo chown --recursive netbox /opt/netbox/netbox/media/ -``` + ``` + sudo groupadd --system netbox + sudo adduser --system -g netbox netbox + sudo chown --recursive netbox /opt/netbox/netbox/media/ + ``` ## Configuration diff --git a/docs/requirements.txt b/docs/requirements.txt index 9c863fec7..18b55d37b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -mkdocs==1.1 +mkdocs-material git+https://github.com/cmacmackin/markdown-include.git diff --git a/mkdocs.yml b/mkdocs.yml index 092cb559a..233a61fdf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,14 +5,15 @@ python: install: - requirements: docs/requirements.txt theme: - name: readthedocs - navigation_depth: 3 + name: material extra_css: - extra.css markdown_extensions: - - admonition: + - admonition - markdown_include.include: headingOffset: 1 + - pymdownx.superfences + - pymdownx.tabbed nav: - Introduction: 'index.md' - Installation: From d2c8aae59c68307424dd914a9076b39c0d580857 Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Mon, 15 Feb 2021 21:01:55 +1030 Subject: [PATCH 122/302] Fix #5819 and #5872 - Fix Primary IP Sorting Issues for Devices and VMs --- netbox/dcim/tables/devices.py | 18 +++++++++++++----- netbox/virtualization/tables.py | 18 +++++++++++++----- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index edd9e7a43..52f4449af 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -1,5 +1,6 @@ import django_tables2 as tables from django_tables2.utils import Accessor +from django.conf import settings from dcim.models import ( ConsolePort, ConsoleServerPort, Device, DeviceBay, DeviceRole, FrontPort, Interface, InventoryItem, Platform, @@ -127,11 +128,18 @@ class DeviceTable(BaseTable): verbose_name='Type', text=lambda record: record.device_type.display_name ) - primary_ip = tables.Column( - linkify=True, - order_by=('primary_ip6', 'primary_ip4'), - verbose_name='IP Address' - ) + if settings.PREFER_IPV4: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip4', 'primary_ip6'), + verbose_name='IP Address' + ) + else: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip6', 'primary_ip4'), + verbose_name='IP Address' + ) primary_ip4 = tables.Column( linkify=True, verbose_name='IPv4 Address' diff --git a/netbox/virtualization/tables.py b/netbox/virtualization/tables.py index 34a070623..e183765f1 100644 --- a/netbox/virtualization/tables.py +++ b/netbox/virtualization/tables.py @@ -1,5 +1,5 @@ import django_tables2 as tables - +from django.conf import settings from dcim.tables.devices import BaseInterfaceTable from tenancy.tables import COL_TENANT from utilities.tables import ( @@ -125,10 +125,18 @@ class VirtualMachineDetailTable(VirtualMachineTable): linkify=True, verbose_name='IPv6 Address' ) - primary_ip = tables.Column( - linkify=True, - verbose_name='IP Address' - ) + if settings.PREFER_IPV4: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip4', 'primary_ip6'), + verbose_name='IP Address' + ) + else: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip6', 'primary_ip4'), + verbose_name='IP Address' + ) tags = TagColumn( url_name='virtualization:virtualmachine_list' ) From 992657cbe053560b71f3a0e2ac3fd50d71563276 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 11:47:26 -0500 Subject: [PATCH 123/302] Introduce SelectSpeedWidget --- netbox/project-static/js/forms.js | 6 ++++++ netbox/utilities/forms/widgets.py | 8 ++++++++ .../templates/widgets/select_speed.html | 20 +++++++++++++++++++ 3 files changed, 34 insertions(+) create mode 100644 netbox/utilities/templates/widgets/select_speed.html diff --git a/netbox/project-static/js/forms.js b/netbox/project-static/js/forms.js index 0feb7fc2f..f189adc1b 100644 --- a/netbox/project-static/js/forms.js +++ b/netbox/project-static/js/forms.js @@ -103,6 +103,12 @@ $(document).ready(function() { return data.text; } + // Speed selector + $("a.set_speed").click(function(e) { + e.preventDefault(); + $("#id_" + $(this).attr("target")).val($(this).attr("data")); + }); + // Color Picker $('.netbox-select2-color-picker').select2({ allowClear: true, diff --git a/netbox/utilities/forms/widgets.py b/netbox/utilities/forms/widgets.py index 1c456c74c..11418fd42 100644 --- a/netbox/utilities/forms/widgets.py +++ b/netbox/utilities/forms/widgets.py @@ -16,6 +16,7 @@ __all__ = ( 'DatePicker', 'DateTimePicker', 'NumericArrayField', + 'SelectSpeedWidget', 'SelectWithDisabled', 'SelectWithPK', 'SlugWidget', @@ -111,6 +112,13 @@ class ContentTypeSelect(StaticSelect2): option_template_name = 'widgets/select_contenttype.html' +class SelectSpeedWidget(forms.NumberInput): + """ + Speed field with dropdown selections for convenience. + """ + template_name = 'widgets/select_speed.html' + + class NumericArrayField(SimpleArrayField): def to_python(self, value): diff --git a/netbox/utilities/templates/widgets/select_speed.html b/netbox/utilities/templates/widgets/select_speed.html new file mode 100644 index 000000000..8e259ca8d --- /dev/null +++ b/netbox/utilities/templates/widgets/select_speed.html @@ -0,0 +1,20 @@ +
+ {% include 'django/forms/widgets/number.html' %} + + + + +
From 2a517cde9f929846f7bb806dbe0ee37fb17f0832 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 13:08:02 -0500 Subject: [PATCH 124/302] Add support for form fieldsets --- netbox/templates/generic/object_edit.html | 49 +++++++++++++++++-- netbox/utilities/templatetags/form_helpers.py | 8 +++ 2 files changed, 52 insertions(+), 5 deletions(-) diff --git a/netbox/templates/generic/object_edit.html b/netbox/templates/generic/object_edit.html index 965749a6d..7056256ec 100644 --- a/netbox/templates/generic/object_edit.html +++ b/netbox/templates/generic/object_edit.html @@ -30,14 +30,53 @@
{% endif %} {% block form %} -
-
{{ obj_type|capfirst }}
+ {% if form.Meta.fieldsets %} + {# Render grouped fields accoring to Form #} + {% for group, fields in form.Meta.fieldsets %} +
+
{{ group }}
+
+ {% for name in fields %} + {% render_field form|getfield:name %} + {% endfor %} +
+
+ {% endfor %} + {% if form.custom_fields %} +
+
Custom Fields
- {% block form_fields %} - {% render_form form %} - {% endblock %} + {% render_custom_fields form %}
+
+ {% endif %} + {% if form.tags %} +
+
Tags
+
+ {% render_field form.tags %} +
+
+ {% endif %} + {% if form.comments %} +
+
Comments
+
+ {% render_field form.comments %} +
+
+ {% endif %} + {% else %} + {# Render all fields in a single group #} +
+
{{ obj_type|capfirst }}
+
+ {% block form_fields %} + {% render_form form %} + {% endblock %} +
+ {% endif %} {% endblock %}
diff --git a/netbox/utilities/templatetags/form_helpers.py b/netbox/utilities/templatetags/form_helpers.py index d3451ce86..9d46e8c37 100644 --- a/netbox/utilities/templatetags/form_helpers.py +++ b/netbox/utilities/templatetags/form_helpers.py @@ -4,6 +4,14 @@ from django import template register = template.Library() +@register.filter() +def getfield(form, fieldname): + """ + Return the specified field of a Form. + """ + return form[fieldname] + + @register.inclusion_tag('utilities/render_field.html') def render_field(field, bulk_nullable=False): """ From 42e82f0ead06fd1aa19a7d46ff5b9db6dcff0552 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 13:51:48 -0500 Subject: [PATCH 125/302] Update object edit template to use fieldsets where possible --- netbox/circuits/forms.py | 15 +++- netbox/circuits/views.py | 2 - netbox/dcim/forms.py | 28 +++++++- netbox/dcim/views.py | 5 -- netbox/extras/forms.py | 3 + netbox/extras/views.py | 1 - netbox/ipam/forms.py | 19 +++++ netbox/ipam/views.py | 4 -- netbox/templates/circuits/circuit_edit.html | 62 ----------------- netbox/templates/circuits/provider_edit.html | 42 ----------- netbox/templates/dcim/devicetype_edit.html | 44 ------------ netbox/templates/dcim/powerfeed_edit.html | 52 -------------- netbox/templates/dcim/powerpanel_edit.html | 23 ------- .../templates/dcim/rackreservation_edit.html | 33 --------- netbox/templates/dcim/site_edit.html | 57 --------------- netbox/templates/extras/tag_edit.html | 14 ---- netbox/templates/ipam/aggregate_edit.html | 35 ---------- netbox/templates/ipam/prefix_edit.html | 46 ------------- netbox/templates/ipam/vlan_edit.html | 44 ------------ netbox/templates/ipam/vrf_edit.html | 42 ----------- netbox/templates/tenancy/tenant_edit.html | 35 ---------- .../virtualization/cluster_edit.html | 42 ----------- .../virtualization/virtualmachine_edit.html | 69 ------------------- netbox/tenancy/forms.py | 3 + netbox/tenancy/views.py | 1 - netbox/virtualization/forms.py | 11 +++ netbox/virtualization/views.py | 2 - 27 files changed, 75 insertions(+), 659 deletions(-) delete mode 100644 netbox/templates/circuits/circuit_edit.html delete mode 100644 netbox/templates/circuits/provider_edit.html delete mode 100644 netbox/templates/dcim/devicetype_edit.html delete mode 100644 netbox/templates/dcim/powerfeed_edit.html delete mode 100644 netbox/templates/dcim/powerpanel_edit.html delete mode 100644 netbox/templates/dcim/rackreservation_edit.html delete mode 100644 netbox/templates/dcim/site_edit.html delete mode 100644 netbox/templates/extras/tag_edit.html delete mode 100644 netbox/templates/ipam/aggregate_edit.html delete mode 100644 netbox/templates/ipam/prefix_edit.html delete mode 100644 netbox/templates/ipam/vlan_edit.html delete mode 100644 netbox/templates/ipam/vrf_edit.html delete mode 100644 netbox/templates/tenancy/tenant_edit.html delete mode 100644 netbox/templates/virtualization/cluster_edit.html delete mode 100644 netbox/templates/virtualization/virtualmachine_edit.html diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 4731c9adb..8c35d972d 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -9,8 +9,8 @@ from tenancy.forms import TenancyFilterForm, TenancyForm from tenancy.models import Tenant from utilities.forms import ( add_blank_choice, BootstrapMixin, CommentField, CSVChoiceField, CSVModelChoiceField, CSVModelForm, DatePicker, - DynamicModelChoiceField, DynamicModelMultipleChoiceField, SmallTextarea, SlugField, StaticSelect2, - StaticSelect2Multiple, TagFilterField, + DynamicModelChoiceField, DynamicModelMultipleChoiceField, SelectSpeedWidget, SmallTextarea, SlugField, + StaticSelect2, StaticSelect2Multiple, TagFilterField, ) from .choices import CircuitStatusChoices from .models import Circuit, CircuitTermination, CircuitType, Provider @@ -33,6 +33,10 @@ class ProviderForm(BootstrapMixin, CustomFieldModelForm): fields = [ 'name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments', 'tags', ] + fieldsets = ( + ('Provider', ('name', 'slug', 'asn')), + ('Support Info', ('account', 'portal_url', 'noc_contact', 'admin_contact')), + ) widgets = { 'noc_contact': SmallTextarea( attrs={'rows': 5} @@ -127,7 +131,7 @@ class ProviderFilterForm(BootstrapMixin, CustomFieldFilterForm): # Circuit types # -class CircuitTypeForm(BootstrapMixin, forms.ModelForm): +class CircuitTypeForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -171,6 +175,10 @@ class CircuitForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'cid', 'type', 'provider', 'status', 'install_date', 'commit_rate', 'description', 'tenant_group', 'tenant', 'comments', 'tags', ] + fieldsets = ( + ('Circuit', ('provider', 'cid', 'type', 'status', 'install_date', 'commit_rate', 'description')), + ('Tenancy', ('tenant_group', 'tenant')), + ) help_texts = { 'cid': "Unique circuit ID", 'commit_rate': "Committed rate", @@ -178,6 +186,7 @@ class CircuitForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): widgets = { 'status': StaticSelect2(), 'install_date': DatePicker(), + 'commit_rate': SelectSpeedWidget(), } diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index 9fea26652..eec05dab8 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -52,7 +52,6 @@ class ProviderView(generic.ObjectView): class ProviderEditView(generic.ObjectEditView): queryset = Provider.objects.all() model_form = forms.ProviderForm - template_name = 'circuits/provider_edit.html' class ProviderDeleteView(generic.ObjectDeleteView): @@ -160,7 +159,6 @@ class CircuitView(generic.ObjectView): class CircuitEditView(generic.ObjectEditView): queryset = Circuit.objects.all() model_form = forms.CircuitForm - template_name = 'circuits/circuit_edit.html' class CircuitDeleteView(generic.ObjectDeleteView): diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 40c16d59f..30c92bad8 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -231,6 +231,14 @@ class SiteForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'physical_address', 'shipping_address', 'latitude', 'longitude', 'contact_name', 'contact_phone', 'contact_email', 'comments', 'tags', ] + fieldsets = ( + ('Site', ('name', 'slug', 'status', 'region', 'facility', 'asn', 'time_zone', 'description')), + ('Tenancy', ('tenant_group', 'tenant')), + ('Contact Info', ( + 'physical_address', 'shipping_address', 'latitude', 'longitude', 'contact_name', 'contact_phone', + 'contact_email', + )), + ) widgets = { 'physical_address': SmallTextarea( attrs={ @@ -780,8 +788,12 @@ class RackReservationForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): class Meta: model = RackReservation fields = [ - 'rack', 'units', 'user', 'tenant_group', 'tenant', 'description', 'tags', + 'region', 'site', 'rack_group', 'rack', 'units', 'user', 'tenant_group', 'tenant', 'description', 'tags', ] + fieldsets = ( + ('Reservation', ('region', 'site', 'rack_group', 'rack', 'units', 'user', 'description')), + ('Tenancy', ('tenant_group', 'tenant')), + ) class RackReservationCSVForm(CustomFieldModelCSVForm): @@ -941,6 +953,12 @@ class DeviceTypeForm(BootstrapMixin, CustomFieldModelForm): 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'subdevice_role', 'front_image', 'rear_image', 'comments', 'tags', ] + fieldsets = ( + ('Device Type', ( + 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'subdevice_role', + )), + ('Images', ('front_image', 'rear_image')), + ) widgets = { 'subdevice_role': StaticSelect2(), # Exclude SVG images (unsupported by PIL) @@ -4382,6 +4400,9 @@ class PowerPanelForm(BootstrapMixin, CustomFieldModelForm): fields = [ 'region', 'site', 'rack_group', 'name', 'tags', ] + fieldsets = ( + ('Power Panel', ('region', 'site', 'rack_group', 'name')), + ) class PowerPanelCSVForm(CustomFieldModelCSVForm): @@ -4520,6 +4541,11 @@ class PowerFeedForm(BootstrapMixin, CustomFieldModelForm): 'region', 'site', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage', 'max_utilization', 'comments', 'tags', ] + fieldsets = ( + ('Power Panel', ('region', 'site', 'power_panel')), + ('Power Feed', ('rack', 'name', 'status', 'type')), + ('Characteristics', ('supply', 'voltage', 'amperage', 'phase', 'max_utilization')), + ) widgets = { 'status': StaticSelect2(), 'type': StaticSelect2(), diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index b092be612..7df0ea458 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -178,7 +178,6 @@ class SiteView(generic.ObjectView): class SiteEditView(generic.ObjectEditView): queryset = Site.objects.all() model_form = forms.SiteForm - template_name = 'dcim/site_edit.html' class SiteDeleteView(generic.ObjectDeleteView): @@ -421,7 +420,6 @@ class RackReservationView(generic.ObjectView): class RackReservationEditView(generic.ObjectEditView): queryset = RackReservation.objects.all() model_form = forms.RackReservationForm - template_name = 'dcim/rackreservation_edit.html' def alter_obj(self, obj, request, args, kwargs): if not obj.pk: @@ -577,7 +575,6 @@ class DeviceTypeView(generic.ObjectView): class DeviceTypeEditView(generic.ObjectEditView): queryset = DeviceType.objects.all() model_form = forms.DeviceTypeForm - template_name = 'dcim/devicetype_edit.html' class DeviceTypeDeleteView(generic.ObjectDeleteView): @@ -2591,7 +2588,6 @@ class PowerPanelView(generic.ObjectView): class PowerPanelEditView(generic.ObjectEditView): queryset = PowerPanel.objects.all() model_form = forms.PowerPanelForm - template_name = 'dcim/powerpanel_edit.html' class PowerPanelDeleteView(generic.ObjectDeleteView): @@ -2639,7 +2635,6 @@ class PowerFeedView(generic.ObjectView): class PowerFeedEditView(generic.ObjectEditView): queryset = PowerFeed.objects.all() model_form = forms.PowerFeedForm - template_name = 'dcim/powerfeed_edit.html' class PowerFeedDeleteView(generic.ObjectDeleteView): diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index 932d07a4d..fbafd893b 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -116,6 +116,9 @@ class TagForm(BootstrapMixin, forms.ModelForm): fields = [ 'name', 'slug', 'color', 'description' ] + fieldsets = ( + ('Tag', ('name', 'slug', 'color', 'description')), + ) class TagCSVForm(CSVModelForm): diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 57483345c..a6315aa51 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -37,7 +37,6 @@ class TagListView(generic.ObjectListView): class TagEditView(generic.ObjectEditView): queryset = Tag.objects.all() model_form = forms.TagForm - template_name = 'extras/tag_edit.html' class TagDeleteView(generic.ObjectDeleteView): diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index e2cb51417..0c8f7de24 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -50,6 +50,11 @@ class VRFForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'name', 'rd', 'enforce_unique', 'description', 'import_targets', 'export_targets', 'tenant_group', 'tenant', 'tags', ] + fieldsets = ( + ('VRF', ('name', 'rd', 'enforce_unique', 'description')), + ('Route Targets', ('import_targets', 'export_targets')), + ('Tenancy', ('tenant_group', 'tenant')), + ) labels = { 'rd': "RD", } @@ -240,6 +245,10 @@ class AggregateForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): fields = [ 'prefix', 'rir', 'date_added', 'description', 'tenant_group', 'tenant', 'tags', ] + fieldsets = ( + ('Aggregate', ('prefix', 'rir', 'date_added', 'description')), + ('Tenancy', ('tenant_group', 'tenant')), + ) help_texts = { 'prefix': "IPv4 or IPv6 network", 'rir': "Regional Internet Registry responsible for this prefix", @@ -404,6 +413,11 @@ class PrefixForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'prefix', 'vrf', 'site', 'vlan', 'status', 'role', 'is_pool', 'description', 'tenant_group', 'tenant', 'tags', ] + fieldsets = ( + ('Prefix', ('prefix', 'status', 'vrf', 'role', 'description', 'is_pool')), + ('Site/VLAN Assignment', ('region', 'site', 'vlan_group', 'vlan')), + ('Tenancy', ('tenant_group', 'tenant')), + ) widgets = { 'status': StaticSelect2(), } @@ -1163,6 +1177,11 @@ class VLANForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): fields = [ 'site', 'group', 'vid', 'name', 'status', 'role', 'description', 'tenant_group', 'tenant', 'tags', ] + fieldsets = ( + ('VLAN', ('vid', 'name', 'status', 'role', 'description')), + ('Assignment', ('region', 'site', 'group')), + ('Tenancy', ('tenant_group', 'tenant')), + ) help_texts = { 'site': "Leave blank if this VLAN spans multiple sites", 'group': "VLAN group (optional)", diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 39a840f7f..bada223e3 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -50,7 +50,6 @@ class VRFView(generic.ObjectView): class VRFEditView(generic.ObjectEditView): queryset = VRF.objects.all() model_form = forms.VRFForm - template_name = 'ipam/vrf_edit.html' class VRFDeleteView(generic.ObjectDeleteView): @@ -245,7 +244,6 @@ class AggregateView(generic.ObjectView): class AggregateEditView(generic.ObjectEditView): queryset = Aggregate.objects.all() model_form = forms.AggregateForm - template_name = 'ipam/aggregate_edit.html' class AggregateDeleteView(generic.ObjectDeleteView): @@ -444,7 +442,6 @@ class PrefixIPAddressesView(generic.ObjectView): class PrefixEditView(generic.ObjectEditView): queryset = Prefix.objects.all() model_form = forms.PrefixForm - template_name = 'ipam/prefix_edit.html' class PrefixDeleteView(generic.ObjectDeleteView): @@ -769,7 +766,6 @@ class VLANVMInterfacesView(generic.ObjectView): class VLANEditView(generic.ObjectEditView): queryset = VLAN.objects.all() model_form = forms.VLANForm - template_name = 'ipam/vlan_edit.html' class VLANDeleteView(generic.ObjectDeleteView): diff --git a/netbox/templates/circuits/circuit_edit.html b/netbox/templates/circuits/circuit_edit.html deleted file mode 100644 index fe0c6847d..000000000 --- a/netbox/templates/circuits/circuit_edit.html +++ /dev/null @@ -1,62 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Circuit
-
- {% render_field form.provider %} - {% render_field form.cid %} - {% render_field form.type %} - {% render_field form.status %} - {% render_field form.install_date %} -
- -
-
- {{ form.commit_rate }} - {% include 'circuits/inc/speed_widget.html' with target_field='commit_rate' %} -
- {{ form.commit_rate.help_text }} -
-
- {% render_field form.description %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} - -{% block javascript %} - -{% endblock %} diff --git a/netbox/templates/circuits/provider_edit.html b/netbox/templates/circuits/provider_edit.html deleted file mode 100644 index ee0a3a285..000000000 --- a/netbox/templates/circuits/provider_edit.html +++ /dev/null @@ -1,42 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Provider
-
- {% render_field form.name %} - {% render_field form.slug %} - {% render_field form.asn %} -
-
-
-
Support Info
-
- {% render_field form.account %} - {% render_field form.portal_url %} - {% render_field form.noc_contact %} - {% render_field form.admin_contact %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/templates/dcim/devicetype_edit.html b/netbox/templates/dcim/devicetype_edit.html deleted file mode 100644 index 5aba04b39..000000000 --- a/netbox/templates/dcim/devicetype_edit.html +++ /dev/null @@ -1,44 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Device Type
-
- {% render_field form.manufacturer %} - {% render_field form.model %} - {% render_field form.slug %} - {% render_field form.part_number %} - {% render_field form.u_height %} - {% render_field form.is_full_depth %} - {% render_field form.subdevice_role %} -
-
-
-
Rack Images
-
- {% render_field form.front_image %} - {% render_field form.rear_image %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/templates/dcim/powerfeed_edit.html b/netbox/templates/dcim/powerfeed_edit.html deleted file mode 100644 index 0a6581444..000000000 --- a/netbox/templates/dcim/powerfeed_edit.html +++ /dev/null @@ -1,52 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Power Panel
-
- {% render_field form.region %} - {% render_field form.site %} - {% render_field form.power_panel %} -
-
-
-
Power Feed
-
- {% render_field form.rack %} - {% render_field form.name %} - {% render_field form.status %} -
-
-
-
Characteristics
-
- {% render_field form.type %} - {% render_field form.supply %} - {% render_field form.voltage %} - {% render_field form.amperage %} - {% render_field form.phase %} - {% render_field form.max_utilization %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/templates/dcim/powerpanel_edit.html b/netbox/templates/dcim/powerpanel_edit.html deleted file mode 100644 index c1890cd47..000000000 --- a/netbox/templates/dcim/powerpanel_edit.html +++ /dev/null @@ -1,23 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Power Panel
-
- {% render_field form.region %} - {% render_field form.site %} - {% render_field form.rack_group %} - {% render_field form.name %} - {% render_field form.tags %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -{% endblock %} diff --git a/netbox/templates/dcim/rackreservation_edit.html b/netbox/templates/dcim/rackreservation_edit.html deleted file mode 100644 index 1465dc02d..000000000 --- a/netbox/templates/dcim/rackreservation_edit.html +++ /dev/null @@ -1,33 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Rack Reservation
-
- {% render_field form.region %} - {% render_field form.site %} - {% render_field form.rack_group %} - {% render_field form.rack %} - {% render_field form.units %} - {% render_field form.user %} - {% render_field form.description %} - {% render_field form.tags %} -
-
-
-
Tenant Assignment
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -{% endblock %} diff --git a/netbox/templates/dcim/site_edit.html b/netbox/templates/dcim/site_edit.html deleted file mode 100644 index 274863fc4..000000000 --- a/netbox/templates/dcim/site_edit.html +++ /dev/null @@ -1,57 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Site
-
- {% render_field form.name %} - {% render_field form.slug %} - {% render_field form.status %} - {% render_field form.region %} - {% render_field form.facility %} - {% render_field form.asn %} - {% render_field form.time_zone %} - {% render_field form.description %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
-
-
Contact Info
-
- {% render_field form.physical_address %} - {% render_field form.shipping_address %} - {% render_field form.latitude %} - {% render_field form.longitude %} - {% render_field form.contact_name %} - {% render_field form.contact_phone %} - {% render_field form.contact_email %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/templates/extras/tag_edit.html b/netbox/templates/extras/tag_edit.html deleted file mode 100644 index 1516bde39..000000000 --- a/netbox/templates/extras/tag_edit.html +++ /dev/null @@ -1,14 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Tag
-
- {% render_field form.name %} - {% render_field form.slug %} - {% render_field form.color %} - {% render_field form.description %} -
-
-{% endblock %} diff --git a/netbox/templates/ipam/aggregate_edit.html b/netbox/templates/ipam/aggregate_edit.html deleted file mode 100644 index f27abd663..000000000 --- a/netbox/templates/ipam/aggregate_edit.html +++ /dev/null @@ -1,35 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Aggregate
-
- {% render_field form.prefix %} - {% render_field form.rir %} - {% render_field form.date_added %} - {% render_field form.description %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-{% endblock %} diff --git a/netbox/templates/ipam/prefix_edit.html b/netbox/templates/ipam/prefix_edit.html deleted file mode 100644 index 3505c373b..000000000 --- a/netbox/templates/ipam/prefix_edit.html +++ /dev/null @@ -1,46 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Prefix
-
- {% render_field form.prefix %} - {% render_field form.status %} - {% render_field form.vrf %} - {% render_field form.role %} - {% render_field form.description %} - {% render_field form.is_pool %} -
-
-
-
Site/VLAN Assignment
-
- {% render_field form.region %} - {% render_field form.site %} - {% render_field form.vlan_group %} - {% render_field form.vlan %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-{% endblock %} diff --git a/netbox/templates/ipam/vlan_edit.html b/netbox/templates/ipam/vlan_edit.html deleted file mode 100644 index 54dcf727a..000000000 --- a/netbox/templates/ipam/vlan_edit.html +++ /dev/null @@ -1,44 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
VLAN
-
- {% render_field form.vid %} - {% render_field form.name %} - {% render_field form.status %} - {% render_field form.role %} - {% render_field form.description %} -
-
-
-
Assignment
-
- {% render_field form.region %} - {% render_field form.site %} - {% render_field form.group %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-{% endblock %} diff --git a/netbox/templates/ipam/vrf_edit.html b/netbox/templates/ipam/vrf_edit.html deleted file mode 100644 index 189b9c129..000000000 --- a/netbox/templates/ipam/vrf_edit.html +++ /dev/null @@ -1,42 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
VRF
-
- {% render_field form.name %} - {% render_field form.rd %} - {% render_field form.enforce_unique %} - {% render_field form.description %} -
-
-
-
Route Targets
-
- {% render_field form.import_targets %} - {% render_field form.export_targets %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-{% endblock %} diff --git a/netbox/templates/tenancy/tenant_edit.html b/netbox/templates/tenancy/tenant_edit.html deleted file mode 100644 index 8a1d1d1b6..000000000 --- a/netbox/templates/tenancy/tenant_edit.html +++ /dev/null @@ -1,35 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load static %} -{% load form_helpers %} - -{% block form %} -
-
Tenant
-
- {% render_field form.name %} - {% render_field form.slug %} - {% render_field form.group %} - {% render_field form.description %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/templates/virtualization/cluster_edit.html b/netbox/templates/virtualization/cluster_edit.html deleted file mode 100644 index f43fc717f..000000000 --- a/netbox/templates/virtualization/cluster_edit.html +++ /dev/null @@ -1,42 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Cluster
-
- {% render_field form.name %} - {% render_field form.type %} - {% render_field form.group %} - {% render_field form.region %} - {% render_field form.site %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/templates/virtualization/virtualmachine_edit.html b/netbox/templates/virtualization/virtualmachine_edit.html deleted file mode 100644 index 6bffabadd..000000000 --- a/netbox/templates/virtualization/virtualmachine_edit.html +++ /dev/null @@ -1,69 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
-
Virtual Machine
-
- {% render_field form.name %} - {% render_field form.role %} -
-
-
-
Cluster
-
- {% render_field form.cluster_group %} - {% render_field form.cluster %} -
-
-
-
Management
-
- {% render_field form.status %} - {% render_field form.platform %} - {% render_field form.primary_ip4 %} - {% render_field form.primary_ip6 %} -
-
-
-
Resources
-
- {% render_field form.vcpus %} - {% render_field form.memory %} - {% render_field form.disk %} -
-
-
-
Tenancy
-
- {% render_field form.tenant_group %} - {% render_field form.tenant %} -
-
- {% if form.custom_fields %} -
-
Custom Fields
-
- {% render_custom_fields form %} -
-
- {% endif %} -
-
Local Config Context Data
-
- {% render_field form.local_context_data %} -
-
-
-
Tags
-
- {% render_field form.tags %} -
-
-
-
Comments
-
- {% render_field form.comments %} -
-
-{% endblock %} diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index bceab7ce7..ee9adefc0 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -64,6 +64,9 @@ class TenantForm(BootstrapMixin, CustomFieldModelForm): fields = ( 'name', 'slug', 'group', 'description', 'comments', 'tags', ) + fieldsets = ( + ('Tenant', ('name', 'slug', 'group', 'description')), + ) class TenantCSVForm(CustomFieldModelCSVForm): diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index 9fd77d88e..4c72cea42 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -87,7 +87,6 @@ class TenantView(generic.ObjectView): class TenantEditView(generic.ObjectEditView): queryset = Tenant.objects.all() model_form = forms.TenantForm - template_name = 'tenancy/tenant_edit.html' class TenantDeleteView(generic.ObjectDeleteView): diff --git a/netbox/virtualization/forms.py b/netbox/virtualization/forms.py index edacb3e07..7e0c45378 100644 --- a/netbox/virtualization/forms.py +++ b/netbox/virtualization/forms.py @@ -104,6 +104,10 @@ class ClusterForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): fields = ( 'name', 'type', 'group', 'tenant', 'region', 'site', 'comments', 'tags', ) + fieldsets = ( + ('Cluster', ('name', 'type', 'group', 'region', 'site')), + ('Tenancy', ('tenant_group', 'tenant')), + ) class ClusterCSVForm(CustomFieldModelCSVForm): @@ -321,6 +325,13 @@ class VirtualMachineForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'name', 'status', 'cluster_group', 'cluster', 'role', 'tenant_group', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'tags', 'local_context_data', ] + fieldsets = ( + ('Virtual Machine', ('name', 'role', 'status')), + ('Cluster', ('cluster_group', 'cluster')), + ('Management', ('platform', 'primary_ip4', 'primary_ip6')), + ('Resources', ('vcpus', 'memory', 'disk')), + ('Config Context', ('local_context_data',)), + ) help_texts = { 'local_context_data': "Local config context data overwrites all sources contexts in the final rendered " "config context", diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py index dcf9ebcda..e5fe05858 100644 --- a/netbox/virtualization/views.py +++ b/netbox/virtualization/views.py @@ -114,7 +114,6 @@ class ClusterView(generic.ObjectView): class ClusterEditView(generic.ObjectEditView): - template_name = 'virtualization/cluster_edit.html' queryset = Cluster.objects.all() model_form = forms.ClusterForm @@ -276,7 +275,6 @@ class VirtualMachineConfigContextView(ObjectConfigContextView): class VirtualMachineEditView(generic.ObjectEditView): queryset = VirtualMachine.objects.all() model_form = forms.VirtualMachineForm - template_name = 'virtualization/virtualmachine_edit.html' class VirtualMachineDeleteView(generic.ObjectDeleteView): From cef8204f4024d49eb99720fac975a70475cffb7f Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 14:03:14 -0500 Subject: [PATCH 126/302] Merge tags fields with primary object fields in form display --- netbox/circuits/forms.py | 4 ++-- netbox/dcim/forms.py | 10 +++++----- netbox/ipam/forms.py | 8 ++++---- netbox/templates/dcim/device_edit.html | 7 +------ netbox/templates/dcim/interface_edit.html | 7 +------ netbox/templates/dcim/rack_edit.html | 14 +++++++------- netbox/templates/generic/object_edit.html | 8 -------- netbox/templates/ipam/ipaddress_bulk_add.html | 7 +------ netbox/templates/ipam/ipaddress_edit.html | 7 +------ netbox/templates/ipam/service_edit.html | 7 +------ netbox/templates/secrets/secret_edit.html | 7 +------ .../templates/virtualization/vminterface_edit.html | 7 +------ netbox/tenancy/forms.py | 2 +- netbox/virtualization/forms.py | 4 ++-- 14 files changed, 28 insertions(+), 71 deletions(-) diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 8c35d972d..6a2577edb 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -34,7 +34,7 @@ class ProviderForm(BootstrapMixin, CustomFieldModelForm): 'name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments', 'tags', ] fieldsets = ( - ('Provider', ('name', 'slug', 'asn')), + ('Provider', ('name', 'slug', 'asn', 'tags')), ('Support Info', ('account', 'portal_url', 'noc_contact', 'admin_contact')), ) widgets = { @@ -176,7 +176,7 @@ class CircuitForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'comments', 'tags', ] fieldsets = ( - ('Circuit', ('provider', 'cid', 'type', 'status', 'install_date', 'commit_rate', 'description')), + ('Circuit', ('provider', 'cid', 'type', 'status', 'install_date', 'commit_rate', 'description', 'tags')), ('Tenancy', ('tenant_group', 'tenant')), ) help_texts = { diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 30c92bad8..3428dec57 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -232,7 +232,7 @@ class SiteForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'contact_email', 'comments', 'tags', ] fieldsets = ( - ('Site', ('name', 'slug', 'status', 'region', 'facility', 'asn', 'time_zone', 'description')), + ('Site', ('name', 'slug', 'status', 'region', 'facility', 'asn', 'time_zone', 'description', 'tags')), ('Tenancy', ('tenant_group', 'tenant')), ('Contact Info', ( 'physical_address', 'shipping_address', 'latitude', 'longitude', 'contact_name', 'contact_phone', @@ -791,7 +791,7 @@ class RackReservationForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'region', 'site', 'rack_group', 'rack', 'units', 'user', 'tenant_group', 'tenant', 'description', 'tags', ] fieldsets = ( - ('Reservation', ('region', 'site', 'rack_group', 'rack', 'units', 'user', 'description')), + ('Reservation', ('region', 'site', 'rack_group', 'rack', 'units', 'user', 'description', 'tags')), ('Tenancy', ('tenant_group', 'tenant')), ) @@ -955,7 +955,7 @@ class DeviceTypeForm(BootstrapMixin, CustomFieldModelForm): ] fieldsets = ( ('Device Type', ( - 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'subdevice_role', + 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'subdevice_role', 'tags', )), ('Images', ('front_image', 'rear_image')), ) @@ -4401,7 +4401,7 @@ class PowerPanelForm(BootstrapMixin, CustomFieldModelForm): 'region', 'site', 'rack_group', 'name', 'tags', ] fieldsets = ( - ('Power Panel', ('region', 'site', 'rack_group', 'name')), + ('Power Panel', ('region', 'site', 'rack_group', 'name', 'tags')), ) @@ -4543,7 +4543,7 @@ class PowerFeedForm(BootstrapMixin, CustomFieldModelForm): ] fieldsets = ( ('Power Panel', ('region', 'site', 'power_panel')), - ('Power Feed', ('rack', 'name', 'status', 'type')), + ('Power Feed', ('rack', 'name', 'status', 'type', 'tags')), ('Characteristics', ('supply', 'voltage', 'amperage', 'phase', 'max_utilization')), ) widgets = { diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 0c8f7de24..7e45c30b3 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -51,7 +51,7 @@ class VRFForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'tags', ] fieldsets = ( - ('VRF', ('name', 'rd', 'enforce_unique', 'description')), + ('VRF', ('name', 'rd', 'enforce_unique', 'description', 'tags')), ('Route Targets', ('import_targets', 'export_targets')), ('Tenancy', ('tenant_group', 'tenant')), ) @@ -246,7 +246,7 @@ class AggregateForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'prefix', 'rir', 'date_added', 'description', 'tenant_group', 'tenant', 'tags', ] fieldsets = ( - ('Aggregate', ('prefix', 'rir', 'date_added', 'description')), + ('Aggregate', ('prefix', 'rir', 'date_added', 'description', 'tags')), ('Tenancy', ('tenant_group', 'tenant')), ) help_texts = { @@ -414,7 +414,7 @@ class PrefixForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'tags', ] fieldsets = ( - ('Prefix', ('prefix', 'status', 'vrf', 'role', 'description', 'is_pool')), + ('Prefix', ('prefix', 'status', 'vrf', 'role', 'is_pool', 'description', 'tags')), ('Site/VLAN Assignment', ('region', 'site', 'vlan_group', 'vlan')), ('Tenancy', ('tenant_group', 'tenant')), ) @@ -1178,7 +1178,7 @@ class VLANForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'site', 'group', 'vid', 'name', 'status', 'role', 'description', 'tenant_group', 'tenant', 'tags', ] fieldsets = ( - ('VLAN', ('vid', 'name', 'status', 'role', 'description')), + ('VLAN', ('vid', 'name', 'status', 'role', 'description', 'tags')), ('Assignment', ('region', 'site', 'group')), ('Tenancy', ('tenant_group', 'tenant')), ) diff --git a/netbox/templates/dcim/device_edit.html b/netbox/templates/dcim/device_edit.html index 023b7e43c..31b9dddb0 100644 --- a/netbox/templates/dcim/device_edit.html +++ b/netbox/templates/dcim/device_edit.html @@ -7,6 +7,7 @@
{% render_field form.name %} {% render_field form.device_role %} + {% render_field form.tags %}
@@ -92,12 +93,6 @@ {% render_field form.local_context_data %}
-
-
Tags
-
- {% render_field form.tags %} -
-
Comments
diff --git a/netbox/templates/dcim/interface_edit.html b/netbox/templates/dcim/interface_edit.html index 1f549febd..a1eb2cee1 100644 --- a/netbox/templates/dcim/interface_edit.html +++ b/netbox/templates/dcim/interface_edit.html @@ -24,6 +24,7 @@ {% render_field form.mtu %} {% render_field form.mgmt_only %} {% render_field form.description %} + {% render_field form.tags %}
@@ -34,12 +35,6 @@ {% render_field form.tagged_vlans %}
-
-
Tags
-
- {% render_field form.tags %} -
-
{% endblock %} {% block buttons %} diff --git a/netbox/templates/dcim/rack_edit.html b/netbox/templates/dcim/rack_edit.html index 9ce242191..8d23467e3 100644 --- a/netbox/templates/dcim/rack_edit.html +++ b/netbox/templates/dcim/rack_edit.html @@ -9,9 +9,15 @@ {% render_field form.site %} {% render_field form.group %} {% render_field form.name %} - {% render_field form.facility_id %} {% render_field form.status %} {% render_field form.role %} + {% render_field form.tags %} +
+
+
+
Inventory Control
+
+ {% render_field form.facility_id %} {% render_field form.serial %} {% render_field form.asset_tag %}
@@ -52,12 +58,6 @@
{% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
Comments
diff --git a/netbox/templates/generic/object_edit.html b/netbox/templates/generic/object_edit.html index 7056256ec..a07b2dfaf 100644 --- a/netbox/templates/generic/object_edit.html +++ b/netbox/templates/generic/object_edit.html @@ -50,14 +50,6 @@
{% endif %} - {% if form.tags %} -
-
Tags
-
- {% render_field form.tags %} -
-
- {% endif %} {% if form.comments %}
Comments
diff --git a/netbox/templates/ipam/ipaddress_bulk_add.html b/netbox/templates/ipam/ipaddress_bulk_add.html index f019d48b8..db103b43b 100644 --- a/netbox/templates/ipam/ipaddress_bulk_add.html +++ b/netbox/templates/ipam/ipaddress_bulk_add.html @@ -17,6 +17,7 @@ {% render_field model_form.role %} {% render_field model_form.vrf %} {% render_field model_form.description %} + {% render_field model_form.tags %}
@@ -26,12 +27,6 @@ {% render_field model_form.tenant %}
-
-
Tags
-
- {% render_field model_form.tags %} -
-
{% if model_form.custom_fields %}
Custom Fields
diff --git a/netbox/templates/ipam/ipaddress_edit.html b/netbox/templates/ipam/ipaddress_edit.html index eb15a3059..33e58ce09 100644 --- a/netbox/templates/ipam/ipaddress_edit.html +++ b/netbox/templates/ipam/ipaddress_edit.html @@ -19,6 +19,7 @@ {% render_field form.vrf %} {% render_field form.dns_name %} {% render_field form.description %} + {% render_field form.tags %}
@@ -78,12 +79,6 @@ {% render_field form.nat_inside %}
-
-
Tags
-
- {% render_field form.tags %} -
-
{% if form.custom_fields %}
Custom Fields
diff --git a/netbox/templates/ipam/service_edit.html b/netbox/templates/ipam/service_edit.html index 8d6fde9e9..7cc74f450 100644 --- a/netbox/templates/ipam/service_edit.html +++ b/netbox/templates/ipam/service_edit.html @@ -31,6 +31,7 @@
{% render_field form.ipaddresses %} {% render_field form.description %} + {% render_field form.tags %} {% if form.custom_fields %} @@ -41,10 +42,4 @@ {% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
{% endblock %} diff --git a/netbox/templates/secrets/secret_edit.html b/netbox/templates/secrets/secret_edit.html index 4e2d78042..b7e7ab785 100644 --- a/netbox/templates/secrets/secret_edit.html +++ b/netbox/templates/secrets/secret_edit.html @@ -39,6 +39,7 @@ {% render_field form.role %} {% render_field form.name %} {% render_field form.userkeys %} + {% render_field form.tags %}
@@ -72,12 +73,6 @@
{% endif %} -
-
Tags
-
- {% render_field form.tags %} -
-
diff --git a/netbox/templates/virtualization/vminterface_edit.html b/netbox/templates/virtualization/vminterface_edit.html index d1fe6d104..d4869aaf9 100644 --- a/netbox/templates/virtualization/vminterface_edit.html +++ b/netbox/templates/virtualization/vminterface_edit.html @@ -20,6 +20,7 @@ {% render_field form.mac_address %} {% render_field form.mtu %} {% render_field form.description %} + {% render_field form.tags %}
@@ -30,12 +31,6 @@ {% render_field form.tagged_vlans %}
-
-
Tags
-
- {% render_field form.tags %} -
-
{% endblock %} {% block buttons %} diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index ee9adefc0..97e72bb02 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -65,7 +65,7 @@ class TenantForm(BootstrapMixin, CustomFieldModelForm): 'name', 'slug', 'group', 'description', 'comments', 'tags', ) fieldsets = ( - ('Tenant', ('name', 'slug', 'group', 'description')), + ('Tenant', ('name', 'slug', 'group', 'description', 'tags')), ) diff --git a/netbox/virtualization/forms.py b/netbox/virtualization/forms.py index 7e0c45378..addfb05cd 100644 --- a/netbox/virtualization/forms.py +++ b/netbox/virtualization/forms.py @@ -105,7 +105,7 @@ class ClusterForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'name', 'type', 'group', 'tenant', 'region', 'site', 'comments', 'tags', ) fieldsets = ( - ('Cluster', ('name', 'type', 'group', 'region', 'site')), + ('Cluster', ('name', 'type', 'group', 'region', 'site', 'tags')), ('Tenancy', ('tenant_group', 'tenant')), ) @@ -326,7 +326,7 @@ class VirtualMachineForm(BootstrapMixin, TenancyForm, CustomFieldModelForm): 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'tags', 'local_context_data', ] fieldsets = ( - ('Virtual Machine', ('name', 'role', 'status')), + ('Virtual Machine', ('name', 'role', 'status', 'tags')), ('Cluster', ('cluster_group', 'cluster')), ('Management', ('platform', 'primary_ip4', 'primary_ip6')), ('Resources', ('vcpus', 'memory', 'disk')), From d6cf385a3c5363c63007b3d40b8e3152e708170a Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 14:12:34 -0500 Subject: [PATCH 127/302] Update CircuitTermination fields to use SelectSpeedWidget --- netbox/circuits/forms.py | 2 + .../circuits/circuittermination_edit.html | 130 +++++------------- .../templates/circuits/inc/speed_widget.html | 17 --- 3 files changed, 40 insertions(+), 109 deletions(-) delete mode 100644 netbox/templates/circuits/inc/speed_widget.html diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 6a2577edb..18d49d08e 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -338,4 +338,6 @@ class CircuitTerminationForm(BootstrapMixin, forms.ModelForm): } widgets = { 'term_side': forms.HiddenInput(), + 'port_speed': SelectSpeedWidget(), + 'upstream_speed': SelectSpeedWidget(), } diff --git a/netbox/templates/circuits/circuittermination_edit.html b/netbox/templates/circuits/circuittermination_edit.html index 43dba8438..917fca970 100644 --- a/netbox/templates/circuits/circuittermination_edit.html +++ b/netbox/templates/circuits/circuittermination_edit.html @@ -1,97 +1,43 @@ -{% extends 'base.html' %} +{% extends 'generic/object_edit.html' %} {% load static %} {% load form_helpers %} -{% block content %} -
- {% csrf_token %} - {% for field in form.hidden_fields %} - {{ field }} - {% endfor %} -
-
-

{% block title %}{{ obj.circuit.provider }} {{ obj.circuit }} - Side {{ form.term_side.value }}{% endblock %}

- {% if form.non_field_errors %} -
-
Errors
-
- {{ form.non_field_errors }} -
-
- {% endif %} -
-
Location
-
-
- -
-

{{ obj.circuit.provider }}

-
-
-
- -
-

{{ obj.circuit.cid }}

-
-
-
- -
-

{{ form.term_side.value }}

-
-
- {% render_field form.region %} - {% render_field form.site %} -
-
-
-
Termination Details
-
-
- -
-
- {{ form.port_speed }} - {% include 'circuits/inc/speed_widget.html' with target_field='port_speed' %} -
- {{ form.port_speed.help_text }} -
-
-
- -
-
- {{ form.upstream_speed }} - {% include 'circuits/inc/speed_widget.html' with target_field='upstream_speed' %} -
- {{ form.upstream_speed.help_text }} -
-
- {% render_field form.xconnect_id %} - {% render_field form.pp_info %} - {% render_field form.description %} -
-
-
-
-
-
- {% if obj.pk %} - - {% else %} - - {% endif %} - Cancel -
-
-
-{% endblock %} +{% block title %}{{ obj.circuit.provider }} {{ obj.circuit }} - Side {{ form.term_side.value }}{% endblock %} -{% block javascript %} - +{% block form %} +
+
Location
+
+
+ +
+

{{ obj.circuit.provider }}

+
+
+
+ +
+

{{ obj.circuit.cid }}

+
+
+
+ +
+

{{ form.term_side.value }}

+
+
+ {% render_field form.region %} + {% render_field form.site %} +
+
+
+
Termination Details
+
+ {% render_field form.port_speed %} + {% render_field form.upstream_speed %} + {% render_field form.xconnect_id %} + {% render_field form.pp_info %} + {% render_field form.description %} +
+
{% endblock %} diff --git a/netbox/templates/circuits/inc/speed_widget.html b/netbox/templates/circuits/inc/speed_widget.html deleted file mode 100644 index 988418945..000000000 --- a/netbox/templates/circuits/inc/speed_widget.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - From 664a39911cf28c22c45253e2077693bc2cd39ba6 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 15:58:13 -0500 Subject: [PATCH 128/302] Add custom field support for organizational models to API serializers --- netbox/circuits/api/serializers.py | 6 ++-- netbox/circuits/api/views.py | 2 +- netbox/dcim/api/serializers.py | 37 +++++++++++++++--------- netbox/dcim/api/views.py | 12 ++++---- netbox/ipam/api/serializers.py | 25 +++++++++++----- netbox/ipam/api/views.py | 6 ++-- netbox/secrets/api/serializers.py | 6 ++-- netbox/secrets/api/views.py | 3 +- netbox/tenancy/api/serializers.py | 7 +++-- netbox/tenancy/api/views.py | 3 +- netbox/virtualization/api/serializers.py | 12 +++++--- netbox/virtualization/api/views.py | 4 +-- 12 files changed, 77 insertions(+), 46 deletions(-) diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 12ec9ba7f..17dce6624 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -31,13 +31,15 @@ class ProviderSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # Circuits # -class CircuitTypeSerializer(ValidatedModelSerializer): +class CircuitTypeSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittype-detail') circuit_count = serializers.IntegerField(read_only=True) class Meta: model = CircuitType - fields = ['id', 'url', 'name', 'slug', 'description', 'circuit_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'description', 'custom_fields', 'created', 'last_updated', 'circuit_count', + ] class CircuitCircuitTerminationSerializer(WritableNestedSerializer, ConnectedEndpointSerializer): diff --git a/netbox/circuits/api/views.py b/netbox/circuits/api/views.py index 736871a73..c2fe3d089 100644 --- a/netbox/circuits/api/views.py +++ b/netbox/circuits/api/views.py @@ -34,7 +34,7 @@ class ProviderViewSet(CustomFieldModelViewSet): # Circuit Types # -class CircuitTypeViewSet(ModelViewSet): +class CircuitTypeViewSet(CustomFieldModelViewSet): queryset = CircuitType.objects.annotate( circuit_count=count_related(Circuit, 'type') ) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 6f497bfa6..3aa5dea2f 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -82,7 +82,7 @@ class ConnectedEndpointSerializer(ValidatedModelSerializer): # Regions/sites # -class RegionSerializer(serializers.ModelSerializer): +class RegionSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:region-detail') parent = NestedRegionSerializer(required=False, allow_null=True) site_count = serializers.IntegerField(read_only=True) @@ -90,7 +90,10 @@ class RegionSerializer(serializers.ModelSerializer): class Meta: model = Region - fields = ['id', 'url', 'name', 'slug', 'parent', 'description', 'site_count', '_depth'] + fields = [ + 'id', 'url', 'name', 'slug', 'parent', 'description', 'custom_fields', 'created', 'last_updated', + 'site_count', '_depth', + ] class SiteSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): @@ -120,7 +123,7 @@ class SiteSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # Racks # -class RackGroupSerializer(ValidatedModelSerializer): +class RackGroupSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rackgroup-detail') site = NestedSiteSerializer() parent = NestedRackGroupSerializer(required=False, allow_null=True) @@ -129,16 +132,22 @@ class RackGroupSerializer(ValidatedModelSerializer): class Meta: model = RackGroup - fields = ['id', 'url', 'name', 'slug', 'site', 'parent', 'description', 'rack_count', '_depth'] + fields = [ + 'id', 'url', 'name', 'slug', 'site', 'parent', 'description', 'custom_fields', 'created', 'last_updated', + 'rack_count', '_depth', + ] -class RackRoleSerializer(ValidatedModelSerializer): +class RackRoleSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rackrole-detail') rack_count = serializers.IntegerField(read_only=True) class Meta: model = RackRole - fields = ['id', 'url', 'name', 'slug', 'color', 'description', 'rack_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'color', 'description', 'custom_fields', 'created', 'last_updated', + 'rack_count', + ] class RackSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): @@ -242,7 +251,7 @@ class RackElevationDetailFilterSerializer(serializers.Serializer): # Device types # -class ManufacturerSerializer(ValidatedModelSerializer): +class ManufacturerSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:manufacturer-detail') devicetype_count = serializers.IntegerField(read_only=True) inventoryitem_count = serializers.IntegerField(read_only=True) @@ -251,7 +260,8 @@ class ManufacturerSerializer(ValidatedModelSerializer): class Meta: model = Manufacturer fields = [ - 'id', 'url', 'name', 'slug', 'description', 'devicetype_count', 'inventoryitem_count', 'platform_count', + 'id', 'url', 'name', 'slug', 'description', 'custom_fields', 'created', 'last_updated', 'devicetype_count', + 'inventoryitem_count', 'platform_count', ] @@ -378,7 +388,7 @@ class DeviceBayTemplateSerializer(ValidatedModelSerializer): # Devices # -class DeviceRoleSerializer(ValidatedModelSerializer): +class DeviceRoleSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:devicerole-detail') device_count = serializers.IntegerField(read_only=True) virtualmachine_count = serializers.IntegerField(read_only=True) @@ -386,11 +396,12 @@ class DeviceRoleSerializer(ValidatedModelSerializer): class Meta: model = DeviceRole fields = [ - 'id', 'url', 'name', 'slug', 'color', 'vm_role', 'description', 'device_count', 'virtualmachine_count', + 'id', 'url', 'name', 'slug', 'color', 'vm_role', 'description', 'custom_fields', 'created', 'last_updated', + 'device_count', 'virtualmachine_count', ] -class PlatformSerializer(ValidatedModelSerializer): +class PlatformSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:platform-detail') manufacturer = NestedManufacturerSerializer(required=False, allow_null=True) device_count = serializers.IntegerField(read_only=True) @@ -399,8 +410,8 @@ class PlatformSerializer(ValidatedModelSerializer): class Meta: model = Platform fields = [ - 'id', 'url', 'name', 'slug', 'manufacturer', 'napalm_driver', 'napalm_args', 'description', 'device_count', - 'virtualmachine_count', + 'id', 'url', 'name', 'slug', 'manufacturer', 'napalm_driver', 'napalm_args', 'description', 'custom_fields', + 'created', 'last_updated', 'device_count', 'virtualmachine_count', ] diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index ae39f6ad0..ae488a1e4 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -99,7 +99,7 @@ class PassThroughPortMixin(object): # Regions # -class RegionViewSet(ModelViewSet): +class RegionViewSet(CustomFieldModelViewSet): queryset = Region.objects.add_related_count( Region.objects.all(), Site, @@ -134,7 +134,7 @@ class SiteViewSet(CustomFieldModelViewSet): # Rack groups # -class RackGroupViewSet(ModelViewSet): +class RackGroupViewSet(CustomFieldModelViewSet): queryset = RackGroup.objects.add_related_count( RackGroup.objects.all(), Rack, @@ -150,7 +150,7 @@ class RackGroupViewSet(ModelViewSet): # Rack roles # -class RackRoleViewSet(ModelViewSet): +class RackRoleViewSet(CustomFieldModelViewSet): queryset = RackRole.objects.annotate( rack_count=count_related(Rack, 'role') ) @@ -238,7 +238,7 @@ class RackReservationViewSet(ModelViewSet): # Manufacturers # -class ManufacturerViewSet(ModelViewSet): +class ManufacturerViewSet(CustomFieldModelViewSet): queryset = Manufacturer.objects.annotate( devicetype_count=count_related(DeviceType, 'manufacturer'), inventoryitem_count=count_related(InventoryItem, 'manufacturer'), @@ -317,7 +317,7 @@ class DeviceBayTemplateViewSet(ModelViewSet): # Device roles # -class DeviceRoleViewSet(ModelViewSet): +class DeviceRoleViewSet(CustomFieldModelViewSet): queryset = DeviceRole.objects.annotate( device_count=count_related(Device, 'device_role'), virtualmachine_count=count_related(VirtualMachine, 'role') @@ -330,7 +330,7 @@ class DeviceRoleViewSet(ModelViewSet): # Platforms # -class PlatformViewSet(ModelViewSet): +class PlatformViewSet(CustomFieldModelViewSet): queryset = Platform.objects.annotate( device_count=count_related(Device, 'platform'), virtualmachine_count=count_related(VirtualMachine, 'platform') diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 9b8d36590..719ea51e2 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -67,13 +67,16 @@ class RouteTargetSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # RIRs/aggregates # -class RIRSerializer(ValidatedModelSerializer): +class RIRSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:rir-detail') aggregate_count = serializers.IntegerField(read_only=True) class Meta: model = RIR - fields = ['id', 'url', 'name', 'slug', 'is_private', 'description', 'aggregate_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'is_private', 'description', 'custom_fields', 'created', 'last_updated', + 'aggregate_count', + ] class AggregateSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): @@ -85,8 +88,8 @@ class AggregateSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): class Meta: model = Aggregate fields = [ - 'id', 'url', 'family', 'prefix', 'rir', 'tenant', 'date_added', 'description', 'tags', 'custom_fields', 'created', - 'last_updated', + 'id', 'url', 'family', 'prefix', 'rir', 'tenant', 'date_added', 'description', 'tags', 'custom_fields', + 'created', 'last_updated', ] read_only_fields = ['family'] @@ -95,24 +98,30 @@ class AggregateSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # VLANs # -class RoleSerializer(ValidatedModelSerializer): +class RoleSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:role-detail') prefix_count = serializers.IntegerField(read_only=True) vlan_count = serializers.IntegerField(read_only=True) class Meta: model = Role - fields = ['id', 'url', 'name', 'slug', 'weight', 'description', 'prefix_count', 'vlan_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'weight', 'description', 'custom_fields', 'created', 'last_updated', + 'prefix_count', 'vlan_count', + ] -class VLANGroupSerializer(ValidatedModelSerializer): +class VLANGroupSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:vlangroup-detail') site = NestedSiteSerializer(required=False, allow_null=True) vlan_count = serializers.IntegerField(read_only=True) class Meta: model = VLANGroup - fields = ['id', 'url', 'name', 'slug', 'site', 'description', 'vlan_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'site', 'description', 'custom_fields', 'created', 'last_updated', + 'vlan_count', + ] validators = [] def validate(self, data): diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index 16db8f04f..b6f0a7463 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -55,7 +55,7 @@ class RouteTargetViewSet(CustomFieldModelViewSet): # RIRs # -class RIRViewSet(ModelViewSet): +class RIRViewSet(CustomFieldModelViewSet): queryset = RIR.objects.annotate( aggregate_count=count_related(Aggregate, 'rir') ) @@ -77,7 +77,7 @@ class AggregateViewSet(CustomFieldModelViewSet): # Roles # -class RoleViewSet(ModelViewSet): +class RoleViewSet(CustomFieldModelViewSet): queryset = Role.objects.annotate( prefix_count=count_related(Prefix, 'role'), vlan_count=count_related(VLAN, 'role') @@ -282,7 +282,7 @@ class IPAddressViewSet(CustomFieldModelViewSet): # VLAN groups # -class VLANGroupViewSet(ModelViewSet): +class VLANGroupViewSet(CustomFieldModelViewSet): queryset = VLANGroup.objects.prefetch_related('site').annotate( vlan_count=count_related(VLAN, 'group') ) diff --git a/netbox/secrets/api/serializers.py b/netbox/secrets/api/serializers.py index b08b87bc5..627685de0 100644 --- a/netbox/secrets/api/serializers.py +++ b/netbox/secrets/api/serializers.py @@ -15,13 +15,15 @@ from .nested_serializers import * # Secrets # -class SecretRoleSerializer(ValidatedModelSerializer): +class SecretRoleSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='secrets-api:secretrole-detail') secret_count = serializers.IntegerField(read_only=True) class Meta: model = SecretRole - fields = ['id', 'url', 'name', 'slug', 'description', 'secret_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'description', 'custom_fields', 'created', 'last_updated', 'secret_count', + ] class SecretSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): diff --git a/netbox/secrets/api/views.py b/netbox/secrets/api/views.py index 8c959f90d..3650abd30 100644 --- a/netbox/secrets/api/views.py +++ b/netbox/secrets/api/views.py @@ -8,6 +8,7 @@ from rest_framework.response import Response from rest_framework.routers import APIRootView from rest_framework.viewsets import ViewSet +from extras.api.views import CustomFieldModelViewSet from netbox.api.views import ModelViewSet from secrets import filters from secrets.exceptions import InvalidKey @@ -33,7 +34,7 @@ class SecretsRootView(APIRootView): # Secret Roles # -class SecretRoleViewSet(ModelViewSet): +class SecretRoleViewSet(CustomFieldModelViewSet): queryset = SecretRole.objects.annotate( secret_count=count_related(Secret, 'role') ) diff --git a/netbox/tenancy/api/serializers.py b/netbox/tenancy/api/serializers.py index 4c2f9faee..d301ee3fe 100644 --- a/netbox/tenancy/api/serializers.py +++ b/netbox/tenancy/api/serializers.py @@ -11,7 +11,7 @@ from .nested_serializers import * # Tenants # -class TenantGroupSerializer(ValidatedModelSerializer): +class TenantGroupSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='tenancy-api:tenantgroup-detail') parent = NestedTenantGroupSerializer(required=False, allow_null=True) tenant_count = serializers.IntegerField(read_only=True) @@ -19,7 +19,10 @@ class TenantGroupSerializer(ValidatedModelSerializer): class Meta: model = TenantGroup - fields = ['id', 'url', 'name', 'slug', 'parent', 'description', 'tenant_count', '_depth'] + fields = [ + 'id', 'url', 'name', 'slug', 'parent', 'description', 'custom_fields', 'created', 'last_updated', + 'tenant_count', '_depth', + ] class TenantSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): diff --git a/netbox/tenancy/api/views.py b/netbox/tenancy/api/views.py index 2b7ae8365..3b57e1a02 100644 --- a/netbox/tenancy/api/views.py +++ b/netbox/tenancy/api/views.py @@ -4,7 +4,6 @@ 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 netbox.api.views import ModelViewSet from tenancy import filters from tenancy.models import Tenant, TenantGroup from utilities.utils import count_related @@ -24,7 +23,7 @@ class TenancyRootView(APIRootView): # Tenant Groups # -class TenantGroupViewSet(ModelViewSet): +class TenantGroupViewSet(CustomFieldModelViewSet): queryset = TenantGroup.objects.add_related_count( TenantGroup.objects.all(), Tenant, diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index 518b7086c..4883f9f62 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -18,22 +18,26 @@ from .nested_serializers import * # Clusters # -class ClusterTypeSerializer(ValidatedModelSerializer): +class ClusterTypeSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:clustertype-detail') cluster_count = serializers.IntegerField(read_only=True) class Meta: model = ClusterType - fields = ['id', 'url', 'name', 'slug', 'description', 'cluster_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'description', 'custom_fields', 'created', 'last_updated', 'cluster_count', + ] -class ClusterGroupSerializer(ValidatedModelSerializer): +class ClusterGroupSerializer(CustomFieldModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:clustergroup-detail') cluster_count = serializers.IntegerField(read_only=True) class Meta: model = ClusterGroup - fields = ['id', 'url', 'name', 'slug', 'description', 'cluster_count'] + fields = [ + 'id', 'url', 'name', 'slug', 'description', 'custom_fields', 'created', 'last_updated', 'cluster_count', + ] class ClusterSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index 586ad5028..ea2b33e4f 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -20,7 +20,7 @@ class VirtualizationRootView(APIRootView): # Clusters # -class ClusterTypeViewSet(ModelViewSet): +class ClusterTypeViewSet(CustomFieldModelViewSet): queryset = ClusterType.objects.annotate( cluster_count=count_related(Cluster, 'type') ) @@ -28,7 +28,7 @@ class ClusterTypeViewSet(ModelViewSet): filterset_class = filters.ClusterTypeFilterSet -class ClusterGroupViewSet(ModelViewSet): +class ClusterGroupViewSet(CustomFieldModelViewSet): queryset = ClusterGroup.objects.annotate( cluster_count=count_related(Cluster, 'group') ) From ed059d80d696e355624b24cc744388f6da11ede6 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 16:44:16 -0500 Subject: [PATCH 129/302] Introduce OrganizationalModelSerializer --- netbox/circuits/api/serializers.py | 7 ++++--- netbox/dcim/api/serializers.py | 15 ++++++--------- netbox/ipam/api/serializers.py | 9 +++++---- netbox/netbox/api/serializers.py | 4 ++++ netbox/virtualization/api/serializers.py | 7 ++++--- 5 files changed, 23 insertions(+), 19 deletions(-) diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 17dce6624..74d8136e0 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -2,11 +2,12 @@ from rest_framework import serializers from circuits.choices import CircuitStatusChoices from circuits.models import Provider, Circuit, CircuitTermination, CircuitType -from dcim.api.nested_serializers import NestedCableSerializer, NestedInterfaceSerializer, NestedSiteSerializer +from dcim.api.nested_serializers import NestedCableSerializer, NestedSiteSerializer from dcim.api.serializers import CableTerminationSerializer, ConnectedEndpointSerializer from extras.api.customfields import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer -from netbox.api import ChoiceField, ValidatedModelSerializer, WritableNestedSerializer +from netbox.api import ChoiceField +from netbox.api.serializers import OrganizationalModelSerializer, WritableNestedSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from .nested_serializers import * @@ -31,7 +32,7 @@ class ProviderSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # Circuits # -class CircuitTypeSerializer(CustomFieldModelSerializer): +class CircuitTypeSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittype-detail') circuit_count = serializers.IntegerField(read_only=True) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 3aa5dea2f..7d86d18a1 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -13,15 +13,12 @@ from dcim.models import ( PowerPortTemplate, Rack, RackGroup, RackReservation, RackRole, RearPort, RearPortTemplate, Region, Site, VirtualChassis, ) -from dcim.utils import decompile_path_node from extras.api.customfields import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer from ipam.models import VLAN -from netbox.api import ( - ChoiceField, ContentTypeField, SerializedPKRelatedField, TimeZoneField, ValidatedModelSerializer, - WritableNestedSerializer, -) +from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField, TimeZoneField +from netbox.api.serializers import OrganizationalModelSerializer, ValidatedModelSerializer, WritableNestedSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from users.api.nested_serializers import NestedUserSerializer from utilities.api import get_serializer_for_model @@ -138,7 +135,7 @@ class RackGroupSerializer(CustomFieldModelSerializer): ] -class RackRoleSerializer(CustomFieldModelSerializer): +class RackRoleSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rackrole-detail') rack_count = serializers.IntegerField(read_only=True) @@ -251,7 +248,7 @@ class RackElevationDetailFilterSerializer(serializers.Serializer): # Device types # -class ManufacturerSerializer(CustomFieldModelSerializer): +class ManufacturerSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:manufacturer-detail') devicetype_count = serializers.IntegerField(read_only=True) inventoryitem_count = serializers.IntegerField(read_only=True) @@ -388,7 +385,7 @@ class DeviceBayTemplateSerializer(ValidatedModelSerializer): # Devices # -class DeviceRoleSerializer(CustomFieldModelSerializer): +class DeviceRoleSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:devicerole-detail') device_count = serializers.IntegerField(read_only=True) virtualmachine_count = serializers.IntegerField(read_only=True) @@ -401,7 +398,7 @@ class DeviceRoleSerializer(CustomFieldModelSerializer): ] -class PlatformSerializer(CustomFieldModelSerializer): +class PlatformSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:platform-detail') manufacturer = NestedManufacturerSerializer(required=False, allow_null=True) device_count = serializers.IntegerField(read_only=True) diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 719ea51e2..8688da8f2 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -11,7 +11,8 @@ from extras.api.serializers import TaggedObjectSerializer from ipam.choices import * from ipam.constants import IPADDRESS_ASSIGNMENT_MODELS from ipam.models import Aggregate, IPAddress, Prefix, RIR, Role, RouteTarget, Service, VLAN, VLANGroup, VRF -from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField, ValidatedModelSerializer +from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField +from netbox.api.serializers import OrganizationalModelSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from utilities.api import get_serializer_for_model from virtualization.api.nested_serializers import NestedVirtualMachineSerializer @@ -67,7 +68,7 @@ class RouteTargetSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # RIRs/aggregates # -class RIRSerializer(CustomFieldModelSerializer): +class RIRSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:rir-detail') aggregate_count = serializers.IntegerField(read_only=True) @@ -98,7 +99,7 @@ class AggregateSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # VLANs # -class RoleSerializer(CustomFieldModelSerializer): +class RoleSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:role-detail') prefix_count = serializers.IntegerField(read_only=True) vlan_count = serializers.IntegerField(read_only=True) @@ -111,7 +112,7 @@ class RoleSerializer(CustomFieldModelSerializer): ] -class VLANGroupSerializer(CustomFieldModelSerializer): +class VLANGroupSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:vlangroup-detail') site = NestedSiteSerializer(required=False, allow_null=True) vlan_count = serializers.IntegerField(read_only=True) diff --git a/netbox/netbox/api/serializers.py b/netbox/netbox/api/serializers.py index 3a8641efc..02e382d4b 100644 --- a/netbox/netbox/api/serializers.py +++ b/netbox/netbox/api/serializers.py @@ -35,6 +35,10 @@ class ValidatedModelSerializer(serializers.ModelSerializer): return data +class OrganizationalModelSerializer(ValidatedModelSerializer): + pass + + class WritableNestedSerializer(serializers.ModelSerializer): """ Returns a nested representation of an object on read, but accepts only a primary key on write. diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index 4883f9f62..b8ccb99b0 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -7,7 +7,8 @@ from extras.api.customfields import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer from ipam.models import VLAN -from netbox.api import ChoiceField, SerializedPKRelatedField, ValidatedModelSerializer +from netbox.api import ChoiceField, SerializedPKRelatedField +from netbox.api.serializers import OrganizationalModelSerializer, ValidatedModelSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from virtualization.choices import * from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface @@ -18,7 +19,7 @@ from .nested_serializers import * # Clusters # -class ClusterTypeSerializer(CustomFieldModelSerializer): +class ClusterTypeSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:clustertype-detail') cluster_count = serializers.IntegerField(read_only=True) @@ -29,7 +30,7 @@ class ClusterTypeSerializer(CustomFieldModelSerializer): ] -class ClusterGroupSerializer(CustomFieldModelSerializer): +class ClusterGroupSerializer(OrganizationalModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:clustergroup-detail') cluster_count = serializers.IntegerField(read_only=True) From 12fbd349628b94c737cf35b1284f076d87c2ef6c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 25 Feb 2021 17:15:07 -0500 Subject: [PATCH 130/302] Introduce NestedGroupModelSerializer --- netbox/circuits/api/serializers.py | 2 +- netbox/dcim/api/serializers.py | 12 +++---- netbox/extras/api/customfields.py | 35 +------------------- netbox/ipam/api/serializers.py | 2 +- netbox/netbox/api/serializers.py | 41 +++++++++++++++++++++++- netbox/secrets/api/serializers.py | 2 +- netbox/tenancy/api/serializers.py | 6 ++-- netbox/virtualization/api/serializers.py | 2 +- 8 files changed, 53 insertions(+), 49 deletions(-) diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 74d8136e0..5688bf1c7 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -4,7 +4,7 @@ from circuits.choices import CircuitStatusChoices from circuits.models import Provider, Circuit, CircuitTermination, CircuitType from dcim.api.nested_serializers import NestedCableSerializer, NestedSiteSerializer from dcim.api.serializers import CableTerminationSerializer, ConnectedEndpointSerializer -from extras.api.customfields import CustomFieldModelSerializer +from netbox.api.serializers import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from netbox.api import ChoiceField from netbox.api.serializers import OrganizationalModelSerializer, WritableNestedSerializer diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 7d86d18a1..b4ac77e2d 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -13,12 +13,14 @@ from dcim.models import ( PowerPortTemplate, Rack, RackGroup, RackReservation, RackRole, RearPort, RearPortTemplate, Region, Site, VirtualChassis, ) -from extras.api.customfields import CustomFieldModelSerializer +from netbox.api.serializers import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer from ipam.models import VLAN from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField, TimeZoneField -from netbox.api.serializers import OrganizationalModelSerializer, ValidatedModelSerializer, WritableNestedSerializer +from netbox.api.serializers import ( + NestedGroupModelSerializer, OrganizationalModelSerializer, ValidatedModelSerializer, WritableNestedSerializer, +) from tenancy.api.nested_serializers import NestedTenantSerializer from users.api.nested_serializers import NestedUserSerializer from utilities.api import get_serializer_for_model @@ -79,11 +81,10 @@ class ConnectedEndpointSerializer(ValidatedModelSerializer): # Regions/sites # -class RegionSerializer(CustomFieldModelSerializer): +class RegionSerializer(NestedGroupModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:region-detail') parent = NestedRegionSerializer(required=False, allow_null=True) site_count = serializers.IntegerField(read_only=True) - _depth = serializers.IntegerField(source='level', read_only=True) class Meta: model = Region @@ -120,12 +121,11 @@ class SiteSerializer(TaggedObjectSerializer, CustomFieldModelSerializer): # Racks # -class RackGroupSerializer(CustomFieldModelSerializer): +class RackGroupSerializer(NestedGroupModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rackgroup-detail') site = NestedSiteSerializer() parent = NestedRackGroupSerializer(required=False, allow_null=True) rack_count = serializers.IntegerField(read_only=True) - _depth = serializers.IntegerField(source='level', read_only=True) class Meta: model = RackGroup diff --git a/netbox/extras/api/customfields.py b/netbox/extras/api/customfields.py index c8c4ba89e..5cb1fc276 100644 --- a/netbox/extras/api/customfields.py +++ b/netbox/extras/api/customfields.py @@ -1,9 +1,7 @@ from django.contrib.contenttypes.models import ContentType -from rest_framework.fields import CreateOnlyDefault, Field +from rest_framework.fields import Field -from extras.choices import * from extras.models import CustomField -from netbox.api import ValidatedModelSerializer # @@ -56,34 +54,3 @@ class CustomFieldsDataField(Field): data = {**self.parent.instance.custom_field_data, **data} return data - - -class CustomFieldModelSerializer(ValidatedModelSerializer): - """ - Extends ModelSerializer to render any CustomFields and their values associated with an object. - """ - custom_fields = CustomFieldsDataField( - source='custom_field_data', - default=CreateOnlyDefault(CustomFieldDefaultValues()) - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - if self.instance is not None: - - # Retrieve the set of CustomFields which apply to this type of object - content_type = ContentType.objects.get_for_model(self.Meta.model) - fields = CustomField.objects.filter(content_types=content_type) - - # Populate CustomFieldValues for each instance from database - if type(self.instance) in (list, tuple): - for obj in self.instance: - self._populate_custom_fields(obj, fields) - else: - self._populate_custom_fields(self.instance, fields) - - def _populate_custom_fields(self, instance, custom_fields): - instance.custom_fields = {} - for field in custom_fields: - instance.custom_fields[field.name] = instance.cf.get(field.name) diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 8688da8f2..002ad3b89 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -6,7 +6,7 @@ from rest_framework import serializers from rest_framework.validators import UniqueTogetherValidator from dcim.api.nested_serializers import NestedDeviceSerializer, NestedSiteSerializer -from extras.api.customfields import CustomFieldModelSerializer +from netbox.api.serializers import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from ipam.choices import * from ipam.constants import IPADDRESS_ASSIGNMENT_MODELS diff --git a/netbox/netbox/api/serializers.py b/netbox/netbox/api/serializers.py index 02e382d4b..18fc112c8 100644 --- a/netbox/netbox/api/serializers.py +++ b/netbox/netbox/api/serializers.py @@ -1,8 +1,12 @@ +from django.contrib.contenttypes.models import ContentType from django.core.exceptions import FieldError, MultipleObjectsReturned, ObjectDoesNotExist from django.db.models import ManyToManyField from rest_framework import serializers from rest_framework.exceptions import ValidationError +from rest_framework.fields import CreateOnlyDefault +from extras.api.customfields import CustomFieldsDataField, CustomFieldDefaultValues +from extras.models import CustomField from utilities.utils import dict_to_filter_params @@ -35,10 +39,45 @@ class ValidatedModelSerializer(serializers.ModelSerializer): return data -class OrganizationalModelSerializer(ValidatedModelSerializer): +class CustomFieldModelSerializer(ValidatedModelSerializer): + """ + Extends ModelSerializer to render any CustomFields and their values associated with an object. + """ + custom_fields = CustomFieldsDataField( + source='custom_field_data', + default=CreateOnlyDefault(CustomFieldDefaultValues()) + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + if self.instance is not None: + + # Retrieve the set of CustomFields which apply to this type of object + content_type = ContentType.objects.get_for_model(self.Meta.model) + fields = CustomField.objects.filter(content_types=content_type) + + # Populate CustomFieldValues for each instance from database + if type(self.instance) in (list, tuple): + for obj in self.instance: + self._populate_custom_fields(obj, fields) + else: + self._populate_custom_fields(self.instance, fields) + + def _populate_custom_fields(self, instance, custom_fields): + instance.custom_fields = {} + for field in custom_fields: + instance.custom_fields[field.name] = instance.cf.get(field.name) + + +class OrganizationalModelSerializer(CustomFieldModelSerializer): pass +class NestedGroupModelSerializer(CustomFieldModelSerializer): + _depth = serializers.IntegerField(source='level', read_only=True) + + class WritableNestedSerializer(serializers.ModelSerializer): """ Returns a nested representation of an object on read, but accepts only a primary key on write. diff --git a/netbox/secrets/api/serializers.py b/netbox/secrets/api/serializers.py index 627685de0..207836c4c 100644 --- a/netbox/secrets/api/serializers.py +++ b/netbox/secrets/api/serializers.py @@ -2,7 +2,7 @@ from django.contrib.contenttypes.models import ContentType from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers -from extras.api.customfields import CustomFieldModelSerializer +from netbox.api.serializers import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from secrets.constants import SECRET_ASSIGNMENT_MODELS from secrets.models import Secret, SecretRole diff --git a/netbox/tenancy/api/serializers.py b/netbox/tenancy/api/serializers.py index d301ee3fe..c701e6b3b 100644 --- a/netbox/tenancy/api/serializers.py +++ b/netbox/tenancy/api/serializers.py @@ -1,8 +1,7 @@ from rest_framework import serializers -from extras.api.customfields import CustomFieldModelSerializer +from netbox.api.serializers import CustomFieldModelSerializer, NestedGroupModelSerializer from extras.api.serializers import TaggedObjectSerializer -from netbox.api import ValidatedModelSerializer from tenancy.models import Tenant, TenantGroup from .nested_serializers import * @@ -11,11 +10,10 @@ from .nested_serializers import * # Tenants # -class TenantGroupSerializer(CustomFieldModelSerializer): +class TenantGroupSerializer(NestedGroupModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='tenancy-api:tenantgroup-detail') parent = NestedTenantGroupSerializer(required=False, allow_null=True) tenant_count = serializers.IntegerField(read_only=True) - _depth = serializers.IntegerField(source='level', read_only=True) class Meta: model = TenantGroup diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index b8ccb99b0..e3b82e40a 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from dcim.api.nested_serializers import NestedDeviceRoleSerializer, NestedPlatformSerializer, NestedSiteSerializer from dcim.choices import InterfaceModeChoices -from extras.api.customfields import CustomFieldModelSerializer +from netbox.api.serializers import CustomFieldModelSerializer from extras.api.serializers import TaggedObjectSerializer from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer from ipam.models import VLAN From cf7830757724c18c42f827e8db560a16146e4703 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 26 Feb 2021 11:25:23 -0500 Subject: [PATCH 131/302] Update organizational models to use custom field forms --- netbox/circuits/forms.py | 2 +- netbox/dcim/forms.py | 24 ++++++++++++------------ netbox/ipam/forms.py | 16 ++++++++-------- netbox/secrets/forms.py | 4 ++-- netbox/tenancy/forms.py | 4 ++-- netbox/virtualization/forms.py | 8 ++++---- 6 files changed, 29 insertions(+), 29 deletions(-) diff --git a/netbox/circuits/forms.py b/netbox/circuits/forms.py index 18d49d08e..2e66f99f1 100644 --- a/netbox/circuits/forms.py +++ b/netbox/circuits/forms.py @@ -141,7 +141,7 @@ class CircuitTypeForm(BootstrapMixin, CustomFieldModelForm): ] -class CircuitTypeCSVForm(CSVModelForm): +class CircuitTypeCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: diff --git a/netbox/dcim/forms.py b/netbox/dcim/forms.py index 3428dec57..01704ff5a 100644 --- a/netbox/dcim/forms.py +++ b/netbox/dcim/forms.py @@ -173,7 +173,7 @@ class MACAddressField(forms.Field): # Regions # -class RegionForm(BootstrapMixin, forms.ModelForm): +class RegionForm(BootstrapMixin, CustomFieldModelForm): parent = DynamicModelChoiceField( queryset=Region.objects.all(), required=False @@ -187,7 +187,7 @@ class RegionForm(BootstrapMixin, forms.ModelForm): ) -class RegionCSVForm(CSVModelForm): +class RegionCSVForm(CustomFieldModelCSVForm): parent = CSVModelChoiceField( queryset=Region.objects.all(), required=False, @@ -360,7 +360,7 @@ class SiteFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilterForm): # Rack groups # -class RackGroupForm(BootstrapMixin, forms.ModelForm): +class RackGroupForm(BootstrapMixin, CustomFieldModelForm): region = DynamicModelChoiceField( queryset=Region.objects.all(), required=False, @@ -390,7 +390,7 @@ class RackGroupForm(BootstrapMixin, forms.ModelForm): ) -class RackGroupCSVForm(CSVModelForm): +class RackGroupCSVForm(CustomFieldModelCSVForm): site = CSVModelChoiceField( queryset=Site.objects.all(), to_field_name='name', @@ -440,7 +440,7 @@ class RackGroupFilterForm(BootstrapMixin, forms.Form): # Rack roles # -class RackRoleForm(BootstrapMixin, forms.ModelForm): +class RackRoleForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -450,7 +450,7 @@ class RackRoleForm(BootstrapMixin, forms.ModelForm): ] -class RackRoleCSVForm(CSVModelForm): +class RackRoleCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: @@ -913,7 +913,7 @@ class RackReservationFilterForm(BootstrapMixin, TenancyFilterForm): # Manufacturers # -class ManufacturerForm(BootstrapMixin, forms.ModelForm): +class ManufacturerForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -923,7 +923,7 @@ class ManufacturerForm(BootstrapMixin, forms.ModelForm): ] -class ManufacturerCSVForm(CSVModelForm): +class ManufacturerCSVForm(CustomFieldModelCSVForm): class Meta: model = Manufacturer @@ -1705,7 +1705,7 @@ class DeviceBayTemplateImportForm(ComponentTemplateImportForm): # Device roles # -class DeviceRoleForm(BootstrapMixin, forms.ModelForm): +class DeviceRoleForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -1715,7 +1715,7 @@ class DeviceRoleForm(BootstrapMixin, forms.ModelForm): ] -class DeviceRoleCSVForm(CSVModelForm): +class DeviceRoleCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: @@ -1730,7 +1730,7 @@ class DeviceRoleCSVForm(CSVModelForm): # Platforms # -class PlatformForm(BootstrapMixin, forms.ModelForm): +class PlatformForm(BootstrapMixin, CustomFieldModelForm): manufacturer = DynamicModelChoiceField( queryset=Manufacturer.objects.all(), required=False @@ -1749,7 +1749,7 @@ class PlatformForm(BootstrapMixin, forms.ModelForm): } -class PlatformCSVForm(CSVModelForm): +class PlatformCSVForm(CustomFieldModelCSVForm): slug = SlugField() manufacturer = CSVModelChoiceField( queryset=Manufacturer.objects.all(), diff --git a/netbox/ipam/forms.py b/netbox/ipam/forms.py index 7e45c30b3..bf3fd1491 100644 --- a/netbox/ipam/forms.py +++ b/netbox/ipam/forms.py @@ -8,8 +8,8 @@ from extras.models import Tag from tenancy.forms import TenancyFilterForm, TenancyForm from tenancy.models import Tenant from utilities.forms import ( - add_blank_choice, BootstrapMixin, BulkEditNullBooleanSelect, CSVChoiceField, CSVModelChoiceField, CSVModelForm, - DatePicker, DynamicModelChoiceField, DynamicModelMultipleChoiceField, ExpandableIPAddressField, NumericArrayField, + add_blank_choice, BootstrapMixin, BulkEditNullBooleanSelect, CSVChoiceField, CSVModelChoiceField, DatePicker, + DynamicModelChoiceField, DynamicModelMultipleChoiceField, ExpandableIPAddressField, NumericArrayField, ReturnURLForm, SlugField, StaticSelect2, StaticSelect2Multiple, TagFilterField, BOOLEAN_WITH_BLANK_CHOICES, ) from virtualization.models import Cluster, VirtualMachine, VMInterface @@ -195,7 +195,7 @@ class RouteTargetFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilter # RIRs # -class RIRForm(BootstrapMixin, forms.ModelForm): +class RIRForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -205,7 +205,7 @@ class RIRForm(BootstrapMixin, forms.ModelForm): ] -class RIRCSVForm(CSVModelForm): +class RIRCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: @@ -332,7 +332,7 @@ class AggregateFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilterFo # Roles # -class RoleForm(BootstrapMixin, forms.ModelForm): +class RoleForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -342,7 +342,7 @@ class RoleForm(BootstrapMixin, forms.ModelForm): ] -class RoleCSVForm(CSVModelForm): +class RoleCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: @@ -1081,7 +1081,7 @@ class IPAddressFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilterFo # VLAN groups # -class VLANGroupForm(BootstrapMixin, forms.ModelForm): +class VLANGroupForm(BootstrapMixin, CustomFieldModelForm): region = DynamicModelChoiceField( queryset=Region.objects.all(), required=False, @@ -1105,7 +1105,7 @@ class VLANGroupForm(BootstrapMixin, forms.ModelForm): ] -class VLANGroupCSVForm(CSVModelForm): +class VLANGroupCSVForm(CustomFieldModelCSVForm): site = CSVModelChoiceField( queryset=Site.objects.all(), required=False, diff --git a/netbox/secrets/forms.py b/netbox/secrets/forms.py index cdd843e2d..2aa3243ee 100644 --- a/netbox/secrets/forms.py +++ b/netbox/secrets/forms.py @@ -43,7 +43,7 @@ def validate_rsa_key(key, is_secret=True): # Secret roles # -class SecretRoleForm(BootstrapMixin, forms.ModelForm): +class SecretRoleForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -51,7 +51,7 @@ class SecretRoleForm(BootstrapMixin, forms.ModelForm): fields = ('name', 'slug', 'description') -class SecretRoleCSVForm(CSVModelForm): +class SecretRoleCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index 97e72bb02..1d57f5da8 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -15,7 +15,7 @@ from .models import Tenant, TenantGroup # Tenant groups # -class TenantGroupForm(BootstrapMixin, forms.ModelForm): +class TenantGroupForm(BootstrapMixin, CustomFieldModelForm): parent = DynamicModelChoiceField( queryset=TenantGroup.objects.all(), required=False @@ -29,7 +29,7 @@ class TenantGroupForm(BootstrapMixin, forms.ModelForm): ] -class TenantGroupCSVForm(CSVModelForm): +class TenantGroupCSVForm(CustomFieldModelCSVForm): parent = CSVModelChoiceField( queryset=TenantGroup.objects.all(), required=False, diff --git a/netbox/virtualization/forms.py b/netbox/virtualization/forms.py index addfb05cd..c68f2db44 100644 --- a/netbox/virtualization/forms.py +++ b/netbox/virtualization/forms.py @@ -27,7 +27,7 @@ from .models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterf # Cluster types # -class ClusterTypeForm(BootstrapMixin, forms.ModelForm): +class ClusterTypeForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -37,7 +37,7 @@ class ClusterTypeForm(BootstrapMixin, forms.ModelForm): ] -class ClusterTypeCSVForm(CSVModelForm): +class ClusterTypeCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: @@ -49,7 +49,7 @@ class ClusterTypeCSVForm(CSVModelForm): # Cluster groups # -class ClusterGroupForm(BootstrapMixin, forms.ModelForm): +class ClusterGroupForm(BootstrapMixin, CustomFieldModelForm): slug = SlugField() class Meta: @@ -59,7 +59,7 @@ class ClusterGroupForm(BootstrapMixin, forms.ModelForm): ] -class ClusterGroupCSVForm(CSVModelForm): +class ClusterGroupCSVForm(CustomFieldModelCSVForm): slug = SlugField() class Meta: From 7e6cb9d18696eb312954796cda22f19fd1b51c7c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 26 Feb 2021 16:12:52 -0500 Subject: [PATCH 132/302] Closes #1638: Migrate all primary keys to 64-bit integers --- docs/release-notes/index.md | 2 +- docs/release-notes/version-2.11.md | 9 + .../migrations/0025_standardize_models.py | 8 +- .../migrations/0123_standardize_models.py | 288 +----------------- .../dcim/models/device_component_templates.py | 4 +- netbox/dcim/models/device_components.py | 4 +- .../migrations/0054_standardize_models.py | 8 +- netbox/extras/models/models.py | 4 +- netbox/extras/models/tags.py | 4 +- .../migrations/0044_standardize_models.py | 18 +- netbox/netbox/models.py | 54 ++-- .../migrations/0013_standardize_models.py | 8 +- .../migrations/0012_standardize_models.py | 8 +- .../migrations/0011_standardize_models.py | 7 +- netbox/users/models.py | 2 +- .../migrations/0020_standardize_models.py | 28 +- netbox/virtualization/models.py | 4 +- 17 files changed, 72 insertions(+), 388 deletions(-) create mode 100644 docs/release-notes/version-2.11.md diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 8990f83e0..f7f6f36e9 120000 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -1 +1 @@ -version-2.10.md \ No newline at end of file +version-2.11.md \ No newline at end of file diff --git a/docs/release-notes/version-2.11.md b/docs/release-notes/version-2.11.md new file mode 100644 index 000000000..4daeab8bc --- /dev/null +++ b/docs/release-notes/version-2.11.md @@ -0,0 +1,9 @@ +# NetBox v2.11 + +## v2.11-beta1 (FUTURE) + +**WARNING:** This is a beta release and is not suitable for production use. It is intended for development and evaluation purposes only. No upgrade path to the final v2.11 release will be provided from this beta, and users should assume that all data entered into the application will be lost. + +### Other Changes + +* [#1638](https://github.com/netbox-community/netbox/issues/1638) - Migrate all primary keys to 64-bit integers diff --git a/netbox/circuits/migrations/0025_standardize_models.py b/netbox/circuits/migrations/0025_standardize_models.py index 2b1d2664e..f5d348ff3 100644 --- a/netbox/circuits/migrations/0025_standardize_models.py +++ b/netbox/circuits/migrations/0025_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,11 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='circuittype', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), migrations.AlterField( model_name='circuit', name='id', diff --git a/netbox/dcim/migrations/0123_standardize_models.py b/netbox/dcim/migrations/0123_standardize_models.py index 5050e1a26..e9af8c464 100644 --- a/netbox/dcim/migrations/0123_standardize_models.py +++ b/netbox/dcim/migrations/0123_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,291 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='consoleport', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='consoleport', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='consoleport', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='consoleporttemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='consoleporttemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='consoleporttemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='consoleserverport', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='consoleserverport', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='consoleserverport', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='consoleserverporttemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='consoleserverporttemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='consoleserverporttemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='devicebay', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='devicebay', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='devicebay', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='devicebaytemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='devicebaytemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='devicebaytemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='devicerole', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='frontport', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='frontport', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='frontport', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='frontporttemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='frontporttemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='frontporttemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='interface', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='interface', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='interface', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='interfacetemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='interfacetemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='interfacetemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='inventoryitem', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='inventoryitem', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='inventoryitem', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='manufacturer', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='platform', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='poweroutlet', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='poweroutlet', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='poweroutlet', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='poweroutlettemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='poweroutlettemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='poweroutlettemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='powerport', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='powerport', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='powerport', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='powerporttemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='powerporttemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='powerporttemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='rackgroup', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='rackrole', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='rearport', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='rearport', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='rearport', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='rearporttemplate', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='rearporttemplate', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='rearporttemplate', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), - migrations.AddField( - model_name='region', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), migrations.AlterField( model_name='cable', name='id', diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index 7b718936d..d250227b7 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -6,7 +6,7 @@ from dcim.choices import * from dcim.constants import * from extras.models import ObjectChange from extras.utils import extras_features -from netbox.models import PrimaryModel +from netbox.models import BigIDModel from utilities.fields import NaturalOrderingField from utilities.querysets import RestrictedQuerySet from utilities.ordering import naturalize_interface @@ -28,7 +28,7 @@ __all__ = ( ) -class ComponentTemplateModel(PrimaryModel): +class ComponentTemplateModel(BigIDModel): device_type = models.ForeignKey( to='dcim.DeviceType', on_delete=models.CASCADE, diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index f78363ba9..01d2712a7 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -13,7 +13,7 @@ from dcim.constants import * from dcim.fields import MACAddressField from extras.models import ObjectChange, TaggedItem from extras.utils import extras_features -from netbox.models import PrimaryModel +from netbox.models import BigIDModel from utilities.fields import NaturalOrderingField from utilities.mptt import TreeManager from utilities.ordering import naturalize_interface @@ -38,7 +38,7 @@ __all__ = ( ) -class ComponentModel(PrimaryModel): +class ComponentModel(BigIDModel): """ An abstract model inherited by any model which has a parent Device. """ diff --git a/netbox/extras/migrations/0054_standardize_models.py b/netbox/extras/migrations/0054_standardize_models.py index a836f365f..b6c95e77d 100644 --- a/netbox/extras/migrations/0054_standardize_models.py +++ b/netbox/extras/migrations/0054_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,11 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='configcontext', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), migrations.AlterField( model_name='configcontext', name='id', diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index d60a2cc96..bf0dfc873 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -16,7 +16,7 @@ from extras.choices import * from extras.constants import * from extras.querysets import ConfigContextQuerySet from extras.utils import extras_features, FeatureQuery, image_upload -from netbox.models import BigIDModel, PrimaryModel +from netbox.models import BigIDModel, ChangeLoggingMixin from utilities.querysets import RestrictedQuerySet from utilities.utils import deepmerge, render_jinja2 @@ -361,7 +361,7 @@ class ImageAttachment(BigIDModel): # Config contexts # -class ConfigContext(PrimaryModel): +class ConfigContext(ChangeLoggingMixin, BigIDModel): """ A ConfigContext represents a set of arbitrary data available to any Device or VirtualMachine matching its assigned qualifiers (region, site, etc.). For example, the data stored in a ConfigContext assigned to site A and tenant B diff --git a/netbox/extras/models/tags.py b/netbox/extras/models/tags.py index 22e9815a9..3a5b539b1 100644 --- a/netbox/extras/models/tags.py +++ b/netbox/extras/models/tags.py @@ -2,7 +2,7 @@ from django.db import models from django.utils.text import slugify from taggit.models import TagBase, GenericTaggedItemBase -from netbox.models import BigIDModel, CoreModel +from netbox.models import BigIDModel, ChangeLoggingMixin from utilities.choices import ColorChoices from utilities.fields import ColorField from utilities.querysets import RestrictedQuerySet @@ -12,7 +12,7 @@ from utilities.querysets import RestrictedQuerySet # Tags # -class Tag(TagBase, CoreModel): +class Tag(ChangeLoggingMixin, BigIDModel, TagBase): color = ColorField( default=ColorChoices.COLOR_GREY ) diff --git a/netbox/ipam/migrations/0044_standardize_models.py b/netbox/ipam/migrations/0044_standardize_models.py index 2762c9973..a4ad77053 100644 --- a/netbox/ipam/migrations/0044_standardize_models.py +++ b/netbox/ipam/migrations/0044_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,21 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='rir', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='role', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='vlangroup', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), migrations.AlterField( model_name='aggregate', name='id', diff --git a/netbox/netbox/models.py b/netbox/netbox/models.py index c0b0ce7ae..ad11dd18f 100644 --- a/netbox/netbox/models.py +++ b/netbox/netbox/models.py @@ -16,23 +16,13 @@ __all__ = ( ) -class BigIDModel(models.Model): - """ - Abstract base model for all Schematic data objects. Ensures the use of a 64-bit PK. - """ - id = models.BigAutoField( - primary_key=True - ) +# +# Mixins +# - class Meta: - abstract = True - - -class CoreModel(BigIDModel): +class ChangeLoggingMixin(models.Model): """ - Base class for all core objects. Provides the following: - - Change logging - - Custom field support + Provides change logging support. """ created = models.DateField( auto_now_add=True, @@ -62,9 +52,9 @@ class CoreModel(BigIDModel): ) -class PrimaryModel(CoreModel): +class CustomFieldsMixin(models.Model): """ - Primary models represent real objects within the infrastructure being modeled. + Provides support for custom fields. """ custom_field_data = models.JSONField( encoder=DjangoJSONEncoder, @@ -114,7 +104,33 @@ class PrimaryModel(CoreModel): raise ValidationError(f"Missing required custom field '{cf.name}'.") -class NestedGroupModel(PrimaryModel, MPTTModel): +# +# Base model classes + +class BigIDModel(models.Model): + """ + Abstract base model for all data objects. Ensures the use of a 64-bit PK. + """ + id = models.BigAutoField( + primary_key=True + ) + + class Meta: + abstract = True + + +class PrimaryModel(ChangeLoggingMixin, CustomFieldsMixin, BigIDModel): + """ + Primary models represent real objects within the infrastructure being modeled. + """ + # TODO + # tags = TaggableManager(through=TaggedItem) + + class Meta: + abstract = True + + +class NestedGroupModel(ChangeLoggingMixin, BigIDModel, MPTTModel): """ Base model for objects which are used to form a hierarchy (regions, locations, etc.). These models nest recursively using MPTT. Within each parent, each child instance must have a unique name. @@ -157,7 +173,7 @@ class NestedGroupModel(PrimaryModel, MPTTModel): ) -class OrganizationalModel(PrimaryModel): +class OrganizationalModel(ChangeLoggingMixin, BigIDModel): """ Organizational models are those which are used solely to categorize and qualify other objects, and do not convey any real information about the infrastructure being modeled (for example, functional device roles). Organizational diff --git a/netbox/secrets/migrations/0013_standardize_models.py b/netbox/secrets/migrations/0013_standardize_models.py index 9de8dec95..ad18536dc 100644 --- a/netbox/secrets/migrations/0013_standardize_models.py +++ b/netbox/secrets/migrations/0013_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,11 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='secretrole', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), migrations.AlterField( model_name='secret', name='id', diff --git a/netbox/tenancy/migrations/0012_standardize_models.py b/netbox/tenancy/migrations/0012_standardize_models.py index 7ce55cf42..6a277fa7c 100644 --- a/netbox/tenancy/migrations/0012_standardize_models.py +++ b/netbox/tenancy/migrations/0012_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,11 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='tenantgroup', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), migrations.AlterField( model_name='tenant', name='id', diff --git a/netbox/users/migrations/0011_standardize_models.py b/netbox/users/migrations/0011_standardize_models.py index abfbd8702..3c514dd2a 100644 --- a/netbox/users/migrations/0011_standardize_models.py +++ b/netbox/users/migrations/0011_standardize_models.py @@ -1,3 +1,5 @@ +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -18,9 +20,4 @@ class Migration(migrations.Migration): name='id', field=models.BigAutoField(primary_key=True, serialize=False), ), - migrations.AlterField( - model_name='userconfig', - name='id', - field=models.BigAutoField(primary_key=True, serialize=False), - ), ] diff --git a/netbox/users/models.py b/netbox/users/models.py index 529732e65..00e18148c 100644 --- a/netbox/users/models.py +++ b/netbox/users/models.py @@ -51,7 +51,7 @@ class AdminUser(User): # User preferences # -class UserConfig(BigIDModel): +class UserConfig(models.Model): """ This model stores arbitrary user-specific preferences in a JSON data structure. """ diff --git a/netbox/virtualization/migrations/0020_standardize_models.py b/netbox/virtualization/migrations/0020_standardize_models.py index 15585100d..932403698 100644 --- a/netbox/virtualization/migrations/0020_standardize_models.py +++ b/netbox/virtualization/migrations/0020_standardize_models.py @@ -1,4 +1,5 @@ -import django.core.serializers.json +# Generated by Django 3.2b1 on 2021-02-26 21:11 + from django.db import migrations, models @@ -9,31 +10,6 @@ class Migration(migrations.Migration): ] operations = [ - migrations.AddField( - model_name='clustergroup', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='clustertype', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='vminterface', - name='created', - field=models.DateField(auto_now_add=True, null=True), - ), - migrations.AddField( - model_name='vminterface', - name='custom_field_data', - field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), - ), - migrations.AddField( - model_name='vminterface', - name='last_updated', - field=models.DateTimeField(auto_now=True, null=True), - ), migrations.AlterField( model_name='cluster', name='id', diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index a6a63ab3b..364dde30b 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -9,7 +9,7 @@ from dcim.models import BaseInterface, Device from extras.models import ConfigContextModel, ObjectChange, TaggedItem from extras.querysets import ConfigContextModelQuerySet from extras.utils import extras_features -from netbox.models import OrganizationalModel, PrimaryModel +from netbox.models import BigIDModel, OrganizationalModel, PrimaryModel from utilities.fields import NaturalOrderingField from utilities.ordering import naturalize_interface from utilities.query_functions import CollateAsChar @@ -374,7 +374,7 @@ class VirtualMachine(PrimaryModel, ConfigContextModel): # @extras_features('export_templates', 'webhooks') -class VMInterface(PrimaryModel, BaseInterface): +class VMInterface(BigIDModel, BaseInterface): virtual_machine = models.ForeignKey( to='virtualization.VirtualMachine', on_delete=models.CASCADE, From 1dcd857ca6d287d5c14d94e0c1a849283d8a0cbd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 26 Feb 2021 16:25:37 -0500 Subject: [PATCH 133/302] Closes #5370: Extend custom field support to organizational models --- docs/release-notes/version-2.11.md | 4 +++ .../migrations/0025_standardize_models.py | 8 +++-- .../migrations/0123_standardize_models.py | 33 +++++++++++++++++-- .../migrations/0054_standardize_models.py | 2 -- .../migrations/0044_standardize_models.py | 18 ++++++++-- netbox/netbox/models.py | 4 +-- .../migrations/0013_standardize_models.py | 8 +++-- .../migrations/0012_standardize_models.py | 8 +++-- .../migrations/0011_standardize_models.py | 2 -- .../migrations/0020_standardize_models.py | 13 ++++++-- 10 files changed, 82 insertions(+), 18 deletions(-) diff --git a/docs/release-notes/version-2.11.md b/docs/release-notes/version-2.11.md index 4daeab8bc..4c12ed40a 100644 --- a/docs/release-notes/version-2.11.md +++ b/docs/release-notes/version-2.11.md @@ -4,6 +4,10 @@ **WARNING:** This is a beta release and is not suitable for production use. It is intended for development and evaluation purposes only. No upgrade path to the final v2.11 release will be provided from this beta, and users should assume that all data entered into the application will be lost. +### Enhancements + +* [#5370](https://github.com/netbox-community/netbox/issues/5370) - Extend custom field support to organizational models + ### Other Changes * [#1638](https://github.com/netbox-community/netbox/issues/1638) - Migrate all primary keys to 64-bit integers diff --git a/netbox/circuits/migrations/0025_standardize_models.py b/netbox/circuits/migrations/0025_standardize_models.py index f5d348ff3..2b1d2664e 100644 --- a/netbox/circuits/migrations/0025_standardize_models.py +++ b/netbox/circuits/migrations/0025_standardize_models.py @@ -1,5 +1,4 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - +import django.core.serializers.json from django.db import migrations, models @@ -10,6 +9,11 @@ class Migration(migrations.Migration): ] operations = [ + migrations.AddField( + model_name='circuittype', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), migrations.AlterField( model_name='circuit', name='id', diff --git a/netbox/dcim/migrations/0123_standardize_models.py b/netbox/dcim/migrations/0123_standardize_models.py index e9af8c464..4a6fc87b6 100644 --- a/netbox/dcim/migrations/0123_standardize_models.py +++ b/netbox/dcim/migrations/0123_standardize_models.py @@ -1,5 +1,4 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - +import django.core.serializers.json from django.db import migrations, models @@ -10,6 +9,36 @@ class Migration(migrations.Migration): ] operations = [ + migrations.AddField( + model_name='devicerole', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='manufacturer', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='platform', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='rackgroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='rackrole', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='region', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), migrations.AlterField( model_name='cable', name='id', diff --git a/netbox/extras/migrations/0054_standardize_models.py b/netbox/extras/migrations/0054_standardize_models.py index b6c95e77d..c73043345 100644 --- a/netbox/extras/migrations/0054_standardize_models.py +++ b/netbox/extras/migrations/0054_standardize_models.py @@ -1,5 +1,3 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - from django.db import migrations, models diff --git a/netbox/ipam/migrations/0044_standardize_models.py b/netbox/ipam/migrations/0044_standardize_models.py index a4ad77053..2762c9973 100644 --- a/netbox/ipam/migrations/0044_standardize_models.py +++ b/netbox/ipam/migrations/0044_standardize_models.py @@ -1,5 +1,4 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - +import django.core.serializers.json from django.db import migrations, models @@ -10,6 +9,21 @@ class Migration(migrations.Migration): ] operations = [ + migrations.AddField( + model_name='rir', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='role', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='vlangroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), migrations.AlterField( model_name='aggregate', name='id', diff --git a/netbox/netbox/models.py b/netbox/netbox/models.py index ad11dd18f..74d018420 100644 --- a/netbox/netbox/models.py +++ b/netbox/netbox/models.py @@ -130,7 +130,7 @@ class PrimaryModel(ChangeLoggingMixin, CustomFieldsMixin, BigIDModel): abstract = True -class NestedGroupModel(ChangeLoggingMixin, BigIDModel, MPTTModel): +class NestedGroupModel(ChangeLoggingMixin, CustomFieldsMixin, BigIDModel, MPTTModel): """ Base model for objects which are used to form a hierarchy (regions, locations, etc.). These models nest recursively using MPTT. Within each parent, each child instance must have a unique name. @@ -173,7 +173,7 @@ class NestedGroupModel(ChangeLoggingMixin, BigIDModel, MPTTModel): ) -class OrganizationalModel(ChangeLoggingMixin, BigIDModel): +class OrganizationalModel(ChangeLoggingMixin, CustomFieldsMixin, BigIDModel): """ Organizational models are those which are used solely to categorize and qualify other objects, and do not convey any real information about the infrastructure being modeled (for example, functional device roles). Organizational diff --git a/netbox/secrets/migrations/0013_standardize_models.py b/netbox/secrets/migrations/0013_standardize_models.py index ad18536dc..9de8dec95 100644 --- a/netbox/secrets/migrations/0013_standardize_models.py +++ b/netbox/secrets/migrations/0013_standardize_models.py @@ -1,5 +1,4 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - +import django.core.serializers.json from django.db import migrations, models @@ -10,6 +9,11 @@ class Migration(migrations.Migration): ] operations = [ + migrations.AddField( + model_name='secretrole', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), migrations.AlterField( model_name='secret', name='id', diff --git a/netbox/tenancy/migrations/0012_standardize_models.py b/netbox/tenancy/migrations/0012_standardize_models.py index 6a277fa7c..7ce55cf42 100644 --- a/netbox/tenancy/migrations/0012_standardize_models.py +++ b/netbox/tenancy/migrations/0012_standardize_models.py @@ -1,5 +1,4 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - +import django.core.serializers.json from django.db import migrations, models @@ -10,6 +9,11 @@ class Migration(migrations.Migration): ] operations = [ + migrations.AddField( + model_name='tenantgroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), migrations.AlterField( model_name='tenant', name='id', diff --git a/netbox/users/migrations/0011_standardize_models.py b/netbox/users/migrations/0011_standardize_models.py index 3c514dd2a..08d1103ed 100644 --- a/netbox/users/migrations/0011_standardize_models.py +++ b/netbox/users/migrations/0011_standardize_models.py @@ -1,5 +1,3 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - from django.db import migrations, models diff --git a/netbox/virtualization/migrations/0020_standardize_models.py b/netbox/virtualization/migrations/0020_standardize_models.py index 932403698..8ccb3df0d 100644 --- a/netbox/virtualization/migrations/0020_standardize_models.py +++ b/netbox/virtualization/migrations/0020_standardize_models.py @@ -1,5 +1,4 @@ -# Generated by Django 3.2b1 on 2021-02-26 21:11 - +import django.core.serializers.json from django.db import migrations, models @@ -10,6 +9,16 @@ class Migration(migrations.Migration): ] operations = [ + migrations.AddField( + model_name='clustergroup', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='clustertype', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), migrations.AlterField( model_name='cluster', name='id', From 6a9b50f95db660415af4f94fe7bfc4923b104aff Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Fri, 26 Feb 2021 17:23:23 -0500 Subject: [PATCH 134/302] Closes #5873: Use numeric IDs in all object URLs --- docs/release-notes/version-2.11.md | 1 + netbox/circuits/models.py | 2 +- netbox/circuits/tables.py | 7 +++-- netbox/circuits/urls.py | 14 +++++----- netbox/dcim/models/sites.py | 2 +- netbox/dcim/tables/devices.py | 4 +-- netbox/dcim/tables/devicetypes.py | 2 +- netbox/dcim/tables/power.py | 5 ++-- netbox/dcim/tables/racks.py | 6 ++--- netbox/dcim/urls.py | 26 +++++++++---------- netbox/extras/tables.py | 2 +- netbox/extras/urls.py | 6 ++--- netbox/ipam/tables.py | 18 ++++++------- netbox/ipam/urls.py | 12 ++++----- netbox/secrets/tables.py | 2 +- netbox/secrets/urls.py | 6 ++--- netbox/templates/circuits/circuit.html | 2 +- .../circuits/inc/circuit_termination.html | 2 +- netbox/templates/circuits/provider.html | 2 +- netbox/templates/dcim/device.html | 4 +-- netbox/templates/dcim/devicetype.html | 4 +-- netbox/templates/dcim/rack.html | 2 +- netbox/templates/dcim/rackreservation.html | 2 +- netbox/templates/dcim/site.html | 2 +- netbox/templates/extras/tag.html | 2 +- netbox/templates/ipam/prefix.html | 2 +- netbox/templates/ipam/vlan.html | 2 +- netbox/templates/ipam/vlangroup_vlans.html | 2 +- netbox/templates/tenancy/tenant.html | 2 +- netbox/tenancy/models.py | 2 +- netbox/tenancy/tables.py | 4 +-- netbox/tenancy/urls.py | 14 +++++----- netbox/utilities/tables.py | 10 +++---- netbox/utilities/templatetags/buttons.py | 22 +++------------- netbox/utilities/testing/views.py | 10 +------ netbox/virtualization/tables.py | 4 +-- netbox/virtualization/urls.py | 12 ++++----- 37 files changed, 97 insertions(+), 126 deletions(-) diff --git a/docs/release-notes/version-2.11.md b/docs/release-notes/version-2.11.md index 4c12ed40a..1dcf49759 100644 --- a/docs/release-notes/version-2.11.md +++ b/docs/release-notes/version-2.11.md @@ -11,3 +11,4 @@ ### Other Changes * [#1638](https://github.com/netbox-community/netbox/issues/1638) - Migrate all primary keys to 64-bit integers +* [#5873](https://github.com/netbox-community/netbox/issues/5873) - Use numeric IDs in all object URLs diff --git a/netbox/circuits/models.py b/netbox/circuits/models.py index e371df547..693fe5ae6 100644 --- a/netbox/circuits/models.py +++ b/netbox/circuits/models.py @@ -79,7 +79,7 @@ class Provider(PrimaryModel): return self.name def get_absolute_url(self): - return reverse('circuits:provider', args=[self.slug]) + return reverse('circuits:provider', args=[self.pk]) def to_csv(self): return ( diff --git a/netbox/circuits/tables.py b/netbox/circuits/tables.py index 782b02394..e4b859d3c 100644 --- a/netbox/circuits/tables.py +++ b/netbox/circuits/tables.py @@ -39,7 +39,7 @@ class CircuitTypeTable(BaseTable): circuit_count = tables.Column( verbose_name='Circuits' ) - actions = ButtonsColumn(CircuitType, pk_field='slug') + actions = ButtonsColumn(CircuitType) class Meta(BaseTable.Meta): model = CircuitType @@ -56,9 +56,8 @@ class CircuitTable(BaseTable): cid = tables.LinkColumn( verbose_name='ID' ) - provider = tables.LinkColumn( - viewname='circuits:provider', - args=[Accessor('provider__slug')] + provider = tables.Column( + linkify=True ) status = ChoiceFieldColumn() tenant = tables.TemplateColumn( diff --git a/netbox/circuits/urls.py b/netbox/circuits/urls.py index d757fd90d..a8306efa8 100644 --- a/netbox/circuits/urls.py +++ b/netbox/circuits/urls.py @@ -14,19 +14,19 @@ urlpatterns = [ path('providers/import/', views.ProviderBulkImportView.as_view(), name='provider_import'), path('providers/edit/', views.ProviderBulkEditView.as_view(), name='provider_bulk_edit'), path('providers/delete/', views.ProviderBulkDeleteView.as_view(), name='provider_bulk_delete'), - path('providers//', views.ProviderView.as_view(), name='provider'), - path('providers//edit/', views.ProviderEditView.as_view(), name='provider_edit'), - path('providers//delete/', views.ProviderDeleteView.as_view(), name='provider_delete'), - path('providers//changelog/', ObjectChangeLogView.as_view(), name='provider_changelog', kwargs={'model': Provider}), + path('providers//', views.ProviderView.as_view(), name='provider'), + path('providers//edit/', views.ProviderEditView.as_view(), name='provider_edit'), + path('providers//delete/', views.ProviderDeleteView.as_view(), name='provider_delete'), + path('providers//changelog/', ObjectChangeLogView.as_view(), name='provider_changelog', kwargs={'model': Provider}), # Circuit types path('circuit-types/', views.CircuitTypeListView.as_view(), name='circuittype_list'), path('circuit-types/add/', views.CircuitTypeEditView.as_view(), name='circuittype_add'), path('circuit-types/import/', views.CircuitTypeBulkImportView.as_view(), name='circuittype_import'), path('circuit-types/delete/', views.CircuitTypeBulkDeleteView.as_view(), name='circuittype_bulk_delete'), - path('circuit-types//edit/', views.CircuitTypeEditView.as_view(), name='circuittype_edit'), - path('circuit-types//delete/', views.CircuitTypeDeleteView.as_view(), name='circuittype_delete'), - path('circuit-types//changelog/', ObjectChangeLogView.as_view(), name='circuittype_changelog', kwargs={'model': CircuitType}), + path('circuit-types//edit/', views.CircuitTypeEditView.as_view(), name='circuittype_edit'), + path('circuit-types//delete/', views.CircuitTypeDeleteView.as_view(), name='circuittype_delete'), + path('circuit-types//changelog/', ObjectChangeLogView.as_view(), name='circuittype_changelog', kwargs={'model': CircuitType}), # Circuits path('circuits/', views.CircuitListView.as_view(), name='circuit_list'), diff --git a/netbox/dcim/models/sites.py b/netbox/dcim/models/sites.py index 92d8e1b26..417e0b914 100644 --- a/netbox/dcim/models/sites.py +++ b/netbox/dcim/models/sites.py @@ -192,7 +192,7 @@ class Site(PrimaryModel): return self.name def get_absolute_url(self): - return reverse('dcim:site', args=[self.slug]) + return reverse('dcim:site', args=[self.pk]) def to_csv(self): return ( diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index edd9e7a43..20e04e7cc 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -61,7 +61,7 @@ class DeviceRoleTable(BaseTable): ) color = ColorColumn() vm_role = BooleanColumn() - actions = ButtonsColumn(DeviceRole, pk_field='slug') + actions = ButtonsColumn(DeviceRole) class Meta(BaseTable.Meta): model = DeviceRole @@ -85,7 +85,7 @@ class PlatformTable(BaseTable): url_params={'platform': 'slug'}, verbose_name='VMs' ) - actions = ButtonsColumn(Platform, pk_field='slug') + actions = ButtonsColumn(Platform) class Meta(BaseTable.Meta): model = Platform diff --git a/netbox/dcim/tables/devicetypes.py b/netbox/dcim/tables/devicetypes.py index c4d618cd7..c5b8bb70d 100644 --- a/netbox/dcim/tables/devicetypes.py +++ b/netbox/dcim/tables/devicetypes.py @@ -37,7 +37,7 @@ class ManufacturerTable(BaseTable): verbose_name='Platforms' ) slug = tables.Column() - actions = ButtonsColumn(Manufacturer, pk_field='slug') + actions = ButtonsColumn(Manufacturer) class Meta(BaseTable.Meta): model = Manufacturer diff --git a/netbox/dcim/tables/power.py b/netbox/dcim/tables/power.py index ae5c2a5c8..6d6e2541b 100644 --- a/netbox/dcim/tables/power.py +++ b/netbox/dcim/tables/power.py @@ -19,9 +19,8 @@ __all__ = ( class PowerPanelTable(BaseTable): pk = ToggleColumn() name = tables.LinkColumn() - site = tables.LinkColumn( - viewname='dcim:site', - args=[Accessor('site__slug')] + site = tables.Column( + linkify=True ) powerfeed_count = LinkedCountColumn( viewname='dcim:powerfeed_list', diff --git a/netbox/dcim/tables/racks.py b/netbox/dcim/tables/racks.py index 775e90076..1ac0d17bb 100644 --- a/netbox/dcim/tables/racks.py +++ b/netbox/dcim/tables/racks.py @@ -29,10 +29,8 @@ class RackGroupTable(BaseTable): orderable=False, attrs={'td': {'class': 'text-nowrap'}} ) - site = tables.LinkColumn( - viewname='dcim:site', - args=[Accessor('site__slug')], - verbose_name='Site' + site = tables.Column( + linkify=True ) rack_count = tables.Column( verbose_name='Racks' diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index d167ebdb7..6cf61df24 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -27,10 +27,10 @@ urlpatterns = [ path('sites/import/', views.SiteBulkImportView.as_view(), name='site_import'), path('sites/edit/', views.SiteBulkEditView.as_view(), name='site_bulk_edit'), path('sites/delete/', views.SiteBulkDeleteView.as_view(), name='site_bulk_delete'), - path('sites//', views.SiteView.as_view(), name='site'), - path('sites//edit/', views.SiteEditView.as_view(), name='site_edit'), - path('sites//delete/', views.SiteDeleteView.as_view(), name='site_delete'), - path('sites//changelog/', ObjectChangeLogView.as_view(), name='site_changelog', kwargs={'model': Site}), + path('sites//', views.SiteView.as_view(), name='site'), + path('sites//edit/', views.SiteEditView.as_view(), name='site_edit'), + path('sites//delete/', views.SiteDeleteView.as_view(), name='site_delete'), + path('sites//changelog/', ObjectChangeLogView.as_view(), name='site_changelog', kwargs={'model': Site}), path('sites//images/add/', ImageAttachmentEditView.as_view(), name='site_add_image', kwargs={'model': Site}), # Rack groups @@ -80,9 +80,9 @@ urlpatterns = [ path('manufacturers/add/', views.ManufacturerEditView.as_view(), name='manufacturer_add'), path('manufacturers/import/', views.ManufacturerBulkImportView.as_view(), name='manufacturer_import'), path('manufacturers/delete/', views.ManufacturerBulkDeleteView.as_view(), name='manufacturer_bulk_delete'), - path('manufacturers//edit/', views.ManufacturerEditView.as_view(), name='manufacturer_edit'), - path('manufacturers//delete/', views.ManufacturerDeleteView.as_view(), name='manufacturer_delete'), - path('manufacturers//changelog/', ObjectChangeLogView.as_view(), name='manufacturer_changelog', kwargs={'model': Manufacturer}), + path('manufacturers//edit/', views.ManufacturerEditView.as_view(), name='manufacturer_edit'), + path('manufacturers//delete/', views.ManufacturerDeleteView.as_view(), name='manufacturer_delete'), + path('manufacturers//changelog/', ObjectChangeLogView.as_view(), name='manufacturer_changelog', kwargs={'model': Manufacturer}), # Device types path('device-types/', views.DeviceTypeListView.as_view(), name='devicetype_list'), @@ -164,18 +164,18 @@ urlpatterns = [ path('device-roles/add/', views.DeviceRoleEditView.as_view(), name='devicerole_add'), path('device-roles/import/', views.DeviceRoleBulkImportView.as_view(), name='devicerole_import'), path('device-roles/delete/', views.DeviceRoleBulkDeleteView.as_view(), name='devicerole_bulk_delete'), - path('device-roles//edit/', views.DeviceRoleEditView.as_view(), name='devicerole_edit'), - path('device-roles//delete/', views.DeviceRoleDeleteView.as_view(), name='devicerole_delete'), - path('device-roles//changelog/', ObjectChangeLogView.as_view(), name='devicerole_changelog', kwargs={'model': DeviceRole}), + path('device-roles//edit/', views.DeviceRoleEditView.as_view(), name='devicerole_edit'), + path('device-roles//delete/', views.DeviceRoleDeleteView.as_view(), name='devicerole_delete'), + path('device-roles//changelog/', ObjectChangeLogView.as_view(), name='devicerole_changelog', kwargs={'model': DeviceRole}), # Platforms path('platforms/', views.PlatformListView.as_view(), name='platform_list'), path('platforms/add/', views.PlatformEditView.as_view(), name='platform_add'), path('platforms/import/', views.PlatformBulkImportView.as_view(), name='platform_import'), path('platforms/delete/', views.PlatformBulkDeleteView.as_view(), name='platform_bulk_delete'), - path('platforms//edit/', views.PlatformEditView.as_view(), name='platform_edit'), - path('platforms//delete/', views.PlatformDeleteView.as_view(), name='platform_delete'), - path('platforms//changelog/', ObjectChangeLogView.as_view(), name='platform_changelog', kwargs={'model': Platform}), + path('platforms//edit/', views.PlatformEditView.as_view(), name='platform_edit'), + path('platforms//delete/', views.PlatformDeleteView.as_view(), name='platform_delete'), + path('platforms//changelog/', ObjectChangeLogView.as_view(), name='platform_changelog', kwargs={'model': Platform}), # Devices path('devices/', views.DeviceListView.as_view(), name='device_list'), diff --git a/netbox/extras/tables.py b/netbox/extras/tables.py index cccb56c0a..7aeddb48f 100644 --- a/netbox/extras/tables.py +++ b/netbox/extras/tables.py @@ -37,7 +37,7 @@ OBJECTCHANGE_REQUEST_ID = """ class TagTable(BaseTable): pk = ToggleColumn() color = ColorColumn() - actions = ButtonsColumn(Tag, pk_field='slug') + actions = ButtonsColumn(Tag) class Meta(BaseTable.Meta): model = Tag diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py index 36077dc7a..d2f0a2eb2 100644 --- a/netbox/extras/urls.py +++ b/netbox/extras/urls.py @@ -13,9 +13,9 @@ urlpatterns = [ path('tags/import/', views.TagBulkImportView.as_view(), name='tag_import'), path('tags/edit/', views.TagBulkEditView.as_view(), name='tag_bulk_edit'), path('tags/delete/', views.TagBulkDeleteView.as_view(), name='tag_bulk_delete'), - path('tags//edit/', views.TagEditView.as_view(), name='tag_edit'), - path('tags//delete/', views.TagDeleteView.as_view(), name='tag_delete'), - path('tags//changelog/', views.ObjectChangeLogView.as_view(), name='tag_changelog', kwargs={'model': Tag}), + path('tags//edit/', views.TagEditView.as_view(), name='tag_edit'), + path('tags//delete/', views.TagDeleteView.as_view(), name='tag_delete'), + path('tags//changelog/', views.ObjectChangeLogView.as_view(), name='tag_changelog', kwargs={'model': Tag}), # Config contexts path('config-contexts/', views.ConfigContextListView.as_view(), name='configcontext_list'), diff --git a/netbox/ipam/tables.py b/netbox/ipam/tables.py index 86d7e21eb..8101a581d 100644 --- a/netbox/ipam/tables.py +++ b/netbox/ipam/tables.py @@ -111,9 +111,9 @@ VLAN_MEMBER_TAGGED = """ TENANT_LINK = """ {% if record.tenant %} - {{ record.tenant }} + {{ record.tenant }} {% elif record.vrf.tenant %} - {{ record.vrf.tenant }}* + {{ record.vrf.tenant }}* {% else %} — {% endif %} @@ -191,7 +191,7 @@ class RIRTable(BaseTable): url_params={'rir': 'slug'}, verbose_name='Aggregates' ) - actions = ButtonsColumn(RIR, pk_field='slug') + actions = ButtonsColumn(RIR) class Meta(BaseTable.Meta): model = RIR @@ -254,7 +254,7 @@ class RoleTable(BaseTable): url_params={'role': 'slug'}, verbose_name='VLANs' ) - actions = ButtonsColumn(Role, pk_field='slug') + actions = ButtonsColumn(Role) class Meta(BaseTable.Meta): model = Role @@ -444,9 +444,8 @@ class InterfaceIPAddressTable(BaseTable): class VLANGroupTable(BaseTable): pk = ToggleColumn() name = tables.Column(linkify=True) - site = tables.LinkColumn( - viewname='dcim:site', - args=[Accessor('site__slug')] + site = tables.Column( + linkify=True ) vlan_count = LinkedCountColumn( viewname='ipam:vlan_list', @@ -474,9 +473,8 @@ class VLANTable(BaseTable): template_code=VLAN_LINK, verbose_name='ID' ) - site = tables.LinkColumn( - viewname='dcim:site', - args=[Accessor('site__slug')] + site = tables.Column( + linkify=True ) group = tables.LinkColumn( viewname='ipam:vlangroup_vlans', diff --git a/netbox/ipam/urls.py b/netbox/ipam/urls.py index 9b0dc581b..db0eec157 100644 --- a/netbox/ipam/urls.py +++ b/netbox/ipam/urls.py @@ -34,9 +34,9 @@ urlpatterns = [ path('rirs/add/', views.RIREditView.as_view(), name='rir_add'), path('rirs/import/', views.RIRBulkImportView.as_view(), name='rir_import'), path('rirs/delete/', views.RIRBulkDeleteView.as_view(), name='rir_bulk_delete'), - path('rirs//edit/', views.RIREditView.as_view(), name='rir_edit'), - path('rirs//delete/', views.RIRDeleteView.as_view(), name='rir_delete'), - path('vrfs//changelog/', ObjectChangeLogView.as_view(), name='rir_changelog', kwargs={'model': RIR}), + path('rirs//edit/', views.RIREditView.as_view(), name='rir_edit'), + path('rirs//delete/', views.RIRDeleteView.as_view(), name='rir_delete'), + path('rirs//changelog/', ObjectChangeLogView.as_view(), name='rir_changelog', kwargs={'model': RIR}), # Aggregates path('aggregates/', views.AggregateListView.as_view(), name='aggregate_list'), @@ -54,9 +54,9 @@ urlpatterns = [ path('roles/add/', views.RoleEditView.as_view(), name='role_add'), path('roles/import/', views.RoleBulkImportView.as_view(), name='role_import'), path('roles/delete/', views.RoleBulkDeleteView.as_view(), name='role_bulk_delete'), - path('roles//edit/', views.RoleEditView.as_view(), name='role_edit'), - path('roles//delete/', views.RoleDeleteView.as_view(), name='role_delete'), - path('roles//changelog/', ObjectChangeLogView.as_view(), name='role_changelog', kwargs={'model': Role}), + path('roles//edit/', views.RoleEditView.as_view(), name='role_edit'), + path('roles//delete/', views.RoleDeleteView.as_view(), name='role_delete'), + path('roles//changelog/', ObjectChangeLogView.as_view(), name='role_changelog', kwargs={'model': Role}), # Prefixes path('prefixes/', views.PrefixListView.as_view(), name='prefix_list'), diff --git a/netbox/secrets/tables.py b/netbox/secrets/tables.py index 0d8559a2b..dd91985ec 100644 --- a/netbox/secrets/tables.py +++ b/netbox/secrets/tables.py @@ -16,7 +16,7 @@ class SecretRoleTable(BaseTable): url_params={'role': 'slug'}, verbose_name='Secrets' ) - actions = ButtonsColumn(SecretRole, pk_field='slug') + actions = ButtonsColumn(SecretRole) class Meta(BaseTable.Meta): model = SecretRole diff --git a/netbox/secrets/urls.py b/netbox/secrets/urls.py index 9dbb5d044..62a285875 100644 --- a/netbox/secrets/urls.py +++ b/netbox/secrets/urls.py @@ -12,9 +12,9 @@ urlpatterns = [ path('secret-roles/add/', views.SecretRoleEditView.as_view(), name='secretrole_add'), path('secret-roles/import/', views.SecretRoleBulkImportView.as_view(), name='secretrole_import'), path('secret-roles/delete/', views.SecretRoleBulkDeleteView.as_view(), name='secretrole_bulk_delete'), - path('secret-roles//edit/', views.SecretRoleEditView.as_view(), name='secretrole_edit'), - path('secret-roles//delete/', views.SecretRoleDeleteView.as_view(), name='secretrole_delete'), - path('secret-roles//changelog/', ObjectChangeLogView.as_view(), name='secretrole_changelog', kwargs={'model': SecretRole}), + path('secret-roles//edit/', views.SecretRoleEditView.as_view(), name='secretrole_edit'), + path('secret-roles//delete/', views.SecretRoleDeleteView.as_view(), name='secretrole_delete'), + path('secret-roles//changelog/', ObjectChangeLogView.as_view(), name='secretrole_changelog', kwargs={'model': SecretRole}), # Secrets path('secrets/', views.SecretListView.as_view(), name='secret_list'), diff --git a/netbox/templates/circuits/circuit.html b/netbox/templates/circuits/circuit.html index c104b154b..47125da14 100644 --- a/netbox/templates/circuits/circuit.html +++ b/netbox/templates/circuits/circuit.html @@ -74,7 +74,7 @@ Provider - {{ object.provider }} + {{ object.provider }} diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index 477788931..e4854e5ab 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -32,7 +32,7 @@ {% if termination.site.region %} {{ termination.site.region }} / {% endif %} - {{ termination.site }} + {{ termination.site }} diff --git a/netbox/templates/circuits/provider.html b/netbox/templates/circuits/provider.html index 8778c3ac2..7fa512ec6 100644 --- a/netbox/templates/circuits/provider.html +++ b/netbox/templates/circuits/provider.html @@ -51,7 +51,7 @@ {% if perms.extras.view_objectchange %} {% endif %} diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index 55be343ac..917384b98 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -23,7 +23,7 @@ {% if object.site.region %} {{ object.site.region }} / {% endif %} - {{ object.site }} + {{ object.site }} @@ -74,7 +74,7 @@ Device Type - {{ object.device_type.display_name }} ({{ object.device_type.u_height }}U) + {{ object.device_type.display_name }} ({{ object.device_type.u_height }}U) diff --git a/netbox/templates/dcim/devicetype.html b/netbox/templates/dcim/devicetype.html index 6bc970174..110d42c04 100644 --- a/netbox/templates/dcim/devicetype.html +++ b/netbox/templates/dcim/devicetype.html @@ -55,10 +55,10 @@ {% clone_button object %} {% endif %} {% if perms.dcim.change_devicetype %} - {% edit_button object use_pk=True %} + {% edit_button object %} {% endif %} {% if perms.dcim.delete_devicetype %} - {% delete_button object use_pk=True %} + {% delete_button object %} {% endif %}

{{ object.manufacturer }} {{ object.model }}

diff --git a/netbox/templates/dcim/rack.html b/netbox/templates/dcim/rack.html index 6a00308f3..9c0d72a04 100644 --- a/netbox/templates/dcim/rack.html +++ b/netbox/templates/dcim/rack.html @@ -85,7 +85,7 @@ {% if object.site.region %} {{ object.site.region }} / {% endif %} - {{ object.site }} + {{ object.site }} diff --git a/netbox/templates/dcim/rackreservation.html b/netbox/templates/dcim/rackreservation.html index 5273b2a39..4760f4192 100644 --- a/netbox/templates/dcim/rackreservation.html +++ b/netbox/templates/dcim/rackreservation.html @@ -68,7 +68,7 @@ {% if rack.site.region %} {{ rack.site.region }} / {% endif %} - {{ rack.site }} + {{ rack.site }} diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index a0e713fcf..0ffc7e265 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -56,7 +56,7 @@ {% if perms.extras.view_objectchange %} {% endif %} diff --git a/netbox/templates/extras/tag.html b/netbox/templates/extras/tag.html index 2ad7cf814..2cee8f882 100644 --- a/netbox/templates/extras/tag.html +++ b/netbox/templates/extras/tag.html @@ -44,7 +44,7 @@ {% if perms.extras.view_objectchange %} {% endif %} diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index 4b382636b..d195affb2 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -129,7 +129,7 @@ {% if object.site.region %} {{ object.site.region }} / {% endif %} - {{ object.site }} + {{ object.site }} {% else %} None {% endif %} diff --git a/netbox/templates/ipam/vlan.html b/netbox/templates/ipam/vlan.html index d2967ca56..52286e29d 100644 --- a/netbox/templates/ipam/vlan.html +++ b/netbox/templates/ipam/vlan.html @@ -81,7 +81,7 @@ {% if object.site.region %} {{ object.site.region }} / {% endif %} - {{ object.site }} + {{ object.site }} {% else %} None {% endif %} diff --git a/netbox/templates/ipam/vlangroup_vlans.html b/netbox/templates/ipam/vlangroup_vlans.html index 490b7ab2c..ffb75d3b8 100644 --- a/netbox/templates/ipam/vlangroup_vlans.html +++ b/netbox/templates/ipam/vlangroup_vlans.html @@ -8,7 +8,7 @@
  1. VLAN Groups
    2. {% if object.site %} -
  2. {{ object.site }}
    3. +
  3. {{ object.site }}
    4. {% endif %}
  4. {{ object }}
diff --git a/netbox/templates/tenancy/tenant.html b/netbox/templates/tenancy/tenant.html index e2e66e6b2..00044f1c3 100644 --- a/netbox/templates/tenancy/tenant.html +++ b/netbox/templates/tenancy/tenant.html @@ -51,7 +51,7 @@ {% if perms.extras.view_objectchange %} {% endif %} diff --git a/netbox/tenancy/models.py b/netbox/tenancy/models.py index e83f4bdd2..757afb09e 100644 --- a/netbox/tenancy/models.py +++ b/netbox/tenancy/models.py @@ -105,7 +105,7 @@ class Tenant(PrimaryModel): return self.name def get_absolute_url(self): - return reverse('tenancy:tenant', args=[self.slug]) + return reverse('tenancy:tenant', args=[self.pk]) def to_csv(self): return ( diff --git a/netbox/tenancy/tables.py b/netbox/tenancy/tables.py index 9e8be6b18..8872a7012 100644 --- a/netbox/tenancy/tables.py +++ b/netbox/tenancy/tables.py @@ -12,7 +12,7 @@ MPTT_LINK = """ COL_TENANT = """ {% if record.tenant %} - {{ record.tenant }} + {{ record.tenant }} {% else %} — {% endif %} @@ -35,7 +35,7 @@ class TenantGroupTable(BaseTable): url_params={'group': 'slug'}, verbose_name='Tenants' ) - actions = ButtonsColumn(TenantGroup, pk_field='slug') + actions = ButtonsColumn(TenantGroup) class Meta(BaseTable.Meta): model = TenantGroup diff --git a/netbox/tenancy/urls.py b/netbox/tenancy/urls.py index 372308bb8..c07df97a6 100644 --- a/netbox/tenancy/urls.py +++ b/netbox/tenancy/urls.py @@ -12,9 +12,9 @@ urlpatterns = [ path('tenant-groups/add/', views.TenantGroupEditView.as_view(), name='tenantgroup_add'), path('tenant-groups/import/', views.TenantGroupBulkImportView.as_view(), name='tenantgroup_import'), path('tenant-groups/delete/', views.TenantGroupBulkDeleteView.as_view(), name='tenantgroup_bulk_delete'), - path('tenant-groups//edit/', views.TenantGroupEditView.as_view(), name='tenantgroup_edit'), - path('tenant-groups//delete/', views.TenantGroupDeleteView.as_view(), name='tenantgroup_delete'), - path('tenant-groups//changelog/', ObjectChangeLogView.as_view(), name='tenantgroup_changelog', kwargs={'model': TenantGroup}), + path('tenant-groups//edit/', views.TenantGroupEditView.as_view(), name='tenantgroup_edit'), + path('tenant-groups//delete/', views.TenantGroupDeleteView.as_view(), name='tenantgroup_delete'), + path('tenant-groups//changelog/', ObjectChangeLogView.as_view(), name='tenantgroup_changelog', kwargs={'model': TenantGroup}), # Tenants path('tenants/', views.TenantListView.as_view(), name='tenant_list'), @@ -22,9 +22,9 @@ urlpatterns = [ path('tenants/import/', views.TenantBulkImportView.as_view(), name='tenant_import'), path('tenants/edit/', views.TenantBulkEditView.as_view(), name='tenant_bulk_edit'), path('tenants/delete/', views.TenantBulkDeleteView.as_view(), name='tenant_bulk_delete'), - path('tenants//', views.TenantView.as_view(), name='tenant'), - path('tenants//edit/', views.TenantEditView.as_view(), name='tenant_edit'), - path('tenants//delete/', views.TenantDeleteView.as_view(), name='tenant_delete'), - path('tenants//changelog/', ObjectChangeLogView.as_view(), name='tenant_changelog', kwargs={'model': Tenant}), + path('tenants//', views.TenantView.as_view(), name='tenant'), + path('tenants//edit/', views.TenantEditView.as_view(), name='tenant_edit'), + path('tenants//delete/', views.TenantDeleteView.as_view(), name='tenant_delete'), + path('tenants//changelog/', ObjectChangeLogView.as_view(), name='tenant_changelog', kwargs={'model': Tenant}), ] diff --git a/netbox/utilities/tables.py b/netbox/utilities/tables.py index bf087f2c9..f2f567783 100644 --- a/netbox/utilities/tables.py +++ b/netbox/utilities/tables.py @@ -147,24 +147,23 @@ class ButtonsColumn(tables.TemplateColumn): # Note that braces are escaped to allow for string formatting prior to template rendering template_code = """ {{% if "changelog" in buttons %}} - + {{% endif %}} {{% if "edit" in buttons and perms.{app_label}.change_{model_name} %}} - + {{% endif %}} {{% if "delete" in buttons and perms.{app_label}.delete_{model_name} %}} - + {{% endif %}} """ - def __init__(self, model, *args, pk_field='pk', buttons=None, prepend_template=None, return_url_extra='', - **kwargs): + def __init__(self, model, *args, buttons=None, prepend_template=None, return_url_extra='', **kwargs): if prepend_template: prepend_template = prepend_template.replace('{', '{{') prepend_template = prepend_template.replace('}', '}}') @@ -173,7 +172,6 @@ class ButtonsColumn(tables.TemplateColumn): template_code = self.template_code.format( app_label=model._meta.app_label, model_name=model._meta.model_name, - pk_field=pk_field, buttons=buttons ) diff --git a/netbox/utilities/templatetags/buttons.py b/netbox/utilities/templatetags/buttons.py index e7f00cacf..c486dd2e5 100644 --- a/netbox/utilities/templatetags/buttons.py +++ b/netbox/utilities/templatetags/buttons.py @@ -40,16 +40,9 @@ def clone_button(instance): @register.inclusion_tag('buttons/edit.html') -def edit_button(instance, use_pk=False): +def edit_button(instance): viewname = _get_viewname(instance, 'edit') - - # Assign kwargs - if hasattr(instance, 'slug') and not use_pk: - kwargs = {'slug': instance.slug} - else: - kwargs = {'pk': instance.pk} - - url = reverse(viewname, kwargs=kwargs) + url = reverse(viewname, kwargs={'pk': instance.pk}) return { 'url': url, @@ -57,16 +50,9 @@ def edit_button(instance, use_pk=False): @register.inclusion_tag('buttons/delete.html') -def delete_button(instance, use_pk=False): +def delete_button(instance): viewname = _get_viewname(instance, 'delete') - - # Assign kwargs - if hasattr(instance, 'slug') and not use_pk: - kwargs = {'slug': instance.slug} - else: - kwargs = {'pk': instance.pk} - - url = reverse(viewname, kwargs=kwargs) + url = reverse(viewname, kwargs={'pk': instance.pk}) return { 'url': url, diff --git a/netbox/utilities/testing/views.py b/netbox/utilities/testing/views.py index d380996b7..89bac51cf 100644 --- a/netbox/utilities/testing/views.py +++ b/netbox/utilities/testing/views.py @@ -5,7 +5,7 @@ from django.core.exceptions import FieldDoesNotExist, ObjectDoesNotExist from django.db.models import ManyToManyField from django.forms.models import model_to_dict from django.test import Client, TestCase as _TestCase, override_settings -from django.urls import reverse, NoReverseMatch +from django.urls import reverse from django.utils.text import slugify from netaddr import IPNetwork from taggit.managers import TaggableManager @@ -205,14 +205,6 @@ class ModelViewTestCase(ModelTestCase): if instance is None: return reverse(url_format.format(action)) - # Attempt to resolve using slug as the unique identifier if one exists - if hasattr(self.model, 'slug'): - try: - return reverse(url_format.format(action), kwargs={'slug': instance.slug}) - except NoReverseMatch: - pass - - # Default to using the numeric PK to retrieve the URL for an object return reverse(url_format.format(action), kwargs={'pk': instance.pk}) diff --git a/netbox/virtualization/tables.py b/netbox/virtualization/tables.py index 34a070623..808832224 100644 --- a/netbox/virtualization/tables.py +++ b/netbox/virtualization/tables.py @@ -36,7 +36,7 @@ class ClusterTypeTable(BaseTable): cluster_count = tables.Column( verbose_name='Clusters' ) - actions = ButtonsColumn(ClusterType, pk_field='slug') + actions = ButtonsColumn(ClusterType) class Meta(BaseTable.Meta): model = ClusterType @@ -54,7 +54,7 @@ class ClusterGroupTable(BaseTable): cluster_count = tables.Column( verbose_name='Clusters' ) - actions = ButtonsColumn(ClusterGroup, pk_field='slug') + actions = ButtonsColumn(ClusterGroup) class Meta(BaseTable.Meta): model = ClusterGroup diff --git a/netbox/virtualization/urls.py b/netbox/virtualization/urls.py index 3d6f07566..703f99b65 100644 --- a/netbox/virtualization/urls.py +++ b/netbox/virtualization/urls.py @@ -13,18 +13,18 @@ urlpatterns = [ path('cluster-types/add/', views.ClusterTypeEditView.as_view(), name='clustertype_add'), path('cluster-types/import/', views.ClusterTypeBulkImportView.as_view(), name='clustertype_import'), path('cluster-types/delete/', views.ClusterTypeBulkDeleteView.as_view(), name='clustertype_bulk_delete'), - path('cluster-types//edit/', views.ClusterTypeEditView.as_view(), name='clustertype_edit'), - path('cluster-types//delete/', views.ClusterTypeDeleteView.as_view(), name='clustertype_delete'), - path('cluster-types//changelog/', ObjectChangeLogView.as_view(), name='clustertype_changelog', kwargs={'model': ClusterType}), + path('cluster-types//edit/', views.ClusterTypeEditView.as_view(), name='clustertype_edit'), + path('cluster-types//delete/', views.ClusterTypeDeleteView.as_view(), name='clustertype_delete'), + path('cluster-types//changelog/', ObjectChangeLogView.as_view(), name='clustertype_changelog', kwargs={'model': ClusterType}), # Cluster groups path('cluster-groups/', views.ClusterGroupListView.as_view(), name='clustergroup_list'), path('cluster-groups/add/', views.ClusterGroupEditView.as_view(), name='clustergroup_add'), path('cluster-groups/import/', views.ClusterGroupBulkImportView.as_view(), name='clustergroup_import'), path('cluster-groups/delete/', views.ClusterGroupBulkDeleteView.as_view(), name='clustergroup_bulk_delete'), - path('cluster-groups//edit/', views.ClusterGroupEditView.as_view(), name='clustergroup_edit'), - path('cluster-groups//delete/', views.ClusterGroupDeleteView.as_view(), name='clustergroup_delete'), - path('cluster-groups//changelog/', ObjectChangeLogView.as_view(), name='clustergroup_changelog', kwargs={'model': ClusterGroup}), + path('cluster-groups//edit/', views.ClusterGroupEditView.as_view(), name='clustergroup_edit'), + path('cluster-groups//delete/', views.ClusterGroupDeleteView.as_view(), name='clustergroup_delete'), + path('cluster-groups//changelog/', ObjectChangeLogView.as_view(), name='clustergroup_changelog', kwargs={'model': ClusterGroup}), # Clusters path('clusters/', views.ClusterListView.as_view(), name='cluster_list'), From cfddf570b90d692201284ed16e60b5cfdf97cbf8 Mon Sep 17 00:00:00 2001 From: Julian Jacobi Date: Mon, 1 Mar 2021 09:27:21 +0100 Subject: [PATCH 135/302] add custom links to device components --- netbox/dcim/models/device_components.py | 18 +++++++++--------- netbox/templates/dcim/device_component.html | 4 ++++ 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 452aacb56..40063234f 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -198,7 +198,7 @@ class PathEndpoint(models.Model): # Console ports # -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class ConsolePort(CableTermination, PathEndpoint, ComponentModel): """ A physical console port within a Device. ConsolePorts connect to ConsoleServerPorts. @@ -234,7 +234,7 @@ class ConsolePort(CableTermination, PathEndpoint, ComponentModel): # Console server ports # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel): """ A physical port within a Device (typically a designated console server) which provides access to ConsolePorts. @@ -270,7 +270,7 @@ class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel): # Power ports # -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class PowerPort(CableTermination, PathEndpoint, ComponentModel): """ A physical power supply (intake) port within a Device. PowerPorts connect to PowerOutlets. @@ -379,7 +379,7 @@ class PowerPort(CableTermination, PathEndpoint, ComponentModel): # Power outlets # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class PowerOutlet(CableTermination, PathEndpoint, ComponentModel): """ A physical power outlet (output) within a Device which provides power to a PowerPort. @@ -479,7 +479,7 @@ class BaseInterface(models.Model): return super().save(*args, **kwargs) -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): """ A network interface within a Device. A physical Interface can connect to exactly one other Interface. @@ -624,7 +624,7 @@ class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): # Pass-through ports # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class FrontPort(CableTermination, ComponentModel): """ A pass-through port on the front of a Device. @@ -687,7 +687,7 @@ class FrontPort(CableTermination, ComponentModel): }) -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class RearPort(CableTermination, ComponentModel): """ A pass-through port on the rear of a Device. @@ -740,7 +740,7 @@ class RearPort(CableTermination, ComponentModel): # Device bays # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class DeviceBay(ComponentModel): """ An empty space within a Device which can house a child device @@ -800,7 +800,7 @@ class DeviceBay(ComponentModel): # Inventory items # -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class InventoryItem(MPTTModel, ComponentModel): """ An InventoryItem represents a serialized piece of hardware within a Device, such as a line card or power supply. diff --git a/netbox/templates/dcim/device_component.html b/netbox/templates/dcim/device_component.html index c0ce453b3..234d10fdd 100644 --- a/netbox/templates/dcim/device_component.html +++ b/netbox/templates/dcim/device_component.html @@ -1,6 +1,7 @@ {% extends 'base.html' %} {% load helpers %} {% load perms %} +{% load custom_links %} {% load plugins %} {% block header %} @@ -30,6 +31,9 @@ {% endif %}

{% block title %}{{ object.device }} / {{ object }}{% endblock %}

+
+ {% custom_links object %} +