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

nautobot/apps/filters.py

@@ -43,6 +43,7 @@ from nautobot.extras.filters.mixins import (
     StatusFilter,
 )
 from nautobot.extras.plugins import FilterExtension
+from nautobot.ipam.filters import PrefixFilter
 from nautobot.tenancy.filters import TenancyModelFilterSetMixin
 
 __all__ = (
@@ -72,6 +73,7 @@ __all__ = (
     "NaturalKeyOrPKMultipleChoiceFilter",
     "NautobotFilterSet",
     "NumericArrayFilter",
+    "PrefixFilter",
     "RelatedMembershipBooleanFilter",
     "RelationshipFilter",
     "RelationshipModelFilterSetMixin",

nautobot/circuits/filters.py

@@ -16,7 +16,7 @@ from nautobot.dcim.filters import (
 )
 from nautobot.dcim.models import Location
 from nautobot.extras.filters import NautobotFilterSet, StatusModelFilterSetMixin
-from nautobot.tenancy.filters import TenancyModelFilterSetMixin
+from nautobot.tenancy.filters.mixins import TenancyModelFilterSetMixin
 
 from .models import Circuit, CircuitTermination, CircuitType, Provider, ProviderNetwork
 

nautobot/circuits/templates/circuits/inc/circuit_termination.html

@@ -6,7 +6,7 @@ In a future release, we should delete this file.
 
 <div class="panel panel-default">
     <div class="panel-heading">
-        {% include 'circuits/inc/circuit_termination_header_extra_content.html' with termination=termination %}
+        {% include 'circuits/inc/circuit_termination_header_extra_content.html' with termination=termination side=side %}
         <strong>Termination - {{ side }} Side</strong>
     </div>
     {% if termination %}

nautobot/circuits/tests/integration/test_circuit.py

@@ -0,0 +1,135 @@
+from django.contrib.contenttypes.models import ContentType
+from django.urls import reverse
+
+from nautobot.circuits.models import Circuit, CircuitTermination, CircuitType, Provider
+from nautobot.core.testing.integration import ObjectDetailsMixin, ObjectsListMixin, SeleniumTestCase
+from nautobot.dcim.models import Location, LocationType
+from nautobot.extras.models import Status
+from nautobot.tenancy.models import Tenant, TenantGroup
+
+
+class CircuitTestCase(SeleniumTestCase, ObjectsListMixin, ObjectDetailsMixin):
+    """
+    Integration test to check circuits related test cases.
+    """
+
+    def setUp(self):
+        super().setUp()
+        self.login_as_superuser()
+
+        # Termination requirements
+        location_type, location_created = LocationType.objects.get_or_create(name="Circuit at Home")
+        if location_created:
+            location_ct = ContentType.objects.get_for_model(CircuitTermination)
+            location_type.content_types.set([location_ct])
+            location_type.save()
+
+        location_status = Status.objects.get_for_model(Location).first()
+        self.location, _ = Location.objects.get_or_create(
+            name="A Test Location",
+            status=location_status,
+            location_type=location_type,
+        )
+
+        self.provider, _ = Provider.objects.get_or_create(name="World Best Cables")
+        self.circuit_type, _ = CircuitType.objects.get_or_create(
+            name="Yellow Cable",
+        )
+        self.tenant_group, _ = TenantGroup.objects.get_or_create(name="Family Inc.")
+        self.tenant, _ = Tenant.objects.get_or_create(name="Tenant 1", tenant_group=self.tenant_group)
+
+    def create_circuit(self, name):
+        circuit, _ = Circuit.objects.get_or_create(
+            provider=self.provider,
+            cid=name,
+            circuit_type=self.circuit_type,
+            status=Status.objects.get_for_model(Circuit).first(),
+        )
+        return circuit
+
+    def test_circuit_create(self):
+        cid = "Circuit-test-abc123"
+        description = "My Precious Circuit"
+
+        # Create new Circuit from list view
+        self.click_navbar_entry("Circuits", "Circuits")
+        self.assertEqual(self.browser.url, self.live_server_url + reverse("circuits:circuit_list"))
+
+        self.click_list_view_add_button()
+        self.assertEqual(self.browser.url, self.live_server_url + reverse("circuits:circuit_add"))
+
+        # Fill Circuit creation form
+        self.fill_select2_field("provider", self.provider.name)
+        self.browser.fill("cid", cid)
+        self.fill_select2_field("circuit_type", self.circuit_type.name)
+        self.fill_select2_field("status", "")  # pick first status
+        self.browser.fill("install_date", "2025-01-01")
+        self.browser.fill("commit_rate", 192)
+        self.browser.fill("description", "My Precious Circuit")
+        self.fill_select2_field("tenant_group", "Family Inc.")
+        self.fill_select2_field("tenant", "Tenant 1")
+
+        self.click_edit_form_create_button()
+        self.assertTrue(self.browser.is_text_present("Created circuit Circuit-test-abc123"))
+
+        # Navigate to Circuit details by filtering the one just created and clicking on it
+        self.click_navbar_entry("Circuits", "Circuits")
+        self.assertEqual(self.browser.url, self.live_server_url + reverse("circuits:circuit_list"))
+
+        self.apply_filter("circuit_type", "Yellow Cable")
+        self.assertEqual(self.objects_list_visible_items, 1)
+
+        self.click_table_link()
+
+        # Assert that value are properly set
+        circuit = Circuit.objects.get(cid=cid)
+        self.assertIn(self.live_server_url + reverse("circuits:circuit", kwargs={"pk": circuit.pk}), self.browser.url)
+
+        self.assertPanelValue("Circuit", "Circuit ID", cid)
+        self.assertPanelValue("Circuit", "Status", "Active")
+        self.assertPanelValue("Circuit", "Provider", self.provider.name)
+        self.assertPanelValue("Circuit", "Circuit Type", self.circuit_type.name)
+        self.assertPanelValue("Circuit", "Tenant", self.tenant.name)
+        self.assertPanelValue("Circuit", "Date Installed", "Jan. 1, 2025")
+        self.assertPanelValue("Circuit", "Commit Rate (Kbps)", "192")
+        self.assertPanelValue("Circuit", "Description", description)
+
+    def test_circuit_create_termination(self):
+        circuit = self.create_circuit("Circuit-test-termination")
+        sides = ["A", "Z"]
+        for side in sides:
+            with self.subTest(side=side):
+                # Go to Circuit details page
+                details_url = self.live_server_url + reverse("circuits:circuit", kwargs={"pk": circuit.pk})
+                self.browser.visit(details_url)
+                self.assertIn(details_url, self.browser.url)
+
+                # Find and click add termination button
+                termination_panel_xpath = f'//*[@id="main"]//div[@class="panel-heading"][contains(normalize-space(), "Termination - {side} Side")]'
+                self.browser.find_by_xpath(f'{termination_panel_xpath}//a[normalize-space()="Add"]').click()
+
+                port_speed = ord(side)
+                upstream_speed = ord(side) + 10
+                xconnect_id = f"xconnect-id-{side}-123"
+                pp_info = f"pp-info-{side}-123"
+                description = f"{side}-side"
+
+                # Fill termination creation form
+                self.fill_select2_field("location", self.location.name)
+                self.browser.fill("port_speed", port_speed)
+                self.browser.fill("upstream_speed", upstream_speed)
+                self.browser.fill("xconnect_id", xconnect_id)
+                self.browser.fill("pp_info", pp_info)
+                self.browser.fill("description", description)
+                self.click_edit_form_create_button()
+
+                self.assertTrue(self.browser.is_text_present(f"Created circuit termination Termination {side}"))
+
+                # Assert that value are properly set
+                panel_label = f"Termination - {side} Side"
+                self.assertPanelValue(panel_label, "Location", self.location.name)
+                self.assertPanelValue(panel_label, "Port Speed (Kbps)", port_speed)
+                self.assertPanelValue(panel_label, "Upstream Speed (Kbps)", upstream_speed)
+                self.assertPanelValue(panel_label, "Cross-connect ID", xconnect_id)
+                self.assertPanelValue(panel_label, "Patch Panel/port(s)", pp_info)
+                self.assertPanelValue(panel_label, "Description", description)

nautobot/circuits/tests/test_models.py

@@ -17,8 +17,7 @@ class CircuitTerminationModelTestCase(ModelTestCases.BaseModelTestCase):
         provider = Provider.objects.first()
         circuit_type = CircuitType.objects.first()
 
-        location_type_1 = LocationType.objects.get(name="Campus")
-        location_type_1.content_types.set([])
+        location_type_1 = LocationType.objects.create(name="University")
         location_type_2 = LocationType.objects.get(name="Building")
         location_type_2.content_types.add(ContentType.objects.get_for_model(CircuitTermination))
         status = Status.objects.get_for_model(Circuit).first()
@@ -26,7 +25,10 @@ class CircuitTerminationModelTestCase(ModelTestCases.BaseModelTestCase):
             cid="Circuit 1", provider=provider, circuit_type=circuit_type, status=status
         )
         cls.provider_network = ProviderNetwork.objects.create(name="Provider Network 1", provider=provider)
-        cls.location_1 = Location.objects.filter(location_type=location_type_1)[0]
+        location_status = Status.objects.get_for_model(Location).first()
+        cls.location_1 = Location.objects.create(
+            name="Department", location_type=location_type_1, status=location_status
+        )
         cls.location_2 = Location.objects.filter(location_type=location_type_2)[0]
 
         cloud_resource_type = CloudResourceType.objects.get_for_model(CloudNetwork).first()

nautobot/circuits/views.py

@@ -134,6 +134,7 @@ class CircuitUIViewSet(NautobotUIViewSet):
 
     class CircuitTerminationPanel(ObjectFieldsPanel):
         def __init__(self, **kwargs):
+            self.side = kwargs.pop("side")
             super().__init__(
                 fields=(
                     "location",  # TODO: render location hierarchy
@@ -161,7 +162,7 @@ class CircuitUIViewSet(NautobotUIViewSet):
             return True
 
         def get_extra_context(self, context):
-            return {"termination": context[self.context_object_key]}
+            return {"termination": context[self.context_object_key], "side": self.side}
 
         def get_data(self, context):
             """
@@ -237,12 +238,14 @@ class CircuitUIViewSet(NautobotUIViewSet):
                 section=SectionChoices.RIGHT_HALF,
                 weight=100,
                 context_object_key="circuit_termination_a",
+                side=CircuitTerminationSideChoices.SIDE_A,
             ),
             CircuitTerminationPanel(
                 label="Termination - Z Side",
                 section=SectionChoices.RIGHT_HALF,
                 weight=200,
                 context_object_key="circuit_termination_z",
+                side=CircuitTerminationSideChoices.SIDE_Z,
             ),
         ),
     )

nautobot/cloud/api/views.py

@@ -1,5 +1,5 @@
 from nautobot.cloud import filters, models
-from nautobot.extras.api.views import NautobotModelViewSet
+from nautobot.extras.api.views import ModelViewSet, NautobotModelViewSet
 
 from . import serializers
 
@@ -26,7 +26,7 @@ class CloudNetworkViewSet(NautobotModelViewSet):
     filterset_class = filters.CloudNetworkFilterSet
 
 
-class CloudNetworkPrefixAssignmentViewSet(NautobotModelViewSet):
+class CloudNetworkPrefixAssignmentViewSet(ModelViewSet):
     queryset = models.CloudNetworkPrefixAssignment.objects.all()
     serializer_class = serializers.CloudNetworkPrefixAssignmentSerializer
     filterset_class = filters.CloudNetworkPrefixAssignmentFilterSet
@@ -38,7 +38,7 @@ class CloudServiceViewSet(NautobotModelViewSet):
     filterset_class = filters.CloudServiceFilterSet
 
 
-class CloudServiceNetworkAssignmentViewSet(NautobotModelViewSet):
+class CloudServiceNetworkAssignmentViewSet(ModelViewSet):
     queryset = models.CloudServiceNetworkAssignment.objects.all()
     serializer_class = serializers.CloudServiceNetworkAssignmentSerializer
     filterset_class = filters.CloudServiceNetworkAssignmentFilterSet

nautobot/cloud/filters.py

@@ -1,5 +1,3 @@
-import django_filters
-
 from nautobot.cloud import models
 from nautobot.core.filters import (
     BaseFilterSet,
@@ -11,7 +9,7 @@ from nautobot.dcim.models import Manufacturer
 from nautobot.extras.filters import NautobotFilterSet
 from nautobot.extras.models import SecretsGroup
 from nautobot.extras.utils import FeatureQuery
-from nautobot.ipam.models import Prefix
+from nautobot.ipam.filters import PrefixFilter
 
 
 class CloudAccountFilterSet(NautobotFilterSet):
@@ -98,7 +96,7 @@ class CloudNetworkFilterSet(NautobotFilterSet):
         queryset=models.CloudNetwork.objects.all(),
         label="Parent cloud network (name or ID)",
     )
-    prefixes = django_filters.ModelMultipleChoiceFilter(queryset=Prefix.objects.all())
+    prefixes = PrefixFilter()
 
     class Meta:
         model = models.CloudNetwork
@@ -117,8 +115,7 @@ class CloudNetworkPrefixAssignmentFilterSet(BaseFilterSet):
         queryset=models.CloudNetwork.objects.all(),
         label="Cloud network (name or ID)",
     )
-    # Prefix doesn't have an appropriate natural key for NaturalKeyOrPKMultipleChoiceFilter
-    prefix = django_filters.ModelMultipleChoiceFilter(queryset=Prefix.objects.all())
+    prefix = PrefixFilter()
 
     class Meta:
         model = models.CloudNetworkPrefixAssignment

nautobot/cloud/tests/test_filters.py

@@ -65,6 +65,7 @@ class CloudNetworkTestCase(FilterTestCases.FilterTestCase):
         ("name",),
         ("parent", "parent__id"),
         ("parent", "parent__name"),
+        ("prefixes", "prefixes__id"),
     ]
     exclude_q_filter_predicates = [
         "parent__name",
@@ -79,6 +80,16 @@ class CloudNetworkTestCase(FilterTestCases.FilterTestCase):
             queryset = queryset.filter(children__isnull=True)
         return queryset
 
+    def test_prefixes_filter_by_string(self):
+        """Test filtering by prefix strings as an alternative to pk."""
+        prefix = self.queryset.filter(prefixes__isnull=False).first().prefixes.first()
+        params = {"prefixes": [prefix.prefix]}
+        self.assertQuerysetEqualAndNotEmpty(
+            self.filterset(params, self.queryset).qs,
+            self.queryset.filter(prefixes__network=prefix.network, prefixes__prefix_length=prefix.prefix_length),
+            ordered=False,
+        )
+
 
 class CloudNetworkPrefixAssignmentTestCase(FilterTestCases.FilterTestCase):
     queryset = models.CloudNetworkPrefixAssignment.objects.all()
@@ -89,6 +100,16 @@ class CloudNetworkPrefixAssignmentTestCase(FilterTestCases.FilterTestCase):
         ("prefix", "prefix__id"),
     ]
 
+    def test_prefix_filter_by_string(self):
+        """Test filtering by prefix strings as an alternative to pk."""
+        prefix = self.queryset.first().prefix
+        params = {"prefix": [prefix.prefix]}
+        self.assertQuerysetEqualAndNotEmpty(
+            self.filterset(params, self.queryset).qs,
+            self.queryset.filter(prefix__network=prefix.network, prefix__prefix_length=prefix.prefix_length),
+            ordered=False,
+        )
+
 
 class CloudServiceNetworkAssignmentTestCase(FilterTestCases.FilterTestCase):
     queryset = models.CloudServiceNetworkAssignment.objects.all()

nautobot/core/admin.py

@@ -9,7 +9,9 @@ from django_celery_beat.models import (
     PeriodicTask,
     SolarSchedule,
 )
+import social_django.admin  # noqa: F401  # unused-import -- but this import installs the social_django admin
 from social_django.models import Association, Nonce, UserSocialAuth
+import taggit.admin  # noqa: F401  # unused-import -- but this import installs the taggit admin
 from taggit.models import Tag
 
 from nautobot.core.forms import BootstrapMixin

nautobot/core/constants.py

@@ -64,7 +64,6 @@ HTML_ALLOWED_TAGS = nh3.ALLOWED_TAGS - {
 # at present we just copy nh3.ALLOWED_ATTRIBUTES but we can modify this later as desired and appropriate
 HTML_ALLOWED_ATTRIBUTES = deepcopy(nh3.ALLOWED_ATTRIBUTES)
 
-
 #
 # Reserved Names
 #

nautobot/core/forms/__init__.py

@@ -61,6 +61,7 @@ from nautobot.core.forms.widgets import (
     APISelect,
     APISelectMultiple,
     BulkEditNullBooleanSelect,
+    ClearableFileInput,
     ColorSelect,
     ContentTypeSelect,
     DatePicker,
@@ -99,6 +100,7 @@ __all__ = (
     "CSVModelForm",
     "CSVMultipleChoiceField",
     "CSVMultipleContentTypeField",
+    "ClearableFileInput",
     "ColorSelect",
     "CommentField",
     "ConfirmationForm",

nautobot/core/forms/forms.py

@@ -10,6 +10,7 @@ from django.forms import formset_factory
 from django.urls import reverse
 import yaml
 
+from nautobot.core.forms import widgets as nautobot_widgets
 from nautobot.core.utils.filtering import build_lookup_label, get_filter_field_label, get_filterset_parameter_form_field
 from nautobot.ipam import formfields
 
@@ -76,9 +77,9 @@ class BootstrapMixin(forms.BaseForm):
 
         exempt_widgets = [
             forms.CheckboxInput,
-            forms.ClearableFileInput,
             forms.FileInput,
             forms.RadioSelect,
+            nautobot_widgets.ClearableFileInput,
         ]
 
         for field in self.fields.values():

nautobot/core/forms/widgets.py

@@ -13,6 +13,7 @@ __all__ = (
     "APISelect",
     "APISelectMultiple",
     "BulkEditNullBooleanSelect",
+    "ClearableFileInput",
     "ColorSelect",
     "ContentTypeSelect",
     "DatePicker",
@@ -256,3 +257,10 @@ class MultiValueCharInput(StaticSelect2Multiple):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.attrs["class"] = "nautobot-select2-multi-value-char"
+
+
+class ClearableFileInput(forms.ClearableFileInput):
+    template_name = "widgets/clearable_file.html"
+
+    class Media:
+        js = ["bootstrap-filestyle-1.2.3/bootstrap-filestyle.min.js"]

nautobot/core/jobs/__init__.py

@@ -229,7 +229,8 @@ class ExportObjectList(Job):
             # The force_csv=True attribute is a hack, but much easier than trying to construct a valid HttpRequest
             # object from scratch that passes all implicit and explicit assumptions in Django and DRF.
             serializer = serializer_class(queryset, many=True, context={"request": None}, force_csv=True)
-            csv_data = renderer.render(serializer.data)
+            # Explicitly add UTF-8 BOM to the data so that Excel will understand non-ASCII characters correctly...
+            csv_data = codecs.BOM_UTF8 + renderer.render(serializer.data).encode("utf-8")
             self.create_file(filename + ".csv", csv_data)