nautobot 2.3.6__py3-none-any.whl → 2.3.7__py3-none-any.whl

nautobot/__init__.py

@@ -1,6 +1,7 @@
 from importlib import metadata
 import logging
 import os
+import sys
 
 import django
 
@@ -28,8 +29,9 @@ def setup(config_path=None):
     # Point Django to our 'nautobot_config' pseudo-module that we'll load from the provided config path
     os.environ["DJANGO_SETTINGS_MODULE"] = "nautobot_config"
 
-    load_settings(config_path)
+    if "nautobot_config" not in sys.modules:
+        load_settings(config_path)
     django.setup()
 
-    logger.info("Nautobot initialized!")
+    logger.info("Nautobot %s initialized!", __version__)
     __initialized = True

nautobot/circuits/tests/test_views.py

@@ -10,7 +10,7 @@ from nautobot.circuits.models import (
     Provider,
     ProviderNetwork,
 )
-from nautobot.core.testing import post_data, TestCase as NautobotTestCase, ViewTestCases
+from nautobot.core.testing import post_data, TestCase as NautobotTestCase, utils, ViewTestCases
 from nautobot.extras.models import Status, Tag
 
 
@@ -176,13 +176,12 @@ class CircuitTerminationTestCase(
 
         # Visit the termination detail page and assert responses:
         response = self.client.get(reverse("circuits:circuittermination", kwargs={"pk": termination.pk}))
-        self.assertEqual(200, response.status_code)
-        self.assertIn("Test Provider Network", str(response.content))
-        self.assertNotIn("</span> Connect", str(response.content))
+        self.assertBodyContains(response, "Test Provider Network")
+        self.assertNotIn("</span> Connect", utils.extract_page_body(response.content.decode(response.charset)))
 
         # Visit the circuit object detail page and check there is no connect button present:
         response = self.client.get(reverse("circuits:circuit", kwargs={"pk": circuit.pk}))
-        self.assertNotIn("</span> Connect", str(response.content))
+        self.assertNotIn("</span> Connect", utils.extract_page_body(response.content.decode(response.charset)))
 
 
 class CircuitSwapTerminationsTestCase(NautobotTestCase):

nautobot/core/api/views.py

@@ -24,6 +24,7 @@ from graphql import get_default_backend
 from graphql.execution import ExecutionResult
 from graphql.execution.middleware import MiddlewareManager
 from graphql.type.schema import GraphQLSchema
+import redis.exceptions
 from rest_framework import routers, status
 from rest_framework.exceptions import ParseError, PermissionDenied
 from rest_framework.permissions import IsAuthenticated
@@ -58,6 +59,10 @@ HTTP_ACTIONS = {
     "DELETE": "delete",
 }
 
+
+logger = logging.getLogger(__name__)
+
+
 #
 # Mixins
 #
@@ -467,7 +472,16 @@ class StatusView(NautobotAPIVersionMixin, APIView):
         nautobot_apps = dict(sorted(nautobot_apps.items()))
 
         # Gather Celery workers
-        workers = celery_app.control.inspect().active()  # list or None
+        try:
+            workers = celery_app.control.inspect().active()  # list or None
+        except redis.exceptions.ConnectionError:
+            # Celery seems to be not smart enough to auto-retry on intermittent failures, so let's do it ourselves:
+            try:
+                workers = celery_app.control.inspect().active()  # list or None
+            except redis.exceptions.ConnectionError as err:
+                logger.error("Repeated ConnectionError from Celery/Redis: %s", err)
+                workers = None
+
         worker_count = len(workers) if workers is not None else 0
 
         return Response(
@@ -872,7 +886,6 @@ class GetObjectCountsView(NautobotAPIVersionMixin, APIView):
             try:
                 data["url"] = django_reverse(get_route_for_model(model, "list"))
             except NoReverseMatch:
-                logger = logging.getLogger(__name__)
                 route = get_route_for_model(model, "list")
                 logger.warning(f"Handled expected exception when generating filter field: {route}")
             manager = model.objects
@@ -975,7 +988,6 @@ class GetFilterSetFieldDOMElementAPIView(NautobotAPIVersionMixin, APIView):
             # Cant determine the exceptions to handle because any exception could be raised,
             # e.g InterfaceForm would raise a ObjectDoesNotExist Error since no device was provided
             # While other forms might raise other errors, also if model_form is None a TypeError would be raised.
-            logger = logging.getLogger(__name__)
             logger.debug(f"Handled expected exception when generating filter field: {err}")
 
             # Create a temporary form and get a BoundField for the specified field

nautobot/core/templates/inc/javascript.html

@@ -18,6 +18,8 @@
         onerror="window.location='{% url 'media_failure' %}?filename=highlight.js-11.9.0/highlight.min.js'"></script>
 <script src="{% versioned_static 'js/forms.js' %}"
         onerror="window.location='{% url 'media_failure' %}?filename=js/forms.js'"></script>
+<script src="{% versioned_static 'js/nav_menu.js' %}"
+        onerror="window.location='{% url 'media_failure' %}?filename=js/nav_menu.js'"></script>
 <script src="{% versioned_static 'js/theme.js' %}"
         onerror="window.location='{% url 'media_failure' %}?filename=js/theme.js'"></script>
 <script src="{% versioned_static 'js/table_sorting_indicator.js' %}"

nautobot/core/templates/inc/nav_menu.html

@@ -117,254 +117,3 @@
 <button type="button" class="btn btn-xs btn-warning navbar-toggler" aria-label="Collapse navbar">
     <span class="mdi mdi-chevron-up mdi-rotate-270 navbar-toggler-arrow"></span>
 </button>
-
-<script>
-    document.addEventListener('DOMContentLoaded', function() {
-        const navbar = document.querySelector('.navbar-fixed-left');
-        const navbarHeader = document.querySelector('.navbar-header');
-        const mainContent = document.querySelector('#main-content');
-        const footer = document.querySelector('#footer');
-        const dropdownToggles = document.querySelectorAll('.navbar-fixed-left .navbar-nav > .dropdown > a[data-toggle="collapse"]');
-        const dropdowns = document.querySelectorAll('.navbar-fixed-left .navbar-nav .collapse');
-        const toggler = document.querySelector('.navbar-toggler');
-        const togglerIcon = toggler.querySelector('.navbar-toggler-arrow');
-        let lastDropdownId = sessionStorage.getItem('lastOpenedDropdown');
-        let savedScrollPosition = sessionStorage.getItem('navbarScrollPosition');
-        let activeLink = sessionStorage.getItem('activeLink');
-        let expandedByHover = false;
-        let manuallyToggled = sessionStorage.getItem('manuallyToggled') === 'true';
-
-        // Function to reset stored dropdown state information
-        function resetNavbarState() {
-            sessionStorage.removeItem('lastOpenedDropdown');
-            sessionStorage.removeItem('savedScrollPosition');
-            sessionStorage.removeItem('activeLink');
-            sessionStorage.removeItem('navbarCollapsed');
-            expandedByHover = false;
-        }
-
-        toggler.addEventListener('click', function() {
-            let isNowCollapsed;
-            if (expandedByHover) {
-                expandedByHover = false;
-                isNowCollapsed = false;
-            } else {
-                isNowCollapsed = navbar.classList.toggle('collapsed');
-            }
-            sessionStorage.setItem('navbarCollapsed', isNowCollapsed ? 'true' : 'false');
-            // Set 'navbarManuallyToggled' to track any manual toggle
-            sessionStorage.setItem('navbarManuallyToggled', 'true');
-            // Track if the action was an expansion or a collapse
-            sessionStorage.setItem('navbarExpanded', !isNowCollapsed ? 'true' : 'false');
-            if (isNowCollapsed) {
-                togglerIcon.classList.add("mdi-rotate-90");
-                togglerIcon.classList.remove("mdi-rotate-270");
-            } else {
-                togglerIcon.classList.remove("mdi-rotate-90");
-                togglerIcon.classList.add("mdi-rotate-270");
-            }
-            adjustElementsForNavbarState(isNowCollapsed);
-        });
-
-        // Retrieve the navbar collapsed state from session storage on page load
-        const navbarCollapsed = sessionStorage.getItem('navbarCollapsed') === 'true';
-        if (navbarCollapsed) {
-            navbar.classList.add('collapsed');
-            togglerIcon.classList.remove("mdi-rotate-270");
-            togglerIcon.classList.add("mdi-rotate-90");
-            adjustElementsForNavbarState(true);
-        }
-
-        function adjustElementsForNavbarState(isCollapsed) {
-            const marginLeftValue = isCollapsed ? '-240px' : '0px';
-            mainContent.style.marginLeft = marginLeftValue;
-            if(footer) footer.style.marginLeft = marginLeftValue;
-            toggler.style.left = isCollapsed ? '-5px' : '225px';
-        }
-
-        // Expand navbar when hovering near the left edge of the screen
-        document.addEventListener('mousemove', function(e) {
-            if (
-                e.clientX < 20  // 20px from the left edge
-                && (e.clientY < 20 || e.clientY > 50) // not near the toggle button
-                && navbar.classList.contains('collapsed')
-            ) {
-                navbar.classList.remove('collapsed');
-                toggler.style.left = '225px';
-                expandedByHover = true; // Set flag when expanded by hover
-            } else if (expandedByHover && e.clientX > 240) {
-                navbar.classList.add('collapsed');
-                toggler.style.left = '-5px';
-                expandedByHover = false; // Reset flag after auto-collapse
-            }
-        });
-
-        function collapseNavbarIfNeeded() {
-            const windowWidth = window.innerWidth;
-            const navbarManuallyToggled = sessionStorage.getItem('navbarManuallyToggled') === 'true';
-            const navbarExpanded = sessionStorage.getItem('navbarExpanded') === 'true';
-            const isCollapsed = navbar.classList.contains('collapsed');
-
-            if (windowWidth < 1007) {
-                if (!isCollapsed) {
-                    navbar.classList.add('collapsed');
-                    togglerIcon.classList.remove("mdi-rotate-270");
-                    togglerIcon.classList.add("mdi-rotate-90");
-                    adjustElementsForNavbarState(true);
-                    sessionStorage.setItem('navbarCollapsed', 'true');
-                }
-            } else if (windowWidth >= 1007) {
-                // Only expand automatically if it was not manually collapsed
-                if (isCollapsed && (navbarManuallyToggled && navbarExpanded)) {
-                    navbar.classList.remove('collapsed');
-                    togglerIcon.classList.add("mdi-rotate-270");
-                    togglerIcon.classList.remove("mdi-rotate-90");
-                    adjustElementsForNavbarState(false);
-                    sessionStorage.setItem('navbarCollapsed', 'false');
-                }
-                // Do not automatically change the state if it was manually collapsed
-            }
-        }
-
-        // Update the window resize listener
-        function toggleNavbarOnResize() {
-            collapseNavbarIfNeeded(); // Use the new function to decide whether to collapse
-        }
-
-        let debouncedToggleNavbarOnResize = debounce(toggleNavbarOnResize, 50);
-        window.addEventListener('resize', debouncedToggleNavbarOnResize);
-
-        // Select the navbar dropdown elements
-        let navbarItems = document.querySelectorAll('.navbar-fixed-left .navbar-nav > .dropdown > .dropdown-toggle > #dropdown_title');
-
-        // Add a title attribute and tooltip, only if necessary
-        navbarItems.forEach(function(item) {
-            // Check if the text overflows
-            if (item.scrollWidth > item.clientWidth) {
-                // Set the title attribute
-                item.setAttribute('title', item.innerText);
-
-                // Reinitialize Bootstrap tooltip
-                $(item).tooltip();
-            }
-        });
-
-        // Add an event listener for the home link click
-        const homeLink = document.querySelector('.navbar-fixed-left .navbar-brand');
-        if (homeLink) {
-            homeLink.addEventListener('click', function() {
-                resetNavbarState();
-            });
-        }
-
-        // Close all dropdowns except the one specified
-        function closeAllDropdownsExcept(exceptId) {
-            dropdowns.forEach(function(collapse) {
-                if (collapse.id !== exceptId && collapse.classList.contains('in')) {
-                    $(collapse).collapse('hide');
-                }
-            });
-        }
-
-        // Add click event listener to the dropdown links and save the clicked one
-        function addLinkClickListeners() {
-            const dropdownLinks = document.querySelectorAll('.navbar-fixed-left .navbar-nav > .dropdown > .nav-dropdown-menu > li > a');
-
-            dropdownLinks.forEach(function(link) {
-                link.addEventListener('click', function() {
-                    sessionStorage.setItem('activeLink', link.getAttribute('href'));
-                });
-            });
-            collapseNavbarIfNeeded();
-        }
-
-        // Close all dropdowns except the last opened one
-        dropdownToggles.forEach(function(toggle) {
-            toggle.addEventListener('click', function(event) {
-                event.preventDefault();
-                const collapseElement = document.getElementById(this.getAttribute('href').substring(1));
-
-                if (!collapseElement.classList.contains('in')) {
-                    closeAllDropdownsExcept(collapseElement.id);
-                    $(collapseElement).collapse('show');
-                    sessionStorage.setItem('lastOpenedDropdown', collapseElement.id);
-                } else {
-                    $(collapseElement).collapse('hide');
-                    sessionStorage.removeItem('lastOpenedDropdown');
-                }
-            });
-        });
-
-        // Open the last opened dropdown
-        if (lastDropdownId) {
-            let lastDropdownMenu = document.getElementById(lastDropdownId);
-            if (lastDropdownMenu && !lastDropdownMenu.classList.contains('in')) {
-                $(lastDropdownMenu).collapse('show');
-            }
-        }
-
-        // Restore the last saved scroll position
-        if (savedScrollPosition) {
-            navbar.scrollTop = savedScrollPosition;
-        }
-
-        // Function to adjust navbar header visibility based on scroll position and navbar collapsed state
-        function adjustNavbarHeaderVisibility() {
-            // Check if the navbar is collapsed and mainContent is defined
-            if (navbar.classList.contains('collapsed') && mainContent) {
-                const mainContentTop = mainContent.getBoundingClientRect().top;
-                // Show or hide the navbar header based on mainContent's position
-                if (mainContentTop < 0) {
-                    // Main content top is out of view, hide navbar header
-                    navbarHeader.style.top = '-60px'; // height of navbar header
-                } else {
-                    // Main content top is in view, show navbar header
-                    navbarHeader.style.top = '0';
-                }
-            }
-        }
-
-        // Add scroll event listener to adjust navbar header visibility
-        window.addEventListener('scroll', adjustNavbarHeaderVisibility);
-
-        // Call the function initially to set the correct state when the page loads
-        adjustNavbarHeaderVisibility();
-
-        // Debounce function to limit the rate at which the handleScroll function is executed
-        function debounce(func, wait, immediate) {
-            let timeout;
-            return function() {
-                const context = this, args = arguments;
-                const later = function() {
-                    timeout = null;
-                    if (!immediate) func.apply(context, args);
-                };
-                const callNow = immediate && !timeout;
-                clearTimeout(timeout);
-                timeout = setTimeout(later, wait);
-                if (callNow) func.apply(context, args);
-            };
-        }
-
-        // Save the scroll position when the navbar is scrolled
-        navbar.addEventListener('scroll', debounce(function() {
-            sessionStorage.setItem('navbarScrollPosition', navbar.scrollTop);
-        }, 250));
-
-         // Add click event listeners to dropdown links
-        addLinkClickListeners();
-
-        // Apply the 'active' class to the previously clicked link
-        if (activeLink) {
-            let previouslyClickedLink = document.querySelector('.navbar-fixed-left .navbar-nav > .dropdown > .nav-dropdown-menu > li > a[href="' + activeLink + '"]');
-            let currentLocation = window.location.pathname + window.location.search;
-
-            if (previouslyClickedLink && currentLocation.includes(previouslyClickedLink.getAttribute('href'))) {
-                previouslyClickedLink.parentElement.classList.add('active');
-            }
-            else {
-                sessionStorage.removeItem('activeLink');
-            }
-        }
-    });
-</script>

nautobot/core/testing/mixins.py

@@ -9,6 +9,7 @@ from django.core.exceptions import FieldDoesNotExist
 from django.db import connections, DEFAULT_DB_ALIAS
 from django.db.models import JSONField, ManyToManyField, ManyToManyRel
 from django.forms.models import model_to_dict
+from django.test.testcases import assert_and_parse_html
 from django.test.utils import CaptureQueriesContext
 from netaddr import IPNetwork
 from rest_framework.test import APIClient, APIRequestFactory
@@ -172,8 +173,12 @@ class NautobotTestCaseMixin:
                 # REST API response; pass the response data through directly
                 err_message += f"\n{response.data}"
             # Attempt to extract form validation errors from the response HTML
-            form_errors = utils.extract_form_failures(response.content.decode(response.charset))
-            err_message += "\n" + str(form_errors or response.content.decode(response.charset) or "No data")
+            elif form_errors := utils.extract_form_failures(response.content.decode(response.charset)):
+                err_message += f"\n{form_errors}"
+            elif body_content := utils.extract_page_body(response.content.decode(response.charset)):
+                err_message += f"\n{body_content}"
+            else:
+                err_message += "No data"
             if msg:
                 err_message = f"{msg}\n{err_message}"
         self.assertIn(response.status_code, expected_status, err_message)
@@ -277,6 +282,58 @@ class NautobotTestCaseMixin:
 
         return None
 
+    def assertBodyContains(self, response, text, count=None, status_code=200, msg_prefix="", html=False):
+        """
+        Like Django's `assertContains`, but uses `extract_page_body` utility function to scope the check more narrowly.
+
+        Args:
+            response (HttpResponse): The response to inspect
+            text (str): Plaintext or HTML to check for in the response body
+            count (int, optional): Number of times the `text` should occur, or None if we don't care as long as
+                it's present at all.
+            status_code (int): HTTP status code expected
+            html (bool): If True, handle `text` as HTML, ignoring whitespace etc, as in Django's `assertHTMLEqual()`.
+        """
+        # The below is copied from SimpleTestCase._assert_contains and SimpleTestCase.assertContains
+        # If the response supports deferred rendering and hasn't been rendered
+        # yet, then ensure that it does get rendered before proceeding further.
+        if hasattr(response, "render") and callable(response.render) and not response.is_rendered:
+            response.render()
+
+        if msg_prefix:
+            msg_prefix += ": "
+
+        self.assertHttpStatus(  # Nautobot-specific, original uses simple assertEqual()
+            response, status_code, msg_prefix
+        )
+
+        if response.streaming:
+            content = b"".join(response.streaming_content)
+        else:
+            content = response.content
+
+        if not isinstance(text, bytes) or html:
+            text = str(text)
+            content = content.decode(response.charset)
+            content = utils.extract_page_body(content)  # Nautobot-specific
+            text_repr = f"'{text}'"
+        else:
+            text_repr = repr(text)
+
+        if html:
+            content = assert_and_parse_html(self, content, None, "Response's content is not valid HTML:")
+            text = assert_and_parse_html(self, text, None, "Second argument is not valid HTML:")
+        real_count = content.count(text)
+
+        if count is not None:
+            self.assertEqual(
+                real_count,
+                count,
+                msg_prefix + f"Found {real_count} instances of {text_repr} in response (expected {count}):\n{content}",
+            )
+        else:
+            self.assertTrue(real_count != 0, msg_prefix + f"Couldn't find {text_repr} in response:\n{content}")
+
     #
     # Convenience methods
     #