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

nautobot/extras/__init__.py

@@ -1 +0,0 @@
-default_app_config = "nautobot.extras.apps.ExtrasConfig"

nautobot/extras/api/serializers.py

@@ -66,22 +66,33 @@ from nautobot.extras.models import (
     JobHook,
     JobLogEntry,
     JobResult,
+    MetadataChoice,
+    MetadataType,
     Note,
     ObjectChange,
+    ObjectMetadata,
     Relationship,
     RelationshipAssociation,
     Role,
+    SavedView,
     ScheduledJob,
     Secret,
     SecretsGroup,
     SecretsGroupAssociation,
+    StaticGroupAssociation,
     Status,
     Tag,
     Team,
+    UserSavedViewAssociation,
     Webhook,
 )
 from nautobot.extras.models.mixins import NotesMixin
-from nautobot.extras.utils import ChangeLoggedModelsQuery, FeatureQuery, RoleModelsQuery, TaggableClassesQuery
+from nautobot.extras.utils import (
+    ChangeLoggedModelsQuery,
+    FeatureQuery,
+    RoleModelsQuery,
+    TaggableClassesQuery,
+)
 
 from .fields import MultipleChoiceJSONField
 
@@ -322,7 +333,7 @@ class DynamicGroupMembershipSerializer(ValidatedModelSerializer):
         fields = "__all__"
 
 
-class DynamicGroupSerializer(NautobotModelSerializer):
+class DynamicGroupSerializer(TaggedModelSerializerMixin, NautobotModelSerializer):
     content_type = ContentTypeField(
         queryset=ContentType.objects.filter(FeatureQuery("dynamic_groups").get_query()).order_by("app_label", "model"),
     )
@@ -332,10 +343,52 @@ class DynamicGroupSerializer(NautobotModelSerializer):
         fields = "__all__"
         extra_kwargs = {
             "children": {"source": "dynamic_group_memberships", "read_only": True},
-            "filter": {"read_only": False},
+            "filter": {"read_only": False, "required": False},
         }
 
 
+class SavedViewSerializer(ValidatedModelSerializer):
+    class Meta:
+        model = SavedView
+        fields = "__all__"
+
+
+class UserSavedViewAssociationSerializer(ValidatedModelSerializer):
+    class Meta:
+        model = UserSavedViewAssociation
+        fields = "__all__"
+        validators = []
+
+
+class StaticGroupAssociationSerializer(NautobotModelSerializer):
+    associated_object_type = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("dynamic_groups").get_query()).order_by("app_label", "model"),
+    )
+    associated_object = serializers.SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = StaticGroupAssociation
+        fields = "__all__"
+
+    @extend_schema_field(
+        PolymorphicProxySerializer(
+            component_name="DynamicGroupAssociatedObject",
+            resource_type_field_name="object_type",
+            serializers=lambda: nested_serializers_for_models(FeatureQuery("dynamic_groups").list_subclasses()),
+        )
+    )
+    def get_associated_object(self, obj):
+        if obj.associated_object is None:
+            return None
+        try:
+            depth = get_nested_serializer_depth(self)
+            return return_nested_serializer_data_based_on_depth(
+                self, depth, obj, obj.associated_object, "associated_object"
+            )
+        except SerializerNotFound:
+            return None
+
+
 #
 # Export templates
 #
@@ -735,6 +788,63 @@ class JobButtonSerializer(ValidatedModelSerializer, NotesSerializerMixin):
         fields = "__all__"
 
 
+#
+# Metadata
+#
+
+
+class MetadataTypeSerializer(NautobotModelSerializer):
+    content_types = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("metadata").get_query()),
+        many=True,
+    )
+
+    class Meta:
+        model = MetadataType
+        fields = "__all__"
+
+
+class MetadataChoiceSerializer(ValidatedModelSerializer):
+    class Meta:
+        model = MetadataChoice
+        fields = "__all__"
+
+
+class ObjectMetadataValueJSONField(serializers.JSONField):
+    """Special class to discern between itself and serializers.JSONField in NautobotCSVParser"""
+
+
+class ObjectMetadataSerializer(ValidatedModelSerializer):
+    assigned_object_type = ContentTypeField(
+        queryset=ContentType.objects.filter(FeatureQuery("metadata").get_query()),
+    )
+    assigned_object = serializers.SerializerMethodField()
+    value = ObjectMetadataValueJSONField(allow_null=True, required=False)
+
+    class Meta:
+        model = ObjectMetadata
+        fields = "__all__"
+
+    @extend_schema_field(
+        PolymorphicProxySerializer(
+            component_name="ObjectMetadataAssignedObject",
+            resource_type_field_name="object_type",
+            serializers=lambda: nested_serializers_for_models(FeatureQuery("metadata").list_subclasses()),
+            allow_null=True,
+        )
+    )
+    def get_assigned_object(self, obj):
+        if obj.assigned_object is None:
+            return None
+        try:
+            depth = get_nested_serializer_depth(self)
+            return return_nested_serializer_data_based_on_depth(
+                self, depth, obj, obj.assigned_object, "assigned_object"
+            )
+        except SerializerNotFound:
+            return None
+
+
 #
 # Notes
 #
@@ -962,6 +1072,8 @@ class TagSerializer(NautobotModelSerializer):
 
 
 class TeamSerializer(NautobotModelSerializer):
+    contacts = NautobotHyperlinkedRelatedField(queryset=Contact.objects.all(), many=True, required=False)
+
     class Meta:
         model = Team
         fields = "__all__"

nautobot/extras/api/urls.py

@@ -31,6 +31,13 @@ router.register("custom-links", views.CustomLinkViewSet)
 router.register("dynamic-groups", views.DynamicGroupViewSet)
 router.register("dynamic-group-memberships", views.DynamicGroupMembershipViewSet)
 
+# Saved Views
+router.register("saved-views", views.SavedViewViewSet)
+router.register("user-saved-view-associations", views.UserSavedViewAssociationViewSet)
+
+# Static Groups
+router.register("static-group-associations", views.StaticGroupAssociationViewSet)
+
 # Export templates
 router.register("export-templates", views.ExportTemplateViewSet)
 
@@ -68,6 +75,11 @@ router.register("job-results", views.JobResultViewSet)
 # Scheduled Jobs
 router.register("scheduled-jobs", views.ScheduledJobViewSet)
 
+# Metadata
+router.register("metadata-types", views.MetadataTypeViewSet)
+router.register("metadata-choices", views.MetadataChoiceViewSet)
+router.register("object-metadata", views.ObjectMetadataViewSet)
+
 # Notes
 router.register("notes", views.NoteViewSet)
 

nautobot/extras/api/views.py

@@ -1,3 +1,5 @@
+from datetime import timedelta
+
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.forms import ValidationError as FormsValidationError
@@ -54,19 +56,25 @@ from nautobot.extras.models import (
     JobHook,
     JobLogEntry,
     JobResult,
+    MetadataChoice,
+    MetadataType,
     Note,
     ObjectChange,
+    ObjectMetadata,
     Relationship,
     RelationshipAssociation,
     Role,
+    SavedView,
     ScheduledJob,
     Secret,
     SecretsGroup,
     SecretsGroupAssociation,
+    StaticGroupAssociation,
     Status,
     Tag,
     TaggedItem,
     Team,
+    UserSavedViewAssociation,
     Webhook,
 )
 from nautobot.extras.secrets.exceptions import SecretError
@@ -323,6 +331,43 @@ class DynamicGroupMembershipViewSet(ModelViewSet):
     filterset_class = filters.DynamicGroupMembershipFilterSet
 
 
+#
+# Saved Views
+#
+
+
+class SavedViewViewSet(ModelViewSet):
+    queryset = SavedView.objects.select_related("owner")
+    serializer_class = serializers.SavedViewSerializer
+    filterset_class = filters.SavedViewFilterSet
+
+
+class UserSavedViewAssociationViewSet(ModelViewSet):
+    queryset = UserSavedViewAssociation.objects.select_related("user", "saved_view")
+    serializer_class = serializers.UserSavedViewAssociationSerializer
+    filterset_class = filters.UserSavedViewAssociationFilterSet
+
+
+class StaticGroupAssociationViewSet(NautobotModelViewSet):
+    """
+    Manage Static Group Associations through DELETE, GET, POST, PUT, and PATCH requests.
+    """
+
+    queryset = StaticGroupAssociation.objects.select_related("associated_object_type", "dynamic_group")
+    serializer_class = serializers.StaticGroupAssociationSerializer
+    filterset_class = filters.StaticGroupAssociationFilterSet
+
+    def get_queryset(self):
+        if (
+            hasattr(self, "request")
+            and self.request is not None
+            and "dynamic_group" in self.request.GET
+            and self.action in ["list", "retrieve"]
+        ):
+            self.queryset = StaticGroupAssociation.all_objects.select_related("associated_object_type", "dynamic_group")
+        return super().get_queryset()
+
+
 #
 # Export templates
 #
@@ -447,6 +492,59 @@ 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
@@ -646,16 +744,13 @@ class JobViewSetBase(
 
         # Try to create a ScheduledJob, or...
         if schedule_data:
-            schedule = ScheduledJob.create_schedule(
+            schedule = _create_schedule(
+                schedule_data,
+                job_class.serialize_data(cleaned_data),
                 job_model,
                 request.user,
-                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,
+                approval_required,
                 task_queue=input_serializer.validated_data.get("task_queue", None),
-                **job_class.serialize_data(cleaned_data),
             )
         else:
             schedule = None
@@ -932,6 +1027,29 @@ class ScheduledJobViewSet(ReadOnlyModelViewSet):
         return Response(serializer.data)
 
 
+#
+# Metadata
+#
+
+
+class MetadataTypeViewSet(NautobotModelViewSet):
+    queryset = MetadataType.objects.all()
+    serializer_class = serializers.MetadataTypeSerializer
+    filterset_class = filters.MetadataTypeFilterSet
+
+
+class MetadataChoiceViewSet(ModelViewSet):
+    queryset = MetadataChoice.objects.select_related("metadata_type")
+    serializer_class = serializers.MetadataChoiceSerializer
+    filterset_class = filters.MetadataChoiceFilterSet
+
+
+class ObjectMetadataViewSet(NautobotModelViewSet):
+    queryset = ObjectMetadata.objects.all()
+    serializer_class = serializers.ObjectMetadataSerializer
+    filterset_class = filters.ObjectMetadataFilterSet
+
+
 #
 # Notes
 #

nautobot/extras/apps.py

@@ -11,6 +11,7 @@ logger = logging.getLogger(__name__)
 
 
 class ExtrasConfig(NautobotConfig):
+    default = True
     name = "nautobot.extras"
     searchable_models = [
         "contact",
@@ -30,12 +31,11 @@ class ExtrasConfig(NautobotConfig):
         from graphene_django.converter import convert_django_field
 
         from nautobot.core.models.fields import TagsField
-        from nautobot.extras.graphql.types import TagType
 
         @convert_django_field.register(TagsField)
         def convert_field_to_list_tags(field, registry=None):
             """Convert TagsField to List of Tags."""
-            return graphene.List(TagType)
+            return graphene.List("nautobot.extras.graphql.types.TagType")
 
         from nautobot.extras.plugins.validators import wrap_model_clean_methods
 

nautobot/extras/choices.py

@@ -161,6 +161,18 @@ class CustomLinkButtonClassChoices(ButtonClassChoices):
 #
 
 
+class DynamicGroupTypeChoices(ChoiceSet):
+    TYPE_DYNAMIC_FILTER = "dynamic-filter"
+    TYPE_DYNAMIC_SET = "dynamic-set"
+    TYPE_STATIC = "static"
+
+    CHOICES = (
+        (TYPE_DYNAMIC_FILTER, "Filter-defined"),
+        (TYPE_DYNAMIC_SET, "Group of groups"),
+        (TYPE_STATIC, "Static assignment"),
+    )
+
+
 class DynamicGroupOperatorChoices(ChoiceSet):
     OPERATOR_UNION = "union"
     OPERATOR_INTERSECTION = "intersection"
@@ -301,6 +313,37 @@ class LogLevelChoices(ChoiceSet):
     }
 
 
+#
+# Metadata
+#
+
+
+class MetadataTypeDataTypeChoices(CustomFieldTypeChoices):
+    """
+    Values for the MetadataType.data_type field.
+
+    Generally equivalent to CustomFieldTypeChoices, but adds TYPE_CONTACT_OR_TEAM.
+    """
+
+    TYPE_CONTACT_TEAM = "contact-or-team"
+    # TODO: these should be migrated to CustomFieldTypeChoices and support added in CustomField data
+    TYPE_DATETIME = "datetime"
+    TYPE_FLOAT = "float"
+
+    CHOICES = (
+        *CustomFieldTypeChoices.CHOICES,
+        (TYPE_CONTACT_TEAM, "Contact or Team"),
+        # TODO: these should be migrated to CustomFieldTypeChoices and support added in CustomField data
+        (TYPE_DATETIME, "Date/time"),
+        (TYPE_FLOAT, "Floating point number"),
+    )
+
+    MIN_MAX_TYPES = (
+        *CustomFieldTypeChoices.MIN_MAX_TYPES,
+        TYPE_FLOAT,
+    )
+
+
 #
 # ObjectChanges
 #

nautobot/extras/context_managers.py

@@ -90,14 +90,19 @@ class ChangeContext:
             for key in self._object_change_batch(batch_size):
                 for entry in self.deferred_object_changes[key]:
                     objectchange = entry["instance"].to_objectchange(entry["action"])
-                    objectchange.user = entry["user"]
-                    objectchange.user_name = objectchange.user.username
-                    objectchange.request_id = self.change_id
-                    objectchange.change_context = self.context
-                    objectchange.change_context_detail = self.context_detail[:CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL]
-                    if not objectchange.changed_object_id:
-                        objectchange.changed_object_id = entry.get("changed_object_id")
-                    create_object_changes.append(objectchange)
+                    if objectchange is not None:
+                        objectchange.user = entry["user"]
+                        objectchange.user_name = objectchange.user.username
+                        objectchange.request_id = self.change_id
+                        objectchange.change_context = self.context
+                        objectchange.change_context_detail = self.context_detail[:CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL]
+                        if not objectchange.changed_object_id:  # changed_object was deleted
+                            # Clear out the GenericForeignKey to keep Django from complaining about an unsaved object:
+                            objectchange.changed_object = None
+                            # Set the component fields individually:
+                            objectchange.changed_object_id = entry.get("changed_object_id")
+                            objectchange.changed_object_type = entry.get("changed_object_type")
+                        create_object_changes.append(objectchange)
                 self.deferred_object_changes.pop(key, None)
             ObjectChange.objects.bulk_create(create_object_changes, batch_size=batch_size)
 

nautobot/extras/datasources/git.py

@@ -517,6 +517,8 @@ def import_local_config_context(local_type, device_name, context_data, repositor
             record = Device.objects.get(name=device_name)
         elif local_type == "virtual_machines":
             record = VirtualMachine.objects.get(name=device_name)
+        else:
+            raise ValueError(f"Unknown local_type value: {local_type}")
     except MultipleObjectsReturned:
         # Possible for Device as name is not guaranteed globally unique
         # TODO: come up with a design that accounts for non-unique names, as well as un-named Devices.