nautobot 2.0.0a2__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/extras/templates/extras/job_detail.html

@@ -9,7 +9,7 @@
 
 {% block extra_buttons %}
     {% if perms.extras.run_job %}
-        <a href="{% url 'extras:job_run' slug=object.slug %}" class="btn btn-primary"
+        <a href="{% url 'extras:job_run' pk=object.pk %}" class="btn btn-primary"
            {% if not object.installed or not object.enabled %}disabled="disabled"{% endif %}>
             <i class="mdi mdi-play" aria-hidden="true"></i> Run/Schedule
         </a>
@@ -22,16 +22,6 @@
             <strong>Source Code</strong>
         </div>
         <table class="table table-hover panel-body attr-table">
-            <tr>
-                <td>Source</td>
-                <td>{{ object.source | bettertitle }}</td>
-            </tr>
-            {% if object.source == "git" %}
-                <tr>
-                    <td>Repository</td>
-                    <td>{{ object.git_repository|hyperlinked_object }}</td>
-                </tr>
-            {% endif %}
             <tr>
                 <td>Module</td>
                 <td><code>{{ object.module_name }}</code></td>
@@ -152,14 +142,18 @@
                 </td>
             </tr>
             <tr>
-                <td>Default to Committing Changes</td>
-                <td>{{ object.commit_default | render_boolean }}</td>
+                <td>Supports Dryrun</td>
+                <td colspan="2">{{ object.supports_dryrun | render_boolean }}</td>
+            </tr>
+            <tr>
+                <td>Default to Dryrun</td>
+                <td>{{ object.dryrun_default | render_boolean }}</td>
                 <td>
-                    {% if object.commit_default_override %}
+                    {% if object.dryrun_default_override %}
                         <span class="text-muted">
                             overridden; default is
                             {% if object.installed %}
-                                {{ object.job_class.commit_default | render_boolean }}
+                                {{ object.job_class.dryrun_default | render_boolean }}
                             {% else %}
                                 unknown (not currently installed)
                             {% endif %}
@@ -167,6 +161,10 @@
                     {% endif %}
                 </td>
             </tr>
+            <tr>
+                <td>Read-Only Execution</td>
+                <td colspan="2">{{ object.read_only | render_boolean }}</td>
+            </tr>
             <tr>
                 <td>Hide from Default UI</td>
                 <td>{{ object.hidden | render_boolean }}</td>
@@ -183,22 +181,6 @@
                     {% endif %}
                 </td>
             </tr>
-            <tr>
-                <td>Read-Only Execution</td>
-                <td>{{ object.read_only | render_boolean }}</td>
-                <td>
-                    {% if object.read_only_override %}
-                        <span class="text-muted">
-                            overridden; default is
-                            {% if object.installed %}
-                                {{ object.job_class.read_only | render_boolean }}
-                            {% else %}
-                                unknown (not currently installed)
-                            {% endif %}
-                        </span>
-                    {% endif %}
-                </td>
-            </tr>
             <tr>
                 <td>Has Sensitive Variables</td>
                 <td>{{ object.has_sensitive_variables | render_boolean }}</td>

nautobot/extras/templates/extras/job_edit.html

@@ -6,21 +6,6 @@
     <div class="panel panel-default">
         <div class="panel-heading"><strong>Job Source</strong></div>
         <div class="panel-body">
-            <div class="form-group">
-                <label class="col-md-3 control-label">Source</label>
-                <div class="col-md-9" style="padding-top: 7px">
-                    {{ obj.source | split:"." | first | bettertitle }}
-                    <span class="help-block">Source of the Python code for this job</span>
-                </div>
-            </div>
-            {% if obj.source == "git" %}
-                <div class="form-group">
-                    <label class="col-md-3 control-label">Repository</label>
-                    <div class="col-md-9" style="padding-top: 7px">
-                        <td>{{ obj.git_repository | placeholder }}</td>
-                    </div>
-                </div>
-            {% endif %}
             <div class="form-group">
                 <label class="col-md-3 control-label">Module</label>
                 <div class="col-md-9" style="padding-top: 7px">
@@ -48,6 +33,19 @@
                     </div>
                 </div>
             </div>
+            <div class="form-group">
+                <div class="col-md-9 col-md-offset-3">
+                    <div class="checkbox">
+                        <label>
+                            <input type="checkbox" disabled="true" {% if obj.supports_dryrun %}checked="checked"{% endif %}>
+                            Supports dryrun
+                        </label>
+                        <span class="help-block">
+                            Whether this job supports bypassing approval when running with dryrun argument set to true
+                        </span>
+                    </div>
+                </div>
+            </div>
             <div class="form-group">
                 <div class="col-md-9 col-md-offset-3">
                     <div class="checkbox">
@@ -90,9 +88,8 @@
         <div class="panel-heading"><strong>Properties</strong></div>
         <div class="panel-body">
             {% include "extras/inc/overridable_field.html" with field=form.approval_required override_field=form.approval_required_override %}
-            {% include "extras/inc/overridable_field.html" with field=form.commit_default override_field=form.commit_default_override %}
+            {% include "extras/inc/overridable_field.html" with field=form.dryrun_default override_field=form.dryrun_default_override %}
             {% include "extras/inc/overridable_field.html" with field=form.hidden override_field=form.hidden_override %}
-            {% include "extras/inc/overridable_field.html" with field=form.read_only override_field=form.read_only_override %}
             {% include "extras/inc/overridable_field.html" with field=form.soft_time_limit override_field=form.soft_time_limit_override %}
             {% include "extras/inc/overridable_field.html" with field=form.time_limit override_field=form.time_limit_override %}
             {% include "extras/inc/overridable_field.html" with field=form.has_sensitive_variables override_field=form.has_sensitive_variables_override %}

nautobot/extras/templates/extras/jobresult.html

@@ -35,18 +35,20 @@
 {% block buttons %}
     {% if perms.extras.run_job %}
         {% if result.job_model and result.task_kwargs %}
-            <a href="{% url 'extras:job_run' slug=result.job_model.slug %}?kwargs_from_job_result={{ result.pk }}"
+            <a href="{% url 'extras:job_run' pk=result.job_model.pk %}?kwargs_from_job_result={{ result.pk }}"
                class="btn btn-success">
                 <span class="mdi mdi-repeat" aria-hidden="true"></span> Re-Run
             </a>
         {% elif result.job_model is not None %}
-            <a href="{% url 'extras:job_run' slug=result.job_model.slug %}"
+            <a href="{% url 'extras:job_run' pk=result.job_model.pk %}"
                class="btn btn-primary">
                 <span class="mdi mdi-play" aria-hidden="true"></span> Run
             </a>
         {% endif %}
     {% endif %}
-    {% export_button %}
+    <a href="{% url 'extras-api:joblogentry-list' %}?job_result={{ result.pk }}&format=csv" class="btn btn-success">
+        <span class="mdi mdi-database-export" aria-hidden="true"></span> Export
+    </a>
     {{ block.super }}
 {% endblock buttons %}
 
@@ -84,20 +86,36 @@
             <div class="col-md-6">
                 <div class="panel panel-default">
                     <div class="panel-heading">
-                        <strong>Job Inputs</strong>
+                        <strong>Job Positional Arguments</strong>
+                    </div>
+                    <div class="panel-body">
+                        {% include 'extras/inc/json_data.html' with data=result.task_args format="json" %}
+                    </div>
+                </div>
+                <div class="panel panel-default">
+                    <div class="panel-heading">
+                        <strong>Job Keyword Arguments</strong>
                     </div>
                     <div class="panel-body">
                         {% include 'extras/inc/json_data.html' with data=result.task_kwargs format="json" %}
                     </div>
                 </div>
+                <div class="panel panel-default">
+                    <div class="panel-heading">
+                        <strong>Job Celery Keyword Arguments</strong>
+                    </div>
+                    <div class="panel-body">
+                        {% include 'extras/inc/json_data.html' with data=result.celery_kwargs format="json" %}
+                    </div>
+                </div>
             </div>
             <div class="col-md-6">
                 <div class="panel panel-default">
                     <div class="panel-heading">
-                        <strong>Output Data</strong>
+                        <strong>Return Data</strong>
                     </div>
                     <div class="panel-body">
-                        {% include 'extras/inc/json_data.html' with data=result.data format="json" %}
+                        {% include 'extras/inc/json_data.html' with data=result.result format="json" %}
                     </div>
                 </div>
                 <div class="panel panel-default">

nautobot/extras/templates/extras/objectchange_list.html

@@ -3,7 +3,7 @@
 
 {% block title %}Change Log{% endblock %}
 
-{% block sidebar %}
+{% block header_extra %}
     <div class="text-muted">
         Change log retention:
         {% if "CHANGELOG_RETENTION"|settings_or_config %}

nautobot/extras/templates/extras/scheduledjob.html

@@ -8,7 +8,7 @@
 {% block buttons %}
     {% plugin_buttons object %}
     {% if user|can_delete:object %}
-        {% delete_button object key='pk' %}
+        {% delete_button object %}
     {% endif %}
 {% endblock buttons %}
 
@@ -119,7 +119,7 @@
               <strong>User Inputs</strong>
           </div>
           <table class="table table-hover panel-body attr-table">
-              {% for key, value in object.kwargs.data.items %}
+              {% for key, value in object.kwargs.items %}
               <tr>
                 <td>{{ labels|get_item:key }}</td>
                 <td>{% if value is None %}–{% else %}<code>{{ value }}</code>{% endif %}</td>

nautobot/extras/templates/extras/secret.html

@@ -1,6 +1,12 @@
 {% extends 'generic/object_detail.html' %}
 {% load helpers %}
 
+{% block extra_buttons %}
+    <a onClick="checkSecret()" class="btn btn-default">
+        Check Secret
+    </a>
+{% endblock extra_buttons %}
+
 {% block content_left_page %}
     <div class="panel panel-default">
         <div class="panel-heading">
@@ -35,3 +41,25 @@
 {% block content_right_page %}
     {% include 'utilities/obj_table.html' with table=groups_table table_template='panel_table.html' heading='Groups containing this secret' %}
 {% endblock content_right_page %}
+
+
+{% block javascript %}
+<script>
+    function checkSecret() {
+        $.ajax({
+            url: "{% url 'extras-api:secret-check' pk=object.pk %}",
+            dataType: 'json',
+            success: function(json) {
+                if(json.result) {
+                    alert("The secret was successfully retrieved.")
+                } else {
+                    alert("Error retrieving secret: \n\n" + json.message)
+                }
+            },
+            error: function(xhr) {
+                alert("Error checking secret: \n\n" + xhr.responseText);
+            }
+        });
+    }
+</script>
+{% endblock javascript %}

nautobot/extras/templates/extras/secret_edit.html

@@ -6,7 +6,6 @@
         <div class="panel-heading"><strong>Secret</strong></div>
         <div class="panel-body">
             {% render_field form.name %}
-            {% render_field form.slug %}
             {% render_field form.description %}
             {% render_field form.provider %}
         </div>

nautobot/extras/templates/extras/secretsgroup_edit.html

@@ -7,7 +7,6 @@
         <div class="panel-heading"><strong>Secrets Group</strong></div>
         <div class="panel-body">
             {% render_field form.name %}
-            {% render_field form.slug %}
             {% render_field form.description %}
         </div>
     </div>

nautobot/extras/templatetags/custom_links.py

@@ -44,7 +44,6 @@ def custom_links(context, obj):
     group_names = OrderedDict()
 
     for cl in links:
-
         # Organize custom links by group
         if cl.group_name and cl.group_name in group_names:
             group_names[cl.group_name].append(cl)
@@ -67,7 +66,6 @@ def custom_links(context, obj):
 
     # Add grouped links to template
     for group, links in group_names.items():
-
         links_rendered = []
 
         for cl in links:

nautobot/extras/templatetags/job_buttons.py

@@ -144,6 +144,7 @@ def job_buttons(context, obj):
                 "object": obj,
                 "job": jb.job,
                 "hidden_inputs": hidden_inputs,
+                "disabled": "" if context["user"].has_perms(("extras.run_jobbutton", "extras.run_job")) else "disabled",
             }
             try:
                 text_rendered = render_jinja2(jb.text, button_context)

nautobot/extras/templatetags/plugins.py

@@ -31,7 +31,6 @@ def _get_registered_content(obj, method, template_context, return_html=True):
     objects = []
     html = ""
     for template_extension in template_extensions:
-
         # If the class has not overridden the specified method, we can skip it (because we know it
         # will raise NotImplementedError).
         if getattr(template_extension, method) == getattr(TemplateExtension, method):

nautobot/extras/{tests/example_jobs → test_jobs}/api_test_job.py

@@ -1,9 +1,13 @@
 from django.conf import settings
 
-from nautobot.extras.jobs import Job, BooleanVar, IntegerVar, StringVar, ObjectVar
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, BooleanVar, IntegerVar, StringVar, ObjectVar, get_task_logger
 from nautobot.extras.models import Role
 
 
+logger = get_task_logger(__name__)
+
+
 class APITestJob(Job):
     class Meta:
         name = "Job for API Tests"
@@ -15,10 +19,13 @@ class APITestJob(Job):
     var3 = BooleanVar()
     var4 = ObjectVar(model=Role)
 
-    def run(self, data, commit=True):
-        self.log_debug(message=data["var1"])
-        self.log_info(message=data["var2"])
-        self.log_success(message=data["var3"])
-        self.log_warning(message=data["var4"])
+    def run(self, var1, var2, var3, var4):
+        logger.debug(var1)
+        logger.info(var2)
+        logger.warning(var3)
+        logger.error(var4)
 
         return "Job complete"
+
+
+register_jobs(APITestJob)

nautobot/extras/test_jobs/atomic_transaction.py

@@ -0,0 +1,53 @@
+from django.db import transaction
+
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, BooleanVar, get_task_logger
+from nautobot.extras.models import Status
+
+
+logger = get_task_logger(__name__)
+
+
+class SimulatedError(Exception):
+    """I'm just a dummy exception for the purpose of testing."""
+
+
+class TestAtomicDecorator(Job):
+    """
+    Job that uses @transaction.atomic decorator to roll back changes.
+    """
+
+    fail = BooleanVar()
+
+    @transaction.atomic
+    def run(self, fail=False):
+        try:
+            Status.objects.create(name="Test database atomic rollback 1")
+            if fail:
+                raise SimulatedError("simulated failure")
+        except Exception:
+            logger.error("Job failed, all database changes have been rolled back.")
+            raise
+        logger.info("Job succeeded.")
+
+
+class TestAtomicContextManager(Job):
+    """
+    Job that uses `with transaction.atomic()` context manager to roll back changes.
+    """
+
+    fail = BooleanVar()
+
+    def run(self, fail=False):
+        try:
+            with transaction.atomic():
+                Status.objects.create(name="Test database atomic rollback 2")
+                if fail:
+                    raise SimulatedError("simulated failure")
+        except Exception as err:
+            logger.error("Job failed, all database changes have been rolled back.")
+            raise err
+        logger.info("Job succeeded.")
+
+
+register_jobs(TestAtomicContextManager, TestAtomicDecorator)

nautobot/extras/test_jobs/dry_run.py

@@ -0,0 +1,29 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import DryRunVar, Job, get_task_logger
+from nautobot.extras.models import Status
+
+
+logger = get_task_logger(__name__)
+
+
+class TestDryRun(Job):
+    """
+    Job that modifies the database and supports dryrun
+    """
+
+    dryrun = DryRunVar()
+
+    def run(self, dryrun):
+        """
+        Job function.
+        """
+        obj = Status(
+            name="Test Status",
+            slug="test-status",
+        )
+        if not dryrun:
+            obj.save()
+        logger.info("Status created successfully.", extra={"object": obj})
+
+
+register_jobs(TestDryRun)

nautobot/extras/{tests/example_jobs/test_duplicate_name.py → test_jobs/duplicate_name.py}

@@ -1,3 +1,4 @@
+from nautobot.core.celery import register_jobs
 from nautobot.extras.jobs import Job
 
 
@@ -21,3 +22,6 @@ class TestDuplicateName2(Job):
 
 class TestDuplicateNameNoMeta(Job):
     pass
+
+
+register_jobs(TestDuplicateName1, TestDuplicateName2, TestDuplicateNameNoMeta)

nautobot/extras/test_jobs/duplicate_name2.py

@@ -0,0 +1,9 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job
+
+
+class TestDuplicateNameNoMeta(Job):
+    pass
+
+
+register_jobs(TestDuplicateNameNoMeta)

nautobot/extras/test_jobs/fail.py

@@ -0,0 +1,23 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, RunJobTaskFailed, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestFail(Job):
+    """
+    Job with fail result.
+    """
+
+    description = "Validate job import"
+
+    def run(self):
+        """
+        Job function.
+        """
+        logger.info("I'm a test job that fails!")
+        raise RunJobTaskFailed("Test failure")
+
+
+register_jobs(TestFail)

nautobot/extras/{tests/example_jobs/test_field_default.py → test_jobs/field_default.py}

@@ -1,3 +1,4 @@
+from nautobot.core.celery import register_jobs
 from nautobot.extras.jobs import IntegerVar, Job
 
 
@@ -13,3 +14,6 @@ class TestFieldDefault(Job):
         """Metaclass attrs."""
 
         field_order = ["var_int", "var_int_no_default"]
+
+
+register_jobs(TestFieldDefault)

nautobot/extras/{tests/example_jobs/test_field_order.py → test_jobs/field_order.py}

@@ -1,3 +1,4 @@
+from nautobot.core.celery import register_jobs
 from nautobot.extras.jobs import Job, FileVar, StringVar
 
 
@@ -14,3 +15,6 @@ class TestFieldOrder(Job):
         """Metaclass attrs."""
 
         field_order = ["var1", "var2", "var23"]
+
+
+register_jobs(TestFieldOrder)

nautobot/extras/{tests/example_jobs/test_file_upload_fail.py → test_jobs/file_upload_fail.py}

@@ -1,4 +1,8 @@
-from nautobot.extras.jobs import Job, FileVar
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, FileVar, get_task_logger
+
+
+logger = get_task_logger(__name__)
 
 
 class FileUploadFailed(Exception):
@@ -18,10 +22,11 @@ class TestFileUploadFail(Job):
         description="File to upload",
     )
 
-    def run(self, data, commit):
-        blob = data["file"]
-
-        contents = str(blob.read())
-        self.log_warning(message=f"File contents: {contents}")
+    def run(self, file):
+        contents = str(file.read())
+        logger.warning("File contents: %s", contents)
 
         raise self.exception("Test failure")
+
+
+register_jobs(TestFileUploadFail)

nautobot/extras/test_jobs/file_upload_pass.py

@@ -0,0 +1,25 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, FileVar, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestFileUploadPass(Job):
+    class Meta:
+        name = "File Upload Success"
+        description = "Upload a file successfully"
+
+    file = FileVar(
+        description="File to upload",
+    )
+
+    def run(self, file):
+        contents = str(file.read())
+        logger.warning("File contents: %s", contents)
+        logger.info("Job didn't crash!")
+
+        return "Great job!"
+
+
+register_jobs(TestFileUploadPass)

nautobot/extras/test_jobs/has_sensitive_variables.py

@@ -0,0 +1,25 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestHasSensitiveVariables(Job):
+    """
+    Job with JobResult Sensitive Variables censored.
+    """
+
+    description = "Job with has_sensitive_variables set to True"
+
+    class Meta:
+        has_sensitive_variables = True
+
+    def run(self, *args, **kwargs):
+        """
+        Job function.
+        """
+        logger.info("Success")
+
+
+register_jobs(TestHasSensitiveVariables)

nautobot/extras/test_jobs/ipaddress_vars.py

@@ -0,0 +1,66 @@
+import json
+
+from nautobot.extras.jobs import get_task_logger
+
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, IPAddressVar, IPAddressWithMaskVar
+
+
+logger = get_task_logger(__name__)
+name = "IP Addresses"
+
+
+class TestIPAddresses(Job):
+    class Meta:
+        description = "Validate IP Addresses"
+
+    ipv4_address = IPAddressVar(
+        description="IPv4 Address",
+    )
+    ipv4_with_mask = IPAddressWithMaskVar(
+        description="IPv4 with mask",
+    )
+    ipv4_network = IPAddressWithMaskVar(
+        description="IPv4 network",
+    )
+    ipv6_address = IPAddressVar(
+        description="IPv6 Address",
+    )
+    ipv6_with_mask = IPAddressWithMaskVar(
+        description="IPv6 with mask",
+    )
+    ipv6_network = IPAddressWithMaskVar(
+        description="IPv6 network",
+    )
+
+    def run(self, ipv4_address, ipv4_with_mask, ipv4_network, ipv6_address, ipv6_with_mask, ipv6_network):
+        # Log the data as JSON so we can pull it back out for testing.
+        logger.info(
+            "IP Address Test",
+            extra={
+                "object": json.dumps(
+                    {
+                        "ipv4_address": str(ipv4_address),
+                        "ipv4_with_mask": str(ipv4_with_mask),
+                        "ipv4_network": str(ipv4_network),
+                        "ipv6_address": str(ipv6_address),
+                        "ipv6_with_mask": str(ipv6_with_mask),
+                        "ipv6_network": str(ipv6_network),
+                    }
+                ),
+            },
+        )
+
+        logger.warning("IPv4: %s", ipv4_address)
+        logger.warning("IPv4: %s", ipv4_with_mask)
+        logger.warning("IPv4: %s", ipv4_network)
+        logger.warning("IPv6: %s", ipv6_address)
+        logger.warning("IPv6: %s", ipv6_with_mask)
+        logger.warning("IPv6: %s", ipv6_network)
+
+        logger.info("Job didn't crash!")
+
+        return "Nice IPs, bro."
+
+
+register_jobs(TestIPAddresses)