nautobot 2.2.9__py3-none-any.whl → 2.3.0__py3-none-any.whl

nautobot/dcim/migrations/0062_module_data_migration.py

@@ -0,0 +1,25 @@
+from django.db import migrations
+
+from nautobot.extras.management import clear_status_choices, populate_status_choices
+
+
+def populate_module_status_choices(apps, schema_editor):
+    """Create default Status records for the Module model."""
+    populate_status_choices(apps, schema_editor, models=["dcim.Module"])
+
+
+def clear_module_status_choices(apps, schema_editor):
+    """Remove default Status records for the Module model."""
+    clear_status_choices(apps, schema_editor, models=["dcim.Module"])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0001_initial"),
+        ("extras", "0001_initial_part_1"),
+        ("dcim", "0061_module_models"),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_module_status_choices, clear_module_status_choices),
+    ]

nautobot/dcim/models/__init__.py

@@ -5,6 +5,7 @@ from .device_component_templates import (
     DeviceBayTemplate,
     FrontPortTemplate,
     InterfaceTemplate,
+    ModuleBayTemplate,
     PowerOutletTemplate,
     PowerPortTemplate,
     RearPortTemplate,
@@ -20,6 +21,7 @@ from .device_components import (
     InterfaceRedundancyGroup,
     InterfaceRedundancyGroupAssociation,
     InventoryItem,
+    ModuleBay,
     PathEndpoint,
     PowerOutlet,
     PowerPort,
@@ -34,6 +36,8 @@ from .devices import (
     DeviceType,
     DeviceTypeToSoftwareImageFile,
     Manufacturer,
+    Module,
+    ModuleType,
     Platform,
     SoftwareImageFile,
     SoftwareVersion,
@@ -71,6 +75,10 @@ __all__ = (
     "Location",
     "LocationType",
     "Manufacturer",
+    "Module",
+    "ModuleBay",
+    "ModuleBayTemplate",
+    "ModuleType",
     "PathEndpoint",
     "Platform",
     "PowerFeed",

nautobot/dcim/models/cables.py

@@ -255,8 +255,20 @@ class Cable(PrimaryModel):
         # Store the parent Device for the A and B terminations (if applicable) to enable filtering
         if hasattr(self.termination_a, "device"):
             self._termination_a_device = self.termination_a.device
+        if (
+            not self._termination_a_device
+            and hasattr(self.termination_a, "module")
+            and self.termination_a.module.device
+        ):
+            self._termination_a_device = self.termination_a.module.device
         if hasattr(self.termination_b, "device"):
             self._termination_b_device = self.termination_b.device
+        if (
+            not self._termination_b_device
+            and hasattr(self.termination_b, "module")
+            and self.termination_b.module.device
+        ):
+            self._termination_b_device = self.termination_b.module.device
 
         super().save(*args, **kwargs)
 
@@ -314,6 +326,9 @@ class CablePath(BaseModel):
     path = JSONPathField()
     is_active = models.BooleanField(default=False)
     is_split = models.BooleanField(default=False)
+    # `CablePathSerializer` currently does not inherit from `BaseModelSerializer`
+    # thus it does not have `object_type` field needed for the `assigned_object` field using `PolymorphicProxySerializer`.
+    is_metadata_associable_model = False
 
     natural_key_field_names = ["pk"]
 

nautobot/dcim/models/device_component_templates.py

@@ -17,7 +17,15 @@ from nautobot.dcim.choices import (
     SubdeviceRoleChoices,
 )
 from nautobot.dcim.constants import REARPORT_POSITIONS_MAX, REARPORT_POSITIONS_MIN
-from nautobot.extras.models import ChangeLoggedModel, CustomField, CustomFieldModel, RelationshipModel, Status
+from nautobot.extras.models import (
+    ChangeLoggedModel,
+    ContactMixin,
+    CustomField,
+    CustomFieldModel,
+    DynamicGroupsModelMixin,
+    RelationshipModel,
+    Status,
+)
 from nautobot.extras.utils import extras_features
 
 from .device_components import (
@@ -26,6 +34,7 @@ from .device_components import (
     DeviceBay,
     FrontPort,
     Interface,
+    ModuleBay,
     PowerOutlet,
     PowerPort,
     RearPort,
@@ -37,13 +46,22 @@ __all__ = (
     "DeviceBayTemplate",
     "FrontPortTemplate",
     "InterfaceTemplate",
+    "ModuleBayTemplate",
     "PowerOutletTemplate",
     "PowerPortTemplate",
     "RearPortTemplate",
 )
 
 
-class ComponentTemplateModel(BaseModel, ChangeLoggedModel, CustomFieldModel, RelationshipModel):
+# TODO: Changing ComponentTemplateModel to an OrganizationalModel would just involve adding Notes support...
+class ComponentTemplateModel(
+    ContactMixin,
+    DynamicGroupsModelMixin,
+    ChangeLoggedModel,
+    CustomFieldModel,
+    RelationshipModel,
+    BaseModel,
+):
     device_type = ForeignKeyWithAutoRelatedName(to="dcim.DeviceType", on_delete=models.CASCADE)
     name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
     _name = NaturalOrderingField(target_field="name", max_length=CHARFIELD_MAX_LENGTH, blank=True)
@@ -68,6 +86,9 @@ class ComponentTemplateModel(BaseModel, ChangeLoggedModel, CustomFieldModel, Rel
         """
         Return a new ObjectChange with the `related_object` pinned to the `device_type` by default.
         """
+        if "related_object" in kwargs:
+            return super().to_objectchange(action, **kwargs)
+
         try:
             device_type = self.device_type
         except ObjectDoesNotExist:
@@ -102,46 +123,111 @@ class ComponentTemplateModel(BaseModel, ChangeLoggedModel, CustomFieldModel, Rel
         )
 
 
+class ModularComponentTemplateModel(ComponentTemplateModel):
+    """Component Template that supports assignment to a DeviceType or a ModuleType."""
+
+    device_type = ForeignKeyWithAutoRelatedName(
+        to="dcim.DeviceType",
+        on_delete=models.CASCADE,
+        blank=True,
+        null=True,
+    )
+    module_type = ForeignKeyWithAutoRelatedName(
+        to="dcim.ModuleType",
+        on_delete=models.CASCADE,
+        blank=True,
+        null=True,
+    )
+
+    natural_key_field_names = ["device_type", "module_type", "name"]
+
+    class Meta:
+        abstract = True
+        ordering = ("device_type", "module_type", "_name")
+        constraints = [
+            models.UniqueConstraint(
+                fields=("device_type", "name"),
+                name="%(app_label)s_%(class)s_device_type_name_unique",
+            ),
+            models.UniqueConstraint(
+                fields=("module_type", "name"),
+                name="%(app_label)s_%(class)s_module_type_name_unique",
+            ),
+        ]
+
+    @property
+    def parent(self):
+        return self.device_type if self.device_type else self.module_type
+
+    def to_objectchange(self, action, **kwargs):
+        """
+        Return a new ObjectChange with the `related_object` pinned to the `device_type` or `module_type`.
+        """
+        if "related_object" in kwargs:
+            return super().to_objectchange(action, **kwargs)
+
+        try:
+            parent = self.parent
+        except ObjectDoesNotExist:
+            # The parent may have already been deleted
+            parent = None
+
+        return super().to_objectchange(action, related_object=parent, **kwargs)
+
+    def get_absolute_url(self, api=False):
+        if not api:
+            return self.parent.get_absolute_url(api=api)
+        return super().get_absolute_url(api=api)
+
+    def instantiate_model(self, model, device, module=None, **kwargs):
+        """
+        Helper method to self.instantiate().
+        """
+        return super().instantiate_model(model, device, module=module, **kwargs)
+
+    def clean(self):
+        super().clean()
+
+        # Validate that a DeviceType or ModuleType is set, but not both
+        if self.device_type and self.module_type:
+            raise ValidationError("Only one of device_type or module_type must be set")
+
+        if not (self.device_type or self.module_type):
+            raise ValidationError("Either device_type or module_type must be set")
+
+
 @extras_features(
     "custom_validators",
 )
-class ConsolePortTemplate(ComponentTemplateModel):
+class ConsolePortTemplate(ModularComponentTemplateModel):
     """
     A template for a ConsolePort to be created for a new Device.
     """
 
     type = models.CharField(max_length=50, choices=ConsolePortTypeChoices, blank=True)
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = ("device_type", "name")
-
-    def instantiate(self, device):
-        return self.instantiate_model(model=ConsolePort, device=device, type=self.type)
+    def instantiate(self, device, module=None):
+        return self.instantiate_model(model=ConsolePort, device=device, module=module, type=self.type)
 
 
 @extras_features(
     "custom_validators",
 )
-class ConsoleServerPortTemplate(ComponentTemplateModel):
+class ConsoleServerPortTemplate(ModularComponentTemplateModel):
     """
     A template for a ConsoleServerPort to be created for a new Device.
     """
 
     type = models.CharField(max_length=50, choices=ConsolePortTypeChoices, blank=True)
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = ("device_type", "name")
-
-    def instantiate(self, device):
-        return self.instantiate_model(model=ConsoleServerPort, device=device, type=self.type)
+    def instantiate(self, device, module=None):
+        return self.instantiate_model(model=ConsoleServerPort, device=device, module=module, type=self.type)
 
 
 @extras_features(
     "custom_validators",
 )
-class PowerPortTemplate(ComponentTemplateModel):
+class PowerPortTemplate(ModularComponentTemplateModel):
     """
     A template for a PowerPort to be created for a new Device.
     """
@@ -160,14 +246,11 @@ class PowerPortTemplate(ComponentTemplateModel):
         help_text="Allocated power draw (watts)",
     )
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = ("device_type", "name")
-
-    def instantiate(self, device):
+    def instantiate(self, device, module=None):
         return self.instantiate_model(
             model=PowerPort,
             device=device,
+            module=module,
             type=self.type,
             maximum_draw=self.maximum_draw,
             allocated_draw=self.allocated_draw,
@@ -186,7 +269,7 @@ class PowerPortTemplate(ComponentTemplateModel):
 @extras_features(
     "custom_validators",
 )
-class PowerOutletTemplate(ComponentTemplateModel):
+class PowerOutletTemplate(ModularComponentTemplateModel):
     """
     A template for a PowerOutlet to be created for a new Device.
     """
@@ -206,25 +289,29 @@ class PowerOutletTemplate(ComponentTemplateModel):
         help_text="Phase (for three-phase feeds)",
     )
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = ("device_type", "name")
-
     def clean(self):
         super().clean()
 
         # Validate power port assignment
-        if self.power_port_template and self.power_port_template.device_type != self.device_type:
-            raise ValidationError(f"Parent power port ({self.power_port_template}) must belong to the same device type")
+        if self.power_port_template:
+            if self.device_type and self.power_port_template.device_type != self.device_type:
+                raise ValidationError(
+                    f"Parent power port ({self.power_port_template}) must belong to the same device type"
+                )
+            if self.module_type and self.power_port_template.module_type != self.module_type:
+                raise ValidationError(
+                    f"Parent power port ({self.power_port_template}) must belong to the same module type"
+                )
 
-    def instantiate(self, device):
+    def instantiate(self, device, module=None):
         if self.power_port_template:
-            power_port = PowerPort.objects.get(device=device, name=self.power_port_template.name)
+            power_port = PowerPort.objects.get(device=device, module=module, name=self.power_port_template.name)
         else:
             power_port = None
         return self.instantiate_model(
             model=PowerOutlet,
             device=device,
+            module=module,
             type=self.type,
             power_port=power_port,
             feed_leg=self.feed_leg,
@@ -234,7 +321,7 @@ class PowerOutletTemplate(ComponentTemplateModel):
 @extras_features(
     "custom_validators",
 )
-class InterfaceTemplate(ComponentTemplateModel):
+class InterfaceTemplate(ModularComponentTemplateModel):
     """
     A template for a physical data interface on a new Device.
     """
@@ -249,11 +336,7 @@ class InterfaceTemplate(ComponentTemplateModel):
     type = models.CharField(max_length=50, choices=InterfaceTypeChoices)
     mgmt_only = models.BooleanField(default=False, verbose_name="Management only")
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = ("device_type", "name")
-
-    def instantiate(self, device):
+    def instantiate(self, device, module=None):
         try:
             status = Status.objects.get_for_model(Interface).get(name="Active")
         except Status.DoesNotExist:
@@ -261,6 +344,7 @@ class InterfaceTemplate(ComponentTemplateModel):
         return self.instantiate_model(
             model=Interface,
             device=device,
+            module=module,
             type=self.type,
             mgmt_only=self.mgmt_only,
             status=status,
@@ -270,7 +354,7 @@ class InterfaceTemplate(ComponentTemplateModel):
 @extras_features(
     "custom_validators",
 )
-class FrontPortTemplate(ComponentTemplateModel):
+class FrontPortTemplate(ModularComponentTemplateModel):
     """
     Template for a pass-through port on the front of a new Device.
     """
@@ -289,19 +373,25 @@ class FrontPortTemplate(ComponentTemplateModel):
         ],
     )
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = (
-            ("device_type", "name"),
-            ("rear_port_template", "rear_port_position"),
-        )
+    natural_key_field_names = ["device_type", "module_type", "name", "rear_port_template", "rear_port_position"]
+
+    class Meta(ModularComponentTemplateModel.Meta):
+        constraints = [
+            *ModularComponentTemplateModel.Meta.constraints,
+            models.UniqueConstraint(
+                fields=("rear_port_template", "rear_port_position"),
+                name="dcim_frontporttemplate_rear_port_template_position_unique",
+            ),
+        ]
 
     def clean(self):
         super().clean()
 
         # Validate rear port assignment
-        if self.rear_port_template.device_type != self.device_type:
+        if self.device_type and self.rear_port_template.device_type != self.device_type:
             raise ValidationError(f"Rear port ({self.rear_port_template}) must belong to the same device type")
+        if self.module_type and self.rear_port_template.module_type != self.module_type:
+            raise ValidationError(f"Rear port ({self.rear_port_template}) must belong to the same module type")
 
         # Validate rear port position assignment
         if self.rear_port_position > self.rear_port_template.positions:
@@ -312,14 +402,15 @@ class FrontPortTemplate(ComponentTemplateModel):
                 )
             )
 
-    def instantiate(self, device):
+    def instantiate(self, device, module=None):
         if self.rear_port_template:
-            rear_port = RearPort.objects.get(device=device, name=self.rear_port_template.name)
+            rear_port = RearPort.objects.get(device=device, module=module, name=self.rear_port_template.name)
         else:
             rear_port = None
         return self.instantiate_model(
             model=FrontPort,
             device=device,
+            module=module,
             type=self.type,
             rear_port=rear_port,
             rear_port_position=self.rear_port_position,
@@ -329,7 +420,7 @@ class FrontPortTemplate(ComponentTemplateModel):
 @extras_features(
     "custom_validators",
 )
-class RearPortTemplate(ComponentTemplateModel):
+class RearPortTemplate(ModularComponentTemplateModel):
     """
     Template for a pass-through port on the rear of a new Device.
     """
@@ -343,14 +434,11 @@ class RearPortTemplate(ComponentTemplateModel):
         ],
     )
 
-    class Meta:
-        ordering = ("device_type", "_name")
-        unique_together = ("device_type", "name")
-
-    def instantiate(self, device):
+    def instantiate(self, device, module=None):
         return self.instantiate_model(
             model=RearPort,
             device=device,
+            module=module,
             type=self.type,
             positions=self.positions,
         )
@@ -376,3 +464,69 @@ class DeviceBayTemplate(ComponentTemplateModel):
             raise ValidationError(
                 f'Subdevice role of device type ({self.device_type}) must be set to "parent" to allow device bays.'
             )
+
+
+@extras_features("custom_validators")
+class ModuleBayTemplate(ModularComponentTemplateModel):
+    """Template for a slot in a Device or Module which can contain Modules."""
+
+    position = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+        help_text="The position of the module bay within the device or module",
+    )
+    label = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, help_text="Physical label")
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+
+    natural_key_field_names = ["device_type", "module_type", "name"]
+
+    @property
+    def parent(self):
+        return self.device_type if self.device_type else self.module_type
+
+    def __str__(self):
+        return f"{self.parent} ({self.name})"
+
+    def instantiate(self, device, module=None):
+        custom_field_data = {}
+        content_type = ContentType.objects.get_for_model(ModuleBay)
+        fields = CustomField.objects.filter(content_types=content_type)
+        for field in fields:
+            custom_field_data[field.key] = field.default
+
+        return ModuleBay(
+            parent_device=device,
+            parent_module=module,
+            name=self.name,
+            position=self.position,
+            label=self.label,
+            description=self.description,
+            _custom_field_data=custom_field_data,
+        )
+
+    def to_objectchange(self, action, **kwargs):
+        """
+        Return a new ObjectChange with the `related_object` pinned to the parent `device_type` or `module_type`.
+        """
+        try:
+            parent = self.parent
+        except ObjectDoesNotExist:
+            # The parent may have already been deleted
+            parent = None
+
+        return super().to_objectchange(action, related_object=parent, **kwargs)
+
+    def get_absolute_url(self, api=False):
+        if not api:
+            return self.parent.get_absolute_url(api=api)
+        return super().get_absolute_url(api=api)
+
+    def clean(self):
+        super().clean()
+
+        # Validate that a DeviceType or ModuleType is set, but not both
+        if self.device_type and self.module_type:
+            raise ValidationError("Only one of device_type or module_type must be set")
+
+        if not (self.device_type or self.module_type):
+            raise ValidationError("Either device_type or module_type must be set")