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

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)

nautobot/extras/test_jobs/job_button_receiver.py

@@ -0,0 +1,28 @@
+from nautobot.core.celery import register_jobs
+from nautobot.dcim.models import Device, Location
+from nautobot.extras.jobs import JobButtonReceiver, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestJobButtonReceiverSimple(JobButtonReceiver):
+    def receive_job_button(self, obj):
+        logger.info("request.user: %s", self.request.user.username)
+        logger.info(obj.name)
+
+
+class TestJobButtonReceiverComplex(JobButtonReceiver):
+    def receive_job_button(self, obj):
+        logger.info("request.user: %s", self.request.user.username)
+        if isinstance(obj, Device):
+            logger.info("Device: %s", obj)
+        elif isinstance(obj, Location):
+            logger.info("Location: %s", obj)
+
+
+class TestJobButtonReceiverFail(JobButtonReceiver):
+    pass
+
+
+register_jobs(TestJobButtonReceiverComplex, TestJobButtonReceiverFail, TestJobButtonReceiverSimple)

nautobot/extras/test_jobs/job_hook_receiver.py

@@ -0,0 +1,29 @@
+from nautobot.core.celery import register_jobs
+from nautobot.dcim.models import Location, LocationType
+from nautobot.extras.jobs import JobHookReceiver, get_task_logger
+from nautobot.extras.models import Status
+
+
+logger = get_task_logger(__name__)
+
+
+class TestJobHookReceiverLog(JobHookReceiver):
+    def receive_job_hook(self, change, action, changed_object):
+        logger.info("change: %s", change)
+        logger.info("action: %s", action)
+        logger.info("jobresult.user: %s", self.job_result.user.username)
+        logger.info(changed_object.name)
+
+
+class TestJobHookReceiverChange(JobHookReceiver):
+    def receive_job_hook(self, change, action, changed_object):
+        location_type = LocationType.objects.create(name="Job Location Type")
+        status = Status.objects.get_for_model(Location).first()
+        Location.objects.create(name="test_jhr", location_type=location_type, status=status)
+
+
+class TestJobHookReceiverFail(JobHookReceiver):
+    pass
+
+
+register_jobs(TestJobHookReceiverChange, TestJobHookReceiverFail, TestJobHookReceiverLog)

nautobot/extras/test_jobs/job_variables.py

@@ -0,0 +1,88 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.models import Role
+from nautobot.extras.jobs import (
+    BooleanVar,
+    ChoiceVar,
+    FileVar,
+    IntegerVar,
+    IPAddressVar,
+    IPAddressWithMaskVar,
+    IPNetworkVar,
+    Job,
+    MultiChoiceVar,
+    MultiObjectVar,
+    ObjectVar,
+    StringVar,
+    TextVar,
+)
+
+
+CHOICES = (("ff0000", "Red"), ("00ff00", "Green"), ("0000ff", "Blue"))
+
+
+class BooleanVarJob(Job):
+    var1 = BooleanVar()
+
+
+class ChoiceVarJob(Job):
+    var1 = ChoiceVar(choices=CHOICES)
+
+
+class FileVarJob(Job):
+    var1 = FileVar()
+
+
+class IntegerVarJob(Job):
+    var1 = IntegerVar(min_value=5, max_value=10)
+
+
+class IPAddressVarJob(Job):
+    var1 = IPAddressVar()
+
+
+class IPAddressWithMaskVarJob(Job):
+    var1 = IPAddressWithMaskVar()
+
+
+class IPNetworkVarJob(Job):
+    var1 = IPNetworkVar()
+
+
+class MultiChoiceVarJob(Job):
+    var1 = MultiChoiceVar(choices=CHOICES)
+
+
+class MultiObjectVarJob(Job):
+    var1 = MultiObjectVar(model=Role)
+
+
+class ObjectVarJob(Job):
+    var1 = ObjectVar(model=Role)
+
+
+class StringVarJob(Job):
+    var1 = StringVar(min_length=3, max_length=3, regex=r"[a-z]+")
+
+
+class TextVarJob(Job):
+    var1 = TextVar()
+
+
+job_list = [
+    BooleanVarJob,
+    ChoiceVarJob,
+    FileVarJob,
+    IntegerVarJob,
+    IPAddressVarJob,
+    IPAddressWithMaskVarJob,
+    IPNetworkVarJob,
+    MultiChoiceVarJob,
+    MultiObjectVarJob,
+    ObjectVarJob,
+    StringVarJob,
+    TextVarJob,
+]
+
+# Avoid registering the jobs with Celery when this is imported directly as a file
+if __name__ == "test_job_variables":
+    register_jobs(*job_list)

nautobot/extras/test_jobs/location_with_custom_field.py

@@ -0,0 +1,45 @@
+from django.contrib.contenttypes.models import ContentType
+from django.db import transaction
+
+from nautobot.core.celery import register_jobs
+from nautobot.dcim.models import Location, LocationType
+from nautobot.extras.choices import CustomFieldTypeChoices
+from nautobot.extras.jobs import Job, get_task_logger
+from nautobot.extras.models import CustomField, Status
+
+
+logger = get_task_logger(__name__)
+
+
+class TestCreateLocationWithCustomField(Job):
+    class Meta:
+        name = "Location and Custom Field Creation"
+        description = "Location with a custom field"
+
+    def run(self):
+        with transaction.atomic():
+            obj_type = ContentType.objects.get_for_model(Location)
+            cf = CustomField(label="cf1", type=CustomFieldTypeChoices.TYPE_TEXT, default="-")
+            cf.validated_save()
+            cf.content_types.set([obj_type])
+
+            logger.info("CustomField created successfully.", extra={"object": cf})
+
+            location_type = LocationType.objects.create(name="Test Location Type 1")
+            status = Status.objects.get_for_model(Location).first()
+            location_1 = Location.objects.create(
+                name="Test Location", slug="test-location-one", location_type=location_type, status=status
+            )
+            location_1.cf[cf.key] = "some-value"
+            location_1.save()
+            logger.info("Created a new location", extra={"object": location_1})
+
+            location_2 = Location.objects.create(
+                name="Test Site Two", slug="test-location-two", location_type=location_type, status=status
+            )
+            logger.info("Created another new location", extra={"object": location_2})
+
+            return "Job completed."
+
+
+register_jobs(TestCreateLocationWithCustomField)

nautobot/extras/test_jobs/log_redaction.py

@@ -0,0 +1,20 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestLogRedaction(Job):
+    class Meta:
+        description = "Test redaction of logs"
+
+    def run(self):
+        logger.debug("The secret is supersecret123")
+        logger.info("The secret is supersecret123")
+        logger.warning("The secret is supersecret123")
+        logger.error("The secret is supersecret123")
+        logger.critical("The secret is supersecret123")
+
+
+register_jobs(TestLogRedaction)

nautobot/extras/test_jobs/log_skip_db_logging.py

@@ -0,0 +1,17 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestLogSkipDBLogging(Job):
+    class Meta:
+        description = "Test logs not being saved to the database"
+
+    def run(self):
+        logger.debug("I should NOT be logged to the database", extra={"skip_db_logging": True})
+        logger.info("I should be logged to the database")
+
+
+register_jobs(TestLogSkipDBLogging)

nautobot/extras/test_jobs/modify_db.py

@@ -0,0 +1,25 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, get_task_logger
+from nautobot.extras.models import Status
+
+
+logger = get_task_logger(__name__)
+
+
+class TestModifyDB(Job):
+    """
+    Job that modifies the database.
+    """
+
+    def run(self):
+        """
+        Job function.
+        """
+        obj = Status(
+            name="Test Status",
+        )
+        obj.save()
+        logger.info("Status created successfully.", extra={"object": obj})
+
+
+register_jobs(TestModifyDB)

nautobot/extras/{tests/example_jobs/test_no_field_order.py → test_jobs/no_field_order.py}

@@ -1,3 +1,4 @@
+from nautobot.core.celery import register_jobs
 from nautobot.extras.jobs import Job, StringVar
 
 
@@ -16,3 +17,6 @@ class BaseJobClassWithVariable(Job):
 class TestDefaultFieldOrderWithInheritance(BaseJobClassWithVariable):
     b_testvar2 = StringVar(description="This var should be second")
     a_testvar3 = StringVar(description="This var should be third")
+
+
+register_jobs(TestDefaultFieldOrderWithInheritance, TestNoFieldOrder)

nautobot/extras/test_jobs/object_var_optional.py

@@ -0,0 +1,21 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, ObjectVar, get_task_logger
+from nautobot.dcim.models import Location
+
+
+logger = get_task_logger(__name__)
+
+
+class TestOptionalObjectVar(Job):
+    location = ObjectVar(
+        description="Location (optional)",
+        model=Location,
+        required=False,
+    )
+
+    def run(self, location=None):
+        logger.info("The Location if any that the user provided.", extra={"object": location})
+        return "Nice Location (or not)!"
+
+
+register_jobs(TestOptionalObjectVar)

nautobot/extras/test_jobs/object_var_required.py

@@ -0,0 +1,21 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, ObjectVar, get_task_logger
+from nautobot.dcim.models import Location
+
+
+logger = get_task_logger(__name__)
+
+
+class TestRequiredObjectVar(Job):
+    location = ObjectVar(
+        description="Location (required)",
+        model=Location,
+        required=True,
+    )
+
+    def run(self, location):
+        logger.info("The Location that the user provided.", extra={"object": location})
+        return "Nice Location!"
+
+
+register_jobs(TestRequiredObjectVar)

nautobot/extras/test_jobs/object_vars.py

@@ -0,0 +1,26 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, ObjectVar, MultiObjectVar, get_task_logger
+from nautobot.extras.models import Role
+
+
+logger = get_task_logger(__name__)
+name = "Object Vars"
+
+
+class TestObjectVars(Job):
+    class Meta:
+        description = "Validate Objects"
+
+    role = ObjectVar(model=Role)
+    roles = MultiObjectVar(model=Role)
+
+    def run(self, role, roles):
+        logger.info("Role: %s", role)
+        logger.warning("Roles: %s", roles)
+
+        logger.info("Job didn't crash!")
+
+        return "Nice Roles!"
+
+
+register_jobs(TestObjectVars)

nautobot/extras/test_jobs/pass.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 TestPass(Job):
+    """
+    Job with pass result.
+    """
+
+    description = "Validate job import"
+
+    class Meta:
+        has_sensitive_variables = False
+
+    def run(self):
+        """
+        Job function.
+        """
+        logger.info("Success")
+
+
+register_jobs(TestPass)

nautobot/extras/test_jobs/profiling.py

@@ -0,0 +1,32 @@
+import pstats
+import tempfile
+
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import Job, get_task_logger
+
+
+logger = get_task_logger(__name__)
+
+
+class TestProfilingJob(Job):
+    """
+    Job to have profiling tested.
+    """
+
+    description = "Test profiling"
+
+    def run(self):
+        """
+        Job function.
+        """
+
+        logger.info("Profiling test.")
+
+        return []
+
+    def after_return(self, status, retval, task_id, args, kwargs, einfo):
+        super().after_return(status, retval, task_id, args, kwargs, einfo=einfo)
+        pstats.Stats(f"{tempfile.gettempdir()}/nautobot-jobresult-{self.job_result.id}.pstats")
+
+
+register_jobs(TestProfilingJob)

nautobot/extras/test_jobs/read_only_job.py

@@ -0,0 +1,15 @@
+from nautobot.core.celery import register_jobs
+from nautobot.extras.jobs import DryRunVar, Job, StringVar
+
+
+class TestReadOnlyJob(Job):
+    """My job demo."""
+
+    dryrun = DryRunVar()
+    var = StringVar(description="Hello")
+
+    class Meta:
+        read_only = True
+
+
+register_jobs(TestReadOnlyJob)

nautobot/extras/{tests/example_jobs/test_required_args.py → test_jobs/required_args.py}

@@ -1,5 +1,9 @@
+from nautobot.core.celery import register_jobs
 from nautobot.extras.jobs import Job, StringVar
 
 
 class TestRequired(Job):
     var = StringVar(required=True)
+
+
+register_jobs(TestRequired)