nautobot 2.0.5__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

nautobot/extras/api/serializers.py

@@ -51,6 +51,8 @@ from nautobot.extras.models import (
     DynamicGroup,
     DynamicGroupMembership,
     ExportTemplate,
+    ExternalIntegration,
+    FileProxy,
     GitRepository,
     GraphQLQuery,
     ImageAttachment,
@@ -293,6 +295,28 @@ class ExportTemplateSerializer(RelationshipModelSerializerMixin, ValidatedModelS
         return return_nested_serializer_data_based_on_depth(self, depth, obj, obj.owner, "owner")
 
 
+#
+# External integrations
+#
+
+
+class ExternalIntegrationSerializer(NautobotModelSerializer):
+    class Meta:
+        model = ExternalIntegration
+        fields = "__all__"
+
+
+#
+# File proxies
+#
+
+
+class FileProxySerializer(BaseModelSerializer):
+    class Meta:
+        model = FileProxy
+        exclude = ["file"]
+
+
 #
 # Git repositories
 #
@@ -444,6 +468,15 @@ class JobResultSerializer(CustomFieldModelSerializerMixin, BaseModelSerializer):
     class Meta:
         model = JobResult
         fields = "__all__"
+        extra_kwargs = {
+            "files": {"read_only": True},
+        }
+
+    def get_field_names(self, declared_fields, info):
+        """Add reverse relation to related FileProxy objects."""
+        fields = list(super().get_field_names(declared_fields, info))
+        self.extend_field_names(fields, "files")
+        return fields
 
 
 class JobRunResponseSerializer(serializers.Serializer):

nautobot/extras/api/urls.py

@@ -31,6 +31,12 @@ router.register("dynamic-group-memberships", views.DynamicGroupMembershipViewSet
 # Export templates
 router.register("export-templates", views.ExportTemplateViewSet)
 
+# External integrations
+router.register("external-integrations", views.ExternalIntegrationViewSet)
+
+# File proxies
+router.register("file-proxies", views.FileProxyViewSet)
+
 # Git repositories
 router.register("git-repositories", views.GitRepositoryViewSet)
 

nautobot/extras/api/views.py

@@ -1,22 +1,22 @@
 from datetime import timedelta
+
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.forms import ValidationError as FormsValidationError
-from django.http import Http404
+from django.http import FileResponse, Http404
 from django.shortcuts import get_object_or_404
 from django.utils import timezone
 from drf_spectacular.types import OpenApiTypes
-from drf_spectacular.utils import extend_schema, extend_schema_view, OpenApiParameter
+from drf_spectacular.utils import OpenApiParameter, extend_schema, extend_schema_view
 from graphene_django.views import GraphQLView
 from graphql import GraphQLError
-from rest_framework import status
+from rest_framework import mixins, status, viewsets
 from rest_framework.decorators import action
 from rest_framework.exceptions import MethodNotAllowed, PermissionDenied, ValidationError
 from rest_framework.parsers import JSONParser, MultiPartParser
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 from rest_framework.routers import APIRootView
-from rest_framework import mixins, viewsets
 
 from nautobot.core.api.authentication import TokenPermissions
 from nautobot.core.api.utils import get_serializer_for_model
@@ -38,10 +38,14 @@ from nautobot.extras.models import (
     ComputedField,
     ConfigContext,
     ConfigContextSchema,
+    CustomField,
+    CustomFieldChoice,
+    CustomLink,
     DynamicGroup,
     DynamicGroupMembership,
-    CustomLink,
     ExportTemplate,
+    ExternalIntegration,
+    FileProxy,
     GitRepository,
     GraphQLQuery,
     ImageAttachment,
@@ -64,9 +68,9 @@ from nautobot.extras.models import (
     TaggedItem,
     Webhook,
 )
-from nautobot.extras.models import CustomField, CustomFieldChoice
 from nautobot.extras.secrets.exceptions import SecretError
 from nautobot.extras.utils import get_worker_count
+
 from . import serializers
 
 
@@ -321,6 +325,41 @@ class ExportTemplateViewSet(NotesViewSetMixin, ModelViewSet):
     filterset_class = filters.ExportTemplateFilterSet
 
 
+#
+# External integrations
+#
+
+
+class ExternalIntegrationViewSet(NautobotModelViewSet):
+    queryset = ExternalIntegration.objects.select_related("secrets_group")
+    serializer_class = serializers.ExternalIntegrationSerializer
+    filterset_class = filters.ExternalIntegrationFilterSet
+
+
+#
+# File proxies
+#
+
+
+class FileProxyViewSet(ReadOnlyModelViewSet):
+    queryset = FileProxy.objects.select_related("job_result")
+    serializer_class = serializers.FileProxySerializer
+    filterset_class = filters.FileProxyFilterSet
+
+    @extend_schema(
+        methods=["get"],
+        responses=OpenApiTypes.BINARY,
+    )
+    @action(
+        detail=True,
+        methods=["get"],
+    )
+    def download(self, request, *args, **kwargs):
+        """Download the specified FileProxy."""
+        file_proxy = self.get_object()
+        return FileResponse(file_proxy.file.open("rb"), as_attachment=True)
+
+
 #
 # Git repositories
 #

nautobot/extras/factory.py

@@ -3,11 +3,37 @@ import factory
 import faker
 
 from nautobot.core.choices import ColorChoices
-from nautobot.core.factory import NautobotBoolIterator, OrganizationalModelFactory, get_random_instances
-from nautobot.extras.models import Role, Status, Tag
+from nautobot.core.factory import (
+    get_random_instances,
+    NautobotBoolIterator,
+    OrganizationalModelFactory,
+    PrimaryModelFactory,
+    UniqueFaker,
+)
+from nautobot.extras.models import ExternalIntegration, Role, Status, Tag
 from nautobot.extras.utils import FeatureQuery, RoleModelsQuery, TaggableClassesQuery
 
 
+class ExternalIntegrationFactory(PrimaryModelFactory):
+    """ExternalIntegration model factory."""
+
+    class Meta:
+        model = ExternalIntegration
+
+    class Params:
+        has_extra_config = NautobotBoolIterator()
+
+    name = UniqueFaker("bs")
+    remote_url = factory.Faker("url", schemes=["http", "https", "ssh"])
+    verify_ssl = factory.Faker("boolean")
+    timeout = factory.Faker("pyint", min_value=0, max_value=300)
+    extra_config = factory.Maybe(
+        "has_extra_config",
+        factory.Faker("pydict", allowed_types=[bool, int, str]),
+        None,
+    )
+
+
 class RoleFactory(OrganizationalModelFactory):
     """Role model factory."""
 

nautobot/extras/filters/__init__.py

@@ -9,6 +9,7 @@ from nautobot.core.filters import (
     ContentTypeMultipleChoiceFilter,
     MultiValueUUIDFilter,
     NaturalKeyOrPKMultipleChoiceFilter,
+    RelatedMembershipBooleanFilter,
     SearchFilter,
 )
 from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
@@ -52,6 +53,8 @@ from nautobot.extras.models import (
     DynamicGroup,
     DynamicGroupMembership,
     ExportTemplate,
+    ExternalIntegration,
+    FileProxy,
     GitRepository,
     GraphQLQuery,
     ImageAttachment,
@@ -101,6 +104,7 @@ __all__ = (
     "DynamicGroupFilterSet",
     "DynamicGroupMembershipFilterSet",
     "ExportTemplateFilterSet",
+    "FileProxyFilterSet",
     "GitRepositoryFilterSet",
     "GraphQLQueryFilterSet",
     "ImageAttachmentFilterSet",
@@ -484,6 +488,54 @@ class ExportTemplateFilterSet(BaseFilterSet):
         fields = ["id", "content_type", "owner_content_type", "owner_object_id", "name"]
 
 
+#
+# External integrations
+#
+
+
+class ExternalIntegrationFilterSet(NautobotFilterSet):
+    has_secrets_group = RelatedMembershipBooleanFilter(
+        field_name="secrets_group",
+        label="Has secrets group",
+    )
+    secrets_group = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=SecretsGroup.objects.all(),
+        label="Secrets group (ID or name)",
+    )
+
+    class Meta:
+        model = ExternalIntegration
+        fields = "__all__"
+
+
+#
+# File proxies
+#
+
+
+class FileProxyFilterSet(BaseFilterSet):
+    q = SearchFilter(
+        filter_predicates={
+            "name": "icontains",
+            "job_result__job_model__name": "icontains",
+        },
+    )
+    job = NaturalKeyOrPKMultipleChoiceFilter(
+        field_name="job_result__job_model",
+        to_field_name="name",
+        queryset=Job.objects.all(),
+        label="Job (name or ID)",
+    )
+    job_result_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=JobResult.objects.all(),
+        label="Job Result (ID)",
+    )
+
+    class Meta:
+        model = FileProxy
+        fields = ["id", "name", "uploaded_at", "job", "job_result_id"]
+
+
 #
 # Datasources (Git)
 #

nautobot/extras/filters/mixins.py

@@ -291,19 +291,13 @@ class RelationshipModelFilterSetMixin(django_filters.FilterSet):
 
 
 class RoleFilter(NaturalKeyOrPKMultipleChoiceFilter):
-    """Limit role choices to the available role choices for self.model"""
+    """Filter field used for filtering Role fields."""
 
     def __init__(self, *args, **kwargs):
-        kwargs.setdefault("field_name", "role")
         kwargs.setdefault("queryset", Role.objects.all())
-        kwargs.setdefault("to_field_name", "name")
         kwargs.setdefault("label", "Role (name or ID)")
-
         super().__init__(*args, **kwargs)
 
-    def get_queryset(self, request):
-        return self.queryset.get_for_model(self.model)
-
 
 class RoleModelFilterSetMixin(django_filters.FilterSet):
     """
@@ -313,35 +307,16 @@ class RoleModelFilterSetMixin(django_filters.FilterSet):
     role = RoleFilter()
 
 
-class StatusFilter(django_filters.ModelMultipleChoiceFilter):
+class StatusFilter(NaturalKeyOrPKMultipleChoiceFilter):
     """
     Filter field used for filtering Status fields.
-
-    Explicitly sets `to_field_name='value'` and dynamically sets queryset to
-    retrieve choices for the corresponding model & field name bound to the
-    filterset.
     """
 
     def __init__(self, *args, **kwargs):
-        kwargs["to_field_name"] = "name"
+        kwargs.setdefault("queryset", Status.objects.all())
+        kwargs.setdefault("label", "Status (name or ID)")
         super().__init__(*args, **kwargs)
 
-    def get_queryset(self, request):
-        self.queryset = Status.objects.all()
-        return super().get_queryset(request)
-
-    def get_filter_predicate(self, value):
-        """Always use the field's name and the `to_field_name` attribute as predicate."""
-        # e.g. `status__name`
-        to_field_name = self.field.to_field_name
-        name = f"{self.field_name}__{to_field_name}"
-        # Sometimes the incoming value is an instance. This block of logic comes from the base
-        # `get_filter_predicate()` and was added here to support this.
-        try:
-            return {name: getattr(value, to_field_name)}
-        except (AttributeError, TypeError):
-            return {name: value}
-
 
 class StatusModelFilterSetMixin(django_filters.FilterSet):
     """

nautobot/extras/forms/forms.py

@@ -1,3 +1,5 @@
+import inspect
+
 from django import forms
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -49,6 +51,7 @@ from nautobot.extras.models import (
     DynamicGroup,
     DynamicGroupMembership,
     ExportTemplate,
+    ExternalIntegration,
     GitRepository,
     GraphQLQuery,
     ImageAttachment,
@@ -108,6 +111,8 @@ __all__ = (
     "DynamicGroupMembershipFormSet",
     "ExportTemplateForm",
     "ExportTemplateFilterForm",
+    "ExternalIntegrationForm",
+    "ExternalIntegrationBulkEditForm",
     "GitRepositoryForm",
     "GitRepositoryBulkEditForm",
     "GitRepositoryFilterForm",
@@ -568,6 +573,44 @@ class ExportTemplateFilterForm(BootstrapMixin, forms.Form):
     )
 
 
+#
+# External integrations
+#
+
+
+class ExternalIntegrationForm(NautobotModelForm):
+    class Meta:
+        model = ExternalIntegration
+        fields = "__all__"
+
+        EXTRA_CONFIG_HELP_TEXT = """
+            Optional user-defined <a href="https://json.org/">JSON</a> data for this integration. Example:
+            <pre><code>{
+                "headers": {
+                    "Accept": "application/json",
+                    "Content-Type": "application/json",
+                },
+            }</code></pre>
+        """
+        help_texts = {"extra_config": inspect.cleandoc(EXTRA_CONFIG_HELP_TEXT)}
+
+
+class ExternalIntegrationBulkEditForm(NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(
+        queryset=ExternalIntegration.objects.all(),
+        widget=forms.MultipleHiddenInput(),
+    )
+    remote_url = forms.CharField(required=False, label="Remote URL")
+    secrets_group = DynamicModelChoiceField(required=False, queryset=SecretsGroup.objects.all())
+    verify_ssl = forms.NullBooleanField(required=False, label="Verify SSL", widget=BulkEditNullBooleanSelect)
+    timeout = forms.IntegerField(required=False, min_value=0)
+    extra_config = forms.JSONField(required=False)
+
+    class Meta:
+        model = ExternalIntegration
+        nullable_fields = ["extra_config", "secrets_group"]
+
+
 #
 # Git repositories and other data sources
 #

nautobot/extras/jobs.py

@@ -21,6 +21,7 @@ from db_file_storage.form_widgets import DBClearableFileInput
 from django import forms
 from django.conf import settings
 from django.contrib.auth import get_user_model
+from django.core.files.base import ContentFile
 from django.core.files.uploadedfile import InMemoryUploadedFile
 from django.core.validators import RegexValidator
 from django.db.models import Model
@@ -306,7 +307,7 @@ class BaseJob(Task):
         file_fields = list(self._get_file_vars())
         file_ids = [kwargs[f] for f in file_fields]
         if file_ids:
-            self.delete_files(*file_ids)
+            self._delete_file_proxies(*file_ids)
 
         self.logger.info("Job completed", extra={"grouping": "post_run"})
 
@@ -531,8 +532,10 @@ class BaseJob(Task):
     @classmethod
     def _get_vars(cls):
         """
-        Return dictionary of ScriptVariable attributes defined on this class and any base classes to the top of the inheritance chain.
-        The variables are sorted in the order that they were defined, with variables defined on base classes appearing before subclass variables.
+        Return dictionary of ScriptVariable attributes defined on this class or any of its base parent classes.
+
+        The variables are sorted in the order that they were defined,
+        with variables defined on base classes appearing before subclass variables.
         """
         cls_vars = {}
         # get list of base classes, including cls, in reverse method resolution order: [BaseJob, Job, cls]
@@ -661,7 +664,7 @@ class BaseJob(Task):
                 return_data[field_name] = value.pk
             # FileVar (Save each FileVar as a FileProxy)
             elif isinstance(value, InMemoryUploadedFile):
-                return_data[field_name] = BaseJob.save_file(value)
+                return_data[field_name] = BaseJob._save_file_to_proxy(value)
             # IPAddressVar, IPAddressWithMaskVar, IPNetworkVar
             elif isinstance(value, netaddr.ip.BaseIP):
                 return_data[field_name] = str(value)
@@ -721,7 +724,7 @@ class BaseJob(Task):
                 else:
                     return_data[field_name] = var.field_attrs["queryset"].get(pk=value)
             elif isinstance(var, FileVar):
-                return_data[field_name] = cls.load_file(value)
+                return_data[field_name] = cls._load_file_from_proxy(value)
             # IPAddressVar is a netaddr.IPAddress object
             elif isinstance(var, IPAddressVar):
                 return_data[field_name] = netaddr.IPAddress(value)
@@ -758,20 +761,20 @@ class BaseJob(Task):
         return {k: v for k, v in job_kwargs.items() if k in job_vars}
 
     @staticmethod
-    def load_file(pk):
+    def _load_file_from_proxy(pk):
         """Load a file proxy stored in the database by primary key.
 
         Args:
             pk (uuid): Primary key of the `FileProxy` to retrieve
 
         Returns:
-            (FileProxy): A File-like object
+            (File): A File-like object
         """
         fp = FileProxy.objects.get(pk=pk)
         return fp.file
 
     @staticmethod
-    def save_file(uploaded_file):
+    def _save_file_to_proxy(uploaded_file):
         """
         Save an uploaded file to the database as a file proxy and return the
         primary key.
@@ -785,7 +788,7 @@ class BaseJob(Task):
         fp = FileProxy.objects.create(name=uploaded_file.name, file=uploaded_file)
         return fp.pk
 
-    def delete_files(self, *files_to_delete):
+    def _delete_file_proxies(self, *files_to_delete):
         """Given an unpacked list of primary keys for `FileProxy` objects, delete them.
 
         Args:
@@ -824,6 +827,25 @@ class BaseJob(Task):
 
         return data
 
+    def create_file(self, filename, content):
+        """
+        Create a file that can later be downloaded by users.
+
+        Args:
+            filename (str): Name of the file to create, including extension
+            content (str, bytes): Content to populate the created file with.
+
+        Returns:
+            (FileProxy): record that was created
+        """
+        if isinstance(content, str):
+            content = content.encode("utf-8")
+        fp = FileProxy.objects.create(
+            name=filename, job_result=self.job_result, file=ContentFile(content, name=filename)
+        )
+        self.logger.info("Created file [%s](%s)", filename, fp.file.url)
+        return fp
+
 
 class Job(BaseJob):
     """

nautobot/extras/migrations/0100_fileproxy_job_result.py

@@ -0,0 +1,32 @@
+# Generated by Django 3.2.22 on 2023-10-27 16:32
+
+from django.db import migrations, models
+import django.db.models.deletion
+import nautobot.extras.models.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0099_remove_dangling_note_objects"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="fileproxy",
+            name="job_result",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="files",
+                to="extras.jobresult",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="fileproxy",
+            name="file",
+            field=models.FileField(
+                storage=nautobot.extras.models.models._job_storage, upload_to=nautobot.extras.models.models._upload_to
+            ),
+        ),
+    ]

nautobot/extras/migrations/0101_externalintegration.py

@@ -0,0 +1,61 @@
+# Generated by Django 3.2.22 on 2023-11-01 21:29
+
+import django.core.serializers.json
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+import nautobot.core.models.fields
+import nautobot.core.models.validators
+import nautobot.extras.models.mixins
+import uuid
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0100_fileproxy_job_result"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ExternalIntegration",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("name", models.CharField(max_length=255, unique=True)),
+                (
+                    "remote_url",
+                    models.CharField(
+                        max_length=500, validators=[nautobot.core.models.validators.EnhancedURLValidator()]
+                    ),
+                ),
+                ("verify_ssl", models.BooleanField(default=True)),
+                ("timeout", models.IntegerField(default=30, validators=[django.core.validators.MinValueValidator(0)])),
+                ("extra_config", models.JSONField(blank=True, null=True)),
+                (
+                    "secrets_group",
+                    models.ForeignKey(
+                        blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to="extras.secretsgroup"
+                    ),
+                ),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                models.Model,
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+            ),
+        ),
+    ]

nautobot/extras/migrations/0102_set_null_objectchange_contenttype.py

@@ -0,0 +1,32 @@
+# Generated by Django 3.2.23 on 2023-11-27 20:43
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("extras", "0101_externalintegration"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="objectchange",
+            name="changed_object_type",
+            field=models.ForeignKey(
+                null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="+", to="contenttypes.contenttype"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="objectchange",
+            name="related_object_type",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="contenttypes.contenttype",
+            ),
+        ),
+    ]

nautobot/extras/models/__init__.py

@@ -19,6 +19,7 @@ from .models import (
     ConfigContextSchema,
     CustomLink,
     ExportTemplate,
+    ExternalIntegration,
     FileAttachment,
     FileProxy,
     GraphQLQuery,
@@ -45,6 +46,7 @@ __all__ = (
     "DynamicGroup",
     "DynamicGroupMembership",
     "ExportTemplate",
+    "ExternalIntegration",
     "FileAttachment",
     "FileProxy",
     "GitRepository",

nautobot/extras/models/change_logging.py

@@ -84,7 +84,7 @@ class ObjectChange(BaseModel):
     user_name = models.CharField(max_length=150, editable=False)
     request_id = models.UUIDField(editable=False, db_index=True)
     action = models.CharField(max_length=50, choices=ObjectChangeActionChoices)
-    changed_object_type = models.ForeignKey(to=ContentType, on_delete=models.PROTECT, related_name="+")
+    changed_object_type = models.ForeignKey(to=ContentType, on_delete=models.SET_NULL, null=True, related_name="+")
     changed_object_id = models.UUIDField(db_index=True)
     changed_object = GenericForeignKey(ct_field="changed_object_type", fk_field="changed_object_id")
     change_context = models.CharField(
@@ -96,7 +96,7 @@ class ObjectChange(BaseModel):
     change_context_detail = models.CharField(max_length=CHANGELOG_MAX_CHANGE_CONTEXT_DETAIL, blank=True, editable=False)
     related_object_type = models.ForeignKey(
         to=ContentType,
-        on_delete=models.PROTECT,
+        on_delete=models.SET_NULL,
         related_name="+",
         blank=True,
         null=True,