nautobot 2.4.0__py3-none-any.whl → 2.4.0b1__py3-none-any.whl

nautobot/ipam/api/views.py

@@ -50,19 +50,21 @@ class NamespaceViewSet(NautobotModelViewSet):
 
 
 class VRFViewSet(NautobotModelViewSet):
-    queryset = VRF.objects.all()
+    queryset = VRF.objects.select_related("namespace", "tenant").prefetch_related(
+        "devices", "virtual_machines", "prefixes", "import_targets", "export_targets", "tags"
+    )
     serializer_class = serializers.VRFSerializer
     filterset_class = filters.VRFFilterSet
 
 
 class VRFDeviceAssignmentViewSet(NautobotModelViewSet):
-    queryset = VRFDeviceAssignment.objects.all()
+    queryset = VRFDeviceAssignment.objects.select_related("vrf", "device", "virtual_machine")
     serializer_class = serializers.VRFDeviceAssignmentSerializer
     filterset_class = filters.VRFDeviceAssignmentFilterSet
 
 
 class VRFPrefixAssignmentViewSet(NautobotModelViewSet):
-    queryset = VRFPrefixAssignment.objects.all()
+    queryset = VRFPrefixAssignment.objects.select_related("vrf", "prefix")
     serializer_class = serializers.VRFPrefixAssignmentSerializer
     filterset_class = filters.VRFPrefixAssignmentFilterSet
 
@@ -73,7 +75,7 @@ class VRFPrefixAssignmentViewSet(NautobotModelViewSet):
 
 
 class RouteTargetViewSet(NautobotModelViewSet):
-    queryset = RouteTarget.objects.all()
+    queryset = RouteTarget.objects.select_related("tenant").prefetch_related("tags")
     serializer_class = serializers.RouteTargetSerializer
     filterset_class = filters.RouteTargetFilterSet
 
@@ -108,14 +110,21 @@ class RIRViewSet(NautobotModelViewSet):
     update=extend_schema(responses={"200": serializers.PrefixLegacySerializer}, versions=["2.0", "2.1"]),
 )
 class PrefixViewSet(NautobotModelViewSet):
-    queryset = Prefix.objects.all()
+    queryset = Prefix.objects.select_related(
+        "namespace",
+        "parent",
+        "rir",
+        "role",
+        "status",
+        "tenant",
+        "vlan",
+    ).prefetch_related("locations", "tags")
     serializer_class = serializers.PrefixSerializer
     filterset_class = filters.PrefixFilterSet
 
     def get_serializer_class(self):
         if (
             not getattr(self, "swagger_fake_view", False)
-            and hasattr(self.request, "major_version")
             and self.request.major_version == 2
             and self.request.minor_version < 2
         ):
@@ -131,15 +140,15 @@ class PrefixViewSet(NautobotModelViewSet):
         )
         default_code = "precondition_failed"
 
-    def retrieve(self, request, *args, pk=None, **kwargs):
+    def retrieve(self, request, pk=None):
         try:
-            return super().retrieve(request, *args, pk=pk, **kwargs)
+            return super().retrieve(request, pk)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
-    def list(self, request, *args, **kwargs):
+    def list(self, request):
         try:
-            return super().list(request, *args, **kwargs)
+            return super().list(request)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
@@ -177,15 +186,20 @@ class PrefixViewSet(NautobotModelViewSet):
                 available_prefixes = prefix.get_available_prefixes()
 
                 # Validate Requested Prefixes' length
-                requested_prefixes = request.data if isinstance(request.data, list) else [request.data]
+                serializer = serializers.PrefixLengthSerializer(
+                    data=request.data if isinstance(request.data, list) else [request.data],
+                    many=True,
+                    context={
+                        "request": request,
+                        "prefix": prefix,
+                    },
+                )
+                serializer.is_valid(raise_exception=True)
+
+                requested_prefixes = serializer.validated_data
+                # Allocate prefixes to the requested objects based on availability within the parent
                 for requested_prefix in requested_prefixes:
-                    # If the prefix_length is not an integer, return a 400 using the
-                    # serializer.is_valid(raise_exception=True) method call below
-                    if not isinstance(requested_prefix["prefix_length"], int):
-                        return Response(
-                            {"prefix_length": "This field must be an integer."},
-                            status=status.HTTP_400_BAD_REQUEST,
-                        )
+                    # Find the first available prefix equal to or larger than the requested size
                     for available_prefix in available_prefixes.iter_cidrs():
                         if requested_prefix["prefix_length"] >= available_prefix.prefixlen:
                             allocated_prefix = f"{available_prefix.network}/{requested_prefix['prefix_length']}"
@@ -197,6 +211,11 @@ class PrefixViewSet(NautobotModelViewSet):
                             {"detail": "Insufficient space is available to accommodate the requested prefix size(s)"},
                             status=status.HTTP_204_NO_CONTENT,
                         )
+
+                    # The serializer usage above has mapped "custom_fields" dict to "_custom_field_data".
+                    # We need to convert it back to "custom_fields" as we're going to deserialize it a second time below
+                    requested_prefix["custom_fields"] = requested_prefix.pop("_custom_field_data", {})
+
                     # Remove the allocated prefix from the list of available prefixes
                     available_prefixes.remove(allocated_prefix)
 
@@ -209,8 +228,7 @@ class PrefixViewSet(NautobotModelViewSet):
 
                 # Create the new Prefix(es)
                 serializer.is_valid(raise_exception=True)
-                self.perform_create(serializer)
-
+                serializer.save()
                 return Response(serializer.data, status=status.HTTP_201_CREATED)
 
         else:
@@ -257,7 +275,17 @@ class PrefixViewSet(NautobotModelViewSet):
                 "nautobot.ipam.api.views.available_ips", blocking_timeout=5, timeout=settings.REDIS_LOCK_TIMEOUT
             ):
                 # Normalize to a list of objects
-                requested_ips = request.data if isinstance(request.data, list) else [request.data]
+                serializer = serializers.IPAllocationSerializer(
+                    data=request.data if isinstance(request.data, list) else [request.data],
+                    many=True,
+                    context={
+                        "request": request,
+                        "prefix": prefix,
+                    },
+                )
+                serializer.is_valid(raise_exception=True)
+
+                requested_ips = serializer.validated_data
 
                 # Determine if the requested number of IPs is available
                 available_ips = prefix.get_available_ips()
@@ -278,6 +306,9 @@ class PrefixViewSet(NautobotModelViewSet):
                 for requested_ip in requested_ips:
                     requested_ip["address"] = f"{next(available_ips)}/{prefix_length}"
                     requested_ip["namespace"] = prefix.namespace
+                    # The serializer usage above has mapped "custom_fields" dict to "_custom_field_data".
+                    # We need to convert it back to "custom_fields" as we're going to deserialize it a second time below
+                    requested_ip["custom_fields"] = requested_ip.pop("_custom_field_data", {})
 
                 # Initialize the serializer with a list or a single object depending on what was requested
                 context = {"request": request, "depth": 0}
@@ -288,8 +319,7 @@ class PrefixViewSet(NautobotModelViewSet):
 
                 # Create the new IP address(es)
                 serializer.is_valid(raise_exception=True)
-                self.perform_create(serializer)
-
+                serializer.save()
                 return Response(serializer.data, status=status.HTTP_201_CREATED)
 
         # Determine the maximum number of IPs to return
@@ -324,7 +354,7 @@ class PrefixViewSet(NautobotModelViewSet):
 
 
 class PrefixLocationAssignmentViewSet(NautobotModelViewSet):
-    queryset = PrefixLocationAssignment.objects.all()
+    queryset = PrefixLocationAssignment.objects.select_related("prefix", "location")
     serializer_class = serializers.PrefixLocationAssignmentSerializer
     filterset_class = filters.PrefixLocationAssignmentFilterSet
 
@@ -335,7 +365,13 @@ class PrefixLocationAssignmentViewSet(NautobotModelViewSet):
 
 
 class IPAddressViewSet(NautobotModelViewSet):
-    queryset = IPAddress.objects.select_related("parent__namespace")
+    queryset = IPAddress.objects.select_related(
+        "nat_inside",
+        "parent",
+        "role",
+        "status",
+        "tenant",
+    ).prefetch_related("tags", "nat_outside_list")
     serializer_class = serializers.IPAddressSerializer
     filterset_class = filters.IPAddressFilterSet
 
@@ -346,7 +382,7 @@ class IPAddressViewSet(NautobotModelViewSet):
 
 
 class IPAddressToInterfaceViewSet(NautobotModelViewSet):
-    queryset = IPAddressToInterface.objects.all()
+    queryset = IPAddressToInterface.objects.select_related("interface", "ip_address", "vm_interface")
     serializer_class = serializers.IPAddressToInterfaceSerializer
     filterset_class = filters.IPAddressToInterfaceFilterSet
 
@@ -357,24 +393,29 @@ class IPAddressToInterfaceViewSet(NautobotModelViewSet):
 
 
 class VLANGroupViewSet(NautobotModelViewSet):
-    queryset = VLANGroup.objects.annotate(vlan_count=count_related(VLAN, "vlan_group"))
+    queryset = (
+        VLANGroup.objects.select_related("location")
+        .prefetch_related("tags")
+        .annotate(vlan_count=count_related(VLAN, "vlan_group"))
+    )
     serializer_class = serializers.VLANGroupSerializer
     filterset_class = filters.VLANGroupFilterSet
 
-    @staticmethod
-    def vlan_group_queryset():
-        return (
-            VLANGroup.objects.select_related("location")
-            .prefetch_related("tags")
-            .annotate(vlan_count=count_related(VLAN, "vlan_group"))
-        )
+    def restrict_queryset(self, request, *args, **kwargs):
+        """
+        Apply "view" permissions on the POST /available-vlans/ endpoint, otherwise as ModelViewSetMixin.
+        """
+        if request.user.is_authenticated and self.action == "available_vlans":
+            self.queryset = self.queryset.restrict(request.user, "view")
+        else:
+            super().restrict_queryset(request, *args, **kwargs)
 
     class AvailableVLANPermissions(TokenPermissions):
-        """As nautobot.core.api.authentication.TokenPermissions, but enforcing `add_vlan` and `view_vlan` permission."""
+        """As nautobot.core.api.authentication.TokenPermissions, but enforcing add_vlan permission."""
 
         perms_map = {
-            "GET": ["ipam.view_vlangroup", "ipam.view_vlan"],
-            "POST": ["ipam.view_vlangroup", "ipam.view_vlan", "ipam.add_vlan"],
+            "GET": ["ipam.view_vlangroup"],
+            "POST": ["ipam.view_vlangroup", "ipam.add_vlan"],
         }
 
     @extend_schema(methods=["get"], responses={200: ListSerializer(child=IntegerField())})
@@ -390,7 +431,6 @@ class VLANGroupViewSet(NautobotModelViewSet):
         methods=["get", "post"],
         permission_classes=[AvailableVLANPermissions],
         filterset_class=None,
-        queryset=VLAN.objects.all(),
     )
     def available_vlans(self, request, pk=None):
         """
@@ -398,14 +438,23 @@ class VLANGroupViewSet(NautobotModelViewSet):
         By default, the number of VIDs returned will be equivalent to PAGINATE_COUNT.
         An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.
         """
-        vlan_group = get_object_or_404(self.vlan_group_queryset().restrict(user=request.user), pk=pk)
+        vlan_group = get_object_or_404(self.queryset, pk=pk)
 
         if request.method == "POST":
             with cache.lock(
                 "nautobot.ipam.api.views.available_vlans", blocking_timeout=5, timeout=settings.REDIS_LOCK_TIMEOUT
             ):
                 # Normalize to a list of objects
-                requested_vlans = request.data if isinstance(request.data, list) else [request.data]
+                serializer = serializers.VLANAllocationSerializer(
+                    data=request.data if isinstance(request.data, list) else [request.data],
+                    many=True,
+                    context={
+                        "request": request,
+                        "vlan_group": vlan_group,
+                    },
+                )
+                serializer.is_valid(raise_exception=True)
+                requested_vlans = serializer.validated_data
 
                 # Determine if the requested number of VLANs is available
                 available_vids = vlan_group.available_vids
@@ -441,28 +490,20 @@ class VLANGroupViewSet(NautobotModelViewSet):
                         requested_vlan["vid"] = next(_available_vids)
 
                     # Check requested `vlan_group`
-                    if "vlan_group" in requested_vlan:
-                        requested_vlan_group = None
-                        requested_vlan_group_pk = requested_vlan["vlan_group"]
-                        try:
-                            requested_vlan_group = VLANGroup.objects.get(pk=requested_vlan_group_pk)
-                        except VLANGroup.DoesNotExist:
-                            return Response(
-                                {"detail": f"VLAN Group with pk {requested_vlan_group_pk} does not exist."},
-                                status=status.HTTP_204_NO_CONTENT,
-                            )
-
-                        if requested_vlan_group != vlan_group:
-                            return Response(
-                                {
-                                    "detail": f"Invalid VLAN Group requested: {requested_vlan_group}. "
-                                    f"Only VLAN Group {vlan_group} is permitted."
-                                },
-                                status=status.HTTP_204_NO_CONTENT,
-                            )
+                    if "vlan_group" in requested_vlan and requested_vlan["vlan_group"] != vlan_group:
+                        return Response(
+                            {
+                                "detail": f"Invalid VLAN Group requested: {requested_vlan['vlan_group']}. "
+                                f"Only VLAN Group {vlan_group} is permitted."
+                            },
+                            status=status.HTTP_204_NO_CONTENT,
+                        )
                     else:
                         requested_vlan["vlan_group"] = vlan_group.pk
 
+                    # Rewrite custom field data
+                    requested_vlan["custom_fields"] = requested_vlan.pop("_custom_field_data", {})
+
                 # Initialize the serializer with a list or a single object depending on what was requested
                 context = {"request": request, "depth": 0}
 
@@ -473,7 +514,7 @@ class VLANGroupViewSet(NautobotModelViewSet):
 
                 # Create the new VLANs
                 serializer.is_valid(raise_exception=True)
-                self.perform_create(serializer)
+                serializer.save()
 
                 data = serializer.data
 
@@ -539,7 +580,16 @@ class VLANGroupViewSet(NautobotModelViewSet):
     update=extend_schema(responses={"200": serializers.VLANLegacySerializer}, versions=["2.0", "2.1"]),
 )
 class VLANViewSet(NautobotModelViewSet):
-    queryset = VLAN.objects.annotate(prefix_count=count_related(Prefix, "vlan"))
+    queryset = (
+        VLAN.objects.select_related(
+            "vlan_group",
+            "status",
+            "role",
+            "tenant",
+        )
+        .prefetch_related("tags")
+        .annotate(prefix_count=count_related(Prefix, "vlan"))
+    )
     serializer_class = serializers.VLANSerializer
     filterset_class = filters.VLANFilterSet
 
@@ -554,7 +604,6 @@ class VLANViewSet(NautobotModelViewSet):
     def get_serializer_class(self):
         if (
             not getattr(self, "swagger_fake_view", False)
-            and hasattr(self.request, "major_version")
             and self.request.major_version == 2
             and self.request.minor_version < 2
         ):
@@ -562,15 +611,15 @@ class VLANViewSet(NautobotModelViewSet):
             return serializers.VLANLegacySerializer
         return super().get_serializer_class()
 
-    def retrieve(self, request, *args, pk=None, **kwargs):
+    def retrieve(self, request, pk=None):
         try:
-            return super().retrieve(request, *args, pk=pk, **kwargs)
+            return super().retrieve(request, pk)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
-    def list(self, request, *args, **kwargs):
+    def list(self, request):
         try:
-            return super().list(request, *args, **kwargs)
+            return super().list(request)
         except Location.MultipleObjectsReturned as e:
             raise self.LocationIncompatibleLegacyBehavior from e
 
@@ -582,7 +631,7 @@ class VLANViewSet(NautobotModelViewSet):
 
 
 class VLANLocationAssignmentViewSet(NautobotModelViewSet):
-    queryset = VLANLocationAssignment.objects.all()
+    queryset = VLANLocationAssignment.objects.select_related("vlan", "location")
     serializer_class = serializers.VLANLocationAssignmentSerializer
     filterset_class = filters.VLANLocationAssignmentFilterSet
 
@@ -593,6 +642,6 @@ class VLANLocationAssignmentViewSet(NautobotModelViewSet):
 
 
 class ServiceViewSet(NautobotModelViewSet):
-    queryset = Service.objects.all()
+    queryset = Service.objects.select_related("device", "virtual_machine").prefetch_related("tags", "ip_addresses")
     serializer_class = serializers.ServiceSerializer
     filterset_class = filters.ServiceFilterSet

nautobot/ipam/factory.py

@@ -410,7 +410,7 @@ class PrefixFactory(PrimaryModelFactory):
             # Calculate prefix length for child prefixes to allow them to fit in the parent prefix without creating duplicate prefix
             child_cidr = self.prefix_length + max(1, math.ceil(math.log(child_count, 2)))
             # Raise exception for invalid cidr length (>128 for ipv6, >32 for ipv4)
-            if child_cidr > 128 or (self.ip_version == 4 and child_cidr > 32):
+            if child_cidr > 128 or self.ip_version == 4 and child_cidr > 32:
                 raise ValueError(f"Unable to create {child_count} child prefixes in container prefix {self.cidr_str}.")
 
             weights = [1, 6, 3]  # prefer network and pool prefixes

nautobot/ipam/filters.py

@@ -1,5 +1,4 @@
 import contextlib
-import uuid
 
 from django.core.exceptions import ValidationError
 from django.db.models import Q
@@ -324,7 +323,7 @@ class PrefixFilterSet(
         return prefixes_queryset
 
     def generate_query_filter_present_in_vrf(self, value):
-        if isinstance(value, (str, uuid.UUID)):
+        if isinstance(value, str):
             value = VRF.objects.get(pk=value)
 
         query = Q(vrfs=value) | Q(vrfs__export_targets__in=value.import_targets.all())
@@ -486,7 +485,7 @@ class IPAddressFilterSet(
             return queryset.none()
 
     def generate_query_filter_present_in_vrf(self, value):
-        if isinstance(value, (str, uuid.UUID)):
+        if isinstance(value, str):
             value = VRF.objects.get(pk=value)
 
         query = Q(parent__vrfs=value) | Q(parent__vrfs__export_targets__in=value.import_targets.all())