nautobot 2.0.0a2__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/ipam/api/serializers.py

@@ -5,22 +5,15 @@ from rest_framework.validators import UniqueTogetherValidator
 
 from nautobot.core.api import (
     ChoiceField,
-    SerializedPKRelatedField,
-)
-from nautobot.dcim.api.nested_serializers import (
-    NestedDeviceSerializer,
-    NestedLocationSerializer,
-)
-from nautobot.extras.api.serializers import (
     NautobotModelSerializer,
-    RoleModelSerializerMixin,
-    StatusModelSerializerMixin,
-    TaggedModelSerializerMixin,
 )
-from nautobot.ipam.choices import IPAddressFamilyChoices, PrefixTypeChoices, ServiceProtocolChoices
+from nautobot.extras.api.mixins import TaggedModelSerializerMixin
+from nautobot.ipam.api.fields import IPFieldSerializer
+from nautobot.ipam.choices import PrefixTypeChoices, ServiceProtocolChoices
 from nautobot.ipam import constants
 from nautobot.ipam.models import (
     IPAddress,
+    Namespace,
     Prefix,
     RIR,
     RouteTarget,
@@ -29,24 +22,20 @@ from nautobot.ipam.models import (
     VLANGroup,
     VRF,
 )
-from nautobot.tenancy.api.nested_serializers import NestedTenantSerializer
-from nautobot.virtualization.api.nested_serializers import (
-    NestedVirtualMachineSerializer,
-)
 
-# Not all of these variable(s) are actually used anywhere in this file, but are required for the
-# automagically replacing a Serializer with its corresponding NestedSerializer.
-from .nested_serializers import (  # noqa: F401
-    IPFieldSerializer,
-    NestedIPAddressSerializer,
-    NestedPrefixSerializer,
-    NestedRIRSerializer,
-    NestedRouteTargetSerializer,
-    NestedServiceSerializer,
-    NestedVLANGroupSerializer,
-    NestedVLANSerializer,
-    NestedVRFSerializer,
-)
+
+#
+# Namespaces
+#
+
+
+class NamespaceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:namespace-detail")
+
+    class Meta:
+        model = Namespace
+        fields = ["url", "name", "description", "location"]
+
 
 #
 # VRFs
@@ -54,37 +43,13 @@ from .nested_serializers import (  # noqa: F401
 
 
 class VRFSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vrf-detail")
-    tenant = NestedTenantSerializer(required=False, allow_null=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)
 
     class Meta:
         model = VRF
-        fields = [
-            "url",
-            "name",
-            "rd",
-            "tenant",
-            "enforce_unique",
-            "description",
-            "import_targets",
-            "export_targets",
-            "ipaddress_count",
-            "prefix_count",
-        ]
+        fields = "__all__"
+        list_display_fields = ["name", "rd", "tenant", "description"]
 
 
 #
@@ -93,17 +58,10 @@ class VRFSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
 
 
 class RouteTargetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:routetarget-detail")
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-
     class Meta:
         model = RouteTarget
-        fields = [
-            "url",
-            "name",
-            "tenant",
-            "description",
-        ]
+        fields = "__all__"
+        list_display_fields = ["name", "tenant", "description"]
 
 
 #
@@ -112,18 +70,16 @@ class RouteTargetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin)
 
 
 class RIRSerializer(NautobotModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:rir-detail")
     assigned_prefix_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = RIR
-        fields = [
-            "url",
+        fields = "__all__"
+        list_display_fields = [
             "name",
-            "slug",
             "is_private",
-            "description",
             "assigned_prefix_count",
+            "description",
         ]
 
 
@@ -133,25 +89,16 @@ class RIRSerializer(NautobotModelSerializer):
 
 
 class VLANGroupSerializer(NautobotModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vlangroup-detail")
-    location = NestedLocationSerializer(required=False, allow_null=True)
     vlan_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = VLANGroup
-        fields = [
-            "url",
-            "name",
-            "slug",
-            "location",
-            "description",
-            "vlan_count",
-        ]
+        fields = "__all__"
+        list_display_fields = ["name", "location", "vlan_count", "description"]
         # 2.0 TODO: Remove if/when slug is globally unique. This would be a breaking change.
         validators = []
 
     def validate(self, data):
-
         # Validate uniqueness of name and slug if a location has been assigned.
         # 2.0 TODO: Remove if/when slug is globally unique. This would be a breaking change.
         if data.get("location", None):
@@ -165,33 +112,28 @@ class VLANGroupSerializer(NautobotModelSerializer):
         return data
 
 
-class VLANSerializer(
-    NautobotModelSerializer, TaggedModelSerializerMixin, StatusModelSerializerMixin, RoleModelSerializerMixin
-):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vlan-detail")
-    location = NestedLocationSerializer(required=False, allow_null=True)
-    vlan_group = NestedVLANGroupSerializer(required=False, allow_null=True)
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
+class VLANSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     prefix_count = serializers.IntegerField(read_only=True)
 
     class Meta:
         model = VLAN
-        fields = [
-            "url",
+        # TODO(jathan): These were taken from VLANDetailTable and not VLANTable. Let's make sure
+        # these are correct.
+        fields = "__all__"
+        list_display_fields = [
+            "vid",
             "location",
             "vlan_group",
-            "vid",
             "name",
+            "prefixes",
             "tenant",
             "status",
             "role",
             "description",
-            "prefix_count",
         ]
         validators = []
 
     def validate(self, data):
-
         # Validate uniqueness of vid and name if a group has been assigned.
         if data.get("vlan_group", None):
             for field in ["vid", "name"]:
@@ -209,41 +151,31 @@ class VLANSerializer(
 #
 
 
-class PrefixSerializer(
-    NautobotModelSerializer, TaggedModelSerializerMixin, StatusModelSerializerMixin, RoleModelSerializerMixin
-):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:prefix-detail")
-    family = ChoiceField(choices=IPAddressFamilyChoices, read_only=True)
+class PrefixSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     prefix = IPFieldSerializer()
     type = ChoiceField(choices=PrefixTypeChoices, default=PrefixTypeChoices.TYPE_NETWORK)
-    location = NestedLocationSerializer(required=False, allow_null=True)
-    vrf = NestedVRFSerializer(required=False, allow_null=True)
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-    vlan = NestedVLANSerializer(required=False, allow_null=True)
-    rir = NestedRIRSerializer(required=False, allow_null=True)
 
     class Meta:
         model = Prefix
-        fields = [
-            "url",
-            "family",
+        fields = "__all__"
+        list_display_fields = [
             "prefix",
             "type",
-            "location",
+            "status",
             "vrf",
             "tenant",
+            "location",
             "vlan",
-            "status",
             "role",
-            "rir",
-            "date_allocated",
             "description",
         ]
-        read_only_fields = ["family"]
+        extra_kwargs = {
+            "ip_version": {"read_only": True},
+            "prefix_length": {"read_only": True},
+        }
 
 
 class PrefixLengthSerializer(serializers.Serializer):
-
     prefix_length = serializers.IntegerField()
 
     def to_internal_value(self, data):
@@ -254,9 +186,9 @@ class PrefixLengthSerializer(serializers.Serializer):
             raise serializers.ValidationError({"prefix_length": "this field must be int type"})
 
         prefix = self.context.get("prefix")
-        if prefix.family == 4 and requested_prefix > 32:
+        if prefix.ip_version == 4 and requested_prefix > 32:
             raise serializers.ValidationError({"prefix_length": f"Invalid prefix length ({requested_prefix}) for IPv4"})
-        elif prefix.family == 6 and requested_prefix > 128:
+        elif prefix.ip_version == 6 and requested_prefix > 128:
             raise serializers.ValidationError({"prefix_length": f"Invalid prefix length ({requested_prefix}) for IPv6"})
         return data
 
@@ -266,20 +198,15 @@ class AvailablePrefixSerializer(serializers.Serializer):
     Representation of a prefix which does not exist in the database.
     """
 
-    family = serializers.IntegerField(read_only=True)
+    ip_version = serializers.IntegerField(read_only=True)
     prefix = serializers.CharField(read_only=True)
-    vrf = NestedVRFSerializer(read_only=True)
 
     def to_representation(self, instance):
-        if self.context.get("vrf"):
-            vrf = NestedVRFSerializer(self.context["vrf"], context={"request": self.context["request"]}).data
-        else:
-            vrf = None
         return OrderedDict(
             [
-                ("family", instance.version),
+                ("ip_version", instance.version),
                 ("prefix", str(instance)),
-                ("vrf", vrf),
+                ("namepace", instance.namespace),
             ]
         )
 
@@ -289,33 +216,32 @@ class AvailablePrefixSerializer(serializers.Serializer):
 #
 
 
-class IPAddressSerializer(
-    NautobotModelSerializer, TaggedModelSerializerMixin, StatusModelSerializerMixin, RoleModelSerializerMixin
-):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:ipaddress-detail")
-    family = ChoiceField(choices=IPAddressFamilyChoices, read_only=True)
+class IPAddressSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
     address = IPFieldSerializer()
-    vrf = NestedVRFSerializer(required=False, allow_null=True)
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-    nat_inside = NestedIPAddressSerializer(required=False, allow_null=True)
-    nat_outside = NestedIPAddressSerializer(read_only=True, many=True, source="nat_outside_list")
 
     class Meta:
         model = IPAddress
-        fields = [
-            "url",
-            "family",
+        fields = "__all__"
+        list_display_fields = [
             "address",
             "vrf",
-            "tenant",
             "status",
             "role",
-            "nat_inside",
-            "nat_outside",
+            "tenant",
             "dns_name",
             "description",
         ]
-        read_only_fields = ["family"]
+        extra_kwargs = {
+            "ip_version": {"read_only": True},
+            "mask_length": {"read_only": True},
+            "nat_outside_list": {"read_only": True},
+        }
+
+    def get_field_names(self, declared_fields, info):
+        """Add nat_outside_list reverse relation to the automatically discovered fields."""
+        fields = list(super().get_field_names(declared_fields, info))
+        self.extend_field_names(fields, "nat_outside_list")
+        return fields
 
 
 class AvailableIPSerializer(serializers.Serializer):
@@ -323,20 +249,15 @@ class AvailableIPSerializer(serializers.Serializer):
     Representation of an IP address which does not exist in the database.
     """
 
-    family = serializers.IntegerField(read_only=True)
+    ip_version = serializers.IntegerField(read_only=True)
     address = serializers.CharField(read_only=True)
-    vrf = NestedVRFSerializer(read_only=True)
 
     def to_representation(self, instance):
-        if self.context.get("vrf"):
-            vrf = NestedVRFSerializer(self.context["vrf"], context={"request": self.context["request"]}).data
-        else:
-            vrf = None
         return OrderedDict(
             [
-                ("family", self.context["prefix"].version),
+                ("ip_verison", self.context["prefix"].version),
                 ("address", f"{instance}/{self.context['prefix'].prefixlen}"),
-                ("vrf", vrf),
+                ("namespace", instance.namespace),
             ]
         )
 
@@ -347,32 +268,24 @@ class AvailableIPSerializer(serializers.Serializer):
 
 
 class ServiceSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:service-detail")
-    device = NestedDeviceSerializer(required=False, allow_null=True)
-    virtual_machine = NestedVirtualMachineSerializer(required=False, allow_null=True)
+    # TODO #3024 make a backlog item to rip out the choice field.
     protocol = ChoiceField(choices=ServiceProtocolChoices, required=False)
-    ip_addresses = SerializedPKRelatedField(
-        queryset=IPAddress.objects.all(),
-        serializer=NestedIPAddressSerializer,
-        required=False,
-        many=True,
-    )
     ports = serializers.ListField(
         child=serializers.IntegerField(
             min_value=constants.SERVICE_PORT_MIN,
             max_value=constants.SERVICE_PORT_MAX,
-        )
+        ),
     )
 
     class Meta:
         model = Service
-        fields = [
-            "url",
-            "device",
-            "virtual_machine",
-            "name",
-            "ports",
-            "protocol",
-            "ip_addresses",
-            "description",
-        ]
+        fields = "__all__"
+        extra_kwargs = {
+            "device": {"help_text": "Required if no virtual_machine is specified"},
+            "virtual_machine": {"help_text": "Required if no device is specified"},
+        }
+        # TODO(jathan): We need to account for the "parent" field from the `ServiceTable` which is
+        # an either/or column for `device` or `virtual_machine`. For now it's hard-coded to
+        # `device`.
+        # list_display_fields = ["name", "parent", "protocol", "ports", "description"]
+        list_display_fields = ["name", "device", "protocol", "ports", "description"]

nautobot/ipam/api/urls.py

@@ -1,10 +1,13 @@
-from nautobot.core.api import OrderedDefaultRouter
+from nautobot.core.api.routers import OrderedDefaultRouter
 from . import views
 
 
 router = OrderedDefaultRouter()
 router.APIRootView = views.IPAMRootView
 
+# Namespaces
+router.register("namespaces", views.NamespaceViewSet)
+
 # VRFs
 router.register("vrfs", views.VRFViewSet)
 

nautobot/ipam/api/views.py

@@ -13,6 +13,7 @@ from nautobot.extras.api.views import NautobotModelViewSet
 from nautobot.ipam import filters
 from nautobot.ipam.models import (
     IPAddress,
+    Namespace,
     Prefix,
     RIR,
     RouteTarget,
@@ -33,6 +34,17 @@ class IPAMRootView(APIRootView):
         return "IPAM"
 
 
+#
+# Namespace
+#
+
+
+class NamespaceViewSet(NautobotModelViewSet):
+    queryset = Namespace.objects.all()
+    serializer_class = serializers.NamespaceSerializer
+    filterset_class = filters.NamespaceFilterSet
+
+
 #
 # VRFs
 #
@@ -40,12 +52,12 @@ class IPAMRootView(APIRootView):
 
 class VRFViewSet(NautobotModelViewSet):
     queryset = (
-        VRF.objects.select_related("tenant")
-        .prefetch_related("import_targets", "export_targets", "tags")
-        .annotate(
-            ipaddress_count=count_related(IPAddress, "vrf"),
-            prefix_count=count_related(Prefix, "vrf"),
-        )
+        VRF.objects.select_related("tenant").prefetch_related("import_targets", "export_targets", "tags")
+        # FIXME(jathan): See if we need to revise the counts for prefixes/ips, here?
+        # .annotate(
+        #     ipaddress_count=count_related(IPAddress, "vrf"),
+        #     prefix_count=count_related(Prefix, "vrf"),
+        # )
     )
     serializer_class = serializers.VRFSerializer
     filterset_class = filters.VRFFilterSet
@@ -82,9 +94,10 @@ class PrefixViewSet(NautobotModelViewSet):
     queryset = Prefix.objects.select_related(
         "role",
         "status",
+        "location",
         "tenant",
         "vlan",
-        "vrf__tenant",
+        "namespace",
     ).prefetch_related("tags")
     serializer_class = serializers.PrefixSerializer
     filterset_class = filters.PrefixFilterSet
@@ -106,7 +119,6 @@ class PrefixViewSet(NautobotModelViewSet):
         """
         prefix = get_object_or_404(self.queryset, pk=pk)
         if request.method == "POST":
-
             with cache.lock("available-prefixes", blocking_timeout=5, timeout=settings.REDIS_LOCK_TIMEOUT):
                 available_prefixes = prefix.get_available_prefixes()
 
@@ -124,13 +136,12 @@ class PrefixViewSet(NautobotModelViewSet):
                 requested_prefixes = serializer.validated_data
                 # Allocate prefixes to the requested objects based on availability within the parent
                 for requested_prefix in requested_prefixes:
-
                     # 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']}"
                             requested_prefix["prefix"] = allocated_prefix
-                            requested_prefix["vrf"] = prefix.vrf.pk if prefix.vrf else None
+                            requested_prefix["namespace"] = prefix.namespace.pk
                             break
                     else:
                         return Response(
@@ -142,7 +153,7 @@ class PrefixViewSet(NautobotModelViewSet):
                     available_prefixes.remove(allocated_prefix)
 
                 # Initialize the serializer with a list or a single object depending on what was requested
-                context = {"request": request}
+                context = {"request": request, "depth": 0}
                 if isinstance(request.data, list):
                     serializer = serializers.PrefixSerializer(data=requested_prefixes, many=True, context=context)
                 else:
@@ -160,7 +171,7 @@ class PrefixViewSet(NautobotModelViewSet):
                 many=True,
                 context={
                     "request": request,
-                    "vrf": prefix.vrf,
+                    "namespace": prefix.namespace,
                 },
             )
 
@@ -192,9 +203,7 @@ class PrefixViewSet(NautobotModelViewSet):
 
         # Create the next available IP within the prefix
         if request.method == "POST":
-
             with cache.lock("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]
 
@@ -211,15 +220,15 @@ class PrefixViewSet(NautobotModelViewSet):
                         status=status.HTTP_204_NO_CONTENT,
                     )
 
-                # Assign addresses from the list of available IPs and copy VRF assignment from the parent prefix
+                # Assign addresses from the list of available IPs and copy Namespace assignment from the parent Prefix
                 available_ips = iter(available_ips)
                 prefix_length = prefix.prefix.prefixlen
                 for requested_ip in requested_ips:
                     requested_ip["address"] = f"{next(available_ips)}/{prefix_length}"
-                    requested_ip["vrf"] = prefix.vrf.pk if prefix.vrf else None
+                    requested_ip["namespace"] = prefix.namespace.pk
 
                 # Initialize the serializer with a list or a single object depending on what was requested
-                context = {"request": request}
+                context = {"request": request, "depth": 0}
                 if isinstance(request.data, list):
                     serializer = serializers.IPAddressSerializer(data=requested_ips, many=True, context=context)
                 else:
@@ -251,7 +260,7 @@ class PrefixViewSet(NautobotModelViewSet):
                 context={
                     "request": request,
                     "prefix": prefix.prefix,
-                    "vrf": prefix.vrf,
+                    "namespace": prefix.namespace,
                 },
             )
 
@@ -265,11 +274,11 @@ class PrefixViewSet(NautobotModelViewSet):
 
 class IPAddressViewSet(NautobotModelViewSet):
     queryset = IPAddress.objects.select_related(
+        "parent",
         "nat_inside",
         "status",
         "role",
         "tenant",
-        "vrf__tenant",
     ).prefetch_related("tags", "nat_outside_list")
     serializer_class = serializers.IPAddressSerializer
     filterset_class = filters.IPAddressFilterSet

nautobot/ipam/apps.py

@@ -16,6 +16,7 @@ class IPAMConfig(NautobotConfig):
 
         from graphene_django.converter import convert_django_field, convert_field_to_string
         from nautobot.ipam.fields import VarbinaryIPField
+        import nautobot.ipam.signals  # noqa: F401
 
         # Register VarbinaryIPField to be converted to a string type
         convert_django_field.register(VarbinaryIPField)(convert_field_to_string)

nautobot/ipam/choices.py

@@ -1,14 +1,13 @@
 from nautobot.core.choices import ChoiceSet
 
 
-class IPAddressFamilyChoices(ChoiceSet):
-
-    FAMILY_4 = 4
-    FAMILY_6 = 6
+class IPAddressVersionChoices(ChoiceSet):
+    VERSION_4 = 4
+    VERSION_6 = 6
 
     CHOICES = (
-        (FAMILY_4, "IPv4"),
-        (FAMILY_6, "IPv6"),
+        (VERSION_4, "IPv4"),
+        (VERSION_6, "IPv6"),
     )
 
 
@@ -18,7 +17,6 @@ class IPAddressFamilyChoices(ChoiceSet):
 
 
 class PrefixStatusChoices(ChoiceSet):
-
     STATUS_ACTIVE = "active"
     STATUS_RESERVED = "reserved"
     STATUS_DEPRECATED = "deprecated"
@@ -31,7 +29,6 @@ class PrefixStatusChoices(ChoiceSet):
 
 
 class PrefixTypeChoices(ChoiceSet):
-
     TYPE_CONTAINER = "container"
     TYPE_NETWORK = "network"
     TYPE_POOL = "pool"
@@ -49,7 +46,6 @@ class PrefixTypeChoices(ChoiceSet):
 
 
 class IPAddressStatusChoices(ChoiceSet):
-
     STATUS_ACTIVE = "active"
     STATUS_RESERVED = "reserved"
     STATUS_DEPRECATED = "deprecated"
@@ -66,7 +62,6 @@ class IPAddressStatusChoices(ChoiceSet):
 
 
 class IPAddressRoleChoices(ChoiceSet):
-
     ROLE_LOOPBACK = "loopback"
     ROLE_SECONDARY = "secondary"
     ROLE_ANYCAST = "anycast"
@@ -105,7 +100,6 @@ class IPAddressRoleChoices(ChoiceSet):
 
 
 class VLANStatusChoices(ChoiceSet):
-
     STATUS_ACTIVE = "active"
     STATUS_RESERVED = "reserved"
     STATUS_DEPRECATED = "deprecated"
@@ -123,7 +117,6 @@ class VLANStatusChoices(ChoiceSet):
 
 
 class ServiceProtocolChoices(ChoiceSet):
-
     PROTOCOL_TCP = "tcp"
     PROTOCOL_UDP = "udp"
 

nautobot/ipam/constants.py

@@ -33,6 +33,7 @@ PREFIX_LENGTH_MAX = 127  # IPv6
 IPADDRESS_MASK_LENGTH_MIN = 1
 IPADDRESS_MASK_LENGTH_MAX = 128  # IPv6
 
+# TODO(jathan); Rip this out when we get to the IPAddress.parent work.
 IPADDRESS_ROLES_NONUNIQUE = (
     # IPAddress roles which are exempt from unique address enforcement
     IPAddressRoleChoices.ROLE_ANYCAST,