nautobot 2.3.1__py3-none-any.whl → 2.3.2__py3-none-any.whl

nautobot/ipam/factory.py

@@ -84,6 +84,7 @@ class VRFFactory(PrimaryModelFactory):
         model = VRF
         exclude = (
             "has_description",
+            "has_status",
             "has_tenant",
         )
 
@@ -103,6 +104,11 @@ class VRFFactory(PrimaryModelFactory):
     has_description = NautobotBoolIterator()
     description = factory.Maybe("has_description", factory.Faker("text", max_nb_chars=CHARFIELD_MAX_LENGTH), "")
 
+    has_status = NautobotBoolIterator()
+    status = factory.Maybe(
+        "has_status", random_instance(lambda: Status.objects.get_for_model(VRF), allow_null=False), None
+    )
+
     namespace = random_instance(Namespace, allow_null=False)
 
     @factory.post_generation

nautobot/ipam/filters.py

@@ -66,7 +66,7 @@ class NamespaceFilterSet(NautobotFilterSet):
         fields = "__all__"
 
 
-class VRFFilterSet(NautobotFilterSet, TenancyModelFilterSetMixin):
+class VRFFilterSet(NautobotFilterSet, StatusModelFilterSetMixin, TenancyModelFilterSetMixin):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",

nautobot/ipam/forms.py

@@ -125,6 +125,7 @@ class VRFForm(NautobotModelForm, TenancyForm):
             "name",
             "rd",
             "namespace",
+            "status",
             "description",
             "import_targets",
             "export_targets",
@@ -140,10 +141,11 @@ class VRFForm(NautobotModelForm, TenancyForm):
         }
         help_texts = {
             "rd": "Route distinguisher unique to this Namespace (as defined in RFC 4364)",
+            "status": "Operational status of this VRF",
         }
 
 
-class VRFBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+class VRFBulkEditForm(TagsBulkEditFormMixin, StatusModelBulkEditFormMixin, NautobotBulkEditForm):
     pk = forms.ModelMultipleChoiceField(queryset=VRF.objects.all(), widget=forms.MultipleHiddenInput())
     namespace = DynamicModelChoiceField(queryset=Namespace.objects.all(), required=False)
     tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
@@ -162,9 +164,9 @@ class VRFBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
         ]
 
 
-class VRFFilterForm(NautobotFilterForm, TenancyFilterForm):
+class VRFFilterForm(NautobotFilterForm, StatusModelFilterFormMixin, TenancyFilterForm):
     model = VRF
-    field_order = ["q", "import_targets", "export_targets", "tenant_group", "tenant"]
+    field_order = ["q", "import_targets", "export_targets", "status", "tenant_group", "tenant"]
     q = forms.CharField(required=False, label="Search")
     import_targets = DynamicModelMultipleChoiceField(
         queryset=RouteTarget.objects.all(), to_field_name="name", required=False

nautobot/ipam/migrations/0048_vrf_status.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.15 on 2024-08-26 17:20
+
+from django.db import migrations
+import django.db.models.deletion
+
+import nautobot.extras.models.statuses
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0114_computedfield_grouping"),
+        ("ipam", "0047_alter_ipaddress_role_alter_ipaddress_status_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="vrf",
+            name="status",
+            field=nautobot.extras.models.statuses.StatusField(
+                blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to="extras.status"
+            ),
+        ),
+    ]

nautobot/ipam/migrations/0049_vrf_data_migration.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.15 on 2024-08-26 18:05
+
+from django.db import migrations
+
+from nautobot.extras.management import clear_status_choices, populate_status_choices
+
+
+def populate_vrf_status_choices(apps, schema_editor):
+    """Create default Status records for the VRF model."""
+    populate_status_choices(apps, schema_editor, models=["ipam.VRF"])
+
+
+def clear_vrf_status_choices(apps, schema_editor):
+    """Remove default Status records for the VRF model."""
+    clear_status_choices(apps, schema_editor, models=["ipam.VRF"])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("ipam", "0048_vrf_status"),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_vrf_status_choices, clear_vrf_status_choices),
+    ]

nautobot/ipam/models.py

@@ -97,6 +97,7 @@ def get_default_namespace_pk():
     "custom_validators",
     "export_templates",
     "graphql",
+    "statuses",
     "webhooks",
 )
 class VRF(PrimaryModel):
@@ -114,6 +115,7 @@ class VRF(PrimaryModel):
         verbose_name="Route distinguisher",
         help_text="Unique route distinguisher (as defined in RFC 4364)",
     )
+    status = StatusField(blank=True, null=True)
     namespace = models.ForeignKey(
         "ipam.Namespace",
         on_delete=models.PROTECT,

nautobot/ipam/tables.py

@@ -217,7 +217,7 @@ class NamespaceTable(BaseTable):
 #
 
 
-class VRFTable(BaseTable):
+class VRFTable(StatusTableMixin, BaseTable):
     pk = ToggleColumn()
     name = tables.LinkColumn()
     # rd = tables.Column(verbose_name="RD")
@@ -232,6 +232,7 @@ class VRFTable(BaseTable):
             "pk",
             "name",
             # "rd",
+            "status",
             "namespace",
             "tenant",
             "description",
@@ -240,7 +241,7 @@ class VRFTable(BaseTable):
             "tags",
         )
         # default_columns = ("pk", "name", "rd", "namespace", "tenant", "description")
-        default_columns = ("pk", "name", "namespace", "tenant", "description")
+        default_columns = ("pk", "name", "status", "namespace", "tenant", "description")
 
 
 class VRFDeviceAssignmentTable(BaseTable):

nautobot/ipam/templates/ipam/vrf.html

@@ -19,6 +19,10 @@
                     <td>Tenant</td>
                     <td>{{ object.tenant|hyperlinked_object }}</td>
                 </tr>
+                <tr>
+                    <td>Status</td>
+                    <td>{{ object.status|hyperlinked_object_with_color }}</td>
+                </tr>
                 <tr>
                     <td>Description</td>
                     <td>{{ object.description|placeholder }}</td>

nautobot/ipam/templates/ipam/vrf_edit.html

@@ -8,6 +8,7 @@
             {% render_field form.name %}
             {% render_field form.namespace %}
 	        {% render_field form.rd %}
+            {% render_field form.status %}
             {% render_field form.description %}
         </div>
     </div>

nautobot/ipam/tests/test_api.py

@@ -13,7 +13,7 @@ from nautobot.core.testing import APITestCase, APIViewTestCases, disable_warning
 from nautobot.core.testing.api import APITransactionTestCase
 from nautobot.dcim.choices import InterfaceTypeChoices
 from nautobot.dcim.models import Device, DeviceType, Interface, Location, LocationType, Manufacturer
-from nautobot.extras.models import Role, Status
+from nautobot.extras.models import CustomField, Role, Status
 from nautobot.ipam import choices
 from nautobot.ipam.models import (
     IPAddress,
@@ -84,11 +84,14 @@ class VRFTest(APIViewTestCases.APIViewTestCase):
     @classmethod
     def setUpTestData(cls):
         namespace = Namespace.objects.first()
+        vrf_statuses = Status.objects.get_for_model(VRF)
+
         cls.create_data = [
             {
                 "namespace": namespace.pk,
                 "name": "VRF 4",
                 "rd": "65000:4",
+                "status": vrf_statuses.first().pk,
             },
             {
                 "namespace": namespace.pk,
@@ -98,10 +101,12 @@ class VRFTest(APIViewTestCases.APIViewTestCase):
             {
                 "name": "VRF 6",
                 "rd": "65000:6",
+                "status": vrf_statuses.last().pk,
             },
         ]
         cls.bulk_update_data = {
             "description": "New description",
+            "status": vrf_statuses.last().pk,
         }
 
 
@@ -332,6 +337,8 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
         cls.statuses = Status.objects.get_for_model(Prefix)
         cls.status = cls.statuses[0]
         cls.locations = Location.objects.get_for_model(Prefix)
+        cls.custom_field = CustomField.objects.create(key="prefixcf", label="Prefix Custom Field", type="text")
+        cls.custom_field.content_types.add(ContentType.objects.get_for_model(Prefix))
         cls.create_data = [
             {
                 "prefix": "192.168.4.0/24",
@@ -346,6 +353,7 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
                 "rir": rir.pk,
                 "type": choices.PrefixTypeChoices.TYPE_NETWORK,
                 "namespace": cls.namespace.pk,
+                "custom_fields": {"prefixcf": "hello world"},
             },
             {
                 "prefix": "192.168.6.0/24",
@@ -457,12 +465,16 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
                 "prefix_length": child_prefix_length,
                 "status": self.status.pk,
                 "description": f"Test Prefix {i + 1}",
+                "custom_fields": {"prefixcf": f"value {i+1}"},
             }
             response = self.client.post(url, data, format="json", **self.header)
             self.assertHttpStatus(response, status.HTTP_201_CREATED)
             self.assertEqual(response.data["prefix"], str(prefixes_to_be_created[i]))
             self.assertEqual(str(response.data["namespace"]["url"]), self.absolute_api_url(prefix.namespace))
             self.assertEqual(response.data["description"], data["description"])
+            self.assertIn("custom_fields", response.data)
+            self.assertIn("prefixcf", response.data["custom_fields"])
+            self.assertEqual(response.data["custom_fields"]["prefixcf"], data["custom_fields"]["prefixcf"])
 
         # Try to create one more prefix, and expect a HTTP 204 response.
         # This feels wrong to me (shouldn't it be a 4xx or 5xx?) but it's how the API has historically behaved.
@@ -501,6 +513,7 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
                 "prefix_length": child_prefix_length,
                 "description": "Test Prefix 1",
                 "status": self.status.pk,
+                "custom_fields": {"prefixcf": "value 1"},
             },
             {
                 "prefix_length": child_prefix_length,
@@ -537,6 +550,9 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
         response = self.client.post(url, data[:4], format="json", **self.header)
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
         self.assertEqual(len(response.data), 4)
+        self.assertIn("custom_fields", response.data[0])
+        self.assertIn("prefixcf", response.data[0]["custom_fields"])
+        self.assertEqual("value 1", response.data[0]["custom_fields"]["prefixcf"])
 
     def test_list_available_ips(self):
         """
@@ -571,6 +587,8 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             type=choices.PrefixTypeChoices.TYPE_NETWORK,
             status=self.status,
         )
+        cf = CustomField.objects.create(key="ipcf", label="IP Custom Field", type="text")
+        cf.content_types.add(ContentType.objects.get_for_model(IPAddress))
         url = reverse("ipam-api:prefix-available-ips", kwargs={"pk": prefix.pk})
         self.add_permissions("ipam.view_prefix", "ipam.add_ipaddress", "extras.view_status")
 
@@ -579,11 +597,15 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             data = {
                 "description": f"Test IP {i}",
                 "status": self.status.pk,
+                "custom_fields": {"ipcf": f"value {i}"},
             }
             response = self.client.post(url, data, format="json", **self.header)
             self.assertHttpStatus(response, status.HTTP_201_CREATED)
             self.assertEqual(str(response.data["parent"]["url"]), self.absolute_api_url(prefix))
             self.assertEqual(response.data["description"], data["description"])
+            self.assertIn("custom_fields", response.data)
+            self.assertIn("ipcf", response.data["custom_fields"])
+            self.assertEqual(f"value {i}", response.data["custom_fields"]["ipcf"])
 
         # Try to create one more IP
         response = self.client.post(url, {"status": self.status.pk}, format="json", **self.header)
@@ -601,21 +623,29 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             namespace=self.namespace,
             status=self.status,
         )
+        cf = CustomField.objects.create(key="ipcf", label="IP Custom Field", type="text")
+        cf.content_types.add(ContentType.objects.get_for_model(IPAddress))
         url = reverse("ipam-api:prefix-available-ips", kwargs={"pk": prefix.pk})
         self.add_permissions("ipam.view_prefix", "ipam.add_ipaddress", "extras.view_status")
 
         # Try to create seven IPs (only six are available)
-        data = [{"description": f"Test IP {i}", "status": self.status.pk} for i in range(1, 8)]  # 7 IPs
+        data = [
+            {"description": f"Test IP {i}", "status": self.status.pk, "custom_fields": {"ipcf": str(i)}}
+            for i in range(1, 8)
+        ]  # 7 IPs
         response = self.client.post(url, data, format="json", **self.header)
         # This feels wrong to me (shouldn't it be a 4xx or 5xx?) but it's how the API has historically behaved.
         self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
         self.assertIn("detail", response.data)
 
         # Create all six available IPs in a single request
-        data = [{"description": f"Test IP {i}", "status": self.status.pk} for i in range(1, 7)]  # 6 IPs
+        data = data[:6]
         response = self.client.post(url, data, format="json", **self.header)
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
         self.assertEqual(len(response.data), 6)
+        self.assertIn("custom_fields", response.data[0])
+        self.assertIn("ipcf", response.data[0]["custom_fields"])
+        self.assertEqual("1", response.data[0]["custom_fields"]["ipcf"])
 
 
 class PrefixLocationAssignmentTest(APIViewTestCases.APIViewTestCase):

nautobot/ipam/tests/test_views.py

@@ -73,6 +73,7 @@ class VRFTestCase(ViewTestCases.PrimaryObjectViewTestCase):
         tenants = Tenant.objects.all()[:2]
         namespace = Prefix.objects.first().namespace
         prefixes = Prefix.objects.filter(namespace=namespace)
+        vrf_statuses = Status.objects.get_for_model(VRF)
 
         cls.form_data = {
             "name": "VRF X",
@@ -82,9 +83,11 @@ class VRFTestCase(ViewTestCases.PrimaryObjectViewTestCase):
             "description": "A new VRF",
             "prefixes": [prefixes[1].id],
             "tags": [t.pk for t in Tag.objects.get_for_model(VRF)],
+            "status": vrf_statuses.first().pk,
         }
 
         cls.bulk_edit_data = {
+            "status": vrf_statuses.first().pk,
             "tenant": tenants[1].pk,
             "description": "New description",
             "namespace": prefixes[0].namespace.id,

nautobot/project-static/css/base.css

@@ -862,6 +862,12 @@ td span.hover_copy:hover .hover_copy_button {
 .collapse-icon {
     float: right;
     cursor: pointer !important;
+    transition: transform 0.3s ease;
+}
+
+/* Rotates element 180 degrees */
+.rotated180 {
+    transform: rotate(180deg);
 }
 
 /* Draggable homepage panels fade in effect on page load */