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

nautobot/extras/api/views.py

@@ -1,5 +1,3 @@
-from datetime import timedelta
-
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.forms import ValidationError as FormsValidationError
@@ -492,59 +490,6 @@ class ImageAttachmentViewSet(ModelViewSet):
 #
 
 
-def _create_schedule(serializer, data, job_model, user, approval_required, task_queue=None):
-    """
-    This is an internal function to create a scheduled job from API data.
-    It has to handle both once-offs (i.e. of type TYPE_FUTURE) and interval
-    jobs.
-    """
-    type_ = serializer["interval"]
-    if type_ == JobExecutionType.TYPE_IMMEDIATELY:
-        time = timezone.now()
-        name = serializer.get("name") or f"{job_model.name} - {time}"
-    elif type_ == JobExecutionType.TYPE_CUSTOM:
-        time = serializer.get("start_time")  # doing .get("key", "default") returns None instead of "default"
-        if time is None:
-            # "start_time" is checked against models.ScheduledJob.earliest_possible_time()
-            # which returns timezone.now() + timedelta(seconds=15)
-            time = timezone.now() + timedelta(seconds=20)
-        name = serializer["name"]
-    else:
-        time = serializer["start_time"]
-        name = serializer["name"]
-    crontab = serializer.get("crontab", "")
-
-    celery_kwargs = {
-        "nautobot_job_profile": False,
-        "queue": task_queue,
-    }
-
-    # 2.0 TODO: To revisit this as part of a larger Jobs cleanup in 2.0.
-    #
-    # We pass in task and job_model here partly for forward/backward compatibility logic, and
-    # part fallback safety. It's mildly useful to store both the task module/class name and the JobModel
-    # FK on the ScheduledJob, as in the case where the JobModel gets deleted (and the FK becomes
-    # null) you still have a bit of context on the ScheduledJob as to what it was originally
-    # scheduled for.
-    scheduled_job = ScheduledJob(
-        name=name,
-        task=job_model.class_path,
-        job_model=job_model,
-        start_time=time,
-        description=f"Nautobot job {name} scheduled by {user} for {time}",
-        kwargs=data,
-        celery_kwargs=celery_kwargs,
-        interval=type_,
-        one_off=(type_ == JobExecutionType.TYPE_FUTURE),
-        user=user,
-        approval_required=approval_required,
-        crontab=crontab,
-        queue=task_queue,
-    )
-    scheduled_job.validated_save()
-    return scheduled_job
-
-
 class JobViewSetBase(
     NautobotAPIVersionMixin,
     # note no CreateModelMixin
@@ -744,13 +689,16 @@ class JobViewSetBase(
 
         # Try to create a ScheduledJob, or...
         if schedule_data:
-            schedule = _create_schedule(
-                schedule_data,
-                job_class.serialize_data(cleaned_data),
+            schedule = ScheduledJob.create_schedule(
                 job_model,
                 request.user,
-                approval_required,
+                name=schedule_data.get("name"),
+                start_time=schedule_data.get("start_time"),
+                interval=schedule_data.get("interval"),
+                crontab=schedule_data.get("crontab", ""),
+                approval_required=approval_required,
                 task_queue=input_serializer.validated_data.get("task_queue", None),
+                **job_class.serialize_data(cleaned_data),
             )
         else:
             schedule = None

nautobot/extras/factory.py

@@ -251,6 +251,24 @@ class MetadataTypeFactory(PrimaryModelFactory):
                 )
 
 
+def _available_field_names(metadata_type, assigned_object):
+    field_names = [field.name for field in assigned_object._meta.get_fields()]
+    # Avoid collisions, see ObjectMetadata.clean()
+    existing_metadata_scoped_fields = ObjectMetadata.objects.filter(
+        metadata_type=metadata_type,
+        assigned_object_type=ContentType.objects.get_for_model(assigned_object),
+        assigned_object_id=assigned_object.pk,
+    ).values_list("scoped_fields", flat=True)
+    for existing_scoped_fields in existing_metadata_scoped_fields:
+        if existing_scoped_fields:
+            field_names = sorted(set(field_names).difference(existing_scoped_fields))
+        else:
+            field_names = []
+            break
+
+    return field_names
+
+
 class ObjectMetadataFactory(BaseModelFactory):
     """ObjectMetadata model factory"""
 
@@ -263,7 +281,6 @@ class ObjectMetadataFactory(BaseModelFactory):
         MetadataType.objects.all(),
         allow_null=False,
     )
-    scoped_fields = factory.Faker("pylist", allowed_types=[str])
 
     @factory.lazy_attribute
     def contact(self):
@@ -308,22 +325,43 @@ class ObjectMetadataFactory(BaseModelFactory):
             raise RuntimeError(f"Unsupported metadatatype datatype {metadata_type_data_type}")
 
     @factory.lazy_attribute
-    def assigned_object_type(self):
-        while True:
-            allowed_content_types = list(self.metadata_type.content_types.values_list("pk", flat=True))
-            content_type = factory.random.randgen.choice(
-                ContentType.objects.filter(FeatureQuery("metadata").get_query(), pk__in=allowed_content_types)
-            )
+    def assigned_object(self):
+        allowed_content_types = list(self.metadata_type.content_types.all())
+        for content_type in factory.random.randgen.sample(allowed_content_types, len(allowed_content_types)):
             # It does not have a get_absolute_url attribute and is causing failure in API unittests
             if content_type.app_label == "extras" and content_type.model == "taggeditem":
                 continue
-            if content_type.model_class().objects.exists():
-                return content_type
+
+            assigned_model = content_type.model_class()
+            queryset = assigned_model.objects.all()
+
+            if not queryset.exists():
+                continue
+
+            for _ in range(10):
+                assigned_object = factory.random.randgen.choice(queryset)
+                if _available_field_names(self.metadata_type, assigned_object):
+                    return assigned_object
+
+        raise RuntimeError(f"Couldn't find any suitable instances not already covered by {self.metadata_type}")
 
     @factory.lazy_attribute
-    def assigned_object_id(self):
-        queryset = self.assigned_object_type.model_class().objects.all()
-        return factory.random.randgen.choice(queryset).pk
+    def scoped_fields(self):
+        all_field_names = [field.name for field in self.assigned_object._meta.get_fields()]
+        field_names = _available_field_names(self.metadata_type, self.assigned_object)
+        if not field_names:
+            raise RuntimeError(
+                f"All existing scoped_fields for {self.metadata_type} are covered by existing ObjectMetadata for {self.assigned_object}"
+            )
+
+        if len(field_names) < len(all_field_names):
+            minimum_fields = 1  # don't allow an empty list since that would cover all fields
+        else:
+            minimum_fields = 0
+
+        return factory.random.randgen.sample(
+            field_names, k=factory.random.randgen.randint(minimum_fields, len(field_names))
+        )
 
 
 class ObjectChangeFactory(BaseModelFactory):

nautobot/extras/filters/__init__.py

@@ -6,6 +6,7 @@ from django.contrib.contenttypes.models import ContentType
 from django.db.models import Q
 import django_filters
 from drf_spectacular.utils import extend_schema_field
+from timezone_field import TimeZoneField
 
 from nautobot.core.api.exceptions import SerializerNotFound
 from nautobot.core.api.utils import get_serializer_for_model
@@ -181,6 +182,7 @@ class ComputedFieldFilterSet(BaseFilterSet):
             "description": "icontains",
             "content_type__app_label": "icontains",
             "content_type__model": "icontains",
+            "grouping": "icontains",
             "template": "icontains",
             "fallback_value": "icontains",
         },
@@ -192,6 +194,7 @@ class ComputedFieldFilterSet(BaseFilterSet):
         fields = (
             "content_type",
             "key",
+            "grouping",
             "template",
             "fallback_value",
             "weight",
@@ -422,6 +425,7 @@ class CustomFieldFilterSet(BaseFilterSet):
         filter_predicates={
             "label": "icontains",
             "description": "icontains",
+            "grouping": "icontains",
         },
     )
     content_types = ContentTypeMultipleChoiceFilter(
@@ -430,7 +434,7 @@ class CustomFieldFilterSet(BaseFilterSet):
 
     class Meta:
         model = CustomField
-        fields = ["id", "content_types", "label", "required", "filter_logic", "weight"]
+        fields = ["id", "content_types", "label", "grouping", "required", "filter_logic", "weight"]
 
 
 class CustomFieldChoiceFilterSet(BaseFilterSet):
@@ -908,6 +912,7 @@ class JobResultFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "job_model__name": "icontains",
             "name": "icontains",
             "user__username": "icontains",
+            "scheduled_job__name": "icontains",
         },
     )
     job_model = NaturalKeyOrPKMultipleChoiceFilter(
@@ -919,11 +924,16 @@ class JobResultFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
         queryset=Job.objects.all(),
         label="Job (ID) - Deprecated (use job_model filter)",
     )
+    scheduled_job = NaturalKeyOrPKMultipleChoiceFilter(
+        to_field_name="name",
+        queryset=ScheduledJob.objects.all(),
+        label="Scheduled Job (name or ID)",
+    )
     status = django_filters.MultipleChoiceFilter(choices=JobResultStatusChoices, null_value=None)
 
     class Meta:
         model = JobResult
-        fields = ["id", "date_created", "date_done", "name", "status", "user"]
+        fields = ["id", "date_created", "date_done", "name", "status", "user", "scheduled_job"]
 
 
 class JobLogEntryFilterSet(BaseFilterSet):
@@ -957,10 +967,15 @@ class ScheduledJobFilterSet(BaseFilterSet):
         queryset=Job.objects.all(),
         label="Job (ID) - Deprecated (use job_model filter)",
     )
+    time_zone = django_filters.MultipleChoiceFilter(
+        choices=[(str(obj), name) for obj, name in TimeZoneField().choices],
+        label="Time zone",
+        null_value="",
+    )
 
     class Meta:
         model = ScheduledJob
-        fields = ["id", "name", "total_run_count", "start_time", "last_run_at"]
+        fields = ["id", "name", "total_run_count", "start_time", "last_run_at", "time_zone"]
 
 
 #

nautobot/extras/forms/base.py

@@ -26,11 +26,12 @@ __all__ = (
 
 
 class NautobotModelForm(
+    BootstrapMixin,
+    # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
     CustomFieldModelFormMixin,
     DynamicGroupModelFormMixin,
     NoteModelFormMixin,
     RelationshipModelFormMixin,
-    BootstrapMixin,
 ):
     """
     This class exists to combine common functionality and is used to inherit from throughout the
@@ -40,9 +41,10 @@ class NautobotModelForm(
 
 
 class NautobotFilterForm(
-    ContactTeamModelFilterFormMixin,
     BootstrapMixin,
-    CustomFieldModelFilterFormMixin,  # currently must come *after* BootstrapMixin to get proper CSS classes applied
+    # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
+    ContactTeamModelFilterFormMixin,
+    CustomFieldModelFilterFormMixin,
     RelationshipModelFilterFormMixin,
 ):
     """
@@ -53,6 +55,10 @@ class NautobotFilterForm(
 
 
 class NautobotBulkEditForm(
-    BootstrapMixin, CustomFieldModelBulkEditFormMixin, RelationshipModelBulkEditFormMixin, NoteModelBulkEditFormMixin
+    BootstrapMixin,
+    # The below must be listed *after* BootstrapMixin so that BootstrapMixin applies to their dynamic form fields
+    CustomFieldModelBulkEditFormMixin,
+    NoteModelBulkEditFormMixin,
+    RelationshipModelBulkEditFormMixin,
 ):
     """Base class for bulk-edit forms for models that support relationships, custom fields and notes."""

nautobot/extras/forms/forms.py

@@ -219,6 +219,7 @@ class ComputedFieldForm(BootstrapMixin, forms.ModelForm):
         fields = (
             "content_type",
             "label",
+            "grouping",
             "key",
             "description",
             "template",
@@ -1285,6 +1286,12 @@ class JobResultFilterForm(BootstrapMixin, forms.Form):
         required=False,
         widget=StaticSelect2Multiple(),
     )
+    scheduled_job = DynamicModelMultipleChoiceField(
+        label="Scheduled Job",
+        queryset=ScheduledJob.objects.all(),
+        required=False,
+        to_field_name="name",
+    )
 
 
 class ScheduledJobFilterForm(BootstrapMixin, forms.Form):

nautobot/extras/forms/mixins.py

@@ -174,7 +174,7 @@ class DynamicGroupModelFormMixin(forms.ModelForm):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        if self._meta.model.is_dynamic_group_associable_model:
+        if getattr(self._meta.model, "is_dynamic_group_associable_model", False):
             self.fields["dynamic_groups"] = DynamicModelMultipleChoiceField(
                 required=False,
                 initial=self.instance.dynamic_groups if self.instance else None,
@@ -193,7 +193,7 @@ class DynamicGroupModelFormMixin(forms.ModelForm):
 
     def save(self, commit=True):
         obj = super().save(commit=commit)
-        if commit and obj.is_dynamic_group_associable_model:
+        if commit and getattr(obj, "is_dynamic_group_associable_model", False):
             current_groups = set(obj.dynamic_groups.filter(group_type=DynamicGroupTypeChoices.TYPE_STATIC))
             for dynamic_group in set(self.cleaned_data.get("dynamic_groups")).difference(current_groups):
                 dynamic_group.add_members([obj])

nautobot/extras/homepage.py

@@ -7,14 +7,24 @@ def get_job_results(request):
     """Callback function to collect job history for panel."""
     return (
         JobResult.objects.filter(status__in=JobResultStatusChoices.READY_STATES)
-        .defer("result")
+        .restrict(request.user, "view")
+        .only("id", "name", "status", "date_done", "user")
         .order_by("-date_done")[:10]
     )
 
 
 def get_changelog(request):
     """Callback function to collect changelog for panel."""
-    return ObjectChange.objects.restrict(request.user, "view")[:15]
+    return ObjectChange.objects.restrict(request.user, "view").only(
+        "id",
+        "action",
+        "changed_object",
+        "changed_object_id",
+        "changed_object_type",
+        "object_repr",
+        "user_name",
+        "time",
+    )[:15]
 
 
 layout = (

nautobot/extras/jobs.py

@@ -20,7 +20,7 @@ from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.files.base import ContentFile
-from django.core.files.uploadedfile import InMemoryUploadedFile
+from django.core.files.uploadedfile import UploadedFile
 from django.core.validators import RegexValidator
 from django.db.models import Model
 from django.db.models.query import QuerySet
@@ -539,7 +539,7 @@ class BaseJob:
             elif isinstance(value, Model):
                 return_data[field_name] = value.pk
             # FileVar (Save each FileVar as a FileProxy)
-            elif isinstance(value, InMemoryUploadedFile):
+            elif isinstance(value, UploadedFile):
                 return_data[field_name] = BaseJob._save_file_to_proxy(value)
             # IPAddressVar, IPAddressWithMaskVar, IPNetworkVar
             elif isinstance(value, netaddr.ip.BaseIP):

nautobot/extras/management/__init__.py

@@ -32,6 +32,7 @@ STATUS_CHOICESET_MAP = {
     "ipam.IPAddress": ipam_choices.IPAddressStatusChoices,
     "ipam.Prefix": ipam_choices.PrefixStatusChoices,
     "ipam.VLAN": ipam_choices.VLANStatusChoices,
+    "ipam.VRF": ipam_choices.VRFStatusChoices,
     "virtualization.VirtualMachine": vm_choices.VirtualMachineStatusChoices,
     "virtualization.VMInterface": vm_choices.VMInterfaceStatusChoices,
 }
@@ -48,6 +49,7 @@ STATUS_COLOR_MAP = {
     "Decommissioning": ColorChoices.COLOR_AMBER,
     "Deprecated": ColorChoices.COLOR_RED,
     "Deprovisioning": ColorChoices.COLOR_AMBER,
+    "Down": ColorChoices.COLOR_AMBER,
     "End-of-Life": ColorChoices.COLOR_RED,
     "Extended Support": ColorChoices.COLOR_CYAN,
     "Failed": ColorChoices.COLOR_RED,
@@ -76,6 +78,7 @@ STATUS_DESCRIPTION_MAP = {
     "Decommissioning": "Unit is being decommissioned",
     "Deprecated": "Unit has been deprecated",
     "Deprovisioning": "Circuit is being deprovisioned",
+    "Down": "VRF is down",
     "End-of-Life": "Unit has reached end-of-life",
     "Extended Support": "Software is in extended support",
     "Failed": "Unit has failed",

nautobot/extras/migrations/0111_metadata.py

@@ -72,7 +72,7 @@ class Migration(migrations.Migration):
                 ("last_updated", models.DateTimeField(auto_now=True, null=True)),
                 (
                     "scoped_fields",
-                    nautobot.core.models.fields.JSONArrayField(base_field=models.CharField(max_length=255)),
+                    nautobot.core.models.fields.JSONArrayField(base_field=models.CharField(max_length=255), blank=True),
                 ),
                 ("_value", models.JSONField(blank=True, null=True)),
                 ("assigned_object_id", models.UUIDField(db_index=True)),
@@ -91,7 +91,7 @@ class Migration(migrations.Migration):
                         blank=True,
                         null=True,
                         on_delete=django.db.models.deletion.PROTECT,
-                        related_name="object_metadatas",
+                        related_name="object_metadata",
                         to="extras.contact",
                     ),
                 ),
@@ -99,7 +99,7 @@ class Migration(migrations.Migration):
                     "metadata_type",
                     models.ForeignKey(
                         on_delete=django.db.models.deletion.PROTECT,
-                        related_name="object_metadatas",
+                        related_name="object_metadata",
                         to="extras.metadatatype",
                     ),
                 ),
@@ -109,7 +109,7 @@ class Migration(migrations.Migration):
                         blank=True,
                         null=True,
                         on_delete=django.db.models.deletion.PROTECT,
-                        related_name="object_metadatas",
+                        related_name="object_metadata",
                         to="extras.team",
                     ),
                 ),

nautobot/extras/migrations/0114_computedfield_grouping.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.15 on 2024-08-09 14:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0113_saved_views"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="computedfield",
+            name="grouping",
+            field=models.CharField(blank=True, max_length=255),
+        ),
+    ]

nautobot/extras/migrations/0115_scheduledjob_time_zone.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.15 on 2024-08-19 13:44
+
+from django.db import migrations
+from django.utils import timezone
+import timezone_field.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0114_computedfield_grouping"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="scheduledjob",
+            name="time_zone",
+            field=timezone_field.fields.TimeZoneField(default=timezone.get_default_timezone_name),
+        ),
+        migrations.AlterModelOptions(
+            name="scheduledjob",
+            options={"ordering": ["name"]},
+        ),
+    ]

nautobot/extras/models/customfields.py

@@ -88,6 +88,11 @@ class ComputedField(
         help_text="Internal field name. Please use underscores rather than dashes in this key.",
         slugify_function=slugify_dashes_to_underscores,
     )
+    grouping = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+        help_text="Human-readable grouping that this computed field belongs to.",
+    )
     label = models.CharField(max_length=CHARFIELD_MAX_LENGTH, help_text="Name of the field as displayed to users")
     description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
     template = models.TextField(max_length=500, help_text="Jinja2 template code for field value")
@@ -295,6 +300,55 @@ class CustomFieldModel(models.Model):
             return computed_field.render(context={"obj": self})
         return computed_field.template
 
+    def get_computed_fields_grouping_basic(self):
+        """
+        This method exists to help call get_computed_field_groupings() in templates where a function argument (advanced_ui) cannot be specified.
+        Return a dictonary of computed fields grouped by the same grouping in the form
+        {
+            <grouping_1>: [(cf1, <value for cf1>), (cf2, <value for cf2>), ...],
+            ...
+            <grouping_5>: [(cf8, <value for cf8>), (cf9, <value for cf9>), ...],
+            ...
+        }
+        which have advanced_ui set to False
+        """
+        return self.get_computed_fields_grouping(advanced_ui=False)
+
+    def get_computed_fields_grouping_advanced(self):
+        """
+        This method exists to help call get_computed_field_groupings() in templates where a function argument (advanced_ui) cannot be specified.
+        Return a dictonary of computed fields grouped by the same grouping in the form
+        {
+            <grouping_1>: [(cf1, <value for cf1>), (cf2, <value for cf2>), ...],
+            ...
+            <grouping_5>: [(cf8, <value for cf8>), (cf9, <value for cf9>), ...],
+            ...
+        }
+        which have advanced_ui set to True
+        """
+        return self.get_computed_fields_grouping(advanced_ui=True)
+
+    def get_computed_fields_grouping(self, advanced_ui=None):
+        """
+        Return a dictonary of computed fields grouped by the same grouping in the form
+        {
+            <grouping_1>: [(cf1, <value for cf1>), (cf2, <value for cf2>), ...],
+            ...
+            <grouping_5>: [(cf8, <value for cf8>), (cf9, <value for cf9>), ...],
+            ...
+        }
+        """
+        record = {}
+        computed_fields = ComputedField.objects.get_for_model(self)
+        if advanced_ui is not None:
+            computed_fields = computed_fields.filter(advanced_ui=advanced_ui)
+
+        for field in computed_fields:
+            data = (field, field.render(context={"obj": self}))
+            record.setdefault(field.grouping, []).append(data)
+        record = dict(sorted(record.items()))
+        return record
+
     def get_computed_fields(self, label_as_key=False, advanced_ui=None):
         """
         Return a dictionary of all computed fields and their rendered values for this model.