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

nautobot/dcim/models/device_components.py

@@ -4,7 +4,7 @@ from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models, transaction
 from django.db.models import Sum
-from django.urls import reverse
+from django.utils.functional import classproperty
 
 from nautobot.core.models.fields import ForeignKeyWithAutoRelatedName, MACAddressCharField, NaturalOrderingField
 from nautobot.core.models.generics import PrimaryModel
@@ -30,11 +30,10 @@ from nautobot.dcim.constants import (
     VIRTUAL_IFACE_TYPES,
     WIRELESS_IFACE_TYPES,
 )
-
 from nautobot.extras.models import (
     RelationshipModel,
     Status,
-    StatusModel,
+    StatusField,
 )
 from nautobot.extras.utils import extras_features
 
@@ -216,24 +215,10 @@ class ConsolePort(CableTermination, PathEndpoint, ComponentModel):
         help_text="Physical port type",
     )
 
-    csv_headers = ["device", "name", "label", "type", "description"]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:consoleport", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.type,
-            self.description,
-        )
-
     @property
     def parent(self):
         return self.device
@@ -257,24 +242,10 @@ class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel):
         help_text="Physical port type",
     )
 
-    csv_headers = ["device", "name", "label", "type", "description"]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:consoleserverport", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.type,
-            self.description,
-        )
-
     @property
     def parent(self):
         return self.device
@@ -316,34 +287,10 @@ class PowerPort(CableTermination, PathEndpoint, ComponentModel):
         help_text="Allocated power draw (watts)",
     )
 
-    csv_headers = [
-        "device",
-        "name",
-        "label",
-        "type",
-        "maximum_draw",
-        "allocated_draw",
-        "description",
-    ]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:powerport", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.get_type_display(),
-            self.maximum_draw,
-            self.allocated_draw,
-            self.description,
-        )
-
     @property
     def parent(self):
         return self.device
@@ -453,34 +400,10 @@ class PowerOutlet(CableTermination, PathEndpoint, ComponentModel):
         help_text="Phase (for three-phase feeds)",
     )
 
-    csv_headers = [
-        "device",
-        "name",
-        "label",
-        "type",
-        "power_port",
-        "feed_leg",
-        "description",
-    ]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:poweroutlet", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.get_type_display(),
-            self.power_port.name if self.power_port else None,
-            self.get_feed_leg_display(),
-            self.description,
-        )
-
     @property
     def parent(self):
         return self.device
@@ -498,11 +421,12 @@ class PowerOutlet(CableTermination, PathEndpoint, ComponentModel):
 #
 
 
-class BaseInterface(RelationshipModel, StatusModel):
+class BaseInterface(RelationshipModel):
     """
     Abstract base class for fields shared by dcim.Interface and virtualization.VMInterface.
     """
 
+    status = StatusField(blank=False, null=False)
     enabled = models.BooleanField(default=True)
     mac_address = MACAddressCharField(blank=True, default="", verbose_name="MAC Address")
     mtu = models.PositiveIntegerField(
@@ -619,48 +543,10 @@ class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface):
         verbose_name="IP Addresses",
     )
 
-    csv_headers = [
-        "device",
-        "name",
-        "label",
-        "lag",
-        "type",
-        "enabled",
-        "mac_address",
-        "mtu",
-        "mgmt_only",
-        "description",
-        "mode",
-        "status",
-        "parent_interface",
-        "bridge",
-    ]
-
     class Meta:
         ordering = ("device", CollateAsChar("_name"))
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:interface", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier if self.device else None,
-            self.name,
-            self.label,
-            self.lag.name if self.lag else None,
-            self.get_type_display(),
-            self.enabled,
-            self.mac_address,
-            self.mtu,
-            str(self.mgmt_only),
-            self.description,
-            self.get_mode_display(),
-            self.get_status_display(),
-            self.parent_interface.name if self.parent_interface else None,
-            self.bridge.name if self.bridge else None,
-        )
-
     def clean(self):
         super().clean()
 
@@ -891,16 +777,6 @@ class FrontPort(CableTermination, ComponentModel):
         ],
     )
 
-    csv_headers = [
-        "device",
-        "name",
-        "label",
-        "type",
-        "rear_port",
-        "rear_port_position",
-        "description",
-    ]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = (
@@ -908,20 +784,6 @@ class FrontPort(CableTermination, ComponentModel):
             ("rear_port", "rear_port_position"),
         )
 
-    def get_absolute_url(self):
-        return reverse("dcim:frontport", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.get_type_display(),
-            self.rear_port.name,
-            self.rear_port_position,
-            self.description,
-        )
-
     @property
     def parent(self):
         return self.device
@@ -958,15 +820,10 @@ class RearPort(CableTermination, ComponentModel):
         ],
     )
 
-    csv_headers = ["device", "name", "label", "type", "positions", "description"]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:rearport", kwargs={"pk": self.pk})
-
     def clean(self):
         super().clean()
 
@@ -980,16 +837,6 @@ class RearPort(CableTermination, ComponentModel):
                 }
             )
 
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.get_type_display(),
-            self.positions,
-            self.description,
-        )
-
     @property
     def parent(self):
         return self.device
@@ -1014,24 +861,10 @@ class DeviceBay(ComponentModel):
         null=True,
     )
 
-    csv_headers = ["device", "name", "label", "installed_device", "description"]
-
     class Meta:
         ordering = ("device", "_name")
         unique_together = ("device", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:devicebay", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.identifier,
-            self.name,
-            self.label,
-            self.installed_device.identifier if self.installed_device else None,
-            self.description,
-        )
-
     def clean(self):
         super().clean()
 
@@ -1099,34 +932,15 @@ class InventoryItem(TreeModel, ComponentModel):
     )
     discovered = models.BooleanField(default=False, help_text="This item was automatically discovered")
 
-    csv_headers = [
-        "device",
-        "name",
-        "label",
-        "manufacturer",
-        "part_id",
-        "serial",
-        "asset_tag",
-        "discovered",
-        "description",
-    ]
-
     class Meta:
         ordering = ("_name",)
         unique_together = ("device", "parent", "name")
 
-    def get_absolute_url(self):
-        return reverse("dcim:inventoryitem", kwargs={"pk": self.pk})
-
-    def to_csv(self):
-        return (
-            self.device.name or f"{{{self.device.pk}}}",
-            self.name,
-            self.label,
-            self.manufacturer.name if self.manufacturer else None,
-            self.part_id,
-            self.serial,
-            self.asset_tag,
-            str(self.discovered),
-            self.description,
-        )
+    @classproperty  # https://github.com/PyCQA/pylint-django/issues/240
+    def natural_key_field_lookups(cls):  # pylint: disable=no-self-argument
+        """
+        Due to the recursive nature of InventoryItem.unique_together, we need a custom implementation of this property.
+
+        For the time being we just use the PK as a natural key.
+        """
+        return ["pk"]

nautobot/dcim/models/devices.py

@@ -16,7 +16,7 @@ from nautobot.core.models.fields import AutoSlugField, NaturalOrderingField
 from nautobot.core.models.generics import OrganizationalModel, PrimaryModel
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.dcim.choices import DeviceFaceChoices, DeviceRedundancyGroupFailoverStrategyChoices, SubdeviceRoleChoices
-from nautobot.extras.models import ConfigContextModel, RoleRequiredRoleModelMixin, StatusModel
+from nautobot.extras.models import ConfigContextModel, RoleField, StatusField
 from nautobot.extras.querysets import ConfigContextModelQuerySet
 from nautobot.extras.utils import extras_features
 from .device_components import (
@@ -60,20 +60,12 @@ class Manufacturer(OrganizationalModel):
     name = models.CharField(max_length=100, unique=True)
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = ["name", "description"]
-
     class Meta:
         ordering = ["name"]
 
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("dcim:manufacturer", args=[self.pk])
-
-    def to_csv(self):
-        return (self.name, self.description)
-
 
 @extras_features(
     "custom_links",
@@ -152,9 +144,6 @@ class DeviceType(PrimaryModel):
         self._original_front_image = self.front_image if self.present_in_database else None
         self._original_rear_image = self.rear_image if self.present_in_database else None
 
-    def get_absolute_url(self):
-        return reverse("dcim:devicetype", args=[self.pk])
-
     def to_yaml(self):
         data = OrderedDict(
             (
@@ -356,32 +345,12 @@ class Platform(OrganizationalModel):
     )
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = [
-        "name",
-        "manufacturer",
-        "napalm_driver",
-        "napalm_args",
-        "description",
-    ]
-
     class Meta:
         ordering = ["name"]
 
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("dcim:platform", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            self.manufacturer.name if self.manufacturer else None,
-            self.napalm_driver,
-            self.napalm_args,
-            self.description,
-        )
-
 
 @extras_features(
     "custom_links",
@@ -393,7 +362,7 @@ class Platform(OrganizationalModel):
     "statuses",
     "webhooks",
 )
-class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleModelMixin):
+class Device(PrimaryModel, ConfigContextModel):
     """
     A Device represents a piece of physical hardware. Each Device is assigned a DeviceType,
     Role, and (optionally) a Platform. Device names are not required, however if one is set it must be unique.
@@ -408,6 +377,8 @@ class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleMode
     """
 
     device_type = models.ForeignKey(to="dcim.DeviceType", on_delete=models.PROTECT, related_name="devices")
+    status = StatusField(blank=False, null=False)
+    role = RoleField(blank=False, null=False)
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -517,27 +488,6 @@ class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleMode
 
     objects = BaseManager.from_queryset(ConfigContextModelQuerySet)()
 
-    csv_headers = [
-        "name",
-        "role",
-        "tenant",
-        "manufacturer",
-        "device_type",
-        "platform",
-        "serial",
-        "asset_tag",
-        "status",
-        "location",
-        "rack_group",
-        "rack_name",
-        "position",
-        "face",
-        "device_redundancy_group",
-        "device_redundancy_group_priority",
-        "secrets_group",
-        "primary_ip",
-        "comments",
-    ]
     clone_fields = [
         "device_type",
         "role",
@@ -550,6 +500,8 @@ class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleMode
         "secrets_group",
     ]
 
+    natural_key_field_names = ["name", "tenant", "location"]  # location should be last since it's variadic
+
     class Meta:
         ordering = ("_name",)  # Name may be null
         unique_together = (
@@ -561,9 +513,6 @@ class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleMode
     def __str__(self):
         return self.display or super().__str__()
 
-    def get_absolute_url(self):
-        return reverse("dcim:device", args=[self.pk])
-
     def validate_unique(self, exclude=None):
         # Check for a duplicate name on a device assigned to the same Location and no Tenant. This is necessary
         # because Django does not consider two NULL fields to be equal, and thus will not trigger a violation
@@ -661,42 +610,28 @@ class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleMode
 
         # Validate primary IP addresses
         vc_interfaces = self.vc_interfaces.all()
-        if self.primary_ip4:
-            if self.primary_ip4.ip_version != 4:
-                raise ValidationError({"primary_ip4": f"{self.primary_ip4} is not an IPv4 address."})
-            if ipam_models.IPAddressToInterface.objects.filter(
-                ip_address=self.primary_ip4, interface__in=vc_interfaces
-            ).exists():
-                pass
-            elif (
-                self.primary_ip4.nat_inside is not None
-                and ipam_models.IPAddressToInterface.objects.filter(
-                    ip_address=self.primary_ip4.nat_inside, interface__in=vc_interfaces
-                ).exists()
-            ):
-                pass
-            else:
-                raise ValidationError(
-                    {"primary_ip4": f"The specified IP address ({self.primary_ip4}) is not assigned to this device."}
-                )
-        if self.primary_ip6:
-            if self.primary_ip6.ip_version != 6:
-                raise ValidationError({"primary_ip6": f"{self.primary_ip6} is not an IPv6 address."})
-            if ipam_models.IPAddressToInterface.objects.filter(
-                ip_address=self.primary_ip6, interface__in=vc_interfaces
-            ).exists():
-                pass
-            elif (
-                self.primary_ip6.nat_inside is not None
-                and ipam_models.IPAddressToInterface.objects.filter(
-                    ip_address=self.primary_ip6.nat_inside, interface__in=vc_interfaces
-                ).exists()
-            ):
-                pass
-            else:
-                raise ValidationError(
-                    {"primary_ip6": f"The specified IP address ({self.primary_ip6}) is not assigned to this device."}
-                )
+        for field in ["primary_ip4", "primary_ip6"]:
+            ip = getattr(self, field)
+            if ip is not None:
+                if field == "primary_ip4":
+                    if ip.ip_version != 4:
+                        raise ValidationError({f"{field}": f"{ip} is not an IPv4 address."})
+                else:
+                    if ip.ip_version != 6:
+                        raise ValidationError({f"{field}": f"{ip} is not an IPv6 address."})
+                if ipam_models.IPAddressToInterface.objects.filter(ip_address=ip, interface__in=vc_interfaces).exists():
+                    pass
+                elif (
+                    ip.nat_inside is not None
+                    and ipam_models.IPAddressToInterface.objects.filter(
+                        ip_address=ip.nat_inside, interface__in=vc_interfaces
+                    ).exists()
+                ):
+                    pass
+                else:
+                    raise ValidationError(
+                        {f"{field}": f"The specified IP address ({ip}) is not assigned to this device."}
+                    )
 
         # Validate manufacturer/platform
         if hasattr(self, "device_type") and self.platform:
@@ -773,29 +708,6 @@ class Device(PrimaryModel, ConfigContextModel, StatusModel, RoleRequiredRoleMode
             device.rack = self.rack
             device.save()
 
-    def to_csv(self):
-        return (
-            self.name or "",
-            self.role.name,
-            self.tenant.name if self.tenant else None,
-            self.device_type.manufacturer.name,
-            self.device_type.model,
-            self.platform.name if self.platform else None,
-            self.serial,
-            self.asset_tag,
-            self.get_status_display(),
-            self.location.name,
-            self.rack.rack_group.name if self.rack and self.rack.rack_group else None,
-            self.rack.name if self.rack else None,
-            self.position,
-            self.get_face_display(),
-            self.device_redundancy_group.slug if self.device_redundancy_group else None,
-            self.device_redundancy_group_priority,
-            self.secrets_group.name if self.secrets_group else None,
-            self.primary_ip if self.primary_ip else None,
-            self.comments,
-        )
-
     @property
     def display(self):
         if self.name:
@@ -911,8 +823,6 @@ class VirtualChassis(PrimaryModel):
     name = models.CharField(max_length=64, db_index=True)
     domain = models.CharField(max_length=30, blank=True)
 
-    csv_headers = ["name", "domain", "master"]
-
     class Meta:
         ordering = ["name"]
         verbose_name_plural = "virtual chassis"
@@ -920,9 +830,6 @@ class VirtualChassis(PrimaryModel):
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("dcim:virtualchassis", kwargs={"pk": self.pk})
-
     @property
     def member_interfaces(self):
         """Return a list of Interfaces common to all member devices."""
@@ -951,13 +858,6 @@ class VirtualChassis(PrimaryModel):
 
         return super().delete(*args, **kwargs)
 
-    def to_csv(self):
-        return (
-            self.name,
-            self.domain,
-            self.master.name if self.master else None,
-        )
-
 
 @extras_features(
     "custom_links",
@@ -968,12 +868,13 @@ class VirtualChassis(PrimaryModel):
     "statuses",
     "webhooks",
 )
-class DeviceRedundancyGroup(PrimaryModel, StatusModel):
+class DeviceRedundancyGroup(PrimaryModel):
     """
     A DeviceRedundancyGroup represents a logical grouping of physical hardware for the purposes of high-availability.
     """
 
     name = models.CharField(max_length=100, unique=True)
+    status = StatusField(blank=False, null=False)
     description = models.CharField(max_length=200, blank=True)
 
     failover_strategy = models.CharField(
@@ -1000,8 +901,6 @@ class DeviceRedundancyGroup(PrimaryModel, StatusModel):
         "secrets_group",
     ]
 
-    csv_headers = ["name", "failover_strategy", "status", "secrets_group", "comments"]
-
     class Meta:
         ordering = ("name",)
 
@@ -1011,15 +910,3 @@ class DeviceRedundancyGroup(PrimaryModel, StatusModel):
 
     def __str__(self):
         return self.name
-
-    def get_absolute_url(self):
-        return reverse("dcim:deviceredundancygroup", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            self.failover_strategy,
-            self.get_status_display(),
-            self.secrets_group.name if self.secrets_group else None,
-            self.comments,
-        )