nautobot 2.3.0b1__py3-none-any.whl → 2.3.2__py3-none-any.whl

nautobot/extras/views.py

@@ -1,8 +1,8 @@
-from datetime import timedelta
 import logging
 from urllib.parse import parse_qs
 
 from celery import chain
+from django.conf import settings
 from django.contrib import messages
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.contenttypes.models import ContentType
@@ -24,6 +24,11 @@ from django_tables2 import RequestConfig
 from jsonschema.validators import Draft7Validator
 from rest_framework.decorators import action
 
+try:
+    from zoneinfo import ZoneInfo
+except ImportError:  # python 3.8
+    from backports.zoneinfo import ZoneInfo
+
 from nautobot.core.forms import restrict_form_fields
 from nautobot.core.models.querysets import count_related
 from nautobot.core.models.utils import pretty_print_query
@@ -1388,55 +1393,25 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
             schedule_type = schedule_form.cleaned_data["_schedule_type"]
 
             if (not dryrun and job_model.approval_required) or schedule_type in JobExecutionType.SCHEDULE_CHOICES:
-                crontab = ""
-
-                if schedule_type == JobExecutionType.TYPE_IMMEDIATELY:
-                    # The job must be approved.
-                    # If the schedule_type is immediate, we still create the task, but mark it for approval
-                    # as a once in the future task with the due date set to the current time. This means
-                    # when approval is granted, the task is immediately due for execution.
-                    schedule_type = JobExecutionType.TYPE_FUTURE
-                    schedule_datetime = timezone.now()
-                    schedule_name = f"{job_model} - {schedule_datetime}"
-
-                else:
-                    schedule_name = schedule_form.cleaned_data["_schedule_name"]
-
-                    if schedule_type == JobExecutionType.TYPE_CUSTOM:
-                        crontab = schedule_form.cleaned_data["_recurrence_custom_time"]
-                        # doing .get("key", "default") returns None instead of "default" here for some reason
-                        schedule_datetime = schedule_form.cleaned_data.get("_schedule_start_time")
-                        if schedule_datetime is None:
-                            # "_schedule_start_time" is checked against ScheduledJob.earliest_possible_time()
-                            # which returns timezone.now() + timedelta(seconds=15)
-                            schedule_datetime = timezone.now() + timedelta(seconds=20)
-                    else:
-                        schedule_datetime = schedule_form.cleaned_data["_schedule_start_time"]
-
-                celery_kwargs = {"nautobot_job_profile": profile, "queue": task_queue}
-                scheduled_job = ScheduledJob(
-                    name=schedule_name,
-                    task=job_model.class_path,
-                    job_model=job_model,
-                    start_time=schedule_datetime,
-                    description=f"Nautobot job {schedule_name} scheduled by {request.user} for {schedule_datetime}",
-                    kwargs=job_class.serialize_data(job_form.cleaned_data),
-                    celery_kwargs=celery_kwargs,
+                scheduled_job = ScheduledJob.create_schedule(
+                    job_model,
+                    request.user,
+                    name=schedule_form.cleaned_data.get("_schedule_name"),
+                    start_time=schedule_form.cleaned_data.get("_schedule_start_time"),
                     interval=schedule_type,
-                    one_off=schedule_type == JobExecutionType.TYPE_FUTURE,
-                    queue=task_queue,
-                    user=request.user,
+                    crontab=schedule_form.cleaned_data.get("_recurrence_custom_time"),
                     approval_required=job_model.approval_required,
-                    crontab=crontab,
+                    task_queue=task_queue,
+                    profile=profile,
+                    **job_class.serialize_data(job_form.cleaned_data),
                 )
-                scheduled_job.validated_save()
 
                 if job_model.approval_required:
-                    messages.success(request, f"Job {schedule_name} successfully submitted for approval")
-                    return redirect(return_url if return_url else "extras:scheduledjob_approval_queue_list")
+                    messages.success(request, f"Job {scheduled_job.name} successfully submitted for approval")
+                    return redirect(return_url or "extras:scheduledjob_approval_queue_list")
                 else:
-                    messages.success(request, f"Job {schedule_name} successfully scheduled")
-                    return redirect(return_url if return_url else "extras:scheduledjob_list")
+                    messages.success(request, f"Job {scheduled_job.name} successfully scheduled")
+                    return redirect(return_url or "extras:scheduledjob_list")
 
             else:
                 # Enqueue job for immediate execution
@@ -1722,7 +1697,12 @@ class SavedViewUIViewSet(
         view_name = new_global_default_view.view
         message = ""
         if new_global_default_view.is_global_default:
-            message += f"<br>The global default saved View for '{view_name}' is set to <a href='{new_global_default_view.get_absolute_url()}'>{new_global_default_view.name}</a>."
+            message = format_html(
+                '<br>The global default saved view for "{}" is set to <a href="{}">{}</a>',
+                view_name,
+                new_global_default_view.get_absolute_url(),
+                new_global_default_view.name,
+            )
         return message
 
     def list(self, request, *args, **kwargs):
@@ -1942,6 +1922,7 @@ class ScheduledJobView(generic.ObjectView):
         return {
             "labels": labels,
             "job_class_found": (job_class is not None),
+            "default_time_zone": ZoneInfo(settings.TIME_ZONE),
             **super().get_extra_context(request, instance),
         }
 
@@ -2076,8 +2057,13 @@ class JobLogEntryTableView(generic.GenericView):
         else:
             queryset = instance.job_log_entries.all()
         log_table = tables.JobLogEntryTable(data=queryset, user=request.user)
-        RequestConfig(request).configure(log_table)
-        return HttpResponse(log_table.as_html(request))
+        paginate = {
+            "paginator_class": EnhancedPaginator,
+            "per_page": get_paginate_count(request),
+        }
+        RequestConfig(request, paginate).configure(log_table)
+        table = log_table.as_html(request)
+        return HttpResponse(table)
 
 
 #
@@ -2237,15 +2223,13 @@ class MetadataTypeUIViewSet(NautobotUIViewSet):
 
 
 class ObjectMetadataUIViewSet(
-    ObjectBulkDestroyViewMixin,
     ObjectChangeLogViewMixin,
-    ObjectDestroyViewMixin,
     ObjectDetailViewMixin,
     ObjectListViewMixin,
 ):
     filterset_class = filters.ObjectMetadataFilterSet
     filterset_form_class = forms.ObjectMetadataFilterForm
-    queryset = ObjectMetadata.objects.all().order_by("assigned_object_type", "scoped_fields")
+    queryset = ObjectMetadata.objects.all().order_by("assigned_object_type", "assigned_object_id", "scoped_fields")
     serializer_class = serializers.ObjectMetadataSerializer
     table_class = tables.ObjectMetadataTable
     action_buttons = ("export",)
@@ -2444,7 +2428,7 @@ class RoleUIViewSet(viewsets.NautobotUIViewSet):
 
             if ContentType.objects.get_for_model(Prefix) in context["content_types"]:
                 prefixes = instance.prefixes.restrict(request.user, "view")
-                prefix_table = PrefixTable(prefixes)
+                prefix_table = PrefixTable(prefixes, hide_hierarchy_ui=True)
                 prefix_table.columns.hide("role")
                 RequestConfig(request, paginate).configure(prefix_table)
                 context["prefix_table"] = prefix_table

nautobot/ipam/api/views.py

@@ -202,7 +202,7 @@ class PrefixViewSet(NautobotModelViewSet):
                         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["namespace"] = prefix.namespace.pk
+                            requested_prefix["namespace"] = prefix.namespace
                             break
                     else:
                         return Response(
@@ -210,6 +210,10 @@ class PrefixViewSet(NautobotModelViewSet):
                             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)
 
@@ -299,7 +303,10 @@ class PrefixViewSet(NautobotModelViewSet):
                 prefix_length = prefix.prefix.prefixlen
                 for requested_ip in requested_ips:
                     requested_ip["address"] = f"{next(available_ips)}/{prefix_length}"
-                    requested_ip["namespace"] = prefix.namespace.pk
+                    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}

nautobot/ipam/choices.py

@@ -102,6 +102,23 @@ class IPAddressTypeChoices(ChoiceSet):
     )
 
 
+#
+# VRFs
+#
+
+
+class VRFStatusChoices(ChoiceSet):
+    STATUS_ACTIVE = "active"
+    STATUS_DOWN = "down"
+    STATUS_DEPRECATED = "deprecated"
+
+    CHOICES = (
+        (STATUS_ACTIVE, "Active"),
+        (STATUS_DOWN, "Down"),
+        (STATUS_DEPRECATED, "Deprecated"),
+    )
+
+
 #
 # VLANs
 #

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",
@@ -498,7 +498,7 @@ class IPAddressFilterSet(
             return queryset.none()
         interface_ids = []
         for device in devices:
-            interface_ids.extend(device.all_interfaces.values_list("id", flat=True))
+            interface_ids.extend(device.vc_interfaces.values_list("id", flat=True))
         return queryset.filter(interfaces__in=interface_ids)
 
     def filter_virtual_machine(self, queryset, name, value):

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
@@ -899,7 +901,7 @@ class ServiceForm(NautobotModelForm):
         # Limit IP address choices to those assigned to interfaces of the parent device/VM
         if self.instance.device:
             self.fields["ip_addresses"].queryset = IPAddress.objects.filter(
-                interfaces__in=self.instance.device.all_interfaces.values_list("id", flat=True)
+                interfaces__in=self.instance.device.vc_interfaces.values_list("id", flat=True)
             )
         elif self.instance.virtual_machine:
             self.fields["ip_addresses"].queryset = IPAddress.objects.filter(

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

@@ -49,7 +49,6 @@ logger = logging.getLogger(__name__)
 @extras_features(
     "custom_links",
     "custom_validators",
-    "dynamic_groups",
     "export_templates",
     "graphql",
     "locations",
@@ -98,6 +97,7 @@ def get_default_namespace_pk():
     "custom_validators",
     "export_templates",
     "graphql",
+    "statuses",
     "webhooks",
 )
 class VRF(PrimaryModel):
@@ -115,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,
@@ -399,7 +400,6 @@ class RIR(OrganizationalModel):
 @extras_features(
     "custom_links",
     "custom_validators",
-    "dynamic_groups",
     "export_templates",
     "graphql",
     "locations",
@@ -501,11 +501,6 @@ class Prefix(PrimaryModel):
         "type",
         "vlan",
     ]
-    """
-    dynamic_group_filter_fields = {
-        "vrf": "vrf_id",  # Duplicate filter fields that will be collapsed in 2.0
-    }
-    """
 
     class Meta:
         ordering = (
@@ -986,7 +981,6 @@ class PrefixLocationAssignment(BaseModel):
 @extras_features(
     "custom_links",
     "custom_validators",
-    "dynamic_groups",
     "export_templates",
     "graphql",
     "statuses",
@@ -1020,7 +1014,7 @@ class IPAddress(PrimaryModel):
     parent = models.ForeignKey(
         "ipam.Prefix",
         blank=True,
-        null=True,
+        null=True,  # TODO remove this, it shouldn't be permitted for the database!
         related_name="ip_addresses",  # `IPAddress` to use `related_name="ip_addresses"`
         on_delete=models.PROTECT,
         help_text="The parent Prefix of this IPAddress.",
@@ -1117,7 +1111,7 @@ class IPAddress(PrimaryModel):
             raise ValidationError({"namespace": "No suitable parent Prefix exists in this Namespace"}) from e
 
     def clean(self):
-        super().clean()
+        self.address = self.address  # not a no-op - forces re-calling of self._deconstruct_address()
 
         # Validate that host is not being modified
         if self.present_in_database:
@@ -1131,8 +1125,8 @@ class IPAddress(PrimaryModel):
 
         closest_parent = self._get_closest_parent()
         # Validate `parent` can be used as the parent for this ipaddress
-        if self.parent and closest_parent:
-            if self.parent != closest_parent:
+        if closest_parent is not None:
+            if self.parent is not None and self.parent != closest_parent:
                 raise ValidationError(
                     {
                         "parent": (
@@ -1144,23 +1138,20 @@ class IPAddress(PrimaryModel):
             self.parent = closest_parent
             self._namespace = None
 
-    def save(self, *args, **kwargs):
         # 3.0 TODO: uncomment the below to enforce this constraint
         # if self.parent.type != choices.PrefixTypeChoices.TYPE_NETWORK:
         #     err_msg = f"IP addresses cannot be created in {self.parent.type} prefixes. You must create a network prefix first."
         #     raise ValidationError({"address": err_msg})
 
-        self.address = self.address  # not a no-op - forces re-calling of self._deconstruct_address()
-
         # Force dns_name to lowercase
         if not self.dns_name.islower:
             self.dns_name = self.dns_name.lower()
 
-        # Host and mask_length are required to get closest parent
-        closest_parent = self._get_closest_parent()
-        if closest_parent is not None:
-            self.parent = closest_parent
-            self._namespace = None
+        super().clean()
+
+    def save(self, *args, **kwargs):
+        self.clean()  # MUST do data fixup as above
+
         super().save(*args, **kwargs)
 
     @property

nautobot/ipam/querysets.py

@@ -1,6 +1,7 @@
 import re
 
 from django.core.exceptions import ValidationError
+from django.core.validators import validate_ipv46_address
 from django.db.models import ProtectedError, Q
 import netaddr
 
@@ -397,6 +398,31 @@ class IPAddressQuerySet(BaseNetworkQuerySet):
         """
         return super().order_by("host")
 
+    def get_or_create(self, **kwargs):
+        from nautobot.ipam.models import get_default_namespace, Prefix
+
+        parent = kwargs.get("parent")
+        namespace = kwargs.pop("namespace", None)
+        host = kwargs.get("host")
+        mask_length = kwargs.get("mask_length")
+        # If `host` or `mask_length` is None skip; then there is no way of getting the closest parent;
+        if parent is None and host is not None and mask_length is not None:
+            if namespace is None:
+                namespace = get_default_namespace()
+            cidr = f"{host}/{mask_length}"
+
+            try:
+                validate_ipv46_address(host)
+            except ValidationError as err:
+                raise ValidationError({"host": err.error_list}) from err
+            try:
+                netaddr.IPNetwork(cidr)
+            except netaddr.AddrFormatError as err:
+                raise ValidationError(f"{cidr} does not appear to be an IPv4 or IPv6 network.") from err
+            parent = Prefix.objects.filter(namespace=namespace).get_closest_parent(cidr=cidr, include_self=True)
+            kwargs["parent"] = parent
+        return super().get_or_create(**kwargs)
+
     def string_search(self, search):
         """
         Interpret a search string and return useful results.

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):
@@ -355,6 +356,9 @@ class PrefixTable(StatusTableMixin, RoleTableMixin, BaseTable):
     location_count = LinkedCountColumn(
         viewname="dcim:location_list", url_params={"prefixes": "pk"}, verbose_name="Locations"
     )
+    cloud_networks_count = LinkedCountColumn(
+        viewname="cloud:cloudnetwork_list", url_params={"prefixes": "pk"}, verbose_name="Cloud Networks"
+    )
 
     class Meta(BaseTable.Meta):
         model = Prefix
@@ -368,6 +372,7 @@ class PrefixTable(StatusTableMixin, RoleTableMixin, BaseTable):
             "namespace",
             "tenant",
             "location_count",
+            "cloud_networks_count",
             "vlan",
             "role",
             "rir",

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>