Get tests passing for UI 2.0 (#3632)

* Get tests passing for UI 2.0

* Add changelog fragment.

* Updates from feedback

* Exception handling

changes/2901.added

@@ -0,0 +1 @@
+Added `get_absolute_url` method on `BaseModel` which will attempt to resolve the detail view route for all subclassed models.

examples/example_plugin/example_plugin/models.py

@@ -1,5 +1,4 @@
 from django.db import models
-from django.urls import reverse
 
 from nautobot.apps.models import extras_features, OrganizationalModel
 
@@ -26,9 +25,6 @@ class Meta:
     def __str__(self):
         return f"{self.name} - {self.number}"
 
-    def get_absolute_url(self):
-        return reverse("plugins:example_plugin:examplemodel", kwargs={"pk": self.pk})
-
     def to_csv(self):
         return (
             self.name,
@@ -51,6 +47,3 @@ class AnotherExampleModel(OrganizationalModel):
 
     class Meta:
         ordering = ["name"]
-
-    def get_absolute_url(self):
-        return reverse("plugins:example_plugin:anotherexamplemodel", kwargs={"pk": self.pk})

nautobot/circuits/models.py

@@ -1,7 +1,6 @@
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.db import models
-from django.urls import reverse
 
 from nautobot.dcim.fields import ASNField
 from nautobot.dcim.models import CableTermination, PathEndpoint
@@ -56,9 +55,6 @@ class Meta:
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("circuits:providernetwork", args=[self.slug])
-
     def to_csv(self):
         return (
             self.provider.name,
@@ -127,9 +123,6 @@ class Meta:
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("circuits:provider", args=[self.slug])
-
     def to_csv(self):
         return (
             self.name,
@@ -165,9 +158,6 @@ class Meta:
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("circuits:circuittype", args=[self.slug])
-
     def to_csv(self):
         return (
             self.name,
@@ -255,9 +245,6 @@ class Meta:
     def __str__(self):
         return self.cid
 
-    def get_absolute_url(self):
-        return reverse("circuits:circuit", args=[self.pk])
-
     def to_csv(self):
         return (
             self.cid,
@@ -325,9 +312,6 @@ class Meta:
     def __str__(self):
         return f"Termination {self.term_side}: {self.site or self.provider_network}"
 
-    def get_absolute_url(self):
-        return reverse("circuits:circuittermination", args=[self.pk])
-
     def clean(self):
         super().clean()
 

nautobot/core/api/urls.py

@@ -56,6 +56,8 @@
     path("graphql/", GraphQLDRFAPIView.as_view(), name="graphql-api"),
     # Plugins
     path("plugins/", include((plugin_api_patterns, "plugins-api"))),
+    # Core, keeping for backwards compatibility of the legacy UI (Dynamic Filter Form)
+    path("core/", include((core_api_patterns, "core-api"))),
     # UI
     path("ui/", include((ui_api_patterns, "ui-api"))),
 ]

nautobot/core/api/views.py

@@ -210,49 +210,49 @@ def get_serializer(self, *args, **kwargs):
         return super().get_serializer(*args, **kwargs)
 
     # TODO: the below needs to be either fixed or removed as part of issue #3042.
-    # def get_serializer_class(self):
-    #     logger = logging.getLogger("nautobot.core.api.views.ModelViewSet")
-
-    #     # If using 'brief' mode, find and return the nested serializer for this model, if one exists
-    #     if self.brief:
-    #         logger.debug("Request is for 'brief' format; initializing nested serializer")
-    #         try:
-    #             serializer = get_serializer_for_model(self.queryset.model, prefix="Nested")
-    #             logger.debug(f"Using serializer {serializer}")
-    #             return serializer
-    #         except SerializerNotFound:
-    #             logger.debug(f"Nested serializer for {self.queryset.model} not found!")
-
-    #     # Fall back to the hard-coded serializer class
-    #     return self.serializer_class
+    def get_serializer_class(self):
+        logger = logging.getLogger("nautobot.core.api.views.ModelViewSet")
+
+        # If using 'brief' mode, find and return the nested serializer for this model, if one exists
+        if self.brief:
+            logger.debug("Request is for 'brief' format; initializing nested serializer")
+            try:
+                serializer = get_serializer_for_model(self.queryset.model, prefix="Nested")
+                logger.debug(f"Using serializer {serializer}")
+                return serializer
+            except SerializerNotFound:
+                logger.debug(f"Nested serializer for {self.queryset.model} not found!")
+
+        # Fall back to the hard-coded serializer class
+        return self.serializer_class
 
     # TODO: this is part of issue #3042.
-    def get_serializer_context(self):
-        ctx = super().get_serializer_context()
-        ctx["request"] = None
-        try:
-            depth = int(self.request.query_params.get("depth", 0))
-        except ValueError:
-            depth = 0  # Ignore non-numeric parameters and keep default 0 depth
-        ctx["depth"] = depth
+    # def get_serializer_context(self):
+    #     ctx = super().get_serializer_context()
+    #     ctx["request"] = None
+    #     try:
+    #         depth = int(self.request.query_params.get("depth", 0))
+    #     except ValueError:
+    #         depth = 0  # Ignore non-numeric parameters and keep default 0 depth
+    #     ctx["depth"] = depth
 
-        return ctx
+    #     return ctx
 
     # TODO: the below needs to be either fixed or remvoed as part of issue #3042.
-    # def get_queryset(self):
-    #     # If using brief mode, clear all prefetches from the queryset and append only brief_prefetch_fields (if any)
-    #     if self.brief:
-    #         # v2 TODO(jathan): Replace prefetch_related with select_related
-    #         return super().get_queryset().prefetch_related(None).prefetch_related(*self.brief_prefetch_fields)
+    def get_queryset(self):
+        # If using brief mode, clear all prefetches from the queryset and append only brief_prefetch_fields (if any)
+        if self.brief:
+            # v2 TODO(jathan): Replace prefetch_related with select_related
+            return super().get_queryset().prefetch_related(None).prefetch_related(*self.brief_prefetch_fields)
 
-    #     return super().get_queryset()
+        return super().get_queryset()
 
-    # def initialize_request(self, request, *args, **kwargs):
-    #     # Check if brief=True has been passed
-    #     if request.method == "GET" and request.GET.get("brief"):
-    #         self.brief = True
+    def initialize_request(self, request, *args, **kwargs):
+        # Check if brief=True has been passed
+        if request.method == "GET" and request.GET.get("brief"):
+            self.brief = True
 
-    #     return super().initialize_request(request, *args, **kwargs)
+        return super().initialize_request(request, *args, **kwargs)
 
     def restrict_queryset(self, request, *args, **kwargs):
         """

nautobot/core/context_processors.py

@@ -36,7 +36,7 @@ def settings(request):
 
     return {
         "settings": django_settings,
-        "base_template": "base_react.html" if request.COOKIES.get("newui", False) else "base_django.html",
+        "root_template": "base_react.html" if request.COOKIES.get("newui", False) else "base_django.html",
     }
 
 

nautobot/core/models/__init__.py

@@ -1,8 +1,10 @@
 import uuid
 
 from django.db import models
+from django.urls import NoReverseMatch, reverse
 
 from nautobot.core.models.querysets import RestrictedQuerySet
+from nautobot.core.utils.lookup import get_route_for_model
 
 
 class BaseModel(models.Model):
@@ -34,6 +36,29 @@ def present_in_database(self):
         """
         return not self._state.adding
 
+    def get_absolute_url(self):
+        """
+        Return the canonical URL for this object.
+        """
+
+        # Iterate the pk-like fields and try to get a URL, or return None.
+        fields = ["pk", "slug"]  # TODO: Eventually all PKs
+        actions = ["retrieve", "detail", ""]  # TODO: Eventually all retrieve
+
+        for field in fields:
+            if not hasattr(self, field):
+                continue
+
+            for action in actions:
+                route = get_route_for_model(self, action)
+
+                try:
+                    return reverse(route, kwargs={field: getattr(self, field)})
+                except NoReverseMatch:
+                    continue
+
+        return AttributeError(f"Cannot find a URL for {self} ({self._meta.app_label}.{self._meta.model_name})")
+
     class Meta:
         abstract = True
 

nautobot/core/models/name_color_content_types.py

@@ -1,7 +1,6 @@
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from django.db.models import Q
-from django.urls import reverse
 
 from nautobot.core.choices import ColorChoices
 from nautobot.core.models import BaseModel
@@ -84,11 +83,6 @@ def __str__(self):
     def natural_key(self):
         return (self.name,)
 
-    def get_absolute_url(self):
-        ct = f"{self._meta.app_label}:{self._meta.model_name}"
-        # TODO(timizuo): Replace self.slug with natural key or pk
-        return reverse(ct, args=[self.slug])
-
     def get_content_types(self):
         return ",".join(f"{ct.app_label}.{ct.model}" for ct in self.content_types.all())
 

nautobot/core/templates/base.html

@@ -1 +1 @@
-{% extends base_template|default:'base_django.html' %}
+{% extends root_template|default:'base_django.html' %}

nautobot/core/utils/lookup.py

@@ -76,7 +76,9 @@ def get_route_for_model(model, action, api=False):
 
     suffix = "" if not api else "-api"
     prefix = f"{model._meta.app_label}{suffix}:{model._meta.model_name}"
-    sep = "_" if not api else "-"
+    sep = ""
+    if action != "":
+        sep = "_" if not api else "-"
     viewname = f"{prefix}{sep}{action}"
 
     if model._meta.app_label in settings.PLUGINS:

nautobot/core/views/generic.py

@@ -126,23 +126,22 @@ def get(self, request, *args, **kwargs):
         if isinstance(instance, ChangeLoggedModel):
             changelog_url = instance.get_changelog_url()
 
-        # TODO: we shouldn't be importing a private-named function from another module. Should it be renamed?
-        from nautobot.extras.templatetags.plugins import _get_registered_content
-
-        temp_fake_context = {
-            "object": instance,
-            "request": request,
-            "settings": {},
-            "csrf_token": "",
-            "perms": {},
-        }
-
-        plugin_tabs = _get_registered_content(instance, "detail_tabs", temp_fake_context, return_html=False)
-
         # TODO: this feels inelegant - should the tabs lookup be a dedicated endpoint rather than piggybacking
         # on the object-retrieve endpoint?
         # TODO: similar functionality probably needed in NautobotUIViewSet as well, not currently present
         if request.GET.get("viewconfig", None) == "true":
+            # TODO: we shouldn't be importing a private-named function from another module. Should it be renamed?
+            from nautobot.extras.templatetags.plugins import _get_registered_content
+
+            temp_fake_context = {
+                "object": instance,
+                "request": request,
+                "settings": {},
+                "csrf_token": "",
+                "perms": {},
+            }
+
+            plugin_tabs = _get_registered_content(instance, "detail_tabs", temp_fake_context, return_html=False)
             resp = {"tabs": plugin_tabs}
             return JsonResponse(resp)
         else:

nautobot/core/views/mixins.py

@@ -181,8 +181,12 @@ def get_return_url(self, request, obj=None):
         # Note that the use of both `obj.present_in_database` and `obj.pk` is correct here because this conditional
         # handles all three of the create, update, and delete operations. When Django deletes an instance
         # from the DB, it sets the instance's PK field to None, regardless of the use of a UUID.
-        if obj is not None and obj.present_in_database and obj.pk and hasattr(obj, "get_absolute_url"):
-            return obj.get_absolute_url()
+        try:
+            if obj is not None and obj.present_in_database and obj.pk:
+                return obj.get_absolute_url()
+        except AttributeError:
+            # Model has no get_absolute_url() method or no reverse match
+            pass
 
         # Fall back to the default URL (if specified) for the view.
         if self.default_return_url is not None:

nautobot/dcim/models/cables.py

@@ -6,7 +6,6 @@
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.db import models
 from django.db.models import Sum
-from django.urls import reverse
 from django.utils.functional import classproperty
 
 from nautobot.core.models.fields import ColorField
@@ -136,9 +135,6 @@ def __str__(self):
         pk = self.pk or self._pk
         return self.label or f"#{pk}"
 
-    def get_absolute_url(self):
-        return reverse("dcim:cable", args=[self.pk])
-
     @classproperty  # https://github.com/PyCQA/pylint-django/issues/240
     def STATUS_CONNECTED(cls):  # pylint: disable=no-self-argument
         """Return a cached "connected" `Status` object for later reference."""

nautobot/dcim/models/device_component_templates.py

@@ -76,6 +76,9 @@ def to_objectchange(self, action, **kwargs):
 
         return super().to_objectchange(action, related_object=device_type, **kwargs)
 
+    def get_absolute_url(self):
+        return self.device_type.get_absolute_url()
+
     def instantiate_model(self, model, device, **kwargs):
         """
         Helper method to self.instantiate().