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

nautobot/circuits/navigation.py

@@ -1,14 +1,13 @@
-from nautobot.core.apps import NavMenuAddButton, NavMenuGroup, NavMenuItem, NavMenuImportButton, NavMenuTab
+from nautobot.core.apps import NavMenuGroup, NavMenuItem, NavMenuTab
 
 
 menu_items = (
     NavMenuTab(
-        name="Circuits",
-        weight=500,
+        name="Inventory",
         groups=(
             NavMenuGroup(
                 name="Circuits",
-                weight=100,
+                weight=400,
                 items=(
                     NavMenuItem(
                         link="circuits:circuit_list",
@@ -17,92 +16,38 @@ menu_items = (
                         permissions=[
                             "circuits.view_circuit",
                         ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="circuits:circuit_add",
-                                permissions=[
-                                    "circuits.add_circuit",
-                                ],
-                            ),
-                            NavMenuImportButton(
-                                link="circuits:circuit_import",
-                                permissions=[
-                                    "circuits.add_circuit",
-                                ],
-                            ),
-                        ),
+                    ),
+                    NavMenuItem(
+                        link="circuits:circuittermination_list",
+                        name="Circuit Terminations",
+                        weight=200,
+                        permissions=[
+                            "circuits.view_circuittermination",
+                        ],
                     ),
                     NavMenuItem(
                         link="circuits:circuittype_list",
                         name="Circuit Types",
-                        weight=200,
+                        weight=300,
                         permissions=[
                             "circuits.view_circuittype",
                         ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="circuits:circuittype_add",
-                                permissions=[
-                                    "circuits.add_circuittype",
-                                ],
-                            ),
-                            NavMenuImportButton(
-                                link="circuits:circuittype_import",
-                                permissions=[
-                                    "circuits.add_circuittype",
-                                ],
-                            ),
-                        ),
                     ),
-                ),
-            ),
-            NavMenuGroup(
-                name="Providers",
-                weight=200,
-                items=(
                     NavMenuItem(
                         link="circuits:provider_list",
                         name="Providers",
-                        weight=100,
+                        weight=400,
                         permissions=[
                             "circuits.view_provider",
                         ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="circuits:provider_add",
-                                permissions=[
-                                    "circuits.add_provider",
-                                ],
-                            ),
-                            NavMenuImportButton(
-                                link="circuits:provider_import",
-                                permissions=[
-                                    "circuits.add_provider",
-                                ],
-                            ),
-                        ),
                     ),
                     NavMenuItem(
                         link="circuits:providernetwork_list",
                         name="Provider Networks",
-                        weight=200,
+                        weight=500,
                         permissions=[
                             "circuits.view_providernetwork",
                         ],
-                        buttons=(
-                            NavMenuAddButton(
-                                link="circuits:providernetwork_add",
-                                permissions=[
-                                    "circuits.add_providernetwork",
-                                ],
-                            ),
-                            NavMenuImportButton(
-                                link="circuits:providernetwork_import",
-                                permissions=[
-                                    "circuits.add_providernetwork",
-                                ],
-                            ),
-                        ),
                     ),
                 ),
             ),

nautobot/circuits/signals.py

@@ -1,4 +1,3 @@
-from cacheops import invalidate_obj
 from django.contrib.contenttypes.models import ContentType
 from django.db import transaction
 from django.db.models import Q
@@ -29,7 +28,6 @@ def rebuild_paths_circuits(obj):
 
     with transaction.atomic():
         for cp in cable_paths:
-            invalidate_obj(cp.origin)
             cp.delete()
             # Prevent looping back to rebuild_paths during the atomic transaction.
             create_cablepath(cp.origin, rebuild=False)

nautobot/circuits/tables.py

@@ -9,7 +9,7 @@ from nautobot.core.tables import (
 )
 from nautobot.extras.tables import StatusTableMixin
 from nautobot.tenancy.tables import TenantColumn
-from .models import Circuit, CircuitType, Provider, ProviderNetwork
+from .models import Circuit, CircuitTermination, CircuitType, Provider, ProviderNetwork
 
 CIRCUIT_TERMINATION_PARENT = """
 {% load helpers %}
@@ -141,3 +141,41 @@ class CircuitTable(StatusTableMixin, BaseTable):
             "circuit_termination_z",
             "description",
         )
+
+
+#
+# Circuit Terminations
+#
+
+
+class CircuitTerminationTable(BaseTable):
+    pk = ToggleColumn()
+    circuit = tables.Column(linkify=True)
+    term_side = tables.Column(linkify=True)
+    location = tables.Column(linkify=True)
+    provider_network = tables.Column(linkify=True)
+    cable = tables.Column(linkify=True)
+
+    class Meta(BaseTable.Meta):
+        model = CircuitTermination
+        fields = (
+            "pk",
+            "circuit",
+            "term_side",
+            "location",
+            "provider_network",
+            "cable",
+            "port_speed",
+            "upstream_speed",
+            "xconnect_id",
+            "pp_info",
+            "description",
+            "tags",
+        )
+        default_columns = (
+            "pk",
+            "circuit",
+            "term_side",
+            "location",
+            "provider_network",
+        )

nautobot/circuits/tests/integration/test_relationships.py

@@ -57,8 +57,8 @@ class CircuitRelationshipsTestCase(SeleniumTestCase):
             name="Test Power Panel",
         )
         m2m = Relationship.objects.create(
-            name="Termination 2 Provider m2m",
-            slug="termination-2-provider-m2m",
+            label="Termination 2 Provider m2m",
+            key="termination_2_provider_m2m",
             source_type=circuit_termination_ct,
             destination_type=provider_ct,
             type=RelationshipTypeChoices.TYPE_MANY_TO_MANY,
@@ -74,8 +74,8 @@ class CircuitRelationshipsTestCase(SeleniumTestCase):
             destination=provider2,
         )
         o2m = Relationship.objects.create(
-            name="Termination 2 Location o2m",
-            slug="termination-2-provider-o2m",
+            label="Termination 2 Location o2m",
+            key="termination_2_provider_o2m",
             source_type=circuit_termination_ct,
             destination_type=location_ct,
             type=RelationshipTypeChoices.TYPE_ONE_TO_MANY,
@@ -86,8 +86,8 @@ class CircuitRelationshipsTestCase(SeleniumTestCase):
             destination=location,
         )
         o2o = Relationship.objects.create(
-            name="Termination 2 Power Panel o2o",
-            slug="termination-2-power-panel-o2o",
+            label="Termination 2 Power Panel o2o",
+            key="termination_2_power_panel_o2o",
             source_type=circuit_termination_ct,
             destination_type=power_panel_ct,
             type=RelationshipTypeChoices.TYPE_ONE_TO_ONE,
@@ -100,7 +100,7 @@ class CircuitRelationshipsTestCase(SeleniumTestCase):
         # https://github.com/nautobot/nautobot/issues/2077
         fake_ct = ContentType.objects.create(app_label="nonexistent", model="nonexistentmodel")
         bad_relation = Relationship.objects.create(
-            name="Termination 2 Nonexistent",
+            label="Termination 2 Nonexistent",
             source_type=circuit_termination_ct,
             destination_type=fake_ct,
             type=RelationshipTypeChoices.TYPE_MANY_TO_MANY,
@@ -122,8 +122,8 @@ class CircuitRelationshipsTestCase(SeleniumTestCase):
         """
         self.browser.visit(self.live_server_url)
 
-        # Click Circuits dropdown button
-        self.browser.links.find_by_partial_text("Circuits")[0].click()
+        # Click Inventory dropdown button
+        self.browser.links.find_by_partial_text("Inventory")[0].click()
 
         # Click Circuits link
         self.browser.links.find_by_partial_text("Circuits")[1].click()

nautobot/circuits/tests/test_api.py

@@ -17,7 +17,6 @@ class AppTest(APITestCase):
 
 class ProviderTest(APIViewTestCases.APIViewTestCase):
     model = Provider
-    brief_fields = ["circuit_count", "display", "id", "name", "url"]
     create_data = [
         {
             "name": "Provider 4",
@@ -37,7 +36,6 @@ class ProviderTest(APIViewTestCases.APIViewTestCase):
 
 class ProviderNetworkTest(APIViewTestCases.APIViewTestCase):
     model = ProviderNetwork
-    brief_fields = ["display", "id", "name", "slug", "url"]
 
     @classmethod
     def setUpTestData(cls):
@@ -76,7 +74,6 @@ class ProviderNetworkTest(APIViewTestCases.APIViewTestCase):
 
 class CircuitTypeTest(APIViewTestCases.APIViewTestCase):
     model = CircuitType
-    brief_fields = ["circuit_count", "display", "id", "name", "url"]
     create_data = (
         {
             "name": "Circuit Type 4",
@@ -103,7 +100,6 @@ class CircuitTypeTest(APIViewTestCases.APIViewTestCase):
 
 class CircuitTest(APIViewTestCases.APIViewTestCase):
     model = Circuit
-    brief_fields = ["cid", "display", "id", "url"]
 
     @classmethod
     def setUpTestData(cls):
@@ -160,7 +156,6 @@ class CircuitTest(APIViewTestCases.APIViewTestCase):
 
 class CircuitTerminationTest(APIViewTestCases.APIViewTestCase):
     model = CircuitTermination
-    brief_fields = ["cable", "circuit", "display", "id", "term_side", "url"]
     choices_fields = ["term_side"]
 
     @classmethod
@@ -175,11 +170,12 @@ class CircuitTerminationTest(APIViewTestCases.APIViewTestCase):
 
         provider = Provider.objects.first()
         circuit_type = CircuitType.objects.first()
+        status = Status.objects.get_for_model(Circuit).first()
 
         circuits = (
-            Circuit.objects.create(cid="Circuit 1", provider=provider, circuit_type=circuit_type),
-            Circuit.objects.create(cid="Circuit 2", provider=provider, circuit_type=circuit_type),
-            Circuit.objects.create(cid="Circuit 3", provider=provider, circuit_type=circuit_type),
+            Circuit.objects.create(cid="Circuit 1", provider=provider, circuit_type=circuit_type, status=status),
+            Circuit.objects.create(cid="Circuit 2", provider=provider, circuit_type=circuit_type, status=status),
+            Circuit.objects.create(cid="Circuit 3", provider=provider, circuit_type=circuit_type, status=status),
         )
 
         CircuitTermination.objects.create(circuit=circuits[0], location=locations[0], term_side=SIDE_A)

nautobot/circuits/tests/test_filters.py

@@ -39,9 +39,14 @@ class ProviderTestCase(FilterTestCases.NameOnlyFilterTestCase):
         circuit_types = CircuitType.objects.all()[:2]
         cls.locations = Location.objects.filter(children__isnull=True)[:2]
 
+        status = Status.objects.get_for_model(Circuit).first()
         circuits = (
-            Circuit.objects.create(provider=providers[0], circuit_type=circuit_types[0], cid="Test Circuit 1"),
-            Circuit.objects.create(provider=providers[1], circuit_type=circuit_types[1], cid="Test Circuit 1"),
+            Circuit.objects.create(
+                provider=providers[0], circuit_type=circuit_types[0], cid="Test Circuit 1", status=status
+            ),
+            Circuit.objects.create(
+                provider=providers[1], circuit_type=circuit_types[1], cid="Test Circuit 1", status=status
+            ),
         )
 
         CircuitTermination.objects.create(circuit=circuits[0], location=cls.locations[0], term_side="A")
@@ -150,8 +155,9 @@ class CircuitTerminationTestCase(FilterTestCases.FilterTestCase):
             status=device_status,
             location=location,
         )
-        interface1 = Interface.objects.create(device=device1, name="eth0")
-        interface2 = Interface.objects.create(device=device2, name="eth0")
+        interface_status = Status.objects.get_for_model(Interface).first()
+        interface1 = Interface.objects.create(device=device1, name="eth0", status=interface_status)
+        interface2 = Interface.objects.create(device=device2, name="eth0", status=interface_status)
 
         circuit_terminations = CircuitTermination.objects.all()
         circuit_terminations[0].tags.set(Tag.objects.get_for_model(CircuitTermination))

nautobot/circuits/tests/test_models.py

@@ -5,6 +5,7 @@ from nautobot.circuits.choices import CircuitTerminationSideChoices
 from nautobot.circuits.models import Circuit, CircuitTermination, CircuitType, Provider, ProviderNetwork
 from nautobot.core.testing.models import ModelTestCases
 from nautobot.dcim.models import Location, LocationType
+from nautobot.extras.models import Status
 
 
 class CircuitTerminationModelTestCase(ModelTestCases.BaseModelTestCase):
@@ -19,7 +20,10 @@ class CircuitTerminationModelTestCase(ModelTestCases.BaseModelTestCase):
         location_type_1.content_types.set([])
         location_type_2 = LocationType.objects.get(name="Building")
         location_type_2.content_types.add(ContentType.objects.get_for_model(CircuitTermination))
-        cls.circuit = Circuit.objects.create(cid="Circuit 1", provider=provider, circuit_type=circuit_type)
+        status = Status.objects.get_for_model(Circuit).first()
+        cls.circuit = Circuit.objects.create(
+            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]
         cls.location_2 = Location.objects.filter(location_type=location_type_2)[0]

nautobot/circuits/tests/test_views.py

@@ -10,6 +10,7 @@ from nautobot.circuits.models import (
     ProviderNetwork,
 )
 from nautobot.core.testing import post_data, TestCase as NautobotTestCase, ViewTestCases
+from nautobot.dcim.models import Location
 from nautobot.extras.models import Status, Tag
 
 
@@ -170,17 +171,38 @@ class ProviderNetworkTestCase(ViewTestCases.PrimaryObjectViewTestCase):
         cls.slug_source = "name"
 
 
-class CircuitTerminationTestCase(NautobotTestCase):
-    def setUp(self):
-        super().setUp()
-        self.user.is_superuser = True
-        self.user.save()
+class CircuitTerminationTestCase(
+    ViewTestCases.GetObjectViewTestCase,
+    ViewTestCases.GetObjectChangelogViewTestCase,
+    ViewTestCases.GetObjectNotesViewTestCase,
+    # create/edit views are special cases, not currently tested
+    ViewTestCases.DeleteObjectViewTestCase,
+    ViewTestCases.ListObjectsViewTestCase,
+    ViewTestCases.BulkImportObjectsViewTestCase,
+    # No bulk-edit support currently
+    ViewTestCases.BulkDeleteObjectsViewTestCase,
+):
+    model = CircuitTermination
+
+    @classmethod
+    def setUpTestData(cls):
+        circuit = Circuit.objects.filter(circuit_terminations__isnull=True).first()
+        provider_network = ProviderNetwork.objects.filter(circuit_terminations__isnull=True).first()
+        location = Location.objects.get_for_model(CircuitTermination).first()
+
+        cls.csv_data = (
+            "term_side,circuit,location,provider_network,port_speed",
+            f"A,{circuit.natural_key_slug},{location.natural_key_slug}",
+            f"Z,{circuit.natural_key_slug},,{provider_network.natural_key_slug},1000",
+        )
 
     def test_circuit_termination_detail_200(self):
         """
         This tests that a circuit termination's detail page (with a provider
         network instead of a site) returns a 200 response and doesn't contain the connect menu button.
         """
+        self.user.is_superuser = True
+        self.user.save()
 
         # Set up the required objects:
         provider = Provider.objects.first()

nautobot/circuits/views.py

@@ -2,6 +2,7 @@ from django.contrib import messages
 from django.db import transaction
 from django.db.models import Q
 from django.shortcuts import get_object_or_404, redirect, render
+from django.utils.http import is_safe_url
 from django_tables2 import RequestConfig
 
 
@@ -28,13 +29,11 @@ class CircuitTypeUIViewSet(
     view_mixins.ObjectChangeLogViewMixin,
     view_mixins.ObjectNotesViewMixin,
 ):
-    bulk_create_form_class = forms.CircuitTypeCSVForm
     filterset_class = filters.CircuitTypeFilterSet
     form_class = forms.CircuitTypeForm
     queryset = CircuitType.objects.annotate(circuit_count=count_related(Circuit, "circuit_type"))
     serializer_class = serializers.CircuitTypeSerializer
     table_class = tables.CircuitTypeTable
-    lookup_field = "pk"
 
     def get_extra_context(self, request, instance):
         # Circuits
@@ -61,15 +60,20 @@ class CircuitTypeUIViewSet(
 
 class CircuitTerminationUIViewSet(
     view_mixins.ObjectDetailViewMixin,
+    view_mixins.ObjectListViewMixin,
     view_mixins.ObjectEditViewMixin,
     view_mixins.ObjectDestroyViewMixin,
+    view_mixins.ObjectBulkDestroyViewMixin,
+    view_mixins.ObjectBulkCreateViewMixin,
     view_mixins.ObjectChangeLogViewMixin,
     view_mixins.ObjectNotesViewMixin,
 ):
+    action_buttons = ("import", "export")
+    filterset_class = filters.CircuitTerminationFilterSet
     form_class = forms.CircuitTerminationForm
-    lookup_field = "pk"
     queryset = CircuitTermination.objects.all()
     serializer_class = serializers.CircuitTerminationSerializer
+    table_class = tables.CircuitTerminationTable
 
     def get_object(self):
         obj = super().get_object()
@@ -77,12 +81,20 @@ class CircuitTerminationUIViewSet(
             obj.circuit = get_object_or_404(Circuit, pk=self.kwargs["circuit"])
         return obj
 
-    def get_return_url(self, request, obj):
-        return obj.circuit.get_absolute_url()
+    def get_return_url(self, request, obj=None):
+        # First, see if `return_url` was specified as a query parameter or form data. Use this URL only if it's
+        # considered safe.
+        query_param = request.GET.get("return_url") or request.POST.get("return_url")
+        if query_param and is_safe_url(url=query_param, allowed_hosts=request.get_host()):
+            return query_param
+
+        if obj is not None and obj.present_in_database and obj.pk:
+            return obj.circuit.get_absolute_url()
+
+        return super().get_return_url(request, obj=obj)
 
 
 class ProviderUIViewSet(NautobotUIViewSet):
-    bulk_create_form_class = forms.ProviderCSVForm
     bulk_update_form_class = forms.ProviderBulkEditForm
     filterset_class = filters.ProviderFilterSet
     filterset_form_class = forms.ProviderFilterForm
@@ -90,7 +102,6 @@ class ProviderUIViewSet(NautobotUIViewSet):
     queryset = Provider.objects.annotate(count_circuits=count_related(Circuit, "provider"))
     serializer_class = serializers.ProviderSerializer
     table_class = tables.ProviderTable
-    lookup_field = "pk"
 
     def get_extra_context(self, request, instance):
         context = super().get_extra_context(request, instance)
@@ -115,12 +126,10 @@ class ProviderUIViewSet(NautobotUIViewSet):
 
 
 class CircuitUIViewSet(NautobotUIViewSet):
-    bulk_create_form_class = forms.CircuitCSVForm
     bulk_update_form_class = forms.CircuitBulkEditForm
     filterset_class = filters.CircuitFilterSet
     filterset_form_class = forms.CircuitFilterForm
     form_class = forms.CircuitForm
-    lookup_field = "pk"
     # v2 TODO(jathan): Replace prefetch_related with select_related
     prefetch_related = ["provider", "circuit_type", "tenant", "circuit_termination_a", "circuit_termination_z"]
     queryset = Circuit.objects.all()
@@ -169,7 +178,6 @@ class CircuitUIViewSet(NautobotUIViewSet):
 
 class ProviderNetworkUIViewSet(NautobotUIViewSet):
     model = ProviderNetwork
-    bulk_create_form_class = forms.ProviderNetworkCSVForm
     bulk_update_form_class = forms.ProviderNetworkBulkEditForm
     filterset_class = filters.ProviderNetworkFilterSet
     filterset_form_class = forms.ProviderNetworkFilterForm

nautobot/core/api/__init__.py

@@ -4,10 +4,13 @@ from .fields import (
     SerializedPKRelatedField,
     TimeZoneSerializerField,
 )
-from .routers import OrderedDefaultRouter
 from .serializers import (
     BaseModelSerializer,
     BulkOperationSerializer,
+    CustomFieldModelSerializerMixin,
+    NautobotModelSerializer,
+    NotesSerializerMixin,
+    RelationshipModelSerializerMixin,
     TreeModelSerializerMixin,
     ValidatedModelSerializer,
     WritableNestedSerializer,
@@ -19,7 +22,10 @@ __all__ = (
     "BulkOperationSerializer",
     "ChoiceField",
     "ContentTypeField",
-    "OrderedDefaultRouter",
+    "CustomFieldModelSerializerMixin",
+    "NautobotModelSerializer",
+    "NotesSerializerMixin",
+    "RelationshipModelSerializerMixin",
     "SerializedPKRelatedField",
     "TimeZoneSerializerField",
     "TreeModelSerializerMixin",

nautobot/core/api/fields.py

@@ -1,5 +1,4 @@
 from collections import OrderedDict
-
 from django.core.exceptions import ObjectDoesNotExist
 from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
@@ -8,6 +7,7 @@ from rest_framework.relations import PrimaryKeyRelatedField, RelatedField
 from timezone_field.rest_framework import TimeZoneSerializerField as TimeZoneSerializerField_
 
 
+# TODO: why is this not a serializers.ChoiceField subclass??
 class ChoiceField(serializers.Field):
     """
     Represent a ChoiceField as {'value': <DB value>, 'label': <string>}. Accepts a single value on write.
@@ -51,9 +51,18 @@ class ChoiceField(serializers.Field):
                 return data
             raise ValidationError("This field may not be blank.")
 
+        if isinstance(data, dict):
+            if "value" in data:
+                data = data["value"]
+            else:
+                raise ValidationError(
+                    'Value must be passed directly (e.g. "foo": 123) '
+                    'or as a dict with key "value" (e.g. "foo": {"value": 123}).'
+                )
+
         # Provide an explicit error message if the request is trying to write a dict or list
-        if isinstance(data, (dict, list)):
-            raise ValidationError('Value must be passed directly (e.g. "foo": 123); do not use a dictionary or list.')
+        if isinstance(data, list):
+            raise ValidationError('Value must be passed directly (e.g. "foo": 123); do not use a list.')
 
         # Check for string representations of boolean/integer values
         if hasattr(data, "lower"):
@@ -110,9 +119,9 @@ class ObjectTypeField(serializers.CharField):
     Represent the ContentType of this serializer's model as "<app_label>.<model>".
     """
 
-    def __init__(self, *args, read_only=True, **kwargs):  # pylint: disable=useless-parent-delegation
+    def __init__(self, *args, read_only=True, source="*", **kwargs):  # pylint: disable=useless-parent-delegation
         """Default read_only to True as this should never be a writable field."""
-        super().__init__(*args, read_only=read_only, **kwargs)
+        super().__init__(*args, read_only=read_only, source=source, **kwargs)
 
     def to_representation(self, _value):
         """
@@ -121,7 +130,7 @@ class ObjectTypeField(serializers.CharField):
         Implemented this way because `_value` may be None when generating the schema.
         """
         model = self.parent.Meta.model
-        return f"{model._meta.app_label}.{model._meta.model_name}"
+        return model._meta.label_lower
 
 
 class SerializedPKRelatedField(PrimaryKeyRelatedField):

nautobot/core/api/filter_backends.py

@@ -17,11 +17,12 @@ class NautobotFilterBackend(DjangoFilterBackend):
 
         for non_filter_param in (
             "api_version",  # used to select the Nautobot API version
-            "brief",  # used to select NestedSerializer rather than Serializer
+            "depth",  # nested levels of the serializers default to depth=0
             "format",  # "json" or "api", used in the interactive HTML REST API views
-            "include",  # used to include computed fields (excluded by default)
+            "include",  # used to include computed fields, relationships, config-contexts, etc. (excluded by default)
             "limit",  # pagination
             "offset",  # pagination
+            "sort",  # sorting of results
         ):
             data.pop(non_filter_param, None)