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

nautobot/core/cli/bootstrap_v3_to_v5.py

@@ -135,6 +135,61 @@ def _fix_nav_tabs_items(html: str, stats: dict, file_path=None) -> str:
     return pattern.sub(ul_replacer, html)
 
 
+def _fix_dropdown_lis(html: str, stats: dict, file_path=None) -> str:
+    """Adds 'dropdown-item' class to all <li><a>...</a></li> tags in the given HTML string."""
+
+    def a_replacer(match):
+        a_tag = match.group(0)
+        # If Django template logic is found, notify user and skip auto-fix
+        if re.search(r"{%.*%}", a_tag):
+            if "manual_nav_template_lines" not in stats:
+                stats["manual_nav_template_lines"] = []
+            # Get line number and character position of li_tag
+            html_lines = html.splitlines()
+            for i, line in enumerate(html_lines):
+                if a_tag in line:
+                    # Append line number, character position and file path for easier identification
+                    stats["manual_nav_template_lines"].append(
+                        f"{file_path}:{i + 1}:{line.index(a_tag)} - Please review manually '{a_tag}'"
+                    )
+                    break
+            else:
+                stats["manual_nav_template_lines"].append(f"{file_path} - Please review manually '{a_tag}'")
+            return a_tag
+
+        # Add dropdown-item to <a>
+        class_attr_match = re.search(r"""class=(["'])(.*?)\1""", a_tag)
+        if class_attr_match:
+            classes = class_attr_match.group(2).split()
+            if not any("dropdown-item" in _class for _class in classes):
+                classes.append("dropdown-item")
+                stats["dropdown_items"] += 1
+            new_class_attr = f'class="{" ".join(classes)}"'
+            a_tag = re.sub(r"""class=(["'])(.*?)\1""", new_class_attr, a_tag, count=1)
+        else:
+            a_tag = re.sub(r"<a(\s|>)", r'<a class="dropdown-item"\1', a_tag, count=1)
+            stats["dropdown_items"] += 1
+
+        return a_tag
+
+    return re.sub("<a[^>]*>.*?</a>", a_replacer, html, flags=re.DOTALL)
+
+
+def _fix_dropdown_items(html: str, stats: dict, file_path=None) -> str:
+    """Ensures that all <li> elements within <ul class="dropdown-menu"> have class="dropdown-item" as appropriate."""
+
+    def ul_replacer(ul_match):
+        ul_tag = ul_match.group(0)
+        ul_tag_new = _fix_dropdown_lis(ul_tag, stats, file_path=file_path)
+        return ul_tag_new
+
+    pattern = re.compile(
+        r"""<ul\s+class=(["'])(?:[^"']*\s)?dropdown-menu(?:\s[^"']*)?\1[^>]*>.*?</ul>""",
+        re.DOTALL | re.IGNORECASE,
+    )
+    return pattern.sub(ul_replacer, html)
+
+
 def _fix_extra_nav_tabs_block(html_string: str, stats: dict, file_path: str) -> str:
     """
     Finds {% block extra_nav_tabs %} blocks and adds nav-item/nav-link to <li> tags inside using regex.
@@ -505,6 +560,7 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
         "extra_breadcrumbs": 0,
         "breadcrumb_items": 0,
         "nav_items": 0,
+        "dropdown_items": 0,
         "panel_classes": 0,
         "manual_nav_template_lines": [],
     }
@@ -521,6 +577,7 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
         "checkbox-inline": "form-check-input",
         "close": "btn-close",
         "control-label": "col-form-label",
+        "dropdown-menu-right": "dropdown-menu-end",
         "form-control-static": "form-control-plaintext",
         "form-group": "mb-10 d-flex justify-content-center",
         "help-block": "form-text",
@@ -582,6 +639,7 @@ def convert_bootstrap_classes(html_input: str, file_path: str) -> tuple[str, dic
     current_html = _convert_caret_in_span_to_mdi(current_html, stats)
     current_html = _convert_hover_copy_buttons(current_html, stats)
     current_html = _fix_nav_tabs_items(current_html, stats, file_path=file_path)
+    current_html = _fix_dropdown_items(current_html, stats, file_path=file_path)
 
     return current_html, stats
 
@@ -598,7 +656,15 @@ def fix_html_files_in_directory(directory: str, resize=False) -> None:
 
     totals = {
         k: 0
-        for k in ["replacements", "extra_breadcrumbs", "breadcrumb_items", "nav_items", "panel_classes", "resizing_xs"]
+        for k in [
+            "replacements",
+            "extra_breadcrumbs",
+            "breadcrumb_items",
+            "nav_items",
+            "dropdown_items",
+            "panel_classes",
+            "resizing_xs",
+        ]
     }
     # Breakpoints that are not xs do not count as failures in djlint, so we keep a separate counter
     resizing_other = 0
@@ -663,6 +729,8 @@ def fix_html_files_in_directory(directory: str, resize=False) -> None:
                         print(f"{stats['breadcrumb_items']} breadcrumb-items, ", end="")
                     if stats["nav_items"]:
                         print(f"{stats['nav_items']} nav-items, ", end="")
+                    if stats["dropdown_items"]:
+                        print(f"{stats['dropdown_items']} dropdown-items, ", end="")
                     if stats["panel_classes"]:
                         print(f"{stats['panel_classes']} panel replacements, ", end="")
                     print()
@@ -683,6 +751,7 @@ def fix_html_files_in_directory(directory: str, resize=False) -> None:
     print(f"- Extra-breadcrumb fixes:      {totals['extra_breadcrumbs']}")
     print(f"- <li> in <ol.breadcrumb>:     {totals['breadcrumb_items']}")
     print(f"- <li> in <ul.nav-tabs>:       {totals['nav_items']}")
+    print(f"- <a> in <ul.dropdown-menu>:   {totals['dropdown_items']}")
     print(f"- Panel class replacements:    {totals['panel_classes']}")
     print(f"- Resizing breakpoint xs:      {totals['resizing_xs']}")
     print("-------------------------------------")

nautobot/core/cli/migrate_deprecated_templates.py

@@ -0,0 +1,200 @@
+import argparse
+import os
+import re
+
+TEMPLATE_REPLACEMENTS = {
+    # Format: new_template: [old_template1, old_template2, ...]
+    "circuits/circuit_create.html": ["circuits/circuit_edit.html"],
+    "circuits/circuittermination_create.html": ["circuits/circuittermination_edit.html"],
+    "circuits/provider_create.html": ["circuits/provider_edit.html"],
+    "circuits/provider_retrieve.html": ["circuits/provider.html"],
+    "dcim/cable_retrieve.html": ["dcim/cable.html"],
+    "dcim/cable_update.html": ["dcim/cable_edit.html"],
+    "dcim/device_create.html": ["dcim/device_edit.html"],
+    "dcim/devicetype_update.html": ["dcim/devicetype_edit.html"],
+    "dcim/location_retrieve.html": ["dcim/location.html"],
+    "dcim/location_update.html": ["dcim/location_edit.html"],
+    "dcim/rack_retrieve.html": ["dcim/rack.html"],
+    "dcim/rack_update.html": ["dcim/rack_edit.html"],
+    "dcim/rackreservation_retrieve.html": ["dcim/rackreservation.html"],
+    "dcim/virtualchassis_create.html": ["dcim/virtualchassis_add.html"],
+    "extras/configcontext_update.html": ["extras/configcontext_edit.html"],
+    "extras/configcontextschema_retrieve.html": ["extras/configcontextschema.html"],
+    "extras/configcontextschema_update.html": ["extras/configcontextschema_edit.html"],
+    "extras/customfield_update.html": ["extras/customfield_edit.html"],
+    "extras/dynamicgroup_retrieve.html": ["extras/dynamicgroup.html"],
+    "extras/dynamicgroup_update.html": ["extras/dynamicgroup_edit.html"],
+    "extras/gitrepository_retrieve.html": ["extras/gitrepository.html"],
+    "extras/gitrepository_update.html": ["extras/gitrepository_object_edit.html"],
+    "extras/graphqlquery_retrieve.html": ["extras/graphqlquery.html"],
+    "extras/jobresult_retrieve.html": ["extras/jobresult.html"],
+    "extras/note_retrieve.html": ["extras/note.html"],
+    "extras/objectchange_retrieve.html": ["extras/objectchange.html"],
+    "extras/secretsgroup_update.html": ["extras/secretsgroup_edit.html"],
+    "extras/tag_update.html": ["extras/tag_edit.html"],
+    "generic/object_bulk_create.html": ["generic/object_bulk_import.html"],
+    "generic/object_bulk_destroy.html": ["generic/object_bulk_delete.html"],
+    "generic/object_bulk_update.html": ["generic/object_bulk_edit.html"],
+    "generic/object_changelog.html": ["extras/object_changelog.html"],
+    "generic/object_create.html": ["dcim/powerpanel_edit.html", "generic/object_edit.html", "ipam/service_edit.html"],
+    "generic/object_destroy.html": ["generic/object_delete.html"],
+    "generic/object_notes.html": ["extras/object_notes.html"],
+    "generic/object_retrieve.html": [
+        "circuits/circuit.html",
+        "circuits/circuit_retrieve.html",
+        "circuits/circuittermination.html",
+        "circuits/circuittermination_retrieve.html",
+        "circuits/circuittype.html",
+        "circuits/circuittype_retrieve.html",
+        "circuits/providernetwork.html",
+        "circuits/providernetwork_retrieve.html",
+        "cloud/cloudaccount_retrieve.html",
+        "cloud/cloudnetwork_retrieve.html",
+        "cloud/cloudresourcetype_retrieve.html",
+        "cloud/cloudservice_retrieve.html",
+        "dcim/controller/base.html",
+        "dcim/controller_retrieve.html",
+        "dcim/controller_wirelessnetworks.html",
+        "dcim/controllermanageddevicegroup_retrieve.html",
+        "dcim/device/base.html",
+        "dcim/device/consoleports.html",
+        "dcim/device/consoleserverports.html",
+        "dcim/device/devicebays.html",
+        "dcim/device/frontports.html",
+        "dcim/device/interfaces.html",
+        "dcim/device/inventory.html",
+        "dcim/device/modulebays.html",
+        "dcim/device/poweroutlets.html",
+        "dcim/device/powerports.html",
+        "dcim/device/rearports.html",
+        "dcim/device/wireless.html",
+        "dcim/devicefamily_retrieve.html",
+        "dcim/deviceredundancygroup_retrieve.html",
+        "dcim/devicetype.html",
+        "dcim/devicetype_retrieve.html",
+        "dcim/interfaceredundancygroup_retrieve.html",
+        "dcim/locationtype.html",
+        "dcim/locationtype_retrieve.html",
+        "dcim/manufacturer.html",
+        "dcim/platform.html",
+        "dcim/powerfeed.html",
+        "dcim/powerfeed_retrieve.html",
+        "dcim/powerpanel.html",
+        "dcim/powerpanel_retrieve.html",
+        "dcim/rackgroup.html",
+        "dcim/softwareimagefile_retrieve.html",
+        "dcim/softwareversion_retrieve.html",
+        "dcim/virtualchassis.html",
+        "dcim/virtualchassis_retrieve.html",
+        "dcim/virtualdevicecontext_retrieve.html",
+        "extras/computedfield.html",
+        "extras/computedfield_retrieve.html",
+        "extras/configcontext.html",
+        "extras/configcontext_retrieve.html",
+        "extras/contact_retrieve.html",
+        "extras/customfield.html",
+        "extras/customfield_retrieve.html",
+        "extras/customlink.html",
+        "extras/exporttemplate.html",
+        "extras/job_detail.html",
+        "extras/jobbutton_retrieve.html",
+        "extras/jobhook.html",
+        "extras/jobqueue_retrieve.html",
+        "extras/metadatatype_retrieve.html",
+        "extras/secretsgroup.html",
+        "extras/secretsgroup_retrieve.html",
+        "extras/status.html",
+        "extras/tag.html",
+        "extras/tag_retrieve.html",
+        "extras/team_retrieve.html",
+        "generic/object_detail.html",
+        "ipam/rir.html",
+        "ipam/service.html",
+        "ipam/service_retrieve.html",
+        "ipam/vlan.html",
+        "ipam/vlan_retrieve.html",
+        "ipam/vlangroup.html",
+        "tenancy/tenant.html",
+        "virtualization/clustergroup.html",
+        "virtualization/clustertype.html",
+        "virtualization/virtualmachine.html",
+        "virtualization/virtualmachine_retrieve.html",
+        "wireless/radioprofile_retrieve.html",
+        "wireless/supporteddatarate_retrieve.html",
+        "wireless/wirelessnetwork_retrieve.html",
+    ],
+    "ipam/prefix_retrieve.html": ["ipam/prefix.html"],
+    "ipam/vlan_update.html": ["ipam/vlan_edit.html"],
+    "tenancy/tenant_create.html": ["tenancy/tenant_edit.html"],
+    "tenancy/tenantgroup_retrieve.html": ["tenancy/tenantgroup.html"],
+    "virtualchassis_update.html": ["dcim/virtualchassis_edit.html"],
+    "virtualization/virtualmachine_update.html": ["virtualization/virtualmachine_edit.html"],
+}
+
+
+def replace_template_references(content: str) -> tuple[str, bool]:
+    """
+    Replaces references to deprecated templates with new ones.
+
+    Args:
+        content: The content of the file to replace references in.
+
+    Returns:
+        A tuple containing the updated content and a boolean indicating if any changes were made.
+    """
+    for new_template, old_templates in TEMPLATE_REPLACEMENTS.items():
+        for old_template in old_templates:
+            pattern = rf"(\{{%\s*extends\s*['\"]){re.escape(old_template)}(['\"]\s*%\}})"
+            new_content, count = re.subn(pattern, rf"\1{new_template}\2", content)
+            if count > 0:
+                # A django template can only have one extends statement, so we can return as soon as we find a match.
+                return new_content, True
+
+    return content, False
+
+
+def replace_deprecated_templates(path: str, dry_run: bool = False):
+    """
+    Recursively finds all .html files in the given directory,
+    and replaces references to deprecated templates with new ones.
+    """
+
+    if os.path.isfile(path):
+        only_filename = os.path.basename(path)
+        path = os.path.dirname(path)
+    else:
+        only_filename = None
+
+    for root, _, files in os.walk(path):
+        for filename in files:
+            if only_filename and only_filename != filename:
+                continue
+            if filename.endswith((".html")):
+                file_path = os.path.join(root, filename)
+                with open(file_path, "r", encoding="utf-8") as f:
+                    original_content = f.read()
+
+                content = original_content
+
+                fixed_content, was_updated = replace_template_references(content)
+
+                if was_updated:
+                    if dry_run:
+                        print(f"Detected deprecated template reference in {file_path}")
+                        continue
+                    with open(file_path, "w", encoding="utf-8") as f:
+                        f.write(fixed_content)
+                    print(f"Updated: {file_path}")
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Replace deprecated templates with new ones")
+    parser.add_argument("path", type=str, help="Path to directory in which to recursively fix all .html files.")
+    parser.add_argument("--dry-run", action="store_true", help="Do not make any changes to the files.")
+    args = parser.parse_args()
+
+    replace_deprecated_templates(args.path, args.dry_run)
+
+
+if __name__ == "__main__":
+    main()

nautobot/core/constants.py

@@ -210,3 +210,6 @@ GLOBAL_SEARCH_EXCLUDE_LIST = [
     "vrfprefixassignment",
     "webhook",
 ]
+
+# M2M fields that are included by default in API responses if exclude_m2m is not provided
+DEFAULT_M2M_FIELDS = ["tags", "content_types", "object_types"]

nautobot/core/context_processors.py

@@ -1,3 +1,5 @@
+from urllib.parse import urlparse
+
 from django.conf import settings as django_settings
 from django.urls import NoReverseMatch, reverse
 
@@ -78,6 +80,12 @@ def nav_menu(request):
             pass
 
     nav_menu_object = {"tabs": {}}
+
+    if htmx_current_url := request.headers.get("HX-Current-URL"):
+        current_url = urlparse(htmx_current_url).path
+    else:
+        current_url = request.path
+
     for tab_name, tab_details in registry["nav_menu"]["tabs"].items():
         if not tab_details["permissions"] or has_one_or_more_perms(request.user, tab_details["permissions"]):
             nav_menu_object["tabs"][tab_name] = {"groups": {}, "icon": tab_details["icon"]}
@@ -93,7 +101,7 @@ def nav_menu(request):
                             if has_identified_active_link:
                                 is_active = False
                             else:
-                                is_active = item_link in [request.path, related_list_view_link]
+                                is_active = item_link in [current_url, related_list_view_link]
                                 if is_active:
                                     has_identified_active_link = True
 

nautobot/core/forms/forms.py

@@ -377,7 +377,7 @@ class DynamicFilterForm(BootstrapMixin, forms.Form):
 
     def _get_lookup_field_choices(self):
         """Get choices for lookup_fields i.e filterset parameters without a lookup expr"""
-        from nautobot.extras.filters.mixins import RelationshipFilter  # Avoid circular import
+        from nautobot.extras.filter_mixins import RelationshipFilter  # Avoid circular import
 
         filterset_without_lookup = (
             (

nautobot/core/jobs/__init__.py

@@ -22,7 +22,7 @@ from nautobot.core.celery import app, register_jobs
 from nautobot.core.exceptions import AbortTransaction
 from nautobot.core.jobs.bulk_actions import BulkDeleteObjects, BulkEditObjects
 from nautobot.core.jobs.cleanup import LogsCleanup
-from nautobot.core.jobs.groups import RefreshDynamicGroupCaches
+from nautobot.core.jobs.groups import RefreshDynamicGroupCacheJobButtonReceiver, RefreshDynamicGroupCaches
 from nautobot.core.utils.lookup import get_filterset_for_model
 from nautobot.core.utils.requests import get_filterable_params_from_filter_params
 from nautobot.data_validation import models
@@ -440,8 +440,10 @@ def clean_compliance_rules_results_for_instance(instance, excluded_pks):
 class RunRegisteredDataComplianceRules(Job):
     """Run the validate function on all registered DataComplianceRule classes and, optionally, the built-in data validation rules."""
 
-    name = "Run Registered Data Compliance Rules"
-    description = "Runs selected Data Compliance rule classes."
+    class Meta:
+        name = "Run Registered Data Compliance Rules"
+        description = "Runs selected Data Compliance rule classes."
+        has_sensitive_variables = False
 
     selected_data_compliance_rules = MultiChoiceVar(
         choices=get_data_compliance_choices,
@@ -536,6 +538,7 @@ jobs = [
     ImportObjects,
     LogsCleanup,
     RefreshDynamicGroupCaches,
+    RefreshDynamicGroupCacheJobButtonReceiver,
     RunRegisteredDataComplianceRules,
 ]
 register_jobs(*jobs)

nautobot/core/jobs/groups.py

@@ -1,5 +1,5 @@
 from nautobot.extras.choices import DynamicGroupTypeChoices
-from nautobot.extras.jobs import Job, ObjectVar
+from nautobot.extras.jobs import Job, JobButtonReceiver, ObjectVar
 from nautobot.extras.models import DynamicGroup
 
 name = "System Jobs"
@@ -31,8 +31,38 @@ class RefreshDynamicGroupCaches(Job):
         if single_group is not None:
             groups = groups.filter(pk=single_group.pk)
 
+        if not groups.exists():
+            self.logger.info("No relevant dynamic groups were specified, nothing to do.")
+            return
+
+        self.logger.info("Re-calculating and re-caching group members. This may take some time.")
         for group in groups:
             group.update_cached_members()
             self.logger.info("Cache refreshed successfully, now with %d members", group.count, extra={"object": group})
 
         self.logger.info("Cache(s) refreshed")
+
+
+class RefreshDynamicGroupCacheJobButtonReceiver(JobButtonReceiver):
+    """
+    System Job Button Receiver to re-calculate and re-cache the members of a given Dynamic Group.
+    """
+
+    class Meta:
+        name = "Refresh Dynamic Group Cache (Job Button Receiver)"
+        description = "Re-calculate and re-cache the membership list of a given Dynamic Group."
+
+    def receive_job_button(self, obj):
+        if not isinstance(obj, DynamicGroup):
+            self.fail("This job button should only be used with Dynamic Group records.")
+        elif obj.group_type == DynamicGroupTypeChoices.TYPE_STATIC:
+            self.fail(
+                "The members of this Dynamic Group are statically defined and do not need to be recalculated.",
+                extra={"object": obj},
+            )
+        else:
+            self.logger.info(
+                "Re-calculating and re-caching group members. This may take some time.", extra={"object": obj}
+            )
+            obj.update_cached_members()
+            self.logger.success("Cache refreshed successfully, now with %d members", obj.count, extra={"object": obj})

nautobot/core/management/commands/generate_test_data.py

@@ -133,6 +133,14 @@ class Command(BaseCommand):
             )
             from nautobot.tenancy.factory import TenantFactory, TenantGroupFactory
             from nautobot.users.factory import UserFactory
+            from nautobot.vpn.factory import (
+                VPNFactory,
+                VPNPhase1PolicyFactory,
+                VPNPhase2PolicyFactory,
+                VPNProfileFactory,
+                VPNTunnelEndpointFactory,
+                VPNTunnelFactory,
+            )
             from nautobot.wireless.factory import (
                 ControllerManagedDeviceGroupWithMembersFactory,
                 RadioProfileFactory,
@@ -171,14 +179,12 @@ class Command(BaseCommand):
         )
         # ...and some tags that apply to a random subset of content-types
         _create_batch(TagFactory, 15, description="on some content-types")
-        _create_batch(UserFactory, 5)
+        _create_batch(UserFactory, 10)
         _create_batch(SavedViewFactory, 20)
         _create_batch(ContactFactory, 20)
         _create_batch(TeamFactory, 20)
-        _create_batch(TenantGroupFactory, 10, description="without parents", has_parent=False)
-        _create_batch(TenantGroupFactory, 10, description="with parents", has_parent=True)
-        _create_batch(TenantFactory, 10, description="without a parent group", has_tenant_group=False)
-        _create_batch(TenantFactory, 10, description="with a parent group", has_tenant_group=True)
+        _create_batch(TenantGroupFactory, 30)
+        _create_batch(TenantFactory, 30)
         _create_batch(LocationTypeFactory, 7)  # only 7 unique LocationTypes are hard-coded presently
         # First 7 locations must be created in specific order so subsequent objects have valid parents to reference
         _create_batch(LocationFactory, 7, description="as structure", has_parent=True)
@@ -192,7 +198,7 @@ class Command(BaseCommand):
         _create_batch(VRFFactory, 20)
         _create_batch(VLANGroupFactory, 20)
         _create_batch(VLANFactory, 20)
-        for i in range(30):
+        for i in range(50):
             _create_batch(
                 PrefixFactory,
                 1,
@@ -207,7 +213,15 @@ class Command(BaseCommand):
                 prefix=f"2001:db8:0:{i}::/64",
                 type=PrefixTypeChoices.TYPE_CONTAINER,
             )
-        _create_batch(NamespaceFactory, 5, description="without any Prefixes or IPAddresses")
+        _create_batch(
+            NamespaceFactory, 5, description="with a Tenant and without any Prefixes or IPAddresses", has_tenant=True
+        )
+        _create_batch(
+            NamespaceFactory,
+            5,
+            description="without a Tenant and without any Prefixes or IPAddresses",
+            has_tenant=False,
+        )
         _create_batch(DeviceFamilyFactory, 20)
         _create_batch(ManufacturerFactory, 8)  # First 8 hard-coded Manufacturers
         _create_batch(PlatformFactory, 20, description="with Manufacturers", has_manufacturer=True)
@@ -222,7 +236,7 @@ class Command(BaseCommand):
         _create_batch(ConsoleServerPortTemplateFactory, 30)
         _create_batch(RearPortTemplateFactory, 30)
         _create_batch(FrontPortTemplateFactory, 30)
-        _create_batch(InterfaceTemplateFactory, 30)
+        _create_batch(InterfaceTemplateFactory, 50)
         _create_batch(PowerPortTemplateFactory, 30)
         _create_batch(PowerOutletTemplateFactory, 30)
         _create_batch(ModuleBayTemplateFactory, 60, description="without module families", has_module_family=False)
@@ -324,11 +338,16 @@ class Command(BaseCommand):
         _create_batch(WirelessNetworksWithMembersFactory, 5, description="with members")
         # make sure we have some supported data rates that have null relationships to make filter tests happy
         _create_batch(SupportedDataRateFactory, 10, description="without any associated objects")
+        _create_batch(VPNPhase1PolicyFactory, 10)
+        _create_batch(VPNPhase2PolicyFactory, 10)
+        _create_batch(VPNProfileFactory, 20)
+        _create_batch(VPNFactory, 10)
+        _create_batch(VPNTunnelEndpointFactory, 20)
+        _create_batch(VPNTunnelFactory, 10)
         _create_batch(JobQueueFactory, 10)
         # make sure we have some tenants that have null relationships to make filter tests happy
         _create_batch(TenantFactory, 10, description="without any associated objects")
         # TODO: nautobot.tenancy.tests.test_filters currently calls the following additional factories:
-        # _create_batch(UserFactory, 10)
         # _create_batch(RackFactory, 10)
         # _create_batch(RackReservationFactory, 10)
         # _create_batch(ClusterTypeFactory, 10)

nautobot/core/models/generics.py

@@ -4,13 +4,20 @@ from nautobot.core.models import BaseModel
 from nautobot.core.models.fields import TagsField
 from nautobot.extras.models.change_logging import ChangeLoggedModel
 from nautobot.extras.models.customfields import CustomFieldModel
-from nautobot.extras.models.mixins import ContactMixin, DynamicGroupsModelMixin, NotesMixin, SavedViewMixin
+from nautobot.extras.models.mixins import (
+    ContactMixin,
+    DataComplianceModelMixin,
+    DynamicGroupsModelMixin,
+    NotesMixin,
+    SavedViewMixin,
+)
 from nautobot.extras.models.relationships import RelationshipModel
 
 logger = logging.getLogger(__name__)
 
 
 class OrganizationalModel(
+    DataComplianceModelMixin,
     ChangeLoggedModel,
     ContactMixin,
     CustomFieldModel,
@@ -35,6 +42,7 @@ class OrganizationalModel(
 
 
 class PrimaryModel(
+    DataComplianceModelMixin,
     ChangeLoggedModel,
     ContactMixin,
     CustomFieldModel,

nautobot/core/models/tree_queries.py

@@ -1,3 +1,5 @@
+import uuid
+
 from django.core.cache import cache
 from django.db.models import Case, When
 from django.db.models.signals import post_delete, post_save
@@ -21,15 +23,18 @@ class TreeQuerySet(TreeQuerySet_, querysets.RestrictedQuerySet):
         Dynamically computes ancestors either through the tree or through the `parent` foreign key depending on whether
         tree fields are present on `of`.
         """
+
+        # If `of` is a UUID, i.e. pk, retrieve the corresponding model instance with tree fields disabled.
+        if isinstance(of, uuid.UUID):
+            of = self.model.objects.without_tree_fields().get(pk=of)
+
         # If `of` has `tree_depth` defined, i.e. if it was retrieved from the database on a queryset where tree fields
         # were enabled (see `TreeQuerySet.with_tree_fields` and `TreeQuerySet.without_tree_fields`), use the default
         # implementation from `tree_queries.query.TreeQuerySet`.
-        # Furthermore, if `of` doesn't have a parent field we also have to defer to the tree-based implementation which
-        # will then annotate the tree fields and proceed as usual.
-        if hasattr(of, "tree_depth") or not hasattr(of, "parent"):
+        if hasattr(of, "tree_depth"):
             return super().ancestors(of, include_self=include_self)
+
         # In the other case, traverse the `parent` foreign key until the root.
-        model_class = of._meta.concrete_model
         ancestor_pks = []
         if include_self:
             ancestor_pks.append(of.pk)
@@ -40,7 +45,7 @@ class TreeQuerySet(TreeQuerySet_, querysets.RestrictedQuerySet):
         # Reference:
         # https://stackoverflow.com/questions/4916851/django-get-a-queryset-from-array-of-ids-in-specific-order
         preserve_order = Case(*[When(pk=pk, then=position) for position, pk in enumerate(ancestor_pks)])
-        return model_class.objects.without_tree_fields().filter(pk__in=ancestor_pks).order_by(preserve_order)
+        return self.model.objects.without_tree_fields().filter(pk__in=ancestor_pks).order_by(preserve_order)
 
     def max_tree_depth(self):
         r"""

nautobot/core/settings.py

@@ -95,11 +95,12 @@ if "NAUTOBOT_DEPLOYMENT_ID" in os.environ and os.environ["NAUTOBOT_DEPLOYMENT_ID
     DEPLOYMENT_ID = os.environ["NAUTOBOT_DEPLOYMENT_ID"]
 
 # Device names are not guaranteed globally-unique by Nautobot but in practice they often are.
-# Set this to True to use the device name alone as the natural key for Device objects.
-# Set this to False to use the sequence (name, tenant, location) as the natural key instead.
-#
-if "NAUTOBOT_DEVICE_NAME_AS_NATURAL_KEY" in os.environ and os.environ["NAUTOBOT_DEVICE_NAME_AS_NATURAL_KEY"] != "":
-    DEVICE_NAME_AS_NATURAL_KEY = is_truthy(os.environ["NAUTOBOT_DEVICE_NAME_AS_NATURAL_KEY"])
+# Select how Devices are uniquely identified:
+#   - 'location_tenant_name': combination of Location + Tenant + Name
+#   - 'name': Device name must be globally unique
+#   - 'none': No enforced uniqueness (rely on other validation rules or custom validators)
+if "NAUTOBOT_DEVICE_UNIQUENESS" in os.environ and os.environ["NAUTOBOT_DEVICE_UNIQUENESS"] != "":
+    DEVICE_UNIQUENESS = os.environ["NAUTOBOT_DEVICE_UNIQUENESS"]
 
 # Event Brokers
 EVENT_BROKERS = {}
@@ -416,6 +417,7 @@ SPECTACULAR_SETTINGS = {
         # result in this error:
         #    enum naming encountered a non-optimally resolvable collision for fields named "mode".
         "InterfaceModeChoices": "nautobot.dcim.choices.InterfaceModeChoices",
+        "VPNPhase2PolicyChoices": "nautobot.vpn.choices.DhGroupChoices",
         "WirelessNetworkModeChoices": "nautobot.wireless.choices.WirelessNetworkModeChoices",
     },
     # Create separate schema components for PATCH requests (fields generally are not `required` on PATCH)
@@ -569,6 +571,7 @@ INSTALLED_APPS = [
     "nautobot.tenancy",
     "nautobot.users",
     "nautobot.virtualization",
+    "nautobot.vpn",
     "nautobot.wireless",
     "drf_spectacular",
     "drf_spectacular_sidecar",
@@ -759,12 +762,15 @@ CONSTANCE_CONFIG = {
         help_text="Number of days to retain object changelog history.\nSet this to 0 to retain changes indefinitely.",
         field_type=int,
     ),
-    "DEVICE_NAME_AS_NATURAL_KEY": ConstanceConfigItem(
-        default=False,
-        help_text="Device names are not guaranteed globally-unique by Nautobot but in practice they often are. "
-        "Set this to True to use the device name alone as the natural key for Device objects. "
-        "Set this to False to use the sequence (name, tenant, location) as the natural key instead.",
-        field_type=bool,
+    "DEVICE_UNIQUENESS": ConstanceConfigItem(
+        default="location_tenant_name",
+        help_text=(
+            "Select how Devices are uniquely identified:\n"
+            "- 'location_tenant_name': combination of Location + Tenant + Name\n"
+            "- 'name': Device name must be globally unique\n"
+            "- 'none': No enforced uniqueness (rely on other validation rules or custom validators)"
+        ),
+        field_type=str,
     ),
     "DEPLOYMENT_ID": ConstanceConfigItem(
         default="",
@@ -869,7 +875,7 @@ CONSTANCE_CONFIG_FIELDSETS = {
     "Change Logging": ["CHANGELOG_RETENTION"],
     "Device Connectivity": ["NETWORK_DRIVERS", "PREFER_IPV4"],
     "Installation Metrics": ["DEPLOYMENT_ID"],
-    "Natural Keys": ["DEVICE_NAME_AS_NATURAL_KEY", "LOCATION_NAME_AS_NATURAL_KEY"],
+    "Natural Keys": ["DEVICE_UNIQUENESS", "LOCATION_NAME_AS_NATURAL_KEY"],
     "Pagination": ["PAGINATE_COUNT", "MAX_PAGE_SIZE", "PER_PAGE_DEFAULTS"],
     "Performance": ["JOB_CREATE_FILE_MAX_SIZE"],
     "Rack Elevation Rendering": [