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

nautobot/dcim/tests/test_api.py

@@ -506,6 +506,13 @@ class RackTest(APIViewTestCases.APIViewTestCase):
                 "role": rack_roles[1].pk,
                 "status": statuses[1].pk,
             },
+            # Make sure rack_group is not interpreted as a required field
+            {
+                "name": "Test Rack 7",
+                "location": locations[1].pk,
+                "role": rack_roles[1].pk,
+                "status": statuses[1].pk,
+            },
         ]
         cls.bulk_update_data = {
             "status": statuses[1].pk,
@@ -1539,7 +1546,7 @@ class InterfaceTest(Mixins.BasePortTestMixin):
             ),
         )
 
-        vlan_group = VLANGroup.objects.first()
+        vlan_group = VLANGroup.objects.create(name="Test VLANGroup 1")
         vlan_status = Status.objects.get_for_model(VLAN).first()
         cls.vlans = (
             VLAN.objects.create(name="VLAN 1", vid=1, status=vlan_status, vlan_group=vlan_group),

nautobot/dcim/tests/test_filters.py

@@ -137,12 +137,13 @@ def common_test_data(cls):
     CircuitTermination.objects.create(circuit=circuit, location=loc0, term_side="A")
     CircuitTermination.objects.create(circuit=circuit, location=loc1, term_side="Z")
 
-    manufacturers = list(Manufacturer.objects.all()[:3])
+    manufacturers = list(
+        Manufacturer.objects.filter(device_types__isnull=False, platforms__isnull=False).distinct()[:3]
+    )
     cls.manufacturers = manufacturers
 
-    platforms = Platform.objects.all()[:3]
+    platforms = Platform.objects.filter(manufacturer__in=manufacturers)[:3]
     for num, platform in enumerate(platforms):
-        platform.manufacturer = manufacturers[num]
         platform.napalm_driver = f"driver-{num}"
         platform.napalm_args = ["--test", f"--arg{num}"]
         platform.network_driver = f"driver_{num}"
@@ -651,6 +652,7 @@ class LocationFilterSetTestCase(FilterTestCases.NameOnlyFilterTestCase, FilterTe
         ("racks", "racks__id"),
         ("racks", "racks__name"),
         ("shipping_address",),
+        ("status", "status__id"),
         ("status", "status__name"),
         ("time_zone",),
         ("vlan_groups", "vlan_groups__id"),
@@ -765,7 +767,9 @@ class RackTestCase(FilterTestCases.FilterTestCase, FilterTestCases.TenancyFilter
         ("rack_group", "rack_group__name"),
         ("rack_reservations", "rack_reservations__id"),
         ("role", "role__name"),
+        ("role", "role__id"),
         ("serial",),
+        ("status", "status__id"),
         ("status", "status__name"),
         ("type",),
         ("u_height",),
@@ -1331,6 +1335,7 @@ class DeviceTestCase(FilterTestCases.FilterTestCase, FilterTestCases.TenancyFilt
         ("role", "role__name"),
         ("secrets_group", "secrets_group__id"),
         ("secrets_group", "secrets_group__name"),
+        ("status", "status__id"),
         ("status", "status__name"),
         ("vc_position",),
         ("vc_priority",),
@@ -1824,6 +1829,7 @@ class InterfaceTestCase(FilterTestCases.FilterTestCase):
         ("name",),
         ("parent_interface", "parent_interface__id"),
         ("parent_interface", "parent_interface__name"),
+        ("status", "status__id"),
         ("status", "status__name"),
         ("type",),
         ("tagged_vlans", "tagged_vlans__id"),
@@ -2579,6 +2585,7 @@ class CableTestCase(FilterTestCases.FilterTestCase):
         ("color",),
         ("label",),
         ("length",),
+        ("status", "status__id"),
         ("status", "status__name"),
         ("termination_a_id",),
         ("termination_b_id",),
@@ -2869,6 +2876,7 @@ class PowerFeedTestCase(FilterTestCases.FilterTestCase):
         ("power_panel", "power_panel__name"),
         ("rack", "rack__id"),
         ("rack", "rack__name"),
+        ("status", "status__id"),
         ("status", "status__name"),
         ("voltage",),
     ]

nautobot/dcim/views.py

@@ -13,8 +13,7 @@ from django.forms import (
 )
 from django.shortcuts import get_object_or_404, redirect, render
 from django.utils.functional import cached_property
-from django.utils.html import escape
-from django.utils.safestring import mark_safe
+from django.utils.html import format_html
 from django.views.generic import View
 from django_tables2 import RequestConfig
 
@@ -2634,8 +2633,8 @@ class VirtualChassisAddMemberView(ObjectPermissionRequiredMixin, GetReturnURLMix
 
             if membership_form.is_valid():
                 membership_form.save()
-                msg = f'Added member <a href="{device.get_absolute_url()}">{escape(device)}</a>'
-                messages.success(request, mark_safe(msg))
+                msg = format_html('Added member <a href="{}">{}</a>', device.get_absolute_url(), device)
+                messages.success(request, msg)
 
                 if "_addanother" in request.POST:
                     return redirect(request.get_full_path())
@@ -2684,8 +2683,8 @@ class VirtualChassisRemoveMemberView(ObjectPermissionRequiredMixin, GetReturnURL
         # Protect master device from being removed
         virtual_chassis = VirtualChassis.objects.filter(master=device).first()
         if virtual_chassis is not None:
-            msg = f"Unable to remove master device {escape(device)} from the virtual chassis."
-            messages.error(request, mark_safe(msg))
+            msg = format_html("Unable to remove master device {} from the virtual chassis.", device)
+            messages.error(request, msg)
             return redirect(device.get_absolute_url())
 
         if form.is_valid():

nautobot/extras/admin.py

@@ -31,7 +31,7 @@ class FileProxyForm(forms.ModelForm):
 @admin.register(FileProxy)
 class FileProxyAdmin(NautobotModelAdmin):
     form = FileProxyForm
-    list_display = ["name", "uploaded_at"]
+    list_display = ["name", "file", "uploaded_at"]
     list_filter = ["uploaded_at"]
 
 

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/context_managers.py

@@ -2,10 +2,13 @@ import uuid
 from contextlib import contextmanager
 
 from django.contrib.auth import get_user_model
+from django.contrib.auth.models import AnonymousUser
 from django.test.client import RequestFactory
 
 from nautobot.extras.choices import ObjectChangeEventContextChoices
+from nautobot.extras.models import ObjectChange
 from nautobot.extras.signals import change_context_state
+from nautobot.extras.webhooks import enqueue_webhooks
 
 
 class ChangeContext:
@@ -95,7 +98,9 @@ def change_logging(change_context):
 
 
 @contextmanager
-def web_request_context(user, context_detail="", change_id=None):
+def web_request_context(
+    user, context_detail="", change_id=None, context=ObjectChangeEventContextChoices.CONTEXT_ORM, request=None
+):
     """
     Emulate the context of an HTTP request, which provides functions like change logging and webhook processing
     in response to data changes. This context manager is for use with low level utility tooling, such as the
@@ -116,13 +121,34 @@ def web_request_context(user, context_detail="", change_id=None):
     :param user: User object
     :param context_detail: Optional extra details about the transaction (ex: the plugin name that initiated the change)
     :param change_id: Optional uuid object to uniquely identify the transaction. One will be generated if not supplied
+    :param context: Optional string value of the generated change log entries' "change_context" field, defaults to ObjectChangeEventContextChoices.CONTEXT_ORM.
+        Valid choices are in nautobot.extras.choices.ObjectChangeEventContextChoices
+    :param request: Optional web request instance, one will be generated if not supplied
     """
+    from nautobot.extras.jobs import enqueue_job_hooks  # prevent circular import
 
-    if not isinstance(user, get_user_model()):
-        raise TypeError("The user object must be an instance of nautobot.users.models.User")
+    valid_contexts = {
+        ObjectChangeEventContextChoices.CONTEXT_JOB: JobChangeContext,
+        ObjectChangeEventContextChoices.CONTEXT_JOB_HOOK: JobHookChangeContext,
+        ObjectChangeEventContextChoices.CONTEXT_ORM: ORMChangeContext,
+        ObjectChangeEventContextChoices.CONTEXT_WEB: WebChangeContext,
+    }
 
-    request = RequestFactory().request(SERVER_NAME="web_request_context")
-    request.user = user
-    change_context = ORMChangeContext(request=request, context_detail=context_detail, change_id=change_id)
-    with change_logging(change_context):
-        yield request
+    if context not in valid_contexts:
+        raise TypeError(f"{context} is not a valid context")
+
+    if not isinstance(user, (get_user_model(), AnonymousUser)):
+        raise TypeError(f"{user} is not a valid user object")
+
+    if request is None:
+        request = RequestFactory().request(SERVER_NAME="web_request_context")
+        request.user = user
+    change_context = valid_contexts[context](request=request, context_detail=context_detail, change_id=change_id)
+    try:
+        with change_logging(change_context):
+            yield request
+    finally:
+        # enqueue jobhooks and webhooks, use change_context.change_id in case change_id was not supplied
+        for object_change in ObjectChange.objects.filter(request_id=change_context.change_id).iterator():
+            enqueue_job_hooks(object_change)
+            enqueue_webhooks(object_change)

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
 #