nautobot 3.0.0a2__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

nautobot/core/tests/runner.py

@@ -39,11 +39,12 @@ class NautobotParallelTestSuite(ParallelTestSuite):
 
 class NautobotTestRunner(DiscoverRunner):
     """
-    Custom test runner that excludes (slow) integration and migration tests by default.
+    Custom test runner that excludes (slow) integration and migration tests by default among others.
 
     This test runner is aware of our use of the "integration" tag and only runs integration tests if
     explicitly passed in with `nautobot-server test --tag integration`.
     Similarly, it only runs migration tests if explicitly called with `--tag migration_test`.
+    Similarly, it only runs tests that require the example app(s) if those are present in settings.PLUGINS.
 
     By Nautobot convention, integration tests must be tagged with "integration". The base
     `nautobot.core.testing.integration.SeleniumTestCase` has this tag, therefore any test cases
@@ -58,6 +59,10 @@ class NautobotTestRunner(DiscoverRunner):
     parallel_test_suite = NautobotParallelTestSuite
 
     exclude_tags = ["integration", "migration_test"]
+    if "example_app" not in settings.PLUGINS:
+        exclude_tags.append("example_app")
+    if "example_app_with_view_override" not in settings.PLUGINS:
+        exclude_tags.append("example_app_with_view_override")
 
     @classmethod
     def add_arguments(cls, parser):
@@ -157,6 +162,8 @@ class NautobotTestRunner(DiscoverRunner):
                             db_command = [*command, "--database", alias]
                             call_command(*db_command)
 
+                        call_command("post_upgrade")
+
                     if self.parallel > 1:
                         for index in range(self.parallel):
                             with time_keeper.timed(f"  Cloning '{alias}'"):

nautobot/core/tests/test_api.py

@@ -533,10 +533,12 @@ class ModelViewSetMixinTest(testing.APITestCase):
         self.user.is_superuser = True
         self.user.save()
 
-        # Default behavior - m2m fields included
+        # With exclude_m2m query parameter set to False
         view = self.SimpleIPAddressViewSet()
         view.action_map = {"get": "list"}
-        request = APIRequestFactory().get(reverse("ipam-api:ipaddress-list"), headers=self.header)
+        request = APIRequestFactory().get(
+            reverse("ipam-api:ipaddress-list"), headers=self.header, data={"exclude_m2m": False}
+        )
         force_authenticate(request, user=self.user)
         request = view.initialize_request(request)
         view.setup(request)
@@ -561,7 +563,7 @@ class ModelViewSetMixinTest(testing.APITestCase):
             list(instance.vm_interfaces.all())
             list(instance.tags.all())
 
-        # With exclude_m2m query parameter
+        # With exclude_m2m query parameter set to True
         view = self.SimpleIPAddressViewSet()
         view.action_map = {"get": "list"}
         request = APIRequestFactory().get(

nautobot/core/tests/test_breadcrumbs.py

@@ -35,7 +35,7 @@ class BreadcrumbItemsTestCase(TestCase):
         item = ViewNameBreadcrumbItem(view_name="home", label="Home")
         context = Context({})
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
 
         self.assertEqual(url, "/")
         self.assertEqual(label, "Home")
@@ -50,7 +50,7 @@ class BreadcrumbItemsTestCase(TestCase):
         )
         context = Context({})
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
 
         self.assertEqual(url, f"/dcim/location-types/{self.location_type.pk}/?name=test")
         self.assertEqual(label, "Filtered Locations Types")
@@ -65,7 +65,7 @@ class BreadcrumbItemsTestCase(TestCase):
         )
         context = Context({"object": self.location_type})
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
 
         self.assertEqual(
             url, f"/dcim/location-types/{self.location_type.pk}/?{urlencode({'name': self.location_type.name})}"
@@ -79,7 +79,7 @@ class BreadcrumbItemsTestCase(TestCase):
             label=lambda context: f"Hi, {context['user']}!",
         )
         context = Context({"user": "Frodo"})
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, "/")
         self.assertEqual(label, "Hi, Frodo!")
 
@@ -148,7 +148,7 @@ class BreadcrumbItemsTestCase(TestCase):
                 item = ModelBreadcrumbItem(**test_case["kwargs"])
                 context = Context({"object": self.location_type, "model_type": Device, "device_name": "abc"})
 
-                url, label = item.as_pair(context)
+                url, label = next(item.as_pair(context))
 
                 self.assertEqual(url, test_case["expected_url"])
                 self.assertEqual(label, test_case["expected_label"])
@@ -157,7 +157,7 @@ class BreadcrumbItemsTestCase(TestCase):
         item = ModelBreadcrumbItem(model_key="object", label="custom LaBeL")
         context = Context({"object": self.location_type})
 
-        _, label = item.as_pair(context)
+        _, label = next(item.as_pair(context))
         self.assertEqual(label, "custom LaBeL")
 
     def test_model_item_from_context(self):
@@ -165,7 +165,7 @@ class BreadcrumbItemsTestCase(TestCase):
         item = ModelBreadcrumbItem(model_key="object")
         context = Context({"object": self.location_type})
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
 
         self.assertEqual(url, "/dcim/location-types/")
         self.assertEqual(label, "Location Types")
@@ -175,7 +175,7 @@ class BreadcrumbItemsTestCase(TestCase):
         item = InstanceBreadcrumbItem(instance_key="object")
         context = Context({"object": self.location_type})
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
 
         self.assertEqual(url, f"/dcim/location-types/{self.location_type.pk}/")
         self.assertEqual(label, str(self.location_type))
@@ -192,7 +192,7 @@ class BreadcrumbItemsTestCase(TestCase):
 
         for item in items:
             with self.subTest():
-                _, label = item.as_pair(context)
+                _, label = next(item.as_pair(context))
                 self.assertEqual(label, "Custom Label")
 
     def test_no_reverse_match(self):
@@ -200,7 +200,7 @@ class BreadcrumbItemsTestCase(TestCase):
         item = ViewNameBreadcrumbItem(view_name="nonexistent")
         context = Context({})
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
 
         self.assertEqual(url, "")
         self.assertEqual(label, "")
@@ -210,12 +210,12 @@ class BreadcrumbItemsTestCase(TestCase):
         context = Context({})
         item = InstanceBreadcrumbItem(instance_key="missing_key")
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, "")
         self.assertEqual(label, "")
 
         item = ModelBreadcrumbItem(model_key="missing_key")
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, "")
         self.assertEqual(label, "")
 
@@ -223,7 +223,7 @@ class BreadcrumbItemsTestCase(TestCase):
         context = Context({"object": LocationType.objects.create(name="custom name")})
         item = InstanceBreadcrumbItem()
 
-        _, label = item.as_pair(context)
+        _, label = next(item.as_pair(context))
         self.assertEqual(label, "custom name")
 
     def test_instance_item_is_working_with_directly_passed_instance(self):
@@ -231,7 +231,7 @@ class BreadcrumbItemsTestCase(TestCase):
         instance = LocationType.objects.create(name="cUsToM CoUnTrY")
         item = InstanceBreadcrumbItem(instance=instance)
 
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, f"/dcim/location-types/{instance.pk}/")
         self.assertEqual(label, "cUsToM CoUnTrY")
 
@@ -244,17 +244,17 @@ class BreadcrumbItemsTestCase(TestCase):
         context = Context({"object": location, "status": status})
 
         item = InstanceBreadcrumbItem(instance=context_object_attr("location_type"))
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, f"/dcim/location-types/{location_type.pk}/")
-        self.assertEqual(label, "Country → State")
+        self.assertEqual(label, "State")
 
         item = BaseBreadcrumbItem(label=context_object_attr("name", context_key="status"))
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, "")
         self.assertEqual(label, status.name)
 
         item = InstanceBreadcrumbItem(instance=context_object_attr("location_type.parent"))
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, f"/dcim/location-types/{parent_location_type.pk}/")
         self.assertEqual(label, "Country")
 
@@ -263,7 +263,7 @@ class BreadcrumbItemsTestCase(TestCase):
         context = Context({"object": LocationType.objects.create(name="custom name", parent=parent_location_type)})
         item = InstanceParentBreadcrumbItem()
 
-        _, label = item.as_pair(context)
+        _, label = next(item.as_pair(context))
         self.assertEqual(label, "cUsToM CoUnTrY")
 
     def test_instance_parent_is_create_proper_url(self):
@@ -273,12 +273,12 @@ class BreadcrumbItemsTestCase(TestCase):
         context = Context({"object": location_type})
 
         item = InstanceParentBreadcrumbItem()
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, f"/dcim/location-types/?parent={parent_location_type.pk}")
         self.assertEqual(label, "Country")
 
         item = InstanceParentBreadcrumbItem(parent_query_param="location", parent_lookup_key="name")
-        url, label = item.as_pair(context)
+        url, label = next(item.as_pair(context))
         self.assertEqual(url, "/dcim/location-types/?location=Country")
         self.assertEqual(label, "Country")
 
@@ -296,8 +296,8 @@ class BreadcrumbsTestCase(TestCase):
         breadcrumbs = Breadcrumbs()
 
         # Should have defaults for list and details
-        self.assertEqual(len(breadcrumbs.items["list"]), 2)
-        self.assertEqual(len(breadcrumbs.items["detail"]), 3)
+        self.assertEqual(len(breadcrumbs.items["list"]), 0)
+        self.assertEqual(len(breadcrumbs.items["detail"]), 2)
 
         # Verify adding items
         new_item = BaseBreadcrumbItem()
@@ -306,7 +306,7 @@ class BreadcrumbsTestCase(TestCase):
         self.assertEqual(len(breadcrumbs.items["list"]), 1)
         self.assertEqual(breadcrumbs.items["list"][0], new_item)
 
-        self.assertEqual(len(breadcrumbs.items["detail"]), 2)
+        self.assertEqual(len(breadcrumbs.items["detail"]), 1)
         self.assertEqual(breadcrumbs.items["detail"][0], new_item)
 
         self.assertEqual(len(breadcrumbs.items["custom_action"]), 1)
@@ -325,7 +325,7 @@ class BreadcrumbsTestCase(TestCase):
 
         # Other defaults should still exist
         self.assertIn("detail", breadcrumbs.items)
-        self.assertEqual(len(breadcrumbs.items["detail"]), 3)
+        self.assertEqual(len(breadcrumbs.items["detail"]), 2)
 
     def test_get_items_from_action_static_method(self):
         """Test the _get_items_from_action static method."""
@@ -355,7 +355,6 @@ class BreadcrumbsTestCase(TestCase):
         breadcrumbs = Breadcrumbs()
         expected_items = [
             ("/dcim/location-types/", "Location Types"),
-            (f"/dcim/location-types/{self.location_type.pk}/", str(self.location_type)),
         ]
 
         # Test with an action that doesn't exist but detail=True
@@ -366,13 +365,13 @@ class BreadcrumbsTestCase(TestCase):
         items = breadcrumbs.get_breadcrumbs_items(context)
 
         # Should get 2 items from detail fallback
-        self.assertEqual(len(items), 2)
+        self.assertEqual(len(items), 1)
         self.assertEqual(items, expected_items)
 
     def test_render_method(self):
         """Test the render method."""
         breadcrumbs = Breadcrumbs()
-        context = Context({"view_action": "list", "model": Device})
+        context = Context({"detail": True, "model": Device})
 
         html = breadcrumbs.render(context)
 

nautobot/core/tests/test_checks.py

@@ -1,6 +1,7 @@
 from django.test import override_settings, TestCase
 
 from nautobot.core import checks
+from nautobot.dcim.choices import DeviceUniquenessChoices
 
 
 class CheckCoreSettingsTest(TestCase):
@@ -42,3 +43,30 @@ class CheckCoreSettingsTest(TestCase):
     def test_check_maintenance_mode(self):
         """Error if MAINTENANCE_MODE is set and yet SESSION_ENGINE is still storing sessions in the db."""
         self.assertEqual(checks.check_maintenance_mode(None), [checks.E005])
+
+    @override_settings(
+        DEVICE_NAME_AS_NATURAL_KEY=True,
+    )
+    def test_check_deprecated_device_name_as_natural_key(self):
+        """Warn if DEVICE_NAME_AS_NATURAL_KEY is defined in settings."""
+        self.assertEqual(
+            checks.check_deprecated_device_name_as_natural_key(None),
+            [checks.W006],
+        )
+
+    @override_settings(
+        DEVICE_UNIQUENESS="invalid_value",
+    )
+    def test_check_invalid_device_uniqueness_value(self):
+        """Warn if DEVICE_UNIQUENESS is set to an invalid value."""
+        self.assertEqual(
+            checks.check_valid_value_for_device_uniqueness(None),
+            [checks.W007],
+        )
+
+    @override_settings(
+        DEVICE_UNIQUENESS=DeviceUniquenessChoices.NAME,
+    )
+    def test_check_valid_device_uniqueness_value(self):
+        """No warning if DEVICE_UNIQUENESS is set to a valid value."""
+        self.assertEqual(checks.check_valid_value_for_device_uniqueness(None), [])

nautobot/core/tests/test_cli.py

@@ -0,0 +1,40 @@
+from nautobot.core.cli import migrate_deprecated_templates
+from nautobot.core.testing import TestCase
+
+
+class TestMigrateTemplates(TestCase):
+    def test_template_replacements(self):
+        """Verify that all old templates are replaced by a single new template."""
+        audit_dict = {}
+        for new_template, old_templates in migrate_deprecated_templates.TEMPLATE_REPLACEMENTS.items():
+            for old_template in old_templates:
+                self.assertNotIn(old_template, audit_dict)
+                audit_dict[old_template] = new_template
+
+    def test_replace_template_references_no_change(self):
+        content = """
+        {% extends "base.html" %}
+        {% block content %}
+        <h1>Hello, World!</h1>
+        {% endblock %}
+        """
+        replaced_content, was_updated = migrate_deprecated_templates.replace_template_references(content)
+        self.assertFalse(was_updated)
+        self.assertEqual(replaced_content, content)
+
+    def test_replace_template_references(self):
+        original_content = """
+        {% extends "generic/object_bulk_import.html" %}
+        {% block content %}
+        <h1>Hello, World!</h1>
+        {% endblock %}
+        """
+        new_content = """
+        {% extends "generic/object_bulk_create.html" %}
+        {% block content %}
+        <h1>Hello, World!</h1>
+        {% endblock %}
+        """
+        replaced_content, was_updated = migrate_deprecated_templates.replace_template_references(original_content)
+        self.assertTrue(was_updated)
+        self.assertEqual(replaced_content, new_content)

nautobot/core/tests/test_config.py

@@ -1,7 +1,7 @@
 """Test cases for nautobot.core.config module."""
 
 from constance.test import override_config
-from django.test import override_settings, TestCase
+from django.test import override_settings, tag, TestCase
 
 from nautobot.apps import config as app_config
 from nautobot.core.utils import config
@@ -37,6 +37,7 @@ class GetSettingsOrConfigTestCase(TestCase):
         self.assertRaises(AttributeError, config.get_settings_or_config, "FAKE_SETTING")
 
 
+@tag("example_app")
 class GetAppSettingsOrConfigTestCase(TestCase):
     """Test the get_app_settings_or_config() helper function."""
 

nautobot/core/tests/test_forms.py

@@ -1,21 +1,26 @@
+import inspect
+import sys
 from unittest import mock
 
 from django import forms as django_forms
+from django.apps import apps as django_apps
 from django.contrib.contenttypes.models import ContentType
 from django.http import QueryDict
-from django.test import TestCase
+from django.test import tag
 from django.urls import reverse
+from django_filters.filterset import FilterSet
 from netaddr import IPNetwork
 
 from nautobot.core import filters, forms, testing
 from nautobot.core.utils import requests
+from nautobot.core.utils.filtering import get_filterset_parameter_form_field
 from nautobot.dcim import filters as dcim_filters, forms as dcim_forms, models as dcim_models
 from nautobot.dcim.tests import test_views
 from nautobot.extras import filters as extras_filters, models as extras_models
 from nautobot.ipam import forms as ipam_forms, models as ipam_models
 
 
-class ExpandIPAddress(TestCase):
+class ExpandIPAddress(testing.TestCase):
     """
     Validate the operation of expand_ipaddress_pattern().
     """
@@ -198,7 +203,7 @@ class ExpandIPAddress(TestCase):
             sorted(forms.expand_ipaddress_pattern("1.2.3.[4,,5]/32", 4))
 
 
-class ExpandAlphanumeric(TestCase):
+class ExpandAlphanumeric(testing.TestCase):
     """
     Validate the operation of expand_alphanumeric_pattern().
     """
@@ -332,7 +337,7 @@ class ExpandAlphanumeric(TestCase):
             sorted(forms.expand_alphanumeric_pattern("r[a,,b]a"))
 
 
-class AddFieldToFormClassTest(TestCase):
+class AddFieldToFormClassTest(testing.TestCase):
     def test_field_added(self):
         """
         Test adding of a new field to an existing form.
@@ -361,7 +366,7 @@ class AddFieldToFormClassTest(TestCase):
             )
 
 
-class DynamicModelChoiceFieldTest(TestCase):
+class DynamicModelChoiceFieldTest(testing.TestCase):
     """Tests for DynamicModelChoiceField."""
 
     def setUp(self):
@@ -397,7 +402,7 @@ class DynamicModelChoiceFieldTest(TestCase):
         self.assertEqual(self.field_with_to_field_name.prepare_value(address), address.address)
 
 
-class DynamicModelMultipleChoiceFieldTest(TestCase):
+class DynamicModelMultipleChoiceFieldTest(testing.TestCase):
     """Tests for DynamicModelMultipleChoiceField."""
 
     def setUp(self):
@@ -434,7 +439,7 @@ class DynamicModelMultipleChoiceFieldTest(TestCase):
         )
 
 
-class MultiValueCharFieldTest(TestCase):
+class MultiValueCharFieldTest(testing.TestCase):
     def setUp(self):
         self.filter = filters.MultiValueCharFilter()
         self.field = forms.MultiValueCharField()
@@ -467,7 +472,7 @@ class MultiValueCharFieldTest(TestCase):
         )
 
 
-class NumericArrayFieldTest(TestCase):
+class NumericArrayFieldTest(testing.TestCase):
     def setUp(self):
         super().setUp()
         # We need to use a field with required=False so we can test empty/None inputs
@@ -497,7 +502,7 @@ class NumericArrayFieldTest(TestCase):
                 self.field.clean(test)
 
 
-class AddressFieldMixinTest(TestCase):
+class AddressFieldMixinTest(testing.TestCase):
     """Test cases for the AddressFieldMixin."""
 
     def setUp(self):
@@ -527,7 +532,7 @@ class AddressFieldMixinTest(TestCase):
             mock_init.assert_called_with(initial=self.initial, instance=self.ip)
 
 
-class PrefixFieldMixinTest(TestCase):
+class PrefixFieldMixinTest(testing.TestCase):
     """Test cases for the PrefixFieldMixin."""
 
     def setUp(self):
@@ -576,7 +581,7 @@ class JSONFieldTest(testing.TestCase):
         self.assertEqual('"I am UTF-8! 😀"', forms.JSONField().prepare_value("I am UTF-8! 😀"))
 
 
-class MultiMatchModelMultipleChoiceFieldTest(TestCase):
+class MultiMatchModelMultipleChoiceFieldTest(testing.TestCase):
     def test_clean(self):
         field = forms.MultiMatchModelMultipleChoiceField(
             queryset=ipam_models.VLANGroup.objects.all(), to_field_name="name"
@@ -604,20 +609,57 @@ class MultiMatchModelMultipleChoiceFieldTest(TestCase):
                 field.clean(value)
 
 
-class WidgetsTest(TestCase):
+class WidgetsTest(testing.TestCase):
     def test_api_select_add_query_param_with_utf8(self):
         widget = forms.APISelect()
         widget.add_query_param("utf8", "I am UTF-8! 😀")
         self.assertEqual('["I am UTF-8! 😀"]', widget.attrs["data-query-param-utf8"])
 
 
-class DynamicFilterFormTest(TestCase):
+class DynamicFilterFormTest(testing.TestCase):
+    def test_get_filterset_parameter_form_field_all_filters(self):
+        """
+        Test every FilterSet to validate that Plural names are correctly mapped in get_filterset_parameter_form_field.
+        """
+        filterset_classes = set()
+        for app_config in django_apps.get_app_configs():
+            try:
+                filters_mod = sys.modules.get(f"{app_config.name}.filters")
+                if not filters_mod:
+                    continue
+                for _name, obj in inspect.getmembers(filters_mod):
+                    if (
+                        inspect.isclass(obj)  # Check if obj is a class
+                        and issubclass(obj, FilterSet)  # Check if obj is a subclass of FilterSet
+                        and obj is not FilterSet  # Exclude the base FilterSet class itself
+                        and getattr(getattr(obj, "_meta", None), "model", None)
+                        is not None  # Ensure the FilterSet has a model defined
+                    ):
+                        filterset_classes.add(obj)
+            except Exception as e:
+                # This test might start failing if an app's filters.py gets a design change.
+                self.fail(f"Error processing app '{app_config.name}': {e}")
+        for filterset_class in filterset_classes:
+            filterset = filterset_class()
+            model = filterset._meta.model
+            for filter_name in filterset.filters.keys():
+                try:
+                    field = get_filterset_parameter_form_field(model, filter_name, filterset=filterset)
+                    self.assertIsNotNone(field, "Field was unexpectedly None")
+                except KeyError as e:
+                    self.fail(
+                        f"A filter failed to operate due to mismatched plural name:"
+                        f" Check MODEL_VERBOSE_NAME_PLURAL_TO_FEATURE_NAME_MAPPING:"
+                        f" FilterClass: {filterset_class.__name__} name: {filter_name}: {e}"
+                    )
+
     # TODO(timizuo): investigate why test fails on CI
     # def test_dynamic_filter_form_with_missing_attr(self):
     #     with self.assertRaises(AttributeError) as err:
     #         DynamicFilterForm()
     #     self.assertEqual("'DynamicFilterForm' object requires `filterset_class` attribute", str(err.exception))
 
+    @tag("example_app")
     def test_dynamic_filter_form(self):
         form = forms.DynamicFilterForm(filterset=extras_filters.StatusFilterSet())
         location_form = forms.DynamicFilterForm(filterset=dcim_filters.LocationFilterSet())