nautobot 2.2.6__py3-none-any.whl → 2.2.7__py3-none-any.whl

nautobot/core/api/mixins.py

@@ -6,7 +6,7 @@ from django.core.exceptions import (
     MultipleObjectsReturned,
     ObjectDoesNotExist,
 )
-from django.db.models import AutoField
+from django.db.models import AutoField, Model
 from rest_framework.exceptions import ValidationError
 
 from nautobot.core.api.utils import dict_to_filter_params
@@ -70,6 +70,11 @@ class WritableSerializerMixin:
             # Strip the trailing slash and split on slashes, taking the last value as the PK.
             data = data.rstrip("/").split("/")[-1]
 
+        # If we're passing the validated_data from one serializer as input to another serializer,
+        # data might already be a model instance:
+        if isinstance(data, Model):
+            return {"pk": data.pk}
+
         try:
             # The int case here is taking into account for the User model we inherit from django
             pk = int(data) if isinstance(queryset.model._meta.pk, AutoField) else uuid.UUID(str(data))

nautobot/core/api/schema.py

@@ -4,7 +4,7 @@ import re
 from drf_spectacular.contrib.django_filters import DjangoFilterExtension
 from drf_spectacular.extensions import OpenApiSerializerFieldExtension
 from drf_spectacular.openapi import AutoSchema
-from drf_spectacular.plumbing import build_array_type, build_media_type_object, get_doc, is_serializer
+from drf_spectacular.plumbing import build_array_type, build_media_type_object, get_doc, is_serializer, list_hash
 from drf_spectacular.serializers import PolymorphicProxySerializerExtension
 from rest_framework import serializers
 from rest_framework.relations import ManyRelatedField
@@ -359,6 +359,8 @@ class ChoiceFieldFix(OpenApiSerializerFieldExtension):
             return {
                 "type": value_type,
                 "enum": list(choices.keys()),
+                # Used to deduplicate enums with the same set of choices, since drf-spectacular 0.27.2
+                "x-spec-enum-id": list_hash([(k, v) for k, v in choices.items() if k not in ("", None)]),
             }
         else:
             return {

nautobot/core/celery/__init__.py

@@ -109,7 +109,7 @@ def _import_jobs_from_git_repositories():
             and not GitRepository.objects.filter(slug=filename).exists()
         ):
             logger.warning("Deleting unmanaged (leftover?) Git repository clone at %s", filepath)
-            shutil.rmtree(filepath)
+            shutil.rmtree(filepath, ignore_errors=True)
 
     # Make sure all GitRepository records that include Jobs have up-to-date git clones, and load their jobs
     for repo in GitRepository.objects.filter(provided_contents__contains="extras.job"):

nautobot/core/tests/runner.py

@@ -1,8 +1,10 @@
 import copy
+import hashlib
 
 from django.conf import settings
 from django.core.management import call_command
 from django.db import connections
+from django.db.migrations.recorder import MigrationRecorder
 from django.test.runner import _init_worker, DiscoverRunner, ParallelTestSuite
 from django.test.utils import get_unique_databases_and_mirrors, NullTimeKeeper, override_settings
 import yaml
@@ -113,6 +115,14 @@ class NautobotTestRunner(DiscoverRunner):
                             command += ["--seed", settings.TEST_FACTORY_SEED]
                         if self.cache_test_fixtures:
                             command += ["--cache-test-fixtures"]
+                            # Use the list of applied migrations as a unique hash to keep fixtures from differing
+                            # branches/releases of Nautobot in separate files.
+                            hexdigest = hashlib.shake_128(
+                                ",".join(
+                                    sorted(f"{m.app}.{m.name}" for m in MigrationRecorder.Migration.objects.all())
+                                ).encode("utf-8")
+                            ).hexdigest(10)
+                            command += ["--fixture-file", f"development/factory_dump.{hexdigest}.json"]
                         with time_keeper.timed(f'  Pre-populating test database "{alias}" with factory data...'):
                             db_command = [*command, "--database", alias]
                             call_command(*db_command)

nautobot/extras/models/groups.py

@@ -597,10 +597,17 @@ class DynamicGroup(OrganizationalModel):
             query |= filter_field.generate_query(gq_value)
 
         # For vanilla multiple-choice filters, we want all values in a set union (boolean OR)
-        # because we want ANY of the filter values to match.
+        # because we want ANY of the filter values to match. Unless the filter field is explicitly
+        # conjoining the values, in which case we want a set intersection (boolean AND). We know this isn't right
+        # since the resulting query actually does tag.name == tag_1 AND tag.name == tag_2, but django_filter does
+        # not use Q evaluation for conjoined filters. This function is only used for the display, and the display
+        # is good enough to get the point across.
         elif isinstance(filter_field, django_filters.MultipleChoiceFilter):
             for v in value:
-                query |= models.Q(**filter_field.get_filter_predicate(v))
+                if filter_field.conjoined:
+                    query &= models.Q(**filter_field.get_filter_predicate(v))
+                else:
+                    query |= models.Q(**filter_field.get_filter_predicate(v))
 
         # The method `get_filter_predicate()` is only available on instances or subclasses
         # of `MultipleChoiceFilter`, so we must construct a lookup if a filter is not

nautobot/extras/tests/test_dynamicgroups.py

@@ -646,7 +646,7 @@ class DynamicGroupModelTest(DynamicGroupTestBase):  # TODO: BaseModelTestCase mi
 
         queryset = group.get_queryset()
 
-        # Assert that both querysets resturn the same results
+        # Assert that both querysets return the same results
         group_qs = queryset.filter(multi_query)
         device_qs = Device.objects.filter(location__name__in=multi_value)
         self.assertQuerySetEqual(group_qs, device_qs)
@@ -659,6 +659,13 @@ class DynamicGroupModelTest(DynamicGroupTestBase):  # TODO: BaseModelTestCase mi
         interface_qs = Device.objects.filter(interfaces__isnull=True)
         self.assertQuerySetEqual(solo_qs, interface_qs)
 
+        # Tags are conjoined in the TagFilterSet, ensure that tags__name is using AND. We know this isn't right
+        # since the resulting query actually does tag.name == tag_1 AND tag.name == tag_2, but django_filter does
+        # not use Q evaluation for conjoined filters. This function is only used for the display, and the display
+        # is good enough to get the point across.
+        tags_query = group.generate_query_for_filter(filter_field=fs.filters["tags"], value=["tag_1", "tag_2"])
+        self.assertEqual(str(tags_query), "(AND: ('tags__name', 'tag_1'), ('tags__name', 'tag_2'))")
+
         # Test that a nested field_name w/ `generate_query` works as expected. This is explicitly to
         # test a regression w/ nested name-related values such as `DeviceFilterSet.manufacturer` which
         # filters on `device_type__manufacturer`.

nautobot/extras/views.py

@@ -1069,7 +1069,7 @@ def check_and_call_git_repository_function(request, pk, func):
     # Allow execution only if a worker process is running.
     if not get_worker_count():
         messages.error(request, "Unable to run job: Celery worker process not running.")
-        return redirect(request.get_full_path(), permanent=False)
+        return redirect(reverse("extras:gitrepository", args=(pk,)), permanent=False)
     else:
         repository = get_object_or_404(GitRepository.objects.restrict(request.user, "change"), pk=pk)
         job_result = func(repository, request.user)

nautobot/ipam/api/serializers.py

@@ -321,27 +321,30 @@ class PrefixLocationAssignmentSerializer(ValidatedModelSerializer):
         fields = "__all__"
 
 
-class PrefixLengthSerializer(serializers.Serializer):
-    prefix_length = serializers.IntegerField()
-
-    def to_internal_value(self, data):
-        requested_prefix = data.get("prefix_length")
-        if requested_prefix is None:
-            raise serializers.ValidationError({"prefix_length": "this field can not be missing"})
-        if not isinstance(requested_prefix, int):
-            raise serializers.ValidationError({"prefix_length": "this field must be int type"})
-
-        prefix = self.context.get("prefix")
-        if prefix.ip_version == 4 and requested_prefix > 32:
-            raise serializers.ValidationError({"prefix_length": f"Invalid prefix length ({requested_prefix}) for IPv4"})
-        elif prefix.ip_version == 6 and requested_prefix > 128:
-            raise serializers.ValidationError({"prefix_length": f"Invalid prefix length ({requested_prefix}) for IPv6"})
-        return data
+class PrefixLengthSerializer(PrefixLegacySerializer):
+    """
+    Input serializer for POST to /api/ipam/prefixes/<id>/available-prefixes/, i.e. allocating one or more sub-prefixes.
+
+    Since setting of multiple locations on create is not supported, this uses the legacy single-location option.
+    """
+
+    prefix_length = serializers.IntegerField(required=True)
+
+    class Meta(PrefixLegacySerializer.Meta):
+        fields = PrefixLegacySerializer.Meta.fields.copy()
+        fields.remove("prefix")
+        fields.remove("network")
+        fields.remove("broadcast")
+        fields.remove("parent")
+        fields.remove("ip_version")
+        fields.remove("namespace")
 
 
 class AvailablePrefixSerializer(serializers.Serializer):
     """
     Representation of a prefix which does not exist in the database.
+
+    Response serializer for a GET to /api/ipam/prefixes/<id>/available-prefixes/.
     """
 
     ip_version = serializers.IntegerField(read_only=True)
@@ -437,6 +440,8 @@ class IPAddressSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
 class AvailableIPSerializer(serializers.Serializer):
     """
     Representation of an IP address which does not exist in the database.
+
+    Response serializer for a GET to /api/ipam/prefixes/<id>/available-ips/.
     """
 
     ip_version = serializers.IntegerField(read_only=True)
@@ -451,6 +456,31 @@ class AvailableIPSerializer(serializers.Serializer):
         )
 
 
+class IPAllocationSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
+    """
+    Input serializer for POST to /api/ipam/prefixes/<id>/available-ips/, i.e. allocating addresses from a prefix.
+    """
+
+    class Meta:
+        model = IPAddress
+        fields = (
+            # not address/namespace/parent as those are implied by the selected prefix
+            "status",
+            "type",
+            "dns_name",
+            "description",
+            "role",
+            "tenant",
+            "nat_inside",
+            "tags",
+            "custom_fields",
+        )
+
+    def validate(self, data):
+        data["mask_length"] = self.context["prefix"].prefix_length
+        return super().validate(data)
+
+
 #
 # IP address to interface
 #

nautobot/ipam/api/views.py

@@ -121,8 +121,6 @@ class PrefixViewSet(NautobotModelViewSet):
     filterset_class = filters.PrefixFilterSet
 
     def get_serializer_class(self):
-        if self.action == "available_prefixes" and self.request.method == "POST":
-            return serializers.PrefixLengthSerializer
         if (
             not getattr(self, "swagger_fake_view", False)
             and self.request.major_version == 2
@@ -159,7 +157,11 @@ class PrefixViewSet(NautobotModelViewSet):
             raise self.LocationIncompatibleLegacyBehavior from e
 
     @extend_schema(methods=["get"], responses={200: serializers.AvailablePrefixSerializer(many=True)})
-    @extend_schema(methods=["post"], responses={201: serializers.PrefixSerializer(many=False)})
+    @extend_schema(
+        methods=["post"],
+        request=serializers.PrefixLengthSerializer,
+        responses={201: serializers.PrefixSerializer(many=True)},
+    )
     @action(
         detail=True,
         name="Available Prefixes",
@@ -169,10 +171,10 @@ class PrefixViewSet(NautobotModelViewSet):
     )
     def available_prefixes(self, request, pk=None):
         """
-        A convenience method for returning available child prefixes within a parent.
+        A convenience method for listing and/or allocating available child prefixes within a parent.
 
-        The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
-        invoked in parallel, which results in a race condition where multiple insertions can occur.
+        This uses a Redis lock to prevent this API from being invoked in parallel, in order to avoid a race condition
+        if multiple clients tried to simultaneously request allocation from the same parent prefix.
         """
         prefix = get_object_or_404(self.queryset, pk=pk)
         if request.method == "POST":
@@ -214,9 +216,9 @@ class PrefixViewSet(NautobotModelViewSet):
                 # Initialize the serializer with a list or a single object depending on what was requested
                 context = {"request": request, "depth": 0}
                 if isinstance(request.data, list):
-                    serializer = serializers.PrefixSerializer(data=requested_prefixes, many=True, context=context)
+                    serializer = self.get_serializer_class()(data=requested_prefixes, many=True, context=context)
                 else:
-                    serializer = serializers.PrefixSerializer(data=requested_prefixes[0], context=context)
+                    serializer = self.get_serializer_class()(data=requested_prefixes[0], context=context)
 
                 # Create the new Prefix(es)
                 serializer.is_valid(raise_exception=True)
@@ -238,8 +240,8 @@ class PrefixViewSet(NautobotModelViewSet):
     @extend_schema(methods=["get"], responses={200: serializers.AvailableIPSerializer(many=True)})
     @extend_schema(
         methods=["post"],
-        responses={201: serializers.AvailableIPSerializer(many=True)},
-        request=serializers.AvailableIPSerializer(many=True),
+        responses={201: serializers.IPAddressSerializer(many=True)},
+        request=serializers.IPAllocationSerializer(many=True),
     )
     @action(
         detail=True,
@@ -251,12 +253,13 @@ class PrefixViewSet(NautobotModelViewSet):
     )
     def available_ips(self, request, pk=None):
         """
-        A convenience method for returning available IP addresses within a prefix. By default, the number of IPs
-        returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed,
-        however results will not be paginated.
+        A convenience method for listing and/or allocating available IP addresses within a prefix.
+
+        By default, the number of IPs returned will be equivalent to PAGINATE_COUNT.
+        An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.
 
-        The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being
-        invoked in parallel, which results in a race condition where multiple insertions can occur.
+        This uses a Redis lock to prevent this API from being invoked in parallel, in order to avoid a race condition
+        if multiple clients tried to simultaneously request allocation from the same parent prefix.
         """
         prefix = get_object_or_404(Prefix.objects.restrict(request.user), pk=pk)
 
@@ -266,7 +269,17 @@ class PrefixViewSet(NautobotModelViewSet):
                 "nautobot.ipam.api.views.available_ips", blocking_timeout=5, timeout=settings.REDIS_LOCK_TIMEOUT
             ):
                 # Normalize to a list of objects
-                requested_ips = request.data if isinstance(request.data, list) else [request.data]
+                serializer = serializers.IPAllocationSerializer(
+                    data=request.data if isinstance(request.data, list) else [request.data],
+                    many=True,
+                    context={
+                        "request": request,
+                        "prefix": prefix,
+                    },
+                )
+                serializer.is_valid(raise_exception=True)
+
+                requested_ips = serializer.validated_data
 
                 # Determine if the requested number of IPs is available
                 available_ips = prefix.get_available_ips()

nautobot/ipam/tests/test_api.py

@@ -454,7 +454,6 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
         for i in range(4):
             data = {
                 "prefix_length": child_prefix_length,
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
                 "description": f"Test Prefix {i + 1}",
             }
@@ -464,13 +463,18 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             self.assertEqual(str(response.data["namespace"]["url"]), self.absolute_api_url(prefix.namespace))
             self.assertEqual(response.data["description"], data["description"])
 
-        # Try to create one more prefix
-        response = self.client.post(url, {"prefix_length": child_prefix_length}, format="json", **self.header)
+        # Try to create one more prefix, and expect a HTTP 204 response.
+        # This feels wrong to me (shouldn't it be a 4xx or 5xx?) but it's how the API has historically behaved.
+        response = self.client.post(
+            url, {"prefix_length": child_prefix_length, "status": self.status.pk}, format="json", **self.header
+        )
         self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
         self.assertIn("detail", response.data)
 
-        # Try to create invalid prefix type
-        response = self.client.post(url, {"prefix_length": str(child_prefix_length)}, format="json", **self.header)
+        # Invalid data does trigger a HTTP 400 response.
+        response = self.client.post(
+            url, {"prefix_length": "hello", "status": self.status.pk}, format="json", **self.header
+        )
         self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
         self.assertIn("prefix_length", response.data[0])
 
@@ -495,35 +499,31 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             {
                 "prefix_length": child_prefix_length,
                 "description": "Test Prefix 1",
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
             },
             {
                 "prefix_length": child_prefix_length,
                 "description": "Test Prefix 2",
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
             },
             {
                 "prefix_length": child_prefix_length,
                 "description": "Test Prefix 3",
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
             },
             {
                 "prefix_length": child_prefix_length,
                 "description": "Test Prefix 4",
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
             },
             {
                 "prefix_length": child_prefix_length,
                 "description": "Test Prefix 5",
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
             },
         ]
         response = self.client.post(url, data, format="json", **self.header)
+        # This feels wrong to me (shouldn't it be a 4xx or 5xx?) but it's how the API has historically behaved.
         self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
         self.assertIn("detail", response.data)
 
@@ -577,7 +577,6 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
         for i in range(1, 7):
             data = {
                 "description": f"Test IP {i}",
-                "namespace": self.namespace.pk,
                 "status": self.status.pk,
             }
             response = self.client.post(url, data, format="json", **self.header)
@@ -586,7 +585,8 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
             self.assertEqual(response.data["description"], data["description"])
 
         # Try to create one more IP
-        response = self.client.post(url, {}, format="json", **self.header)
+        response = self.client.post(url, {"status": self.status.pk}, format="json", **self.header)
+        # This feels wrong to me (shouldn't it be a 4xx or 5xx?) but it's how the API has historically behaved.
         self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
         self.assertIn("detail", response.data)
 
@@ -604,19 +604,14 @@ class PrefixTest(APIViewTestCases.APIViewTestCase):
         self.add_permissions("ipam.view_prefix", "ipam.add_ipaddress", "extras.view_status")
 
         # Try to create seven IPs (only six are available)
-        data = [
-            {"description": f"Test IP {i}", "namespace": self.namespace.pk, "status": self.status.pk}
-            for i in range(1, 8)
-        ]  # 7 IPs
+        data = [{"description": f"Test IP {i}", "status": self.status.pk} for i in range(1, 8)]  # 7 IPs
         response = self.client.post(url, data, format="json", **self.header)
+        # This feels wrong to me (shouldn't it be a 4xx or 5xx?) but it's how the API has historically behaved.
         self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
         self.assertIn("detail", response.data)
 
         # Create all six available IPs in a single request
-        data = [
-            {"description": f"Test IP {i}", "namespace": self.namespace.pk, "status": self.status.pk}
-            for i in range(1, 7)
-        ]  # 6 IPs
+        data = [{"description": f"Test IP {i}", "status": self.status.pk} for i in range(1, 7)]  # 6 IPs
         response = self.client.post(url, data, format="json", **self.header)
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
         self.assertEqual(len(response.data), 6)

nautobot/project-static/docs/404.html

@@ -12,7 +12,7 @@
       
       
       <link rel="icon" href="/projects/core/en/stable/assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.28">
     
     
       
@@ -7913,7 +7913,7 @@
     <script id="__config" type="application/json">{"base": "/projects/core/en/stable/", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "/projects/core/en/stable/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="/projects/core/en/stable/assets/javascripts/bundle.ad660dcc.min.js"></script>
+      <script src="/projects/core/en/stable/assets/javascripts/bundle.fe8b6f2b.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/apps/index.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.28">
     
     
       
@@ -8080,7 +8080,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.ad660dcc.min.js"></script>
+      <script src="../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/apps/nautobot-apps.html

@@ -16,7 +16,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.28">
     
     
       
@@ -8014,7 +8014,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.ad660dcc.min.js"></script>
+      <script src="../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>