nautobot 2.4.2__py3-none-any.whl → 2.4.4__py3-none-any.whl

nautobot/extras/api/views.py

@@ -642,7 +642,7 @@ class JobViewSetBase(
             ):
                 raise ValidationError(
                     {
-                        "_task_queue": "_task_queue and _job_queue are both specified. Please specifiy only one or another."
+                        "_task_queue": "_task_queue and _job_queue are both specified. Please specify only one or another."
                     }
                 )
 
@@ -685,7 +685,7 @@ class JobViewSetBase(
                 "job_queue", None
             ):
                 raise ValidationError(
-                    {"task_queue": "task_queue and job_queue are both specified. Please specifiy only one or another."}
+                    {"task_queue": "task_queue and job_queue are both specified. Please specify only one or another."}
                 )
             schedule_data = input_serializer.validated_data.get("schedule", None)
 
@@ -836,7 +836,7 @@ class JobQueueViewSet(NautobotModelViewSet):
     filterset_class = filters.JobQueueFilterSet
 
 
-class JobQueueAssignmentViewSet(NautobotModelViewSet):
+class JobQueueAssignmentViewSet(ModelViewSet):
     """
     Manage job queue assignments through DELETE, GET, POST, PUT, and PATCH requests.
     """
@@ -1069,7 +1069,7 @@ class MetadataChoiceViewSet(ModelViewSet):
     filterset_class = filters.MetadataChoiceFilterSet
 
 
-class ObjectMetadataViewSet(NautobotModelViewSet):
+class ObjectMetadataViewSet(ModelViewSet):
     queryset = ObjectMetadata.objects.all()
     serializer_class = serializers.ObjectMetadataSerializer
     filterset_class = filters.ObjectMetadataFilterSet

nautobot/extras/filters/__init__.py

@@ -854,6 +854,10 @@ class JobFilterSet(BaseFilterSet, CustomFieldModelFilterSetMixin):
             "description": "icontains",
         },
     )
+    job_queues = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=JobQueue.objects.all(),
+        label="Job Queue (name or ID)",
+    )
 
     class Meta:
         model = Job

nautobot/extras/forms/forms.py

@@ -38,6 +38,7 @@ from nautobot.core.forms import (
 )
 from nautobot.core.forms.constants import BOOLEAN_WITH_BLANK_CHOICES
 from nautobot.core.forms.forms import ConfirmationForm
+from nautobot.core.forms.widgets import ClearableFileInput
 from nautobot.core.utils.deprecation import class_deprecated_in_favor_of
 from nautobot.dcim.models import Device, DeviceRedundancyGroup, DeviceType, Location, Platform
 from nautobot.extras.choices import (
@@ -985,6 +986,9 @@ class ImageAttachmentForm(BootstrapMixin, forms.ModelForm):
             "name",
             "image",
         ]
+        widgets = {
+            "image": ClearableFileInput,
+        }
 
 
 #

nautobot/extras/jobs.py

@@ -37,6 +37,7 @@ from nautobot.core.forms import (
     DynamicModelMultipleChoiceField,
     JSONField,
 )
+from nautobot.core.forms.widgets import ClearableFileInput
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.core.utils.logging import sanitize
 from nautobot.core.utils.lookup import get_model_from_name
@@ -1040,12 +1041,18 @@ class DatabaseFileField(forms.FileField):
     widget = DBClearableFileInput
 
 
+class BootstrapStyleFileField(forms.FileField):
+    """File picker with UX bootstrap style and clearable checkbox."""
+
+    widget = ClearableFileInput
+
+
 class FileVar(ScriptVariable):
     """
     An uploaded file.
     """
 
-    form_field = DatabaseFileField
+    form_field = BootstrapStyleFileField
 
 
 class IPAddressVar(ScriptVariable):

nautobot/extras/models/datasources.py

@@ -131,16 +131,20 @@ class GitRepository(PrimaryModel):
 
     def get_latest_sync(self):
         """
-        Return a `JobResult` for the latest sync operation.
+        Return a `JobResult` for the latest sync operation if one has occurred.
 
         Returns:
-            JobResult
+            Returns a `JobResult` if the repo has been synced before, otherwise returns None.
         """
         from nautobot.extras.models import JobResult
 
         # This will match all "GitRepository" jobs (pull/refresh, dry-run, etc.)
         prefix = "nautobot.core.jobs.GitRepository"
-        return JobResult.objects.filter(task_name__startswith=prefix, task_kwargs__repository=self.pk).latest()
+
+        if JobResult.objects.filter(task_name__startswith=prefix, task_kwargs__repository=self.pk).exists():
+            return JobResult.objects.filter(task_name__startswith=prefix, task_kwargs__repository=self.pk).latest()
+        else:
+            return None
 
     def to_csv(self):
         return (

nautobot/extras/plugins/__init__.py

@@ -728,6 +728,31 @@ def register_plugin_menu_items(section_name, menu_items):
 #
 
 
+class CustomValidatorContext(dict):
+    def __init__(self, obj):
+        """
+        If there is an active change context, meaning we are in a web request context,
+        we have access to the current user object. Otherwise, we are likely running inside
+        a management command or other non-web or non-Job context, and we should use an AnonymousUser.
+        This ensures people's custom validators don't outright break when running in non-web
+        contexts, and should generally provide a sane default, given validation based on the
+        user is commonly going to be least-privelege based, and thus the AnonymousUser will
+        cause such validation logic to fail closed.
+        """
+        from django.contrib.auth.models import AnonymousUser
+
+        from nautobot.extras.signals import change_context_state
+
+        change_context = change_context_state.get()
+        user = None
+        if change_context:
+            user = change_context.get_user()
+        if user is None:
+            user = AnonymousUser()
+
+        super().__init__(object=obj, user=user)
+
+
 class CustomValidator:
     """
     This class is used to register plugin custom model validators which act on specified models. It contains the clean
@@ -742,7 +767,7 @@ class CustomValidator:
     model = None
 
     def __init__(self, obj):
-        self.context = {"object": obj}
+        self.context = CustomValidatorContext(obj)
 
     def validation_error(self, message):
         """

nautobot/extras/templates/extras/inc/jobresult.html

@@ -12,45 +12,43 @@
         <strong>Summary of Results</strong>
     </div>
     <table class="table table-hover panel-body">
-        {% if result.job_model is not None %}
             <tr>
                 <td>Job Description</td>
-                <td>{{ result.job_model.description | render_markdown }}</td>
+                <td>{{ result.job_model.description | render_markdown | placeholder }}</td>
             </tr>
-        {% endif %}
         <tr>
             <td>Status</td>
             <td><span id="pending-result-label">{% include 'extras/inc/job_label.html' with result=result %}</span></td>
         </tr>
         <tr>
             <td>Started at</td>
-            <td>{{ result.date_created }}</td>
+            <td>{{ result.date_created | placeholder }}</td>
         </tr>
         <tr>
             <td>User</td>
-            <td>{{ result.user }}</td>
+            <td>{{ result.user | placeholder }}</td>
         </tr>
         <tr>
             <td>Duration</td>
             <td>
-            {% if result.date_done %}
-                {{ result.duration }}
-            {% else %}
+            {% if result.date_created and not result.date_done %}
                 <img src="{% static 'img/ajax-loader.gif' %}">
+            {% else %}
+                {{ result.duration | placeholder}}
             {% endif %}
             </td>
         </tr>
         <tr>
             <td>Return Value</td>
             <td>
-            {% if result.date_done %}
+            {% if result.date_created and not result.date_done %}
+                <img src="{% static 'img/ajax-loader.gif' %}">
+            {% else %}
                 {% if result.result %}
                     <pre>{{ result.result | render_json }}</pre>
                 {% else %}
                     {{ result.result | placeholder }}
                 {% endif %}
-            {% else %}
-                <img src="{% static 'img/ajax-loader.gif' %}">
             {% endif %}
             </td>
         </tr>
@@ -89,6 +87,7 @@
             <input class="form-control" id="log-filter" type="text" placeholder="Filter log level or message" title="Filter log level or message" style="height: 23px" />
         </div>
     </div>
-    {% ajax_table "log_table" "extras:jobresult_log-table" pk=result.pk %}
+    {% if result and result.pk %}
+        {% ajax_table "log_table" "extras:jobresult_log-table" pk=result.pk %}
+    {% endif %}
 </div>
-

nautobot/extras/templates/extras/job.html

@@ -192,4 +192,5 @@
         toggleExecutionType();
     });
 </script>
+{{ job_form.media }}
 {% endblock %}

nautobot/extras/templates/extras/objectchange.html

@@ -1,5 +1,6 @@
 {% extends 'generic/object_retrieve.html' %}
 {% load helpers %}
+{% load static %}
 
 {% block title %}{{ object }}{% endblock %}
 
@@ -95,6 +96,20 @@
                     </tr>
                 </table>
             </div>
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Object Data</strong>
+                </div>
+                <div class="panel-body">
+                    <div class="editor-container" 
+                         data-lang="json"
+                         data-value="{{ object.object_data|render_json:False }}"
+                         style="max-height: 300px">
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="col-md-7">
             <div class="panel panel-default">
                 <div class="panel-heading">
                     <strong>Difference</strong>
@@ -119,22 +134,17 @@
                             {% endif %}
                         </span>
                     {% else %}
-                        <pre class="diff-removed">{{ diff_removed|render_json }}</pre>
-                        <pre class="diff-added">{{ diff_added|render_json }}</pre>
+                        <div class="editor-container" 
+                            data-mode="diff"
+                            data-original="{{ diff_removed | render_json:False }}"
+                            data-modified="{{ diff_added | render_json:False }}"
+                            data-lang="json"
+                            style="max-height: 730px">
+                        </div>
                     {% endif %}
                 </div>
             </div>
         </div>
-        <div class="col-md-7">
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Object Data</strong>
-                </div>
-                <div class="panel-body">
-                    <pre>{{ object.object_data|render_json }}</pre>
-                </div>
-            </div>
-        </div>
     </div>
     <div class="row">
         <div class="col-md-12">
@@ -147,3 +157,9 @@
         </div>
     </div>
 {% endblock %}
+
+{% block javascript %}
+    {{ block.super }}
+    <script src="{% static 'js/editor.js' %}"></script>
+{% endblock %}
+

nautobot/extras/tests/test_api.py

@@ -196,20 +196,6 @@ class ComputedFieldTest(APIViewTestCases.APIViewTestCase):
 
 class ConfigContextTest(APIViewTestCases.APIViewTestCase):
     model = ConfigContext
-    create_data = [
-        {
-            "name": "Config Context 4",
-            "data": {"more_foo": True},
-        },
-        {
-            "name": "Config Context 5",
-            "data": {"more_bar": False},
-        },
-        {
-            "name": "Config Context 6",
-            "data": {"more_baz": None},
-        },
-    ]
     bulk_update_data = {
         "description": "New description",
     }
@@ -220,6 +206,21 @@ class ConfigContextTest(APIViewTestCases.APIViewTestCase):
         ConfigContext.objects.create(name="Config Context 1", weight=100, data={"foo": 123})
         ConfigContext.objects.create(name="Config Context 2", weight=200, data={"bar": 456})
         ConfigContext.objects.create(name="Config Context 3", weight=300, data={"baz": 789})
+        cls.create_data = [
+            {
+                "name": "Config Context 4",
+                "data": {"more_foo": True},
+                "tags": [tag.pk for tag in Tag.objects.get_for_model(Device)],
+            },
+            {
+                "name": "Config Context 5",
+                "data": {"more_bar": False},
+            },
+            {
+                "name": "Config Context 6",
+                "data": {"more_baz": None},
+            },
+        ]
 
     def test_render_configcontext_for_object(self):
         """
@@ -1797,7 +1798,7 @@ class JobTest(
         )
         self.assertHttpStatus(response, status.HTTP_400_BAD_REQUEST)
         self.assertIn(
-            "task_queue and job_queue are both specified. Please specifiy only one or another.", str(response.content)
+            "task_queue and job_queue are both specified. Please specify only one or another.", str(response.content)
         )
 
     @override_settings(EXEMPT_VIEW_PERMISSIONS=["*"])

nautobot/extras/tests/test_dynamicgroups.py

@@ -667,6 +667,20 @@ class DynamicGroupModelTest(DynamicGroupTestBase):  # TODO: BaseModelTestCase mi
         # Cleanup because we're using class-based fixtures in `setUpTestData()`
         group.refresh_from_db()
 
+    def test_set_filter_on_ipaddress_dynamic_group(self):
+        """
+        Test `DynamicGroup.set_filter()` for an IPAddress Dynamic Group.
+        https://github.com/nautobot/nautobot/issues/6805
+        """
+        ipaddress_dg = DynamicGroup.objects.create(
+            name="IP Address Dynamic Group",
+            content_type=ContentType.objects.get_for_model(IPAddress),
+            description="IP Address Dynamic Group",
+        )
+        # Test the fact that set_filter correctly discard an empty PrefixQuerySet
+        ipaddress_dg.set_filter({"parent": Prefix.objects.none()})
+        self.assertEqual(ipaddress_dg.filter, {})
+
     def test_add_child(self):
         """Test `DynamicGroup.add_child()`."""
         self.parent.add_child(

nautobot/extras/tests/test_filters.py

@@ -880,6 +880,8 @@ class JobFilterSetTestCase(FilterTestCases.FilterTestCase):
     generic_filter_tests = (
         ("grouping",),
         ("job_class_name",),
+        ("job_queues", "job_queues__id"),
+        ("job_queues", "job_queues__name"),
         ("module_name",),
         ("name",),
     )

nautobot/extras/tests/test_plugins.py

@@ -17,11 +17,12 @@ from nautobot.dcim.models import Device, DeviceType, Location, LocationType, Man
 from nautobot.dcim.tests.test_views import create_test_device
 from nautobot.extras import plugins
 from nautobot.extras.choices import CustomFieldTypeChoices, RelationshipTypeChoices
+from nautobot.extras.context_managers import web_request_context
 from nautobot.extras.jobs import get_job
 from nautobot.extras.models import CustomField, Relationship, RelationshipAssociation, Role, Secret, Status
 from nautobot.extras.plugins.exceptions import PluginImproperlyConfigured
 from nautobot.extras.plugins.utils import load_plugin
-from nautobot.extras.plugins.validators import wrap_model_clean_methods
+from nautobot.extras.plugins.validators import CustomValidator, wrap_model_clean_methods
 from nautobot.extras.plugins.views import extract_app_data
 from nautobot.extras.registry import DatasourceContent, registry
 from nautobot.ipam.models import IPAddress, Namespace, Prefix
@@ -478,6 +479,16 @@ class AppAPITest(APIViewTestCases.APIViewTestCase):
         pass
 
 
+class TestUserContextCustomValidator(CustomValidator):
+    model = "dcim.locationtype"
+
+    def clean(self):
+        """
+        Used to validate that the correct user context is available in the custom validator.
+        """
+        self.validation_error(self.context["user"])
+
+
 class AppCustomValidationTest(TestCase):
     def setUp(self):
         # When creating a fresh test DB, wrapping model clean methods fails, which is normal.
@@ -485,6 +496,7 @@ class AppCustomValidationTest(TestCase):
         # must manually call the method again to actually perform the action, now that the
         # ContentType table has been created.
         wrap_model_clean_methods()
+        super().setUp()
 
     def test_custom_validator_raises_exception(self):
         location_type = LocationType.objects.get(name="Campus")
@@ -513,6 +525,25 @@ class AppCustomValidationTest(TestCase):
         with self.assertRaises(ValidationError):
             relationship_assoc.clean()
 
+    def test_custom_validator_non_web_request_uses_anonymous_user(self):
+        location_type = LocationType.objects.get(name="Campus")
+        registry["plugin_custom_validators"]["dcim.locationtype"] = [TestUserContextCustomValidator]
+
+        from django.contrib.auth.models import AnonymousUser
+
+        with self.assertRaises(ValidationError) as context:
+            location_type.clean()
+        self.assertEqual(context.exception.message, AnonymousUser())
+
+    def test_custom_validator_web_request_uses_real_user(self):
+        location_type = LocationType.objects.get(name="Campus")
+        registry["plugin_custom_validators"]["dcim.locationtype"] = [TestUserContextCustomValidator]
+
+        with self.assertRaises(ValidationError) as context:
+            with web_request_context(user=self.user):
+                location_type.clean()
+        self.assertEqual(context.exception.message, self.user)
+
 
 class ExampleModelCustomActionViewTest(TestCase):
     """Test for custom action view `all_names` added to Example App"""