nautobot 2.4.1__py3-none-any.whl → 2.4.2__py3-none-any.whl

nautobot/extras/tests/test_utils.py

@@ -4,13 +4,34 @@ import uuid
 from django.core.cache import cache
 
 from nautobot.core.testing import TestCase
+from nautobot.dcim.models import Device, LocationType
 from nautobot.extras.choices import JobQueueTypeChoices
 from nautobot.extras.models import JobQueue
 from nautobot.extras.registry import registry
-from nautobot.extras.utils import get_celery_queues, get_worker_count, populate_model_features_registry
+from nautobot.extras.utils import (
+    get_base_template,
+    get_celery_queues,
+    get_worker_count,
+    populate_model_features_registry,
+)
+from nautobot.users.models import Token
 
 
 class UtilsTestCase(TestCase):
+    def test_get_base_template(self):
+        with self.subTest("explicitly specified base_template always wins"):
+            self.assertEqual(get_base_template("dcim/device/base.html", Device), "dcim/device/base.html")
+
+        with self.subTest("<model>.html wins over <model>_retrieve.html"):
+            # TODO: why do we even have both locationtype.html and locationtype_retrieve.html?
+            self.assertEqual(get_base_template(None, LocationType), "dcim/locationtype.html")
+
+        with self.subTest("<model>_retrieve.html is used if present"):
+            self.assertEqual(get_base_template(None, JobQueue), "extras/jobqueue_retrieve.html")
+
+        with self.subTest("generic/object_retrieve.html is used as a fallback"):
+            self.assertEqual(get_base_template(None, Token), "generic/object_retrieve.html")
+
     @mock.patch("celery.app.control.Inspect.active_queues")
     def test_get_celery_queues(self, mock_active_queues):
         with self.subTest("No queues"):

nautobot/extras/utils.py

@@ -6,6 +6,7 @@ import hmac
 import logging
 import re
 import sys
+from typing import Optional
 
 from django.apps import apps
 from django.conf import settings
@@ -13,7 +14,7 @@ from django.contrib.contenttypes.models import ContentType
 from django.core.cache import cache
 from django.core.validators import ValidationError
 from django.db import transaction
-from django.db.models import Q
+from django.db.models import Model, Q
 from django.template.loader import get_template, TemplateDoesNotExist
 from django.utils.deconstruct import deconstructible
 import kubernetes.client
@@ -36,16 +37,24 @@ from nautobot.extras.registry import registry
 logger = logging.getLogger(__name__)
 
 
-def get_base_template(base_template, model):
+def get_base_template(base_template: Optional[str], model: type[Model]) -> str:
     """
-    Returns the name of the base template, if the base_template is not None
-    Otherwise, default to using "<app>/<model>.html" as the base template, if it exists.
-    Otherwise, check if "<app>/<model>_retrieve.html" used in `NautobotUIViewSet` exists.
-    If both templates do not exist, fall back to "base.html".
+    Attempt to locate the correct base template for an object detail view and related views, if one was not specified.
+
+    Args:
+        base_template (str, optional): If not None, this explicitly specified template will be preferred.
+        model (Model): The model to identify a base template for, if base_template is None.
+
+    Returns the specified `base_template`, if not `None`.
+    Otherwise, if `"<app>/<model_name>.html"` exists (legacy ObjectView pattern), returns that string.
+    Otherwise, if `"<app>/<model_name>_retrieve.html"` exists (as used in `NautobotUIViewSet`), returns that string.
+    If all else fails, returns `"generic/object_retrieve.html"`.
+
+    Note: before Nautobot 2.4.2, this API would default to "base.html" rather than "generic/object_retrieve.html".
+    This behavior was changed to the current behavior to address issue #6550 and similar incorrect behavior.
     """
     if base_template is None:
         base_template = f"{model._meta.app_label}/{model._meta.model_name}.html"
-        # 2.0 TODO(Hanlin): This can be removed once an object view has been established for every model.
         try:
             get_template(base_template)
         except TemplateDoesNotExist:
@@ -53,7 +62,7 @@ def get_base_template(base_template, model):
             try:
                 get_template(base_template)
             except TemplateDoesNotExist:
-                base_template = "base.html"
+                base_template = "generic/object_retrieve.html"
     return base_template
 
 

nautobot/extras/views.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Optional
 from urllib.parse import parse_qs
 
 from django.contrib import messages
@@ -31,6 +32,7 @@ from nautobot.core.models.utils import pretty_print_query, serialize_object_v2
 from nautobot.core.tables import ButtonsColumn
 from nautobot.core.ui import object_detail
 from nautobot.core.ui.choices import SectionChoices
+from nautobot.core.ui.object_detail import ObjectDetailContent, ObjectFieldsPanel
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.lookup import (
     get_filterset_for_model,
@@ -900,10 +902,13 @@ class DynamicGroupBulkDeleteView(generic.BulkDeleteView):
 class ObjectDynamicGroupsView(generic.GenericView):
     """
     Present a list of dynamic groups associated to a particular object.
-    base_template: The name of the template to extend. If not provided, "<app>/<model>.html" will be used.
+
+    base_template: Specify to explicitly identify the base object detail template to render.
+        If not provided, "<app>/<model>.html", "<app>/<model>_retrieve.html", or "generic/object_retrieve.html"
+        will be used, as per `get_base_template()`.
     """
 
-    base_template = None
+    base_template: Optional[str] = None
 
     def get(self, request, model, **kwargs):
         # Handle QuerySet restriction of parent object if needed
@@ -926,7 +931,7 @@ class ObjectDynamicGroupsView(generic.GenericView):
         }
         RequestConfig(request, paginate).configure(dynamicgroups_table)
 
-        self.base_template = get_base_template(self.base_template, model)
+        base_template = get_base_template(self.base_template, model)
 
         return render(
             request,
@@ -936,7 +941,7 @@ class ObjectDynamicGroupsView(generic.GenericView):
                 "verbose_name": obj._meta.verbose_name,
                 "verbose_name_plural": obj._meta.verbose_name_plural,
                 "table": dynamicgroups_table,
-                "base_template": self.base_template,
+                "base_template": base_template,
                 "active_tab": "dynamic-groups",
             },
         )
@@ -2185,10 +2190,13 @@ class ObjectChangeView(generic.ObjectView):
 class ObjectChangeLogView(generic.GenericView):
     """
     Present a history of changes made to a particular object.
-    base_template: The name of the template to extend. If not provided, "<app>/<model>.html" will be used.
+
+    base_template: Specify to explicitly identify the base object detail template to render.
+        If not provided, "<app>/<model>.html", "<app>/<model>_retrieve.html", or "generic/object_retrieve.html"
+        will be used, as per `get_base_template()`.
     """
 
-    base_template = None
+    base_template: Optional[str] = None
 
     def get(self, request, model, **kwargs):
         # Handle QuerySet restriction of parent object if needed
@@ -2216,7 +2224,7 @@ class ObjectChangeLogView(generic.GenericView):
         }
         RequestConfig(request, paginate).configure(objectchanges_table)
 
-        self.base_template = get_base_template(self.base_template, model)
+        base_template = get_base_template(self.base_template, model)
 
         return render(
             request,
@@ -2226,7 +2234,7 @@ class ObjectChangeLogView(generic.GenericView):
                 "verbose_name": obj._meta.verbose_name,
                 "verbose_name_plural": obj._meta.verbose_name_plural,
                 "table": objectchanges_table,
-                "base_template": self.base_template,
+                "base_template": base_template,
                 "active_tab": "changelog",
             },
         )
@@ -2319,10 +2327,13 @@ class NoteDeleteView(generic.ObjectDeleteView):
 class ObjectNotesView(generic.GenericView):
     """
     Present a list of notes associated to a particular object.
-    base_template: The name of the template to extend. If not provided, "<app>/<model>.html" will be used.
+
+    base_template: Specify to explicitly identify the base object detail template to render.
+        If not provided, "<app>/<model>.html", "<app>/<model>_retrieve.html", or "generic/object_retrieve.html"
+        will be used, as per `get_base_template()`.
     """
 
-    base_template = None
+    base_template: Optional[str] = None
 
     def get(self, request, model, **kwargs):
         # Handle QuerySet restriction of parent object if needed
@@ -2346,7 +2357,7 @@ class ObjectNotesView(generic.GenericView):
         }
         RequestConfig(request, paginate).configure(notes_table)
 
-        self.base_template = get_base_template(self.base_template, model)
+        base_template = get_base_template(self.base_template, model)
 
         return render(
             request,
@@ -2356,7 +2367,7 @@ class ObjectNotesView(generic.GenericView):
                 "verbose_name": obj._meta.verbose_name,
                 "verbose_name_plural": obj._meta.verbose_name_plural,
                 "table": notes_table,
-                "base_template": self.base_template,
+                "base_template": base_template,
                 "active_tab": "notes",
                 "form": notes_form,
             },
@@ -2378,6 +2389,38 @@ class RelationshipListView(generic.ObjectListView):
 
 class RelationshipView(generic.ObjectView):
     queryset = Relationship.objects.all()
+    object_detail_content = ObjectDetailContent(
+        panels=(
+            ObjectFieldsPanel(
+                label="Relationship",
+                section=SectionChoices.LEFT_HALF,
+                weight=100,
+                fields="__all__",
+                exclude_fields=[
+                    "source_type",
+                    "source_label",
+                    "source_hidden",
+                    "source_filter",
+                    "destination_type",
+                    "destination_label",
+                    "destination_hidden",
+                    "destination_filter",
+                ],
+            ),
+            ObjectFieldsPanel(
+                label="Source Attributes",
+                section=SectionChoices.RIGHT_HALF,
+                weight=100,
+                fields=["source_type", "source_label", "source_hidden", "source_filter"],
+            ),
+            ObjectFieldsPanel(
+                label="Destination Attributes",
+                section=SectionChoices.RIGHT_HALF,
+                weight=200,
+                fields=["destination_type", "destination_label", "destination_hidden", "destination_filter"],
+            ),
+        )
+    )
 
 
 class RelationshipEditView(generic.ObjectEditView):

nautobot/ipam/models.py

@@ -975,7 +975,10 @@ class Prefix(PrimaryModel):
         while `<Prefix 10.0.0.0/16>.get_all_ips()` will return *both* 10.0.0.1.24 and 10.0.1.1/24.
         """
         return IPAddress.objects.filter(
-            parent__namespace=self.namespace, host__gte=self.network, host__lte=self.broadcast
+            parent__namespace=self.namespace,
+            ip_version=self.ip_version,
+            host__gte=self.network,
+            host__lte=self.broadcast,
         )
 
     def get_first_available_prefix(self):
@@ -1016,7 +1019,10 @@ class Prefix(PrimaryModel):
         # change this when that is the case, see #3873 for historical context.
         if self.type != choices.PrefixTypeChoices.TYPE_CONTAINER:
             pool_ips = IPAddress.objects.filter(
-                parent__namespace=self.namespace, host__gte=self.network, host__lte=self.broadcast
+                parent__namespace=self.namespace,
+                ip_version=self.ip_version,
+                host__gte=self.network,
+                host__lte=self.broadcast,
             ).values_list("host", flat=True)
             child_ips = netaddr.IPSet(pool_ips)
 

nautobot/ipam/tables.py

@@ -79,7 +79,7 @@ IPADDRESS_LINK = """
 {% elif perms.ipam.add_ipaddress %}
     <a href="\
 {% url 'ipam:ipaddress_add' %}\
-?address={{ record.1 }}\
+?address={{ record.1 }}&namespace={{ object.namespace.pk }}\
 {% if object.vrf %}&vrf={{ object.vrf.pk }}{% endif %}\
 {% if object.tenant %}&tenant={{ object.tenant.pk }}{% endif %}\
 " class="btn btn-xs btn-success">\
@@ -101,7 +101,7 @@ IPADDRESS_COPY_LINK = """
 {% elif perms.ipam.add_ipaddress %}
     <a href="\
 {% url 'ipam:ipaddress_add' %}\
-?address={{ record.1 }}\
+?address={{ record.1 }}&namespace={{ object.namespace.pk }}\
 {% if object.vrf %}&vrf={{ object.vrf.pk }}{% endif %}\
 {% if object.tenant %}&tenant={{ object.tenant.pk }}{% endif %}\
 " class="btn btn-xs btn-success">\

nautobot/ipam/templates/ipam/ipaddress.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 {% load render_table from django_tables2 %}
 

nautobot/ipam/templates/ipam/prefix.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block breadcrumbs %}

nautobot/ipam/templates/ipam/rir.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block content_left_page %}

nautobot/ipam/templates/ipam/routetarget.html

@@ -1 +1 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}

nautobot/ipam/templates/ipam/service.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block extra_breadcrumbs %}

nautobot/ipam/templates/ipam/vlan.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
 
 {% block extra_breadcrumbs %}

nautobot/ipam/templates/ipam/vlangroup.html

@@ -1,4 +1,4 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}
 {% load buttons %}
 {% load helpers %}
 {% load plugins %}

nautobot/ipam/templates/ipam/vrf.html

@@ -1 +1 @@
-{% extends 'generic/object_detail.html' %}
+{% extends 'generic/object_retrieve.html' %}

nautobot/ipam/tests/test_models.py

@@ -827,6 +827,24 @@ class TestPrefix(ModelTestCases.BaseModelTestCase):
 
         self.assertEqual(parent_prefix.get_first_available_ip(), "10.0.3.2/29")
 
+    def test_get_all_ips_issue_3319(self):
+        # https://github.com/nautobot/nautobot/issues/3319
+        # Confirm that IPv4 addresses aren't caught up in the IPv6 ::/96 subnet by accident, and vice versa.
+        prefix_v6 = Prefix.objects.create(
+            prefix="::/0", type=PrefixTypeChoices.TYPE_CONTAINER, status=self.status, namespace=self.namespace
+        )
+        prefix_v4 = Prefix.objects.create(
+            prefix="0.0.0.0/0", type=PrefixTypeChoices.TYPE_CONTAINER, status=self.status, namespace=self.namespace
+        )
+        IPAddress.objects.create(address="::0102:0304/128", status=self.status, namespace=self.namespace)
+        IPAddress.objects.create(address="1.2.3.4/32", status=self.status, namespace=self.namespace)
+        self.assertQuerysetEqualAndNotEmpty(
+            prefix_v6.get_all_ips(), IPAddress.objects.filter(ip_version=6, parent__namespace=self.namespace)
+        )
+        self.assertQuerysetEqualAndNotEmpty(
+            prefix_v4.get_all_ips(), IPAddress.objects.filter(ip_version=4, parent__namespace=self.namespace)
+        )
+
     def test_get_utilization(self):
         # Container Prefix
         prefix = Prefix.objects.create(
@@ -982,6 +1000,12 @@ class TestPrefix(ModelTestCases.BaseModelTestCase):
         Prefix.objects.create(prefix="ab80::/9", status=self.status, namespace=self.namespace)
         self.assertEqual(large_prefix_v6.get_utilization(), (2**120, 2**120))
 
+        # https://github.com/nautobot/nautobot/issues/3319
+        v4_10dot_address_space_in_v6 = Prefix.objects.create(
+            prefix="0a00::/8", type=PrefixTypeChoices.TYPE_NETWORK, status=self.status, namespace=self.namespace
+        )
+        self.assertSequenceEqual(v4_10dot_address_space_in_v6.get_utilization(), (0, 2**120))
+
     #
     # Uniqueness enforcement tests
     #

nautobot/ipam/tests/test_utils.py

@@ -1,9 +1,10 @@
 from django.test import TestCase
+import netaddr
 
 from nautobot.core.forms.utils import parse_numeric_range
 from nautobot.extras.models import Status
-from nautobot.ipam.models import VLAN, VLANGroup
-from nautobot.ipam.utils import add_available_vlans
+from nautobot.ipam.models import IPAddress, Namespace, Prefix, VLAN, VLANGroup
+from nautobot.ipam.utils import add_available_ipaddresses, add_available_vlans
 
 
 class AddAvailableVlansTest(TestCase):
@@ -27,6 +28,44 @@ class AddAvailableVlansTest(TestCase):
         )
 
 
+class AddAvailableIPsTest(TestCase):
+    """Tests for add_available_ipaddresses()."""
+
+    def test_add_available_ipaddresses_ipv4(self):
+        prefix = Prefix.objects.create(prefix="22.22.22.0/24", status=Status.objects.get_for_model(Prefix).first())
+        ip_status = Status.objects.get_for_model(IPAddress).first()
+        # .0 isn't available since this isn't a Pool prefix
+        available_1 = (9, "22.22.22.1/24")
+        ip_1 = IPAddress.objects.create(address="22.22.22.10/24", status=ip_status)
+        available_2 = (10, "22.22.22.11/24")
+        ip_2 = IPAddress.objects.create(address="22.22.22.21/24", status=ip_status)
+        available_3 = (233, "22.22.22.22/24")
+        # .255 isn't available since this isn't a Pool prefix
+        self.assertEqual(
+            add_available_ipaddresses(prefix=netaddr.IPNetwork(prefix.prefix), ipaddress_list=(ip_1, ip_2)),
+            [available_1, ip_1, available_2, ip_2, available_3],
+        )
+
+    def test_add_available_ipaddresses_ipv6(self):
+        namespace = Namespace.objects.create(name="add_available_ipv6")
+        prefix = Prefix.objects.create(
+            prefix="::/0", status=Status.objects.get_for_model(Prefix).first(), namespace=namespace
+        )
+        ip_status = Status.objects.get_for_model(IPAddress).first()
+        # .0 is available in IPv6
+        available_1 = (10, "::/0")
+        ip_1 = IPAddress.objects.create(address="::a/0", status=ip_status, namespace=namespace)
+        available_2 = (2**128 - 10 - 10 - 2, "::b/0")
+        ip_2 = IPAddress.objects.create(
+            address="ffff:ffff:ffff:ffff:ffff:ffff:ffff:fff5/0", status=ip_status, namespace=namespace
+        )
+        available_3 = (10, "ffff:ffff:ffff:ffff:ffff:ffff:ffff:fff6/0")
+        self.assertEqual(
+            add_available_ipaddresses(prefix=netaddr.IPNetwork(prefix.prefix), ipaddress_list=(ip_1, ip_2)),
+            [available_1, ip_1, available_2, ip_2, available_3],
+        )
+
+
 class ParseNumericRangeTest(TestCase):
     """Tests for add_available_vlans()."""
 

nautobot/ipam/utils/__init__.py

@@ -41,20 +41,27 @@ def get_add_available_prefixes_callback(show_available: bool, parent: Prefix):
 
 def add_available_ipaddresses(prefix: netaddr.IPNetwork, ipaddress_list: Iterable[IPAddress], is_pool: bool = False):
     """
-    Annotate ranges of available IP addresses within a given prefix. If is_pool is True, the first and last IP will be
-    considered usable (regardless of mask length).
-    """
+    Annotate ranges of available IP addresses within a given prefix.
+
+    Args:
+        prefix (netaddr.IPNetwork): The network to calculate available addresses within.
+        ipaddress_list (Iterable[IPAddress]): List or QuerySet of extant IPAddress objects.
+        is_pool (bool): If True, the first/last IPs in the prefix will be considered usable, regardless of mask length.
 
+    Returns:
+        The contents of `ipaddress_list` interleaved with tuples of the form
+        `(number_of_available_addresses, first_such_address)`.
+    """
     output = []
     prev_ip = None
 
     # Ignore the network and broadcast addresses for non-pool IPv4 prefixes larger than /31.
     if prefix.version == 4 and prefix.prefixlen < 31 and not is_pool:
-        first_ip_in_prefix = netaddr.IPAddress(prefix.first + 1)
-        last_ip_in_prefix = netaddr.IPAddress(prefix.last - 1)
+        first_ip_in_prefix = netaddr.IPAddress(prefix.first + 1, version=prefix.version)
+        last_ip_in_prefix = netaddr.IPAddress(prefix.last - 1, version=prefix.version)
     else:
-        first_ip_in_prefix = netaddr.IPAddress(prefix.first)
-        last_ip_in_prefix = netaddr.IPAddress(prefix.last)
+        first_ip_in_prefix = netaddr.IPAddress(prefix.first, version=prefix.version)
+        last_ip_in_prefix = netaddr.IPAddress(prefix.last, version=prefix.version)
 
     if not ipaddress_list:
         return [
@@ -71,15 +78,15 @@ def add_available_ipaddresses(prefix: netaddr.IPNetwork, ipaddress_list: Iterabl
         ipaddress_list.sort(key=lambda ip: ip.host)
 
     # Account for any available IPs before the first real IP
-    if ipaddress_list[0].address.ip > first_ip_in_prefix:
-        skipped_count = int(ipaddress_list[0].address.ip - first_ip_in_prefix)
+    if ipaddress_list[0].address.ip.value > first_ip_in_prefix.value:
+        skipped_count = ipaddress_list[0].address.ip.value - first_ip_in_prefix.value
         first_skipped = f"{first_ip_in_prefix}/{prefix.prefixlen}"
         output.append((skipped_count, first_skipped))
 
     # Iterate through existing IPs and annotate free ranges
     for ip in ipaddress_list:
         if prev_ip:
-            diff = int(ip.address.ip - prev_ip.address.ip)
+            diff = ip.address.ip.value - prev_ip.address.ip.value
             if diff > 1:
                 first_skipped = f"{prev_ip.address.ip + 1}/{prefix.prefixlen}"
                 output.append((diff - 1, first_skipped))
@@ -88,7 +95,7 @@ def add_available_ipaddresses(prefix: netaddr.IPNetwork, ipaddress_list: Iterabl
 
     # Include any remaining available IPs
     if prev_ip.address.ip < last_ip_in_prefix:
-        skipped_count = int(last_ip_in_prefix - prev_ip.address.ip)
+        skipped_count = last_ip_in_prefix.value - prev_ip.address.ip.value
         first_skipped = f"{prev_ip.address.ip + 1}/{prefix.prefixlen}"
         output.append((skipped_count, first_skipped))