nautobot 2.2.5__py3-none-any.whl → 2.2.7__py3-none-any.whl

nautobot/extras/forms/forms.py

@@ -27,6 +27,7 @@ from nautobot.core.forms import (
     DynamicModelMultipleChoiceField,
     JSONArrayFormField,
     JSONField,
+    LaxURLField,
     MultipleContentTypeField,
     SlugField,
     StaticSelect2,
@@ -687,7 +688,7 @@ class PasswordInputWithPlaceholder(forms.PasswordInput):
 class GitRepositoryForm(NautobotModelForm):
     slug = SlugField(help_text="Filesystem-friendly unique shorthand")
 
-    remote_url = forms.URLField(
+    remote_url = LaxURLField(
         required=True,
         label="Remote URL",
         help_text="Only http:// and https:// URLs are presently supported",
@@ -738,7 +739,7 @@ class GitRepositoryBulkEditForm(NautobotBulkEditForm):
         queryset=GitRepository.objects.all(),
         widget=forms.MultipleHiddenInput(),
     )
-    remote_url = forms.CharField(
+    remote_url = LaxURLField(
         label="Remote URL",
         required=False,
     )
@@ -1012,6 +1013,10 @@ class JobHookForm(BootstrapMixin, forms.ModelForm):
     content_types = MultipleContentTypeField(
         queryset=ChangeLoggedModelsQuery().as_queryset(), required=True, label="Content Type(s)"
     )
+    job = DynamicModelChoiceField(
+        queryset=Job.objects.filter(is_job_hook_receiver=True),
+        query_params={"is_job_hook_receiver": True},
+    )
 
     class Meta:
         model = JobHook
@@ -1179,14 +1184,19 @@ class JobButtonForm(BootstrapMixin, forms.ModelForm):
             api_url="/api/extras/content-types/",
         ),
     )
+    job = DynamicModelChoiceField(
+        queryset=Job.objects.filter(is_job_button_receiver=True),
+        query_params={"is_job_button_receiver": True},
+    )
 
     class Meta:
         model = JobButton
         fields = (
             "content_types",
             "name",
-            "text",
             "job",
+            "enabled",
+            "text",
             "weight",
             "group_name",
             "button_class",
@@ -1206,6 +1216,9 @@ class JobButtonBulkEditForm(BootstrapMixin, BulkEditForm):
         ),
         required=False,
     )
+    enabled = forms.NullBooleanField(
+        required=False, widget=BulkEditNullBooleanSelect, help_text="Whether this job button appears in the UI"
+    )
     weight = forms.IntegerField(required=False)
     group_name = forms.CharField(required=False)
 

nautobot/extras/jobs.py

@@ -1168,6 +1168,14 @@ def enqueue_job_hooks(object_change):
     job_hooks = JobHook.objects.filter(content_types=content_type, enabled=True, **{action_flag: True})
 
     # Enqueue the jobs related to the job_hooks
+    get_jobs(reload=True)
     for job_hook in job_hooks:
         job_model = job_hook.job
-        JobResult.enqueue_job(job_model, object_change.user, object_change=object_change.pk)
+        if not job_model.installed or not job_model.enabled:
+            logger.warning(
+                "JobHook %s is enabled, but the underlying Job %s is not installed and enabled", job_hook, job_model
+            )
+        elif get_job(job_model.class_path) is None:
+            logger.error("JobHook %s is enabled, but the underlying Job implementation is missing", job_hook)
+        else:
+            JobResult.enqueue_job(job_model, object_change.user, object_change=object_change.pk)

nautobot/extras/migrations/0107_laxurlfield.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2.25 on 2024-06-17 13:24
+
+from django.db import migrations
+
+import nautobot.core.models.fields
+import nautobot.core.models.validators
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0106_populate_default_statuses_and_roles_for_contact_associations"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="externalintegration",
+            name="remote_url",
+            field=nautobot.core.models.fields.LaxURLField(max_length=500),
+        ),
+        migrations.AlterField(
+            model_name="gitrepository",
+            name="remote_url",
+            field=nautobot.core.models.fields.LaxURLField(
+                max_length=255,
+                validators=[nautobot.core.models.validators.EnhancedURLValidator(schemes=["http", "https"])],
+            ),
+        ),
+    ]

nautobot/extras/migrations/0108_jobbutton_enabled.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2.25 on 2024-06-17 19:06
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0107_laxurlfield"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="jobbutton",
+            name="enabled",
+            field=models.BooleanField(default=True),
+        ),
+    ]

nautobot/extras/models/datasources.py

@@ -6,18 +6,19 @@ import os
 from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.core.serializers.json import DjangoJSONEncoder
-from django.core.validators import URLValidator
 from django.db import models
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
-from nautobot.core.models.fields import AutoSlugField, slugify_dashes_to_underscores
+from nautobot.core.models.fields import AutoSlugField, LaxURLField, slugify_dashes_to_underscores
 from nautobot.core.models.generics import PrimaryModel
+from nautobot.core.models.validators import EnhancedURLValidator
 from nautobot.extras.utils import check_if_key_is_graphql_safe, extras_features
 
 
 @extras_features(
     "config_context_owners",
     "export_template_owners",
+    "graphql",
     "job_results",
     "webhooks",
 )
@@ -34,15 +35,16 @@ class GitRepository(PrimaryModel):
         slugify_function=slugify_dashes_to_underscores,
     )
 
-    remote_url = models.URLField(
+    remote_url = LaxURLField(
         max_length=CHARFIELD_MAX_LENGTH,
         # For the moment we don't support ssh:// and git:// URLs
         help_text="Only HTTP and HTTPS URLs are presently supported",
-        validators=[URLValidator(schemes=["http", "https"])],
+        validators=[EnhancedURLValidator(schemes=["http", "https"])],
     )
     branch = models.CharField(
         max_length=CHARFIELD_MAX_LENGTH,
         default="main",
+        help_text="Branch, tag, or commit",
     )
 
     current_head = models.CharField(

nautobot/extras/models/groups.py

@@ -597,10 +597,17 @@ class DynamicGroup(OrganizationalModel):
             query |= filter_field.generate_query(gq_value)
 
         # For vanilla multiple-choice filters, we want all values in a set union (boolean OR)
-        # because we want ANY of the filter values to match.
+        # because we want ANY of the filter values to match. Unless the filter field is explicitly
+        # conjoining the values, in which case we want a set intersection (boolean AND). We know this isn't right
+        # since the resulting query actually does tag.name == tag_1 AND tag.name == tag_2, but django_filter does
+        # not use Q evaluation for conjoined filters. This function is only used for the display, and the display
+        # is good enough to get the point across.
         elif isinstance(filter_field, django_filters.MultipleChoiceFilter):
             for v in value:
-                query |= models.Q(**filter_field.get_filter_predicate(v))
+                if filter_field.conjoined:
+                    query &= models.Q(**filter_field.get_filter_predicate(v))
+                else:
+                    query |= models.Q(**filter_field.get_filter_predicate(v))
 
         # The method `get_filter_predicate()` is only available on instances or subclasses
         # of `MultipleChoiceFilter`, so we must construct a lookup if a filter is not

nautobot/extras/models/jobs.py

@@ -318,6 +318,25 @@ class Job(PrimaryModel):
                 {"approval_required": "A job that may have sensitive variables cannot be marked as requiring approval"}
             )
 
+    def save(self, *args, **kwargs):
+        """When a Job is uninstalled, auto-disable all associated JobButtons, JobHooks, and ScheduledJobs."""
+        super().save(*args, **kwargs)
+        if not self.installed:
+            if self.is_job_button_receiver:
+                for jb in JobButton.objects.filter(job=self, enabled=True):
+                    logger.info("Disabling JobButton %s derived from %s", jb, self)
+                    jb.enabled = False
+                    jb.save()
+            if self.is_job_hook_receiver:
+                for jh in JobHook.objects.filter(job=self, enabled=True):
+                    logger.info("Disabling JobHook %s derived from %s", jh, self)
+                    jh.enabled = False
+                    jh.save()
+            for sj in ScheduledJob.objects.filter(job_model=self, enabled=True):
+                logger.info("Disabling ScheduledJob %s derived from %s", sj, self)
+                sj.enabled = False
+                sj.save()
+
 
 @extras_features("graphql")
 class JobHook(OrganizationalModel):
@@ -363,6 +382,9 @@ class JobHook(OrganizationalModel):
         if not self.type_create and not self.type_delete and not self.type_update:
             raise ValidationError("You must select at least one type: create, update, and/or delete.")
 
+        if self.enabled and not (self.job.installed and self.job.enabled):
+            raise ValidationError({"enabled": "The selected Job is not installed and enabled"})
+
     @classmethod
     def check_for_conflicts(
         cls, instance=None, content_types=None, job=None, type_create=None, type_update=None, type_delete=None
@@ -375,6 +397,7 @@ class JobHook(OrganizationalModel):
         """
 
         conflicts = {}
+
         job_hook_error_msg = "A job hook already exists for {action} on {content_type} to job {job}"
 
         if instance is not None and instance.present_in_database:
@@ -783,6 +806,7 @@ class JobButton(BaseModel, ChangeLoggedModel, NotesMixin):
         help_text="The object type(s) to which this job button applies.",
     )
     name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
+    enabled = models.BooleanField(default=True)
     text = models.CharField(
         max_length=500,
         help_text="Jinja2 template code for button text. Reference the object as <code>{{ obj }}</code> such as <code>{{ obj.platform.name }}</code>. Buttons which render as empty text will not be displayed.",
@@ -817,6 +841,12 @@ class JobButton(BaseModel, ChangeLoggedModel, NotesMixin):
     def __str__(self):
         return self.name
 
+    def clean(self):
+        super().clean()
+
+        if self.enabled and not (self.job.installed and self.job.enabled):
+            raise ValidationError({"enabled": "The selected Job is not installed and enabled"})
+
 
 class ScheduledJobs(models.Model):
     """Helper table for tracking updates to scheduled tasks.

nautobot/extras/models/models.py

@@ -22,9 +22,8 @@ from rest_framework.utils.encoders import JSONEncoder
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.models import BaseManager, BaseModel
-from nautobot.core.models.fields import ForeignKeyWithAutoRelatedName
+from nautobot.core.models.fields import ForeignKeyWithAutoRelatedName, LaxURLField
 from nautobot.core.models.generics import OrganizationalModel, PrimaryModel
-from nautobot.core.models.validators import EnhancedURLValidator
 from nautobot.core.utils.data import deepmerge, render_jinja2
 from nautobot.extras.choices import (
     ButtonClassChoices,
@@ -442,10 +441,9 @@ class ExternalIntegration(PrimaryModel):
     """Model for tracking integrations with external applications."""
 
     name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
-    remote_url = models.CharField(
+    remote_url = LaxURLField(
         max_length=500,
         verbose_name="Remote URL",
-        validators=[EnhancedURLValidator()],
     )
     secrets_group = models.ForeignKey(
         null=True,

nautobot/extras/tables.py

@@ -818,6 +818,7 @@ class JobButtonTable(BaseTable):
     pk = ToggleColumn()
     name = tables.Column(linkify=True)
     job = tables.Column(linkify=True)
+    enabled = BooleanColumn()
     confirmation = BooleanColumn()
     content_types = ContentTypesColumn(truncate_words=15)
 
@@ -829,6 +830,7 @@ class JobButtonTable(BaseTable):
             "content_types",
             "text",
             "job",
+            "enabled",
             "group_name",
             "weight",
             "button_class",
@@ -841,6 +843,7 @@ class JobButtonTable(BaseTable):
             "group_name",
             "weight",
             "job",
+            "enabled",
             "confirmation",
         )
 

nautobot/extras/templates/extras/jobbutton_retrieve.html

@@ -32,19 +32,23 @@
                 </tr>
                 <tr>
                     <td>Text</td>
-                    <td><span>{{ object.text }}</span></td>
+                    <td><pre>{{ object.text }}</pre></td>
                 </tr>
                 <tr>
                     <td>Job</td>
                     <td><a href="{% url 'extras:job_run_by_class_path' class_path=object.job.class_path %}">{{ object.job }}</a></td>
                 </tr>
+                <tr>
+                    <td>Enabled</td>
+                    <td>{{ object.enabled|render_boolean }}</td>
+                </tr>
                 <tr>
                     <td>Button Class</td>
                     <td><button class="btn btn-{{ object.button_class }}">{{ object.button_class | title }}</button></td>
                 </tr>
                 <tr>
                     <td>Confirmation</td>
-                    <td><span>{{ object.confirmation }}</span></td>
+                    <td>{{ object.confirmation|render_boolean}}</td>
                 </tr>
             </table>
         </div>

nautobot/extras/templatetags/job_buttons.py

@@ -127,7 +127,7 @@ def _render_job_button_for_obj(job_button, obj, context, content_type):
         "object": obj,
         "job": job_button.job,
         "hidden_inputs": hidden_inputs,
-        "disabled": "" if has_run_perm else "disabled",
+        "disabled": "" if (has_run_perm and job_button.job.installed and job_button.job.enabled) else "disabled",
     }
 
     if job_button.confirmation:
@@ -149,7 +149,7 @@ def job_buttons(context, obj):
     """
     content_type = ContentType.objects.get_for_model(obj)
     # We will enforce "run" permission later in deciding which buttons to show as disabled.
-    buttons = JobButton.objects.filter(content_types=content_type)
+    buttons = JobButton.objects.filter(content_types=content_type, enabled=True)
     if not buttons:
         return SAFE_EMPTY_STR
 

nautobot/extras/tests/git_data/01-valid-files/config_context_schemas/schema-1.yaml

@@ -0,0 +1,18 @@
+---
+_metadata:
+    name: "Config Context Schema 1"
+    description: "Schema for defining first names, last names, and ages."
+data_schema:
+    title: "Person"
+    type: "object"
+    properties:
+        firstName:
+            type: "string"
+            description: "The person's first name."
+        lastName:
+            type: "string"
+            description: "The person's last name."
+        age:
+            description: "Age in years which must be equal to or greater than zero."
+            type: "integer"
+            minimum: 0

nautobot/extras/tests/git_data/01-valid-files/config_contexts/context.yaml

@@ -0,0 +1,12 @@
+---
+_metadata:
+    name: "Frobozz 1000 NTP servers"
+    weight: 1500
+    description: "NTP servers for Frobozz 1000 devices **only**"
+    is_active: true
+    config_context_schema: "Config Context Schema 1"
+    device_types:
+        - model: "Frobozz 1000"
+ntp-servers:
+    - "172.16.10.22"
+    - "172.16.10.33"

nautobot/extras/tests/git_data/01-valid-files/config_contexts/devices/test-device.json

@@ -0,0 +1,3 @@
+{
+    "dns-servers": ["8.8.8.8"]
+}

nautobot/extras/tests/git_data/01-valid-files/config_contexts/locations/Test Location.json

@@ -0,0 +1,7 @@
+{
+    "_metadata": {
+        "name": "Location context",
+        "is_active": false
+    },
+    "domain_name": "example.com"
+}

nautobot/extras/tests/git_data/01-valid-files/export_templates/dcim/device/template.j2

@@ -0,0 +1,3 @@
+{% for device in queryset %}
+{{ device.name }}
+{% endfor %}

nautobot/extras/tests/git_data/01-valid-files/export_templates/dcim/device/template2.html

@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+{% for device in queryset %}
+{{ device.name }}
+{% endfor %}

nautobot/extras/tests/git_data/01-valid-files/export_templates/ipam/vlan/template.j2

@@ -0,0 +1,3 @@
+{% for vlan in queryset %}
+{{ vlan.name }}
+{% endfor %}

nautobot/extras/tests/git_data/01-valid-files/jobs/__init__.py

@@ -0,0 +1,5 @@
+from nautobot.core.celery import register_jobs
+
+from .my_job import MyJob, MyJobButtonReceiver, MyJobHookReceiver
+
+register_jobs(MyJob, MyJobButtonReceiver, MyJobHookReceiver)

nautobot/extras/tests/git_data/01-valid-files/jobs/my_job.py

@@ -0,0 +1,16 @@
+from nautobot.extras.jobs import Job, JobButtonReceiver, JobHookReceiver
+
+
+class MyJob(Job):
+    def run(self):
+        pass
+
+
+class MyJobHookReceiver(JobHookReceiver):
+    def receive_job_hook(self, change, action, changed_object):
+        pass
+
+
+class MyJobButtonReceiver(JobButtonReceiver):
+    def receive_job_button(self, obj):
+        pass

nautobot/extras/tests/git_data/02-invalid-files/config_context_schemas/badschema1.json

@@ -0,0 +1,2 @@
+{
+    "data":

nautobot/extras/tests/git_data/02-invalid-files/config_context_schemas/badschema2.json

@@ -0,0 +1 @@
+{}

nautobot/extras/tests/git_data/02-invalid-files/config_contexts/badcontext1.json

@@ -0,0 +1,2 @@
+{
+    "data":

nautobot/extras/tests/git_data/02-invalid-files/config_contexts/badcontext2.json

@@ -0,0 +1 @@
+{}

nautobot/extras/tests/git_data/02-invalid-files/config_contexts/badcontext3.json

@@ -0,0 +1,3 @@
+{
+    "_metadata": {}
+}

nautobot/extras/tests/git_data/02-invalid-files/config_contexts/devices/nosuchdevice.json

@@ -0,0 +1 @@
+{}

nautobot/extras/tests/git_data/02-invalid-files/export_templates/dcim/nosuchmodel/template.j2

@@ -0,0 +1,3 @@
+{% for nosuchmodel in queryset %}
+{{ nosuchmodel.name }}
+{% endfor %}

nautobot/extras/tests/git_data/02-invalid-files/export_templates/nosuchapp/device/template.j2

@@ -0,0 +1,3 @@
+{% for device in queryset %}
+{{ device.name }}
+{% endfor %}

nautobot/extras/tests/git_data/02-invalid-files/jobs/__init__.py

@@ -0,0 +1,2 @@
+import .syntaxerror
+import .importerror

nautobot/extras/tests/git_data/02-invalid-files/jobs/importerror.py

@@ -0,0 +1 @@
+import nosuchmodule

nautobot/extras/tests/git_data/02-invalid-files/jobs/syntaxerror.py

@@ -0,0 +1 @@
+print(

nautobot/extras/tests/git_helper.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+
+import logging
+import os
+import os.path
+import shutil
+import tempfile
+
+from git import Repo
+
+logger = logging.getLogger(__name__)
+
+
+SOURCE_DIR = os.path.join(os.path.dirname(__file__), "git_data")
+
+
+def create_and_populate_git_repository(target_path):
+    """
+    Create a Git repository in `target_path` and populate it with commits and tags based on contents of `SOURCE_DIR`.
+
+    An initial commit will always be created, containing no tracked files, and will be given the tag `empty-repo`.
+    After that, each subdir under `SOURCE_DIR` will be used as the basis for a single commit to the repo, so given:
+
+        nautobot/extras/tests/git_data
+        ├── 01-valid-files
+        │   ├── config_context_schemas
+        │   │   └── schema-1.yaml
+        │   └── config_contexts
+        │       └── context.yaml
+        └── 02-invalid-files
+            └── config_context_schemas
+             ├── badschema1.json
+             └── badschema2.json
+
+    ...after the initial empty commit, the next commit would contain files `config_context_schemas/schema-1.yaml` and
+    `config_contexts/context.yaml`, and would be given the tag `valid-files`. The next commit would remove those files
+    but add the files `config_context_schemas/badschema1.json` and `config_context_schemas/badschema2.json`, and would
+    be tagged as `invalid-files`.
+
+    Note that each commit is fully defined by the files in the appropriate subdirectory; if you want a file to exist
+    across multiple separate commits, it must exist in multiple subdirectories. Use of symlinks is encouraged in such
+    a scenario.
+    """
+    os.makedirs(target_path, exist_ok=True)
+    repo = Repo.init(target_path, initial_branch="main")
+    repo.config_writer().set_value("user", "name", "Nautobot Automation").release()
+    repo.config_writer().set_value("user", "email", "nautobot@nautobot.com").release()
+
+    repo.index.commit("Empty commit")
+    repo.create_tag("empty-repo", message="Nothing here yet")
+
+    # Create a commit matching each subdirectory in the git_data directory
+    for dirname in sorted(os.listdir(SOURCE_DIR)):
+        # Clean up from any previous commit
+        for root, _, files in os.walk(target_path):
+            if ".git" in root:
+                continue
+            for filename in files:
+                repo.index.remove([os.path.join(root, filename)])
+                os.remove(os.path.join(root, filename))
+
+        shutil.copytree(os.path.join(SOURCE_DIR, dirname), target_path, dirs_exist_ok=True)
+        for root, _, files in os.walk(target_path):
+            if ".git" in root:
+                continue
+            for filename in files:
+                repo.index.add([os.path.join(root, filename)])
+        repo.index.commit(dirname)
+        # Directory "01-valid-files" --> tag "valid-files" so that we won't break tests if we renumber the directories
+        repo.create_tag(dirname[3:], message=f"Tag based on {dirname} files")
+
+
+if __name__ == "__main__":
+    directory_path = tempfile.TemporaryDirectory().name  # pylint: disable=consider-using-with
+    print(f"Creating test Git repository in {directory_path}...")
+    create_and_populate_git_repository(directory_path)