nautobot 2.1.0b1__py3-none-any.whl → 2.1.1__py3-none-any.whl

nautobot/extras/tests/test_views.py

@@ -1,4 +1,5 @@
 from datetime import timedelta
+from unittest import mock
 import urllib.parse
 import uuid
 
@@ -9,13 +10,12 @@ from django.test import override_settings
 from django.urls import reverse
 from django.utils import timezone
 from django.utils.html import format_html
-from unittest import mock
 
 from nautobot.core.choices import ColorChoices
 from nautobot.core.models.fields import slugify_dashes_to_underscores
-from nautobot.core.testing import ViewTestCases, TestCase, extract_page_body, extract_form_failures
+from nautobot.core.testing import extract_form_failures, extract_page_body, TestCase, ViewTestCases
 from nautobot.core.testing.utils import disable_warnings, post_data
-from nautobot.dcim.models import ConsolePort, Device, DeviceType, Interface, Manufacturer, Location, LocationType
+from nautobot.dcim.models import ConsolePort, Device, DeviceType, Interface, Location, LocationType, Manufacturer
 from nautobot.dcim.tests import test_views
 from nautobot.extras.choices import (
     CustomFieldTypeChoices,
@@ -23,6 +23,7 @@ from nautobot.extras.choices import (
     ObjectChangeActionChoices,
     SecretsGroupAccessTypeChoices,
     SecretsGroupSecretTypeChoices,
+    WebhookHttpMethodChoices,
 )
 from nautobot.extras.constants import HTTP_CONTENT_TYPE_JSON
 from nautobot.extras.models import (
@@ -52,13 +53,13 @@ from nautobot.extras.models import (
     Tag,
     Webhook,
 )
+from nautobot.extras.templatetags.job_buttons import NO_CONFIRM_BUTTON
 from nautobot.extras.tests.constants import BIG_GRAPHQL_DEVICE_QUERY
 from nautobot.extras.tests.test_relationships import RequiredRelationshipTestMixin
 from nautobot.extras.utils import RoleModelsQuery, TaggableClassesQuery
 from nautobot.ipam.models import IPAddress, Prefix, VLAN, VLANGroup
 from nautobot.users.models import ObjectPermission
 
-
 # Use the proper swappable User model
 User = get_user_model()
 
@@ -696,12 +697,12 @@ class ExportTemplateTestCase(
 
 class ExternalIntegrationTestCase(ViewTestCases.PrimaryObjectViewTestCase):
     model = ExternalIntegration
-    bulk_edit_data = {"timeout": 10, "verify_ssl": True, "extra_config": r"{}"}
+    bulk_edit_data = {"timeout": 10, "verify_ssl": True, "extra_config": r"{}", "headers": r"{}"}
     csv_data = (
-        "name,remote_url,verify_ssl,timeout",
-        "Test External Integration 1,https://example.com/test1/,False,10",
-        "Test External Integration 2,https://example.com/test2/,True,20",
-        "Test External Integration 3,https://example.com/test3/,False,30",
+        "name,remote_url,verify_ssl,timeout,http_method",
+        "Test External Integration 1,https://example.com/test1/,False,10,POST",
+        "Test External Integration 2,https://example.com/test2/,True,20,DELETE",
+        "Test External Integration 3,https://example.com/test3/,False,30,PATCH",
     )
     form_data = {
         "name": "Test External Integration",
@@ -710,6 +711,9 @@ class ExternalIntegrationTestCase(ViewTestCases.PrimaryObjectViewTestCase):
         "secrets_group": None,
         "timeout": 10,
         "extra_config": '{"foo": "bar"}',
+        "http_method": WebhookHttpMethodChoices.METHOD_GET,
+        "headers": '{"header": "fake header"}',
+        "ca_file_path": "this/is/a/file/path",
     }
 
 
@@ -916,9 +920,9 @@ class SecretsGroupTestCase(
         )
 
         secrets = (
-            Secret.objects.create(name="secret 1", provider="text-file", parameters={"path": "/tmp"}),
-            Secret.objects.create(name="secret 2", provider="text-file", parameters={"path": "/tmp"}),
-            Secret.objects.create(name="secret 3", provider="text-file", parameters={"path": "/tmp"}),
+            Secret.objects.create(name="secret 1", provider="text-file", parameters={"path": "/tmp"}),  # noqa: S108  # hardcoded-temp-file -- false positive
+            Secret.objects.create(name="secret 2", provider="text-file", parameters={"path": "/tmp"}),  # noqa: S108  # hardcoded-temp-file -- false positive
+            Secret.objects.create(name="secret 3", provider="text-file", parameters={"path": "/tmp"}),  # noqa: S108  # hardcoded-temp-file -- false positive
         )
 
         SecretsGroupAssociation.objects.create(
@@ -1033,7 +1037,7 @@ class ScheduledJobTestCase(
     def test_only_enabled_is_listed(self):
         self.add_permissions("extras.view_scheduledjob")
 
-        # this should not appear, since it’s not enabled
+        # this should not appear, since it's not enabled
         ScheduledJob.objects.create(
             enabled=False,
             name="test4",
@@ -2015,14 +2019,24 @@ class JobButtonRenderingTestCase(TestCase):
 
     def setUp(self):
         super().setUp()
-        self.job_button = JobButton(
-            name="JobButton",
+        self.job_button_1 = JobButton(
+            name="JobButton 1",
             text="JobButton {{ obj.name }}",
             job=Job.objects.get(job_class_name="TestJobButtonReceiverSimple"),
             confirmation=False,
         )
-        self.job_button.validated_save()
-        self.job_button.content_types.add(ContentType.objects.get_for_model(LocationType))
+        self.job_button_1.validated_save()
+        self.job_button_1.content_types.add(ContentType.objects.get_for_model(LocationType))
+
+        self.job_button_2 = JobButton(
+            name="JobButton 2",
+            text="Click me!",
+            job=Job.objects.get(job_class_name="TestJobButtonReceiverComplex"),
+            confirmation=False,
+        )
+        self.job_button_2.validated_save()
+        self.job_button_2.content_types.add(ContentType.objects.get_for_model(LocationType))
+
         self.location_type = LocationType.objects.get(name="Campus")
 
     def test_view_object_with_job_button(self):
@@ -2031,11 +2045,12 @@ class JobButtonRenderingTestCase(TestCase):
         self.assertEqual(response.status_code, 200)
         content = extract_page_body(response.content.decode(response.charset))
         self.assertIn(f"JobButton {self.location_type.name}", content, content)
+        self.assertIn("Click me!", content, content)
 
     def test_view_object_with_unsafe_text(self):
         """Ensure that JobButton text can't be used as a vector for XSS."""
-        self.job_button.text = '<script>alert("Hello world!")</script>'
-        self.job_button.validated_save()
+        self.job_button_1.text = '<script>alert("Hello world!")</script>'
+        self.job_button_1.validated_save()
         response = self.client.get(self.location_type.get_absolute_url(), follow=True)
         self.assertEqual(response.status_code, 200)
         content = extract_page_body(response.content.decode(response.charset))
@@ -2043,8 +2058,8 @@ class JobButtonRenderingTestCase(TestCase):
         self.assertIn("&lt;script&gt;alert", content, content)
 
         # Make sure grouped rendering is safe too
-        self.job_button.group = '<script>alert("Goodbye")</script>'
-        self.job_button.validated_save()
+        self.job_button_1.group_name = '<script>alert("Goodbye")</script>'
+        self.job_button_1.validated_save()
         response = self.client.get(self.location_type.get_absolute_url(), follow=True)
         self.assertEqual(response.status_code, 200)
         content = extract_page_body(response.content.decode(response.charset))
@@ -2053,15 +2068,80 @@ class JobButtonRenderingTestCase(TestCase):
 
     def test_view_object_with_unsafe_name(self):
         """Ensure that JobButton names can't be used as a vector for XSS."""
-        self.job_button.text = "JobButton {{ obj"
-        self.job_button.name = '<script>alert("Yo")</script>'
-        self.job_button.validated_save()
+        self.job_button_1.text = "JobButton {{ obj"
+        self.job_button_1.name = '<script>alert("Yo")</script>'
+        self.job_button_1.validated_save()
         response = self.client.get(self.location_type.get_absolute_url(), follow=True)
         self.assertEqual(response.status_code, 200)
         content = extract_page_body(response.content.decode(response.charset))
         self.assertNotIn("<script>alert", content, content)
         self.assertIn("&lt;script&gt;alert", content, content)
 
+    def test_render_constrained_run_permissions(self):
+        obj_perm = ObjectPermission(
+            name="Test permission",
+            constraints={"pk": self.job_button_1.job.pk},
+            actions=["run"],
+        )
+        obj_perm.save()
+        obj_perm.users.add(self.user)
+        obj_perm.object_types.add(ContentType.objects.get_for_model(Job))
+
+        with self.subTest("Ungrouped buttons"):
+            response = self.client.get(self.location_type.get_absolute_url(), follow=True)
+            self.assertEqual(response.status_code, 200)
+            content = extract_page_body(response.content.decode(response.charset))
+            self.assertInHTML(
+                NO_CONFIRM_BUTTON.format(
+                    button_id=self.job_button_1.pk,
+                    button_text=f"JobButton {self.location_type.name}",
+                    button_class=self.job_button_1.button_class,
+                    disabled="",
+                ),
+                content,
+            )
+            self.assertInHTML(
+                NO_CONFIRM_BUTTON.format(
+                    button_id=self.job_button_2.pk,
+                    button_text="Click me!",
+                    button_class=self.job_button_2.button_class,
+                    disabled="disabled",
+                ),
+                content,
+            )
+
+        with self.subTest("Grouped buttons"):
+            self.job_button_1.group_name = "Grouping"
+            self.job_button_1.validated_save()
+            self.job_button_2.group_name = "Grouping"
+            self.job_button_2.validated_save()
+
+            response = self.client.get(self.location_type.get_absolute_url(), follow=True)
+            self.assertEqual(response.status_code, 200)
+            content = extract_page_body(response.content.decode(response.charset))
+            self.assertInHTML(
+                "<li>"
+                + NO_CONFIRM_BUTTON.format(
+                    button_id=self.job_button_1.pk,
+                    button_text=f"JobButton {self.location_type.name}",
+                    button_class="link",
+                    disabled="",
+                )
+                + "</li>",
+                content,
+            )
+            self.assertInHTML(
+                "<li>"
+                + NO_CONFIRM_BUTTON.format(
+                    button_id=self.job_button_2.pk,
+                    button_text="Click me!",
+                    button_class="link",
+                    disabled="disabled",
+                )
+                + "</li>",
+                content,
+            )
+
 
 # TODO: Convert to StandardTestCases.Views
 class ObjectChangeTestCase(TestCase):
@@ -2213,7 +2293,7 @@ class RelationshipTestCase(
             "relationship &quot;VLANs require at least one Device&quot;",
         )
         for vlan in vlans[:3]:
-            self.assertContains(response, f"{str(vlan)}")
+            self.assertContains(response, str(vlan))
 
         # Try editing 6 VLANs and adding the required device (succeeds):
         response = self.client.post(

nautobot/extras/tests/test_webhooks.py

@@ -1,7 +1,7 @@
-import json
-import uuid
 from copy import deepcopy
+import json
 from unittest.mock import patch
+import uuid
 
 from django.apps import apps
 from django.contrib.auth import get_user_model
@@ -17,13 +17,12 @@ from nautobot.dcim.api.serializers import LocationSerializer
 from nautobot.dcim.models import Location, LocationType
 from nautobot.extras.choices import ObjectChangeActionChoices
 from nautobot.extras.context_managers import web_request_context
-from nautobot.extras.models import Webhook, Tag
+from nautobot.extras.models import Tag, Webhook
 from nautobot.extras.models.statuses import Status
 from nautobot.extras.registry import registry
 from nautobot.extras.tasks import process_webhook
 from nautobot.extras.utils import generate_signature
 
-
 User = get_user_model()
 
 
@@ -32,7 +31,7 @@ class WebhookTest(APITestCase):
     def setUpTestData(cls):
         location_ct = ContentType.objects.get_for_model(Location)
         MOCK_URL = "http://localhost/"
-        MOCK_SECRET = "LOOKATMEIMASECRETSTRING"
+        MOCK_SECRET = "LOOKATMEIMASECRETSTRING"  # noqa: S105  # hardcoded-password-string -- OK as this is test code
 
         webhooks = (
             Webhook.objects.create(

nautobot/extras/urls.py

@@ -480,8 +480,6 @@ urlpatterns = [
         views.JobResultDeleteView.as_view(),
         name="jobresult_delete",
     ),
-    # Job Button Run
-    path("job-button/<uuid:pk>/run/", views.JobButtonRunView.as_view(), name="jobbutton_run"),
     # Notes
     path("notes/", views.NoteListView.as_view(), name="note_list"),
     path("notes/add/", views.NoteEditView.as_view(), name="note_add"),

nautobot/extras/utils.py

@@ -25,7 +25,6 @@ from nautobot.extras.constants import (
 )
 from nautobot.extras.registry import registry
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -338,9 +337,9 @@ def refresh_job_model_from_job_class(job_model_class, job_class):
     and in that case we need to not import models ourselves.
     """
     from nautobot.extras.jobs import (
-        JobHookReceiver,
         JobButtonReceiver,
-    )  # imported here to prevent circular import problem
+        JobHookReceiver,
+    )
 
     # Unrecoverable errors
     if len(job_class.__module__) > JOB_MAX_NAME_LENGTH:
@@ -526,10 +525,17 @@ def migrate_role_data(
         to_role_choiceset (ChoiceSet): If `to_role_field` is a choices field, the corresponding ChoiceSet for it
         is_m2m_field (bool): True if the role fields are both ManyToManyFields, else False
     """
+    if from_role_model is not None and from_role_choiceset is not None:
+        raise RuntimeError("from_role_model and from_role_choiceset are mutually exclusive")
+    if from_role_model is None and from_role_choiceset is None:
+        raise RuntimeError("One of from_role_model or from_role_choiceset must be specified and not None")
+    if to_role_model is not None and to_role_choiceset is not None:
+        raise RuntimeError("to_role_model and to_role_choiceset are mutually exclusive")
+    if to_role_model is None and to_role_choiceset is None:
+        raise RuntimeError("One of to_role_model or to_role_choiceset must be specified and not None")
+
     if from_role_model is not None:
-        assert from_role_choiceset is None
         if to_role_model is not None:
-            assert to_role_choiceset is None
             # Mapping "from" model instances to corresponding "to" model instances
             roles_translation_mapping = {
                 # Use .filter().first(), not .get() because "to" role might not exist, especially on reverse migrations
@@ -537,7 +543,6 @@ def migrate_role_data(
                 for from_role in from_role_model.objects.all()
             }
         else:
-            assert to_role_choiceset is not None
             # Mapping "from" model instances to corresponding "to" choices
             # We need to use `label` to look up the from_role instance, but `value` is what we set for the to_role_field
             inverted_to_role_choiceset = {label: value for value, label in to_role_choiceset.CHOICES}
@@ -546,9 +551,7 @@ def migrate_role_data(
                 for from_role in from_role_model.objects.all()
             }
     else:
-        assert from_role_choiceset is not None
         if to_role_model is not None:
-            assert to_role_choiceset is None
             # Mapping "from" choices to corresponding "to" model instances
             roles_translation_mapping = {
                 # Use .filter().first(), not .get() because "to" role might not exist, especially on reverse migrations
@@ -556,7 +559,6 @@ def migrate_role_data(
                 for from_role_value, from_role_label in from_role_choiceset.CHOICES
             }
         else:
-            assert to_role_choiceset is not None
             # Mapping "from" choices to corresponding "to" choices; we don't currently use this case, but it should work
             # We need to use `label` to look up the from_role instance, but `value` is what we set for the to_role_field
             inverted_to_role_choiceset = {label: value for value, label in to_role_choiceset.CHOICES}

nautobot/extras/views.py

@@ -10,11 +10,12 @@ from django.db.models import Count, ProtectedError, Q
 from django.forms.utils import pretty_name
 from django.http import Http404, HttpResponse, HttpResponseForbidden
 from django.shortcuts import get_object_or_404, redirect, render
-from django.template.loader import TemplateDoesNotExist, get_template
+from django.template.loader import get_template, TemplateDoesNotExist
 from django.urls import reverse
 from django.utils import timezone
+from django.utils.encoding import iri_to_uri
 from django.utils.html import format_html
-from django.utils.http import is_safe_url
+from django.utils.http import url_has_allowed_host_and_scheme
 from django.views.generic import View
 from django_tables2 import RequestConfig
 from jsonschema.validators import Draft7Validator
@@ -26,10 +27,10 @@ from nautobot.core.tables import ButtonsColumn
 from nautobot.core.utils.lookup import get_table_for_model
 from nautobot.core.utils.requests import normalize_querydict
 from nautobot.core.views import generic, viewsets
-from nautobot.core.views.viewsets import NautobotUIViewSet
 from nautobot.core.views.mixins import ObjectPermissionRequiredMixin
 from nautobot.core.views.paginator import EnhancedPaginator, get_paginate_count
 from nautobot.core.views.utils import prepare_cloned_fields
+from nautobot.core.views.viewsets import NautobotUIViewSet
 from nautobot.dcim.models import Device, Rack
 from nautobot.dcim.tables import DeviceTable, RackTable
 from nautobot.extras.tasks import delete_custom_field_data
@@ -62,6 +63,7 @@ from .models import (
     GitRepository,
     GraphQLQuery,
     ImageAttachment,
+    Job as JobModel,
     JobButton,
     JobHook,
     JobResult,
@@ -79,7 +81,6 @@ from .models import (
     TaggedItem,
     Webhook,
 )
-from .models import Job as JobModel
 from .registry import registry
 from .tables import RoleTable
 
@@ -413,9 +414,9 @@ class CustomFieldEditView(generic.ObjectEditView):
                 verb = "Created" if object_created else "Modified"
                 msg = f"{verb} {self.queryset.model._meta.verbose_name}"
                 logger.info(f"{msg} {obj} (PK: {obj.pk})")
-                if hasattr(obj, "get_absolute_url"):
+                try:
                     msg = format_html('{} <a href="{}">{}</a>', msg, obj.get_absolute_url(), obj)
-                else:
+                except AttributeError:
                     msg = format_html("{} {}", msg, obj)
                 messages.success(request, msg)
 
@@ -428,8 +429,8 @@ class CustomFieldEditView(generic.ObjectEditView):
                     return redirect(request.get_full_path())
 
                 return_url = form.cleaned_data.get("return_url")
-                if return_url is not None and is_safe_url(url=return_url, allowed_hosts=request.get_host()):
-                    return redirect(return_url)
+                if url_has_allowed_host_and_scheme(url=return_url, allowed_hosts=request.get_host()):
+                    return redirect(iri_to_uri(return_url))
                 else:
                     return redirect(self.get_return_url(request, obj))
 
@@ -651,9 +652,9 @@ class DynamicGroupEditView(generic.ObjectEditView):
                 verb = "Created" if object_created else "Modified"
                 msg = f"{verb} {self.queryset.model._meta.verbose_name}"
                 logger.info(f"{msg} {obj} (PK: {obj.pk})")
-                if hasattr(obj, "get_absolute_url"):
+                try:
                     msg = format_html('{} <a href="{}">{}</a>', msg, obj.get_absolute_url(), obj)
-                else:
+                except AttributeError:
                     msg = format_html("{} {}", msg, obj)
                 messages.success(request, msg)
 
@@ -666,8 +667,8 @@ class DynamicGroupEditView(generic.ObjectEditView):
                     return redirect(request.get_full_path())
 
                 return_url = form.cleaned_data.get("return_url")
-                if return_url is not None and is_safe_url(url=return_url, allowed_hosts=request.get_host()):
-                    return redirect(return_url)
+                if url_has_allowed_host_and_scheme(url=return_url, allowed_hosts=request.get_host()):
+                    return redirect(iri_to_uri(return_url))
                 else:
                     return redirect(self.get_return_url(request, obj))
 
@@ -1152,6 +1153,12 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
         schedule_form = forms.JobScheduleForm(request.POST)
         task_queue = request.POST.get("_task_queue")
 
+        return_url = request.POST.get("_return_url")
+        if return_url is not None and url_has_allowed_host_and_scheme(url=return_url, allowed_hosts=request.get_host()):
+            return_url = iri_to_uri(return_url)
+        else:
+            return_url = None
+
         # Allow execution only if a worker process is running and the job is runnable.
         if not get_worker_count(queue=task_queue):
             messages.error(request, "Unable to run or schedule job: Celery worker process not running.")
@@ -1159,7 +1166,10 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
             messages.error(request, "Unable to run or schedule job: Job is not presently installed.")
         elif not job_model.enabled:
             messages.error(request, "Unable to run or schedule job: Job is not enabled to be run.")
-        elif job_model.has_sensitive_variables and request.POST["_schedule_type"] != JobExecutionType.TYPE_IMMEDIATELY:
+        elif (
+            job_model.has_sensitive_variables
+            and request.POST.get("_schedule_type") != JobExecutionType.TYPE_IMMEDIATELY
+        ):
             messages.error(request, "Unable to schedule job: Job may have sensitive input variables.")
         elif job_model.has_sensitive_variables and job_model.approval_required:
             messages.error(
@@ -1221,10 +1231,10 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
 
                 if job_model.approval_required:
                     messages.success(request, f"Job {schedule_name} successfully submitted for approval")
-                    return redirect("extras:scheduledjob_approval_queue_list")
+                    return redirect(return_url if return_url else "extras:scheduledjob_approval_queue_list")
                 else:
                     messages.success(request, f"Job {schedule_name} successfully scheduled")
-                    return redirect("extras:scheduledjob_list")
+                    return redirect(return_url if return_url else "extras:scheduledjob_list")
 
             else:
                 # Enqueue job for immediate execution
@@ -1237,8 +1247,21 @@ class JobRunView(ObjectPermissionRequiredMixin, View):
                     **job_model.job_class.serialize_data(job_kwargs),
                 )
 
+                if return_url:
+                    messages.info(
+                        request,
+                        format_html(
+                            'Job enqueued. <a href="{}">Click here for the results.</a>',
+                            job_result.get_absolute_url(),
+                        ),
+                    )
+                    return redirect(return_url)
+
                 return redirect("extras:jobresult", pk=job_result.pk)
 
+        if return_url:
+            return redirect(return_url)
+
         template_name = "extras/job.html"
         if job_model.job_class is not None and hasattr(job_model.job_class, "template_name"):
             try:
@@ -1556,31 +1579,6 @@ class JobButtonUIViewSet(NautobotUIViewSet):
     table_class = tables.JobButtonTable
 
 
-class JobButtonRunView(ObjectPermissionRequiredMixin, View):
-    """
-    View to run the Job linked to the Job Button.
-    """
-
-    queryset = JobButton.objects.all()
-
-    def get_required_permission(self):
-        return "extras.run_job"
-
-    def post(self, request, pk):
-        post_data = request.POST
-        job_button = JobButton.objects.get(pk=pk)
-        job_model = job_button.job
-        result = JobResult.enqueue_job(
-            job_model=job_model,
-            user=request.user,
-            object_pk=post_data["object_pk"],
-            object_model_name=post_data["object_model_name"],
-        )
-        msg = format_html('Job enqueued. <a href="{}">Click here for the results.</a>', result.get_absolute_url())
-        messages.info(request=request, message=msg)
-        return redirect(post_data["redirect_path"])
-
-
 #
 # Change logging
 #
@@ -2050,9 +2048,9 @@ class SecretsGroupEditView(generic.ObjectEditView):
                 verb = "Created" if object_created else "Modified"
                 msg = f"{verb} {self.queryset.model._meta.verbose_name}"
                 logger.info(f"{msg} {obj} (PK: {obj.pk})")
-                if hasattr(obj, "get_absolute_url"):
+                try:
                     msg = format_html('{} <a href="{}">{}</a>', msg, obj.get_absolute_url(), obj)
-                else:
+                except AttributeError:
                     msg = format_html("{} {}", msg, obj)
                 messages.success(request, msg)
 
@@ -2065,8 +2063,8 @@ class SecretsGroupEditView(generic.ObjectEditView):
                     return redirect(request.get_full_path())
 
                 return_url = form.cleaned_data.get("return_url")
-                if return_url is not None and is_safe_url(url=return_url, allowed_hosts=request.get_host()):
-                    return redirect(return_url)
+                if url_has_allowed_host_and_scheme(url=return_url, allowed_hosts=request.get_host()):
+                    return redirect(iri_to_uri(return_url))
                 else:
                     return redirect(self.get_return_url(request, obj))
 

nautobot/generate_secret_key.py

@@ -1,8 +1,13 @@
 #!/usr/bin/env python
 # This script will generate a random 50-character string suitable for use as a SECRET_KEY.
-from random import SystemRandom
+# shamelessly pulled from https://docs.python.org/3/library/secrets.html#recipes-and-best-practices
+import secrets
+import string
 
-choice = SystemRandom().choice
-
-charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*(-_=+)"
-print("".join(choice(charset) for _ in range(50)))
+length = 50
+alphabet = string.ascii_letters + string.digits + "!@#$%^&*(-_=+)"  # string.punctuation would be an option
+while True:
+    password = "".join(secrets.choice(alphabet) for i in range(length))
+    if len(set(password)) >= 5:
+        break
+print(password)

nautobot/ipam/api/serializers.py

@@ -11,9 +11,9 @@ from nautobot.core.api import (
     ValidatedModelSerializer,
 )
 from nautobot.extras.api.mixins import TaggedModelSerializerMixin
+from nautobot.ipam import constants
 from nautobot.ipam.api.fields import IPFieldSerializer
 from nautobot.ipam.choices import PrefixTypeChoices, ServiceProtocolChoices
-from nautobot.ipam import constants
 from nautobot.ipam.models import (
     get_default_namespace,
     IPAddress,
@@ -28,7 +28,6 @@ from nautobot.ipam.models import (
     VRF,
 )
 
-
 #
 # Namespaces
 #

nautobot/ipam/api/urls.py

@@ -1,6 +1,6 @@
 from nautobot.core.api.routers import OrderedDefaultRouter
-from . import views
 
+from . import views
 
 router = OrderedDefaultRouter()
 router.APIRootView = views.IPAMRootView

nautobot/ipam/api/views.py

@@ -23,6 +23,7 @@ from nautobot.ipam.models import (
     VLANGroup,
     VRF,
 )
+
 from . import serializers
 
 

nautobot/ipam/apps.py

@@ -15,8 +15,9 @@ class IPAMConfig(NautobotConfig):
         super().ready()
 
         from graphene_django.converter import convert_django_field, convert_field_to_string
+
         from nautobot.ipam.fields import VarbinaryIPField
-        import nautobot.ipam.signals  # noqa: F401
+        import nautobot.ipam.signals  # noqa: F401  # unused-import -- but this import installs the signals
 
         # Register VarbinaryIPField to be converted to a string type
         convert_django_field.register(VarbinaryIPField)(convert_field_to_string)

nautobot/ipam/factory.py

@@ -1,25 +1,24 @@
 import datetime
 import logging
+import math
 
 import factory
 import faker
-import math
 
 from nautobot.core.factory import (
+    get_random_instances,
     NautobotBoolIterator,
     OrganizationalModelFactory,
     PrimaryModelFactory,
-    UniqueFaker,
-    get_random_instances,
     random_instance,
+    UniqueFaker,
 )
 from nautobot.dcim.models import Location
 from nautobot.extras.models import Role, Status
 from nautobot.ipam.choices import PrefixTypeChoices
-from nautobot.ipam.models import IPAddress, Prefix, RIR, RouteTarget, VLAN, VLANGroup, VRF, Namespace
+from nautobot.ipam.models import IPAddress, Namespace, Prefix, RIR, RouteTarget, VLAN, VLANGroup, VRF
 from nautobot.tenancy.models import Tenant
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -51,7 +50,7 @@ def random_route_distinguisher():
     fake = faker.Faker()
     branch = fake.pyint(0, 2)
     if branch == 0:
-        # 16-bit ASNs 64496–64511 are reserved for documentation and sample code
+        # 16-bit ASNs 64496-64511 are reserved for documentation and sample code
         return f"{fake.pyint(64496, 64511)}:{fake.pyint(0, 2**32 - 1)}"
     if branch == 1:
         return f"{fake.ipv4_private()}:{fake.pyint(0, 2**16 - 1)}"
@@ -201,9 +200,7 @@ class VLANFactory(PrimaryModelFactory):
                     ),
                 )
             ]
-        )[
-            :255
-        ]  # truncate to max VLAN.name length just to be safe
+        )[:255]  # truncate to max VLAN.name length just to be safe
     )
 
     status = random_instance(lambda: Status.objects.get_for_model(VLAN), allow_null=False)