nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/core/testing/views.py

@@ -1,6 +1,4 @@
-import csv
 import re
-from io import StringIO
 from typing import Optional, Sequence
 from unittest import skipIf
 import uuid
@@ -13,11 +11,11 @@ from django.test import TestCase as _TestCase
 from django.test import override_settings, tag
 from django.urls import NoReverseMatch, reverse
 from django.utils.http import urlencode
+from django.utils.html import escape
 from django.utils.text import slugify
 from tree_queries.models import TreeNode
 
 from nautobot.core import testing
-from nautobot.core.views import utils as view_utils
 from nautobot.core.templatetags import helpers
 from nautobot.core.testing import mixins
 from nautobot.core.utils import lookup
@@ -174,7 +172,7 @@ class ViewTestCases:
             response_body = testing.extract_page_body(response.content.decode(response.charset))
 
             # The object's display name or string representation should appear in the response
-            self.assertIn(getattr(instance, "display", str(instance)), response_body, msg=response_body)
+            self.assertIn(escape(getattr(instance, "display", str(instance))), response_body, msg=response_body)
 
             # If any Relationships are defined, they should appear in the response
             if self.relationships is not None:
@@ -182,13 +180,13 @@ class ViewTestCases:
                     content_type = ContentType.objects.get_for_model(instance)
                     if content_type == relationship.source_type:
                         self.assertIn(
-                            relationship.get_label(extras_choices.RelationshipSideChoices.SIDE_SOURCE),
+                            escape(relationship.get_label(extras_choices.RelationshipSideChoices.SIDE_SOURCE)),
                             response_body,
                             msg=response_body,
                         )
                     if content_type == relationship.destination_type:
                         self.assertIn(
-                            relationship.get_label(extras_choices.RelationshipSideChoices.SIDE_DESTINATION),
+                            escape(relationship.get_label(extras_choices.RelationshipSideChoices.SIDE_DESTINATION)),
                             response_body,
                             msg=response_body,
                         )
@@ -196,12 +194,14 @@ class ViewTestCases:
             # If any Custom Fields are defined, they should appear in the response
             if self.custom_fields is not None:
                 for custom_field in self.custom_fields:  # false positive pylint: disable=not-an-iterable
-                    self.assertIn(str(custom_field), response_body, msg=response_body)
+                    self.assertIn(escape(str(custom_field)), response_body, msg=response_body)
                     if custom_field.type == extras_choices.CustomFieldTypeChoices.TYPE_MULTISELECT:
                         for value in instance.cf.get(custom_field.key):
-                            self.assertIn(str(value), response_body, msg=response_body)
+                            self.assertIn(escape(str(value)), response_body, msg=response_body)
                     else:
-                        self.assertIn(str(instance.cf.get(custom_field.key) or ""), response_body, msg=response_body)
+                        self.assertIn(
+                            escape(str(instance.cf.get(custom_field.key) or "")), response_body, msg=response_body
+                        )
 
         @override_settings(EXEMPT_VIEW_PERMISSIONS=[])
         def test_get_object_with_constrained_permission(self):
@@ -656,8 +656,8 @@ class ViewTestCases:
             content = testing.extract_page_body(response.content.decode(response.charset))
             # TODO: it'd make test failures more readable if we strip the page headers/footers from the content
             if hasattr(self.model, "name"):
-                self.assertRegex(content, r">\s*" + re.escape(instance1.name) + r"\s*<", msg=content)
-                self.assertNotRegex(content, r">\s*" + re.escape(instance2.name) + r"\s*<", msg=content)
+                self.assertRegex(content, r">\s*" + re.escape(escape(instance1.name)) + r"\s*<", msg=content)
+                self.assertNotRegex(content, r">\s*" + re.escape(escape(instance2.name)) + r"\s*<", msg=content)
             try:
                 self.assertIn(self._get_url("view", instance=instance1), content, msg=content)
                 self.assertNotIn(self._get_url("view", instance=instance2), content, msg=content)
@@ -790,39 +790,6 @@ class ViewTestCases:
                 f"<div>You are viewing a table of {self.model._meta.verbose_name_plural}</div>", response_body
             )
 
-        @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
-        def test_queryset_to_csv(self):
-            # Built-in CSV export
-            if not hasattr(self.model, "csv_headers"):
-                self.skipTest(f"{self.model} has no csv_headers attribute?")
-            response = self.client.get(f"{self._get_url('list')}?export")
-            self.assertHttpStatus(response, 200)
-            self.assertEqual(response.get("Content-Type"), "text/csv")
-            instance1 = self._get_queryset().first()
-            # With filtering
-            response = self.client.get(f"{self._get_url('list')}?export&id={instance1.pk}")
-            self.assertHttpStatus(response, 200)
-            self.assertEqual(response.get("Content-Type"), "text/csv")
-            response_body = response.content.decode(response.charset)
-            reader = csv.DictReader(StringIO(response_body))
-            # This line will make data a dictionary with csv headers as keys and corresponding csv values as values.
-            # For example:
-            # {'name': 'AFRINIC', 'slug': 'afrinic', 'is_private': '', 'description': ...'}
-            data = [dict(row) for row in reader][0]
-
-            # Get expected data
-            instance1_unformatted_data = [
-                *instance1.to_csv(),
-                *instance1.get_custom_fields().values(),
-            ]
-            # Format expected data using `csv_format`, parse back with `csv` and get first row
-            instance1_csv_data = next(iter(csv.reader([view_utils.csv_format(instance1_unformatted_data)])))
-
-            instance1_cf_headers = [cf.add_prefix_to_cf_key() for cf in instance1.get_custom_fields().keys()]
-            instance1_csv_headers = list(self.model.csv_headers) + instance1_cf_headers
-            self.assertEqual(instance1_csv_headers, list(data.keys()))
-            self.assertEqual(instance1_csv_data, list(data.values()))
-
     class CreateMultipleObjectsViewTestCase(ModelViewTestCase):
         """
         Create multiple instances using a single form. Expects the creation of three new instances by default.
@@ -918,6 +885,9 @@ class ViewTestCases:
         """
         Create multiple instances from imported data.
 
+        Note that CSV import, since it's now implemented via the REST API,
+        is also exercised by APIViewTestCases.CreateObjectViewTestCase.test_recreate_object_csv().
+
         :csv_data: A list of CSV-formatted lines (starting with the headers) to be used for bulk object import.
         """
 
@@ -979,8 +949,13 @@ class ViewTestCases:
             self.assertHttpStatus(self.client.get(self._get_url("import")), 200)
 
             # Test POST with permission
-            self.assertHttpStatus(self.client.post(self._get_url("import"), data), 200)
-            self.assertEqual(self._get_queryset().count(), initial_count + len(self.csv_data) - 1)
+            response = self.client.post(self._get_url("import"), data)
+            self.assertHttpStatus(response, 200)
+            self.assertEqual(
+                self._get_queryset().count(),
+                initial_count + len(self.csv_data) - 1,
+                testing.extract_page_body(response.content.decode(response.charset)),
+            )
 
         @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])
         def test_bulk_import_objects_with_constrained_permission(self):

nautobot/core/tests/integration/test_filters.py

@@ -5,7 +5,7 @@ from nautobot.core.testing.integration import SeleniumTestCase
 from nautobot.dcim.factory import LocationTypeFactory
 from nautobot.dcim.models import Location, LocationType
 from nautobot.extras.choices import CustomFieldTypeChoices
-from nautobot.extras.models import CustomField, CustomFieldChoice
+from nautobot.extras.models import CustomField, CustomFieldChoice, Status
 
 
 class ListViewFilterTestCase(SeleniumTestCase):
@@ -22,11 +22,18 @@ class ListViewFilterTestCase(SeleniumTestCase):
         lt2 = LocationType.objects.get(name="Root")
         lt3 = LocationType.objects.get(name="Building")
         lt4 = LocationType.objects.get(name="Floor")
-        campus_loc = Location.objects.create(name="Filter Test Location 1", location_type=lt1)
-        Location.objects.create(name="Filter Test Location 2", location_type=lt2)
-        buidling_loc = Location.objects.create(name="Filter Test Location 3", location_type=lt3, parent=campus_loc)
-        Location.objects.create(name="Filter Test Location 4", location_type=lt4, parent=buidling_loc)
-        Location.objects.create(name="Filter Test Location 5", location_type=lt4, parent=buidling_loc)
+        location_status = Status.objects.get_for_model(Location).first()
+        campus_loc = Location.objects.create(name="Filter Test Location 1", location_type=lt1, status=location_status)
+        Location.objects.create(name="Filter Test Location 2", location_type=lt2, status=location_status)
+        building_loc = Location.objects.create(
+            name="Filter Test Location 3", location_type=lt3, parent=campus_loc, status=location_status
+        )
+        Location.objects.create(
+            name="Filter Test Location 4", location_type=lt4, parent=building_loc, status=location_status
+        )
+        Location.objects.create(
+            name="Filter Test Location 5", location_type=lt4, parent=building_loc, status=location_status
+        )
         # set test user to admin
         self.user.is_superuser = True
         self.user.save()
@@ -102,7 +109,8 @@ class ListViewFilterTestCase(SeleniumTestCase):
         # navigate back to the filter page and try the individual filter remove X button
         self.browser.visit(filtered_locations_url)
         remove_single_filter = self.browser.find_by_xpath(
-            "//div[@class='filters-applied']//span[@class='filter-selection']//span[@class='filter-selection-choice-remove remove-filter-param']",
+            "//div[@class='filters-applied']//span[@class='filter-selection']//"
+            "span[@class='filter-selection-choice-remove remove-filter-param']",
             wait_time=10,
         )
         remove_single_filter.click()
@@ -121,7 +129,8 @@ class ListViewFilterTestCase(SeleniumTestCase):
             value (str or int): The value to fill in the input field or select from the select field.
             field_type (str, optional): The type of the field, either "input" or "select".
             idx (int, optional): The index of the field in case there are multiple fields with the same name.
-            select2_field_name (str, optional): The name of the select2 field in case it is different from the input field name.
+            select2_field_name (str, optional): The name of the select2 field in case it is different from the
+                input field name.
         """
         if field_type == "input":
             self.browser.find_by_name(field_name)[idx].fill(value)

nautobot/core/tests/integration/test_navbar.py

@@ -1,6 +1,5 @@
 from django.test.utils import override_settings
 
-from nautobot.core.choices import ButtonActionColorChoices, ButtonActionIconChoices
 from nautobot.core.testing.integration import SeleniumTestCase
 
 
@@ -9,30 +8,22 @@ class NavBarTestCase(SeleniumTestCase):
 
     fixtures = ["user-data.json"]
     navbar = {
-        "Organization": {
-            "Locations": {
+        "Inventory": {
+            "Organization": {
                 "Locations": {
                     "permission": "dcim.view_location",
-                    "buttons": ["Add", "Import"],
-                },
-            },
-            "Tags": {
-                "Tags": {
-                    "permission": "extras.view_tag",
-                    "buttons": ["Add", "Import"],
                 },
             },
         },
-        "Extensibility": {
-            "Data Management": {
-                "Relationships": {
-                    "permission": "extras.view_relationship",
-                    "buttons": [
-                        "Add",
-                    ],
+        # don't use "Networks" here as the underspecified xpaths below will be fooled by DCIM "Provider Networks"
+        "Automation": {
+            "Extensibility": {
+                "Webhooks": {
+                    "permission": "extras.view_webhook",
                 },
             },
         },
+        # don't use "Platform" here as the underspecified xpaths below will be fooled by DCIM "Platforms"
     }
 
     def setUp(self):
@@ -66,23 +57,9 @@ class NavBarTestCase(SeleniumTestCase):
                 # Append onto tab xpath with group name search
                 group = tab.find_by_xpath(f"{tab_xpath}/following-sibling::ul//li[contains(text(), '{group_name}')]")
 
-                for item_name, item_details in items.items():
+                for item_name in items:
                     item_xpath = f"{tab_xpath}/following-sibling::ul//li[.//a[contains(text(), '{item_name}')]]"
-                    item = group.find_by_xpath(item_xpath)
-
-                    for button_name in item_details["buttons"]:
-                        button = item.find_by_xpath(f"{item_xpath}/div//a[@title='{button_name}']")
-                        # Ensure button has matching class for its name
-                        button_class = getattr(ButtonActionColorChoices, button_name.upper(), None)
-                        if button_class:
-                            rendered_button_class = button["class"].split(" ")[-1].split("-")[-1]
-                            self.assertEqual(button_class, rendered_button_class)
-                        # Ensure button has matching icon for its name
-                        button_icon = getattr(ButtonActionIconChoices, button_name.upper(), None)
-                        if button_icon:
-                            icon = button.find_by_xpath(f"{item_xpath}/div//a[@title='{button_name}']/i")
-                            rendered_button_icon = icon["class"].split(" ")[-1]
-                            self.assertEqual(button_icon, rendered_button_icon)
+                    group.find_by_xpath(item_xpath)
 
     @override_settings(HIDE_RESTRICTED_UI=False)
     def test_navbar_render_limit_permissions(self):
@@ -132,7 +109,7 @@ class NavBarTestCase(SeleniumTestCase):
                 # Append onto tab xpath with group name search
                 group = tab.find_by_xpath(f"{tab_xpath}/following-sibling::ul//li[contains(text(), '{group_name}')]")
 
-                for item_name, _ in items.items():
+                for item_name in items:
                     item_xpath = f"{tab_xpath}/following-sibling::ul//li[.//a[contains(text(), '{item_name}')]]"
                     item = group.find_by_xpath(item_xpath)
                     self.assertEqual(item["class"], "disabled", f"Item `{item_name}` should be disabled.")

nautobot/core/tests/integration/test_plugin_navbar.py

@@ -2,7 +2,6 @@ from unittest import skipIf
 
 from django.conf import settings
 
-from nautobot.core.choices import ButtonActionColorChoices, ButtonActionIconChoices
 from nautobot.core.testing.integration import SeleniumTestCase
 
 
@@ -15,47 +14,21 @@ class PluginNavBarTestCase(SeleniumTestCase):
 
     fixtures = ["user-data.json"]
     navbar = {
-        "Example Menu": {
-            "Example Group 1": {
+        "Inventory": {
+            "Example App": {
                 "Example Model": {
                     "permission": "example_plugin.view_examplemodel",
-                    "buttons": ["Add", "Import"],
                 },
             },
-        },
-        "Circuits": {
             "Circuits": {
                 "Circuits": {
                     "permission": "circuits.view_circuit",
-                    "buttons": ["Add", "Import"],
                 },
-                "Circuit Type": {
+                "Circuit Types": {
                     "permission": "circuits.view_circuittype",
-                    "buttons": ["Add", "Import"],
-                },
-            },
-            "Example Circuit Group": {
-                "Example Model": {
-                    "permission": "example_plugin.view_examplemodel",
-                    "buttons": ["Add", "Import"],
                 },
-            },
-            "Providers": {
                 "Providers": {
                     "permission": "circuits.view_provider",
-                    "buttons": ["Add", "Import"],
-                },
-            },
-        },
-        "Plugins": {
-            "Example Nautobot App": {
-                "Models": {
-                    "permission": "example_plugin.view_examplemodel",
-                    "buttons": ["Add a new example model", "Import example models"],
-                },
-                "Other Models": {
-                    "permission": "example_plugin.view_examplemodel",
-                    "buttons": [],
                 },
             },
         },
@@ -69,9 +42,9 @@ class PluginNavBarTestCase(SeleniumTestCase):
         self.logout()
         super().tearDown()
 
-    def test_plugin_navbar_new_tab(self):
+    def test_plugin_navbar_modify_context(self):
         """
-        Verify that a new menu tab defined and populated by the example plugin is rendered properly.
+        Verify that the example plugin is able to add a new group and items to an existing menu tab/context.
         """
         # Set test user to admin
         self.user.is_superuser = True
@@ -80,80 +53,13 @@ class PluginNavBarTestCase(SeleniumTestCase):
         # Retrieve home page
         self.browser.visit(self.live_server_url)
 
-        tab_xpath = "//*[@id='navbar']//*[contains(text(), 'Example Menu')]"
+        tab_xpath = "//*[@id='navbar']//*[contains(text(), 'Inventory')]"
         tab = self.browser.find_by_xpath(tab_xpath)
         tab.click()
         self.assertTrue(bool(tab["aria-expanded"]))
 
-        group = tab.find_by_xpath(f"{tab_xpath}/following-sibling::ul//li[contains(text(), 'Example Group 1')]")
-
-        item_xpath = f"{tab_xpath}/following-sibling::ul//li[.//a[contains(text(), 'Example Model')]]"
-        group.find_by_xpath(item_xpath)
-
-    def test_plugin_navbar_modify_circuits(self):
-        """
-        Verify that the example plugin is able to add a new group and items to an existing menu tab.
-        """
-        # Set test user to admin
-        self.user.is_superuser = True
-        self.user.save()
-
-        # Retrieve home page
-        self.browser.visit(self.live_server_url)
-
-        tab_xpath = "//*[@id='navbar']//*[contains(text(), 'Circuits')]"
-        tab = self.browser.find_by_xpath(tab_xpath)
-        tab.click()
-        self.assertTrue(bool(tab["aria-expanded"]))
-
-        for group_name, items in self.navbar["Circuits"].items():
-            group = tab.find_by_xpath(f"{tab_xpath}/following-sibling::ul//li[contains(text(), '{group_name}')]")
-            for item_name, item_details in items.items():
-                item_xpath = f"{tab_xpath}/following-sibling::ul//li[.//a[contains(text(), '{item_name}')]]"
-                item = group.find_by_xpath(item_xpath)
-
-                for button_name in item_details["buttons"]:
-                    button = item.find_by_xpath(f"{item_xpath}/div//a[@title='{button_name}']")
-                    # Ensure button has matching class for its name
-                    button_class = getattr(ButtonActionColorChoices, button_name.upper(), None)
-                    if button_class:
-                        self.assertIn(button_class, button["class"])
-                    # Ensure button has matching icon for its name
-                    button_icon = getattr(ButtonActionIconChoices, button_name.upper(), None)
-                    if button_icon:
-                        icon = button.find_by_xpath(f"{item_xpath}/div//a[@title='{button_name}']/i")
-                        self.assertIn(button_icon, icon["class"])
-
-    def test_plugin_navbar_plugin_tab(self):
-        """
-        Test that old-style plugin menu definitions are correctly rendered to the Plugins menu tab.
-        """
-        # Set test user to admin
-        self.user.is_superuser = True
-        self.user.save()
-
-        # Retrieve home page
-        self.browser.visit(self.live_server_url)
-
-        tab_xpath = "//*[@id='navbar']//*[contains(text(), 'Plugins')]"
-        tab = self.browser.find_by_xpath(tab_xpath)
-        tab.click()
-        self.assertTrue(bool(tab["aria-expanded"]))
-
-        for group_name, items in self.navbar["Plugins"].items():
+        for group_name, items in self.navbar["Inventory"].items():
             group = tab.find_by_xpath(f"{tab_xpath}/following-sibling::ul//li[contains(text(), '{group_name}')]")
-            for item_name, item_details in items.items():
+            for item_name in items:
                 item_xpath = f"{tab_xpath}/following-sibling::ul//li[.//a[contains(text(), '{item_name}')]]"
-                item = group.find_by_xpath(item_xpath)
-
-                for button_name in item_details["buttons"]:
-                    button = item.find_by_xpath(f"{item_xpath}/div//a[@title='{button_name}']")
-                    # Ensure button has matching class for its name
-                    button_class = getattr(ButtonActionColorChoices, button_name.upper(), None)
-                    if button_class:
-                        self.assertIn(button_class, button.get_attribute("class"))
-                    # Ensure button has matching icon for its name
-                    button_icon = getattr(ButtonActionIconChoices, button_name.upper(), None)
-                    if button_icon:
-                        icon = button.find_by_xpath(f"{item_xpath}/div//a[@title='{button_name}']/i")
-                        self.assertIn(button_icon, icon["class"])
+                group.find_by_xpath(item_xpath)

nautobot/core/tests/nautobot_config.py

@@ -12,7 +12,7 @@ ALLOWED_HOSTS = ["nautobot.example.com"]
 
 # Discover test jobs from within the Nautobot source code
 JOBS_ROOT = os.path.join(
-    os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))), "extras", "tests", "example_jobs"
+    os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))), "extras", "test_jobs"
 )
 
 # Enable both example plugins
@@ -28,8 +28,6 @@ SECRET_KEY = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
 
 # Use *different* redis_databases than the ones (0 and 1) used during non-automated-testing operations.
 CACHES["default"]["LOCATION"] = parse_redis_connection(redis_database=2)  # noqa: F405
-CACHEOPS_REDIS = parse_redis_connection(redis_database=3)
-CACHEOPS_ENABLED = False  # 2.0 TODO(jathan): Remove me.
 
 # Testing storages within cli.py
 STORAGE_CONFIG = {
@@ -48,6 +46,7 @@ TEST_FACTORY_SEED = "Nautobot"
 TEST_PERFORMANCE_BASELINE_FILE = "nautobot/core/tests/performance_baselines.yml"
 
 # Make Celery run synchronously (eager), to always store eager results, and run the broker in-memory.
+# NOTE: Celery does not honor the TASK_TRACK_STARTED config when running in eager mode, so the job result is not saved until after the task completes.
 CELERY_TASK_ALWAYS_EAGER = True
 CELERY_TASK_STORE_EAGER_RESULT = True
 CELERY_BROKER_URL = "memory://"