nautobot 2.2.2__py3-none-any.whl → 2.2.4__py3-none-any.whl

nautobot/core/tests/test_views_utils.py

@@ -1,8 +1,10 @@
+import urllib.parse
+
 from django.db import ProgrammingError
 from django.test import TestCase
 
 from nautobot.core.models.querysets import count_related
-from nautobot.core.views.utils import check_filter_for_display
+from nautobot.core.views.utils import check_filter_for_display, prepare_cloned_fields
 from nautobot.dcim.filters import DeviceFilterSet
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, InventoryItem, Location, Manufacturer
 from nautobot.extras.models import Role, Status
@@ -147,3 +149,22 @@ class CheckCountRelatedSubquery(TestCase):
             manufacturer_count=count_related(Manufacturer, "inventory_items__device", distinct=True)
         )
         self.assertEqual(qs.get(pk=device1.pk).manufacturer_count, 3)
+
+
+class CheckPrepareClonedFields(TestCase):
+    name = "Building-02"
+    descriptions = ["Complicated Name & Stuff", "Simple Name"]
+
+    def testQueryParameterGeneration(self):
+        """Assert that a clone field with a special character, &, is properly escaped"""
+        instance = Location.objects.get(name=self.name)
+        self.assertIsInstance(instance, Location)
+        for description in self.descriptions:
+            with self.subTest(f"Testing parameter generation for a model with the name '{description}'"):
+                instance.description = description
+                query_params = urllib.parse.parse_qs(prepare_cloned_fields(instance))
+                self.assertTrue(isinstance(query_params, dict))
+                self.assertTrue("description" in query_params.keys())
+                self.assertTrue(isinstance(query_params["description"], list))
+                self.assertTrue(len(query_params["description"]) == 1)
+                self.assertTrue(query_params["description"][0] == description)

nautobot/core/utils/module_loading.py

@@ -0,0 +1,89 @@
+from contextlib import contextmanager
+import importlib
+from importlib.util import find_spec, module_from_spec
+import logging
+import os
+import pkgutil
+import sys
+
+logger = logging.getLogger(__name__)
+
+
+@contextmanager
+def _temporarily_add_to_sys_path(path):
+    """
+    Allow loading of modules and packages from within the provided directory by temporarily modifying `sys.path`.
+
+    On exit, it restores the original `sys.path` value.
+    """
+    old_sys_path = sys.path.copy()
+    sys.path.insert(0, path)
+    try:
+        yield
+    finally:
+        sys.path = old_sys_path
+
+
+def import_modules_privately(path, module_path=None, ignore_import_errors=True):
+    """
+    Import modules from the filesystem without adding the path permanently to `sys.path`.
+
+    This is used for importing Jobs from `JOBS_ROOT` and `GIT_ROOT` in such a way that they remain relatively
+    self-contained and can be easily discarded and reloaded on the fly.
+
+    If you find yourself writing new code that uses this method, please pause and reconsider your life choices.
+
+    Args:
+        path (str): Directory path possibly containing Python modules or packages to load.
+        module_path (list): If set to a non-empty list, only modules matching the given chain of modules will be loaded.
+            For example, `["my_git_repo", "jobs"]`.
+        ignore_import_errors (bool): Exceptions raised while importing modules will be caught and logged.
+            If this is set as False, they will then be re-raised to be handled by the caller of this function.
+    """
+    if module_path is None:
+        module_path = []
+        module_prefix = None
+    else:
+        module_prefix = ".".join(module_path)
+    with _temporarily_add_to_sys_path(path):
+        for finder, discovered_module_name, is_package in pkgutil.walk_packages([path], onerror=logger.error):
+            if module_prefix and not (
+                module_prefix.startswith(f"{discovered_module_name}.")  # my_repo/__init__.py
+                or discovered_module_name == module_prefix  # my_repo/jobs.py
+                or discovered_module_name.startswith(f"{module_prefix}.")  # my_repo/jobs/foobar.py
+            ):
+                continue
+            try:
+                existing_module = find_spec(discovered_module_name)
+            except (ModuleNotFoundError, ValueError):
+                existing_module = None
+            if existing_module is not None:
+                existing_module_path = os.path.realpath(existing_module.origin)
+                if not existing_module_path.startswith(path):
+                    logger.error(
+                        "Unable to load module %s from %s as it conflicts with existing module %s",
+                        discovered_module_name,
+                        path,
+                        existing_module_path,
+                    )
+                    continue
+
+            if discovered_module_name in sys.modules:
+                del sys.modules[discovered_module_name]
+
+            try:
+                if not is_package:
+                    spec = finder.find_spec(discovered_module_name)
+                    if spec is None:
+                        raise ValueError("Unable to find module spec")
+                    module = module_from_spec(spec)
+                    sys.modules[discovered_module_name] = module
+                    spec.loader.exec_module(module)
+                else:
+                    module = importlib.import_module(discovered_module_name)
+
+                importlib.reload(module)
+            except Exception as exc:
+                logger.error("Unable to load module %s from %s: %s", discovered_module_name, path, exc)
+                if not ignore_import_errors:
+                    raise

nautobot/core/views/mixins.py

@@ -485,6 +485,10 @@ class NautobotViewSetMixin(GenericViewSet, AccessMixin, GetReturnURLMixin, FormV
         request: The current request
         instance: The object being viewed
         """
+        if instance is not None:
+            return {
+                "active_tab": request.GET.get("tab", "main"),
+            }
         return {}
 
     def get_template_name(self):

nautobot/core/views/utils.py

@@ -1,5 +1,6 @@
 import datetime
 from io import BytesIO
+import urllib.parse
 
 from django.contrib import messages
 from django.core.exceptions import FieldError, ValidationError
@@ -269,7 +270,7 @@ def prepare_cloned_fields(instance):
         for tag in instance.tags.all():
             params.append(("tags", tag.pk))
 
-    # Concatenate parameters into a URL query string
-    param_string = "&".join([f"{k}={v}" for k, v in params])
+    # Encode the parameters into a URL query string
+    param_string = urllib.parse.urlencode(params)
 
     return param_string

nautobot/dcim/choices.py

@@ -21,6 +21,20 @@ class LocationStatusChoices(ChoiceSet):
     )
 
 
+class LocationDataToContactActionChoices(ChoiceSet):
+    ASSOCIATE_EXISTING_CONTACT = "associate existing contact"
+    ASSOCIATE_EXISTING_TEAM = "associate existing team"
+    CREATE_AND_ASSIGN_NEW_CONTACT = "create and assign new contact"
+    CREATE_AND_ASSIGN_NEW_TEAM = "create and assign new team"
+
+    CHOICES = (
+        (ASSOCIATE_EXISTING_CONTACT, "Associate to existing contact"),
+        (ASSOCIATE_EXISTING_TEAM, "Associate to existing team"),
+        (CREATE_AND_ASSIGN_NEW_CONTACT, "Create and assign new contact"),
+        (CREATE_AND_ASSIGN_NEW_TEAM, "Create and assign new team"),
+    )
+
+
 #
 # Racks
 #

nautobot/dcim/forms.py

@@ -53,7 +53,7 @@ from nautobot.extras.forms import (
     StatusModelFilterFormMixin,
     TagsBulkEditFormMixin,
 )
-from nautobot.extras.models import ExternalIntegration, SecretsGroup, Status
+from nautobot.extras.models import Contact, ContactAssociation, ExternalIntegration, Role, SecretsGroup, Status, Team
 from nautobot.ipam.constants import BGP_ASN_MAX, BGP_ASN_MIN
 from nautobot.ipam.models import IPAddress, IPAddressToInterface, VLAN, VLANLocationAssignment, VRF
 from nautobot.tenancy.forms import TenancyFilterForm, TenancyForm
@@ -69,6 +69,7 @@ from .choices import (
     InterfaceModeChoices,
     InterfaceRedundancyGroupProtocolChoices,
     InterfaceTypeChoices,
+    LocationDataToContactActionChoices,
     PortTypeChoices,
     PowerFeedPhaseChoices,
     PowerFeedSupplyChoices,
@@ -371,6 +372,55 @@ class LocationFilterForm(NautobotFilterForm, StatusModelFilterFormMixin, Tenancy
     tags = TagFilterField(model)
 
 
+class LocationMigrateDataToContactForm(NautobotModelForm):
+    # Assign tab form fields
+    action = forms.ChoiceField(
+        choices=LocationDataToContactActionChoices,
+        required=True,
+        widget=StaticSelect2(),
+    )
+    location = DynamicModelChoiceField(queryset=Location.objects.all(), required=False, label="Source Location")
+    contact = DynamicModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Available Contacts",
+        query_params={"similar_to_location_data": "$location"},
+    )
+    team = DynamicModelChoiceField(
+        queryset=Team.objects.all(),
+        required=False,
+        label="Available Teams",
+        query_params={"similar_to_location_data": "$location"},
+    )
+    role = DynamicModelChoiceField(
+        queryset=Role.objects.all(),
+        required=True,
+        query_params={"content_types": ContactAssociation._meta.label_lower},
+    )
+    status = DynamicModelChoiceField(
+        queryset=Status.objects.all(),
+        required=True,
+        query_params={"content_types": ContactAssociation._meta.label_lower},
+    )
+    name = forms.CharField(required=False, label="Name")
+    phone = forms.CharField(required=False, label="Phone")
+    email = forms.CharField(required=False, label="Email")
+
+    class Meta:
+        model = ContactAssociation
+        fields = [
+            "action",
+            "location",
+            "contact",
+            "team",
+            "role",
+            "status",
+            "name",
+            "phone",
+            "email",
+        ]
+
+
 #
 # Rack groups
 #

nautobot/dcim/models/device_components.py

@@ -205,6 +205,7 @@ class PathEndpoint(models.Model):
 
 @extras_features(
     "cable_terminations",
+    "custom_links",
     "custom_validators",
     "export_templates",
     "graphql",
@@ -236,7 +237,7 @@ class ConsolePort(CableTermination, PathEndpoint, ComponentModel):
 #
 
 
-@extras_features("cable_terminations", "custom_validators", "graphql", "webhooks")
+@extras_features("custom_links", "cable_terminations", "custom_validators", "graphql", "webhooks")
 class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel):
     """
     A physical port within a Device (typically a designated console server) which provides access to ConsolePorts.
@@ -265,6 +266,7 @@ class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel):
 
 @extras_features(
     "cable_terminations",
+    "custom_links",
     "custom_validators",
     "export_templates",
     "graphql",
@@ -380,7 +382,7 @@ class PowerPort(CableTermination, PathEndpoint, ComponentModel):
 #
 
 
-@extras_features("cable_terminations", "custom_validators", "graphql", "webhooks")
+@extras_features("cable_terminations", "custom_links", "custom_validators", "graphql", "webhooks")
 class PowerOutlet(CableTermination, PathEndpoint, ComponentModel):
     """
     A physical power outlet (output) within a Device which provides power to a PowerPort.
@@ -490,6 +492,7 @@ class BaseInterface(RelationshipModel):
 
 @extras_features(
     "cable_terminations",
+    "custom_links",
     "custom_validators",
     "export_templates",
     "graphql",
@@ -892,7 +895,7 @@ class InterfaceRedundancyGroupAssociation(BaseModel, ChangeLoggedModel):
 #
 
 
-@extras_features("cable_terminations", "custom_validators", "graphql", "webhooks")
+@extras_features("cable_terminations", "custom_links", "custom_validators", "graphql", "webhooks")
 class FrontPort(CableTermination, ComponentModel):
     """
     A pass-through port on the front of a Device.
@@ -936,7 +939,7 @@ class FrontPort(CableTermination, ComponentModel):
             )
 
 
-@extras_features("cable_terminations", "custom_validators", "graphql", "webhooks")
+@extras_features("cable_terminations", "custom_links", "custom_validators", "graphql", "webhooks")
 class RearPort(CableTermination, ComponentModel):
     """
     A pass-through port on the rear of a Device.
@@ -978,7 +981,7 @@ class RearPort(CableTermination, ComponentModel):
 #
 
 
-@extras_features("custom_validators", "graphql", "webhooks")
+@extras_features("custom_links", "custom_validators", "graphql", "webhooks")
 class DeviceBay(ComponentModel):
     """
     An empty space within a Device which can house a child device
@@ -1028,6 +1031,7 @@ class DeviceBay(ComponentModel):
 
 
 @extras_features(
+    "custom_links",
     "custom_validators",
     "export_templates",
     "graphql",

nautobot/dcim/templates/dcim/location.html

@@ -78,7 +78,7 @@
     </div>
     <div class="panel panel-default">
         <div class="panel-heading">
-            <strong>Contact Info</strong>
+            <strong>Geographical Info</strong>
         </div>
         <table class="table table-hover panel-body attr-table">
             <tr>
@@ -115,20 +115,39 @@
                     {% endif %}
                 </td>
             </tr>
-            <tr>
-                <td>Contact Name</td>
-                <td>{{ object.contact_name|placeholder }}</td>
-            </tr>
-            <tr>
-                <td>Contact Phone</td>
-                <td>{{ object.contact_phone|hyperlinked_phone_number }}</td>
-            </tr>
-            <tr>
-                <td>Contact E-Mail</td>
-                <td>{{ object.contact_email|hyperlinked_email }}</td>
-            </tr>
         </table>
     </div>
+    {% if show_convert_to_contact_button %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Contact Info</strong>
+            </div>
+            <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Contact Name</td>
+                    <td>{{ object.contact_name|placeholder }}</td>
+                </tr>
+                <tr>
+                    <td>Contact Phone</td>
+                    <td>{{ object.contact_phone|hyperlinked_phone_number }}</td>
+                </tr>
+                <tr>
+                    <td>Contact E-Mail</td>
+                    <td>{{ object.contact_email|hyperlinked_email }}</td>
+                </tr>
+            </table>
+            {% if request.user|has_perms:contact_association_permission %}
+                {% with request.path|add:"?tab=contacts"|urlencode as return_url %}
+                    <div class="panel-footer text-right noprint">
+                        <a href="{% url 'dcim:location_migrate_data_to_contact' pk=object.pk %}?return_url={{return_url}}" class="btn btn-primary btn-xs">
+                            <span class="mdi mdi-account-edit" aria-hidden="true"></span>
+                            Convert to contact/team record
+                        </a>
+                    </div>
+                {% endwith %}
+            {% endif %}
+        </div>
+    {% endif %}
     <div class="panel panel-default">
         <div class="panel-heading">
             <strong>Comments</strong>

nautobot/dcim/templates/dcim/location_migrate_data_to_contact.html

@@ -0,0 +1,102 @@
+{% extends 'generic/object_create.html' %}
+{% load form_helpers %}
+{% load helpers %}
+
+{% block title %}Migrating contact data from {{ obj_type }} {{ obj }}{% endblock %}
+{% block form %}
+    <div id="assign" class="tabcontent">
+        <div class="panel panel-default">
+            <div class="panel-heading"><strong>Contact Data</strong></div>
+            <div class="panel-body">
+                {% render_field form.action %}
+                {% render_field form.location %}
+                <div class="form-group">
+                    <label class="col-md-3 control-label required">Source Location "Contact Name"</label>
+                    <div class="col-md-9">
+                        <p class="form-control-static">{{ obj.contact_name | placeholder}}</p>
+                    </div>
+                </div>
+                <div class="form-group">
+                    <label class="col-md-3 control-label required">Source Location "Contact Phone"</label>
+                    <div class="col-md-9">
+                        <p class="form-control-static">{{ obj.contact_phone | placeholder}}</p>
+                    </div>
+                </div>
+                <div class="form-group">
+                    <label class="col-md-3 control-label required">Source Location "Contact Email"</label>
+                    <div class="col-md-9">
+                        <p class="form-control-static">{{ obj.contact_email | placeholder}}</p>
+                    </div>
+                </div>
+                {% render_field form.name %}
+                {% render_field form.phone %}
+                {% render_field form.email %}
+                {% render_field form.contact %}
+                {% render_field form.team %}
+                {% render_field form.role %}
+                {% render_field form.status %}
+            </div>
+        </div>
+    </div>
+{% endblock %}
+
+{% block buttons %}
+    <button type="submit" name="_create" class="btn btn-primary">Assign</button>
+    <a href="{% url 'dcim:location' pk=obj.pk %}" class="btn btn-default">Cancel</a>
+{% endblock %}
+
+{% block javascript %}
+<script>
+
+    // action drop down toggle
+    const action = document.getElementById("id_action");
+    function toggle_form_fields() {
+        const action_option = action.value;
+        document.getElementById("id_location").disabled = true;
+        const name = document.getElementById("id_name");
+        const name_label = document.querySelector("label[for=id_name]");
+        const phone = document.getElementById("id_phone");
+        const email = document.getElementById("id_email");
+        const similar_contacts_label = document.querySelector("label[for=id_contact]");
+        const similar_contacts = document.getElementById("id_contact");
+        const similar_teams_label = document.querySelector("label[for=id_team]");
+        const similar_teams = document.getElementById("id_team");
+
+        // Toggle these form fields when the action matches
+        similar_contacts.toggleAttribute("required", action_option=="associate existing contact");
+        similar_contacts_label.classList.toggle("required", action_option=="associate existing contact")
+        similar_teams.toggleAttribute("required", action_option=="associate existing team");
+        similar_teams_label.classList.toggle("required", action_option=="associate existing team")
+        name.toggleAttribute("disabled", action_option.match(/associate existing/));
+        name.toggleAttribute("required", action_option.match(/create and assign/));
+        name_label.classList.toggle("required", action_option.match(/create and assign/));
+        phone.toggleAttribute("disabled", action_option.match(/associate existing/));
+        email.toggleAttribute("disabled", action_option.match(/associate existing/));
+
+        // Show and hide form fields and toggle form field labels
+        if (action_option === "associate existing contact"){
+            similar_contacts.parentElement.parentElement.style.display = "block";
+            similar_teams.parentElement.parentElement.style.display = "none";
+            name.parentElement.parentElement.style.display = "none";
+            phone.parentElement.parentElement.style.display = "none";
+            email.parentElement.parentElement.style.display = "none";
+        } else if (action_option === "associate existing team"){
+            similar_teams.parentElement.parentElement.style.display = "block";
+            similar_contacts.parentElement.parentElement.style.display = "none";
+            name.parentElement.parentElement.style.display = "none";
+            phone.parentElement.parentElement.style.display = "none";
+            email.parentElement.parentElement.style.display = "none";
+        } else {
+            similar_contacts.parentElement.parentElement.style.display = "none";
+            similar_contacts.removeAttribute("required")
+            similar_teams.parentElement.parentElement.style.display = "none";
+            name.parentElement.parentElement.style.display = "block";
+            phone.parentElement.parentElement.style.display = "block";
+            email.parentElement.parentElement.style.display = "block";
+        }
+
+    }
+    window.onload = toggle_form_fields
+    action.onchange = toggle_form_fields
+</script>
+{% endblock %}