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

nautobot/extras/management/__init__.py

@@ -1,7 +1,9 @@
 import sys
 
 from django.apps import apps as global_apps
+from django.core.exceptions import FieldError
 from django.db import DEFAULT_DB_ALIAS, IntegrityError
+from django.utils.text import slugify
 
 from nautobot.circuits import choices as circuit_choices
 from nautobot.core.choices import ColorChoices
@@ -29,52 +31,52 @@ CHOICESET_MAP = {
 }
 
 
-# Map of slug -> default hex_color used when importing color choices in `export_statuses_from_choiceset()`.
+# Map of status name -> default hex_color used when importing color choices in `export_statuses_from_choiceset()`.
 # Only a small subset of colors are used by default as these originally were derived from Bootstrap CSS classes.
 COLOR_MAP = {
-    "active": ColorChoices.COLOR_GREEN,  # was COLOR_BLUE for Prefix/IPAddress/VLAN in NetBox
-    "available": ColorChoices.COLOR_GREEN,
-    "connected": ColorChoices.COLOR_GREEN,
-    "dhcp": ColorChoices.COLOR_GREEN,
-    "decommissioned": ColorChoices.COLOR_GREY,
-    "decommissioning": ColorChoices.COLOR_AMBER,
-    "deprecated": ColorChoices.COLOR_RED,
-    "deprovisioning": ColorChoices.COLOR_AMBER,
-    "failed": ColorChoices.COLOR_RED,
-    "inventory": ColorChoices.COLOR_GREY,
-    "maintenance": ColorChoices.COLOR_GREY,
-    "offline": ColorChoices.COLOR_AMBER,
-    "planned": ColorChoices.COLOR_CYAN,
-    "provisioning": ColorChoices.COLOR_BLUE,
-    "reserved": ColorChoices.COLOR_CYAN,
-    "retired": ColorChoices.COLOR_RED,
-    "slaac": ColorChoices.COLOR_GREEN,
-    "staged": ColorChoices.COLOR_BLUE,
-    "staging": ColorChoices.COLOR_BLUE,
+    "Active": ColorChoices.COLOR_GREEN,  # was COLOR_BLUE for Prefix/IPAddress/VLAN in NetBox
+    "Available": ColorChoices.COLOR_GREEN,
+    "Connected": ColorChoices.COLOR_GREEN,
+    "DHCP": ColorChoices.COLOR_GREEN,
+    "Decommissioned": ColorChoices.COLOR_GREY,
+    "Decommissioning": ColorChoices.COLOR_AMBER,
+    "Deprecated": ColorChoices.COLOR_RED,
+    "Deprovisioning": ColorChoices.COLOR_AMBER,
+    "Failed": ColorChoices.COLOR_RED,
+    "Inventory": ColorChoices.COLOR_GREY,
+    "Maintenance": ColorChoices.COLOR_GREY,
+    "Offline": ColorChoices.COLOR_AMBER,
+    "Planned": ColorChoices.COLOR_CYAN,
+    "Provisioning": ColorChoices.COLOR_BLUE,
+    "Reserved": ColorChoices.COLOR_CYAN,
+    "Retired": ColorChoices.COLOR_RED,
+    "SLAAC": ColorChoices.COLOR_GREEN,
+    "Staged": ColorChoices.COLOR_BLUE,
+    "Staging": ColorChoices.COLOR_BLUE,
 }
 
 
-# Map of slug -> description used when importing status choices in `export_statuses_from_choiceset()`.
+# Map of status name -> description used when importing status choices in `export_statuses_from_choiceset()`.
 DESCRIPTION_MAP = {
-    "active": "Unit is active",
-    "available": "Unit is available",
-    "connected": "Cable is connected",
-    "dhcp": "Dynamically assigned IPv4/IPv6 address",
-    "decommissioned": "Circuit has been decommissioned",
-    "decommissioning": "Unit is being decommissioned",
-    "deprecated": "Unit has been deprecated",
-    "deprovisioning": "Circuit is being deprovisioned",
-    "failed": "Unit has failed",
-    "inventory": "Device is in inventory",
-    "maintenance": "Unit is under maintenance",
-    "offline": "Unit is offline",
-    "planned": "Unit has been planned",
-    "provisioning": "Circuit is being provisioned",
-    "reserved": "Unit is reserved",
-    "retired": "Location has been retired",
-    "slaac": "Dynamically assigned IPv6 address",
-    "staged": "Unit has been staged",
-    "staging": "Location is in the process of being staged",
+    "Active": "Unit is active",
+    "Available": "Unit is available",
+    "Connected": "Cable is connected",
+    "DHCP": "Dynamically assigned IPv4/IPv6 address",
+    "Decommissioned": "Circuit has been decommissioned",
+    "Decommissioning": "Unit is being decommissioned",
+    "Deprecated": "Unit has been deprecated",
+    "Deprovisioning": "Circuit is being deprovisioned",
+    "Failed": "Unit has failed",
+    "Inventory": "Device is in inventory",
+    "Maintenance": "Unit is under maintenance",
+    "Offline": "Unit is offline",
+    "Planned": "Unit has been planned",
+    "Provisioning": "Circuit is being provisioned",
+    "Reserved": "Unit is reserved",
+    "Retired": "Location has been retired",
+    "SLAAC": "Dynamically assigned IPv6 address",
+    "Staged": "Unit has been staged",
+    "Staging": "Location is in the process of being staged",
 }
 
 
@@ -109,13 +111,13 @@ def export_statuses_from_choiceset(choiceset, color_map=None, description_map=No
 
     choices = []
 
-    for slug, value in choiceset.CHOICES:
-        choice_kwargs = dict(
-            name=value,
-            slug=slug,
-            description=description_map[slug],
-            color=color_map[slug],
-        )
+    for _, value in choiceset.CHOICES:
+        choice_kwargs = {
+            "name": value,
+            "description": description_map[value],
+            "slug": slugify(value),
+            "color": color_map[value],
+        }
         choices.append(choice_kwargs)
 
     return choices
@@ -176,10 +178,15 @@ def create_custom_statuses(
             try:
                 # may fail if a status with a different slug has a name matching this one
                 obj, created = Status.objects.get_or_create(slug=slug, defaults=defaults)
-            except IntegrityError:
+            except (IntegrityError, FieldError) as error:
                 # OK, what if we look up by name instead?
                 defaults = choice_kwargs.copy()
                 name = defaults.pop("name")
+                # FieldError would occur when calling create_custom_statuses after status slug removal
+                # migration has been migrated
+                # e.g nautobot.extras.tests.test_management.StatusManagementTestCase.test_populate_status_choices_idempotent
+                if isinstance(error, FieldError):
+                    defaults.pop("slug")
                 try:
                     obj, created = Status.objects.get_or_create(name=name, defaults=defaults)
                 except IntegrityError as err:

nautobot/extras/management/commands/renaturalize.py

@@ -55,7 +55,6 @@ class Command(BaseCommand):
         return models
 
     def handle(self, *args, **options):
-
         models = self._get_models(args)
 
         if options["verbosity"]:

nautobot/extras/management/commands/runjob.py

@@ -1,33 +1,30 @@
 import json
 import time
-import uuid
 
 from django.contrib.auth import get_user_model
 from django.core.management.base import BaseCommand, CommandError
-from django.test.client import RequestFactory
 from django.utils import timezone
 
-from nautobot.core.utils.requests import copy_safe_request
 from nautobot.extras.choices import LogLevelChoices, JobResultStatusChoices
 from nautobot.extras.models import Job, JobLogEntry, JobResult
-from nautobot.extras.jobs import get_job, run_job
-from nautobot.extras.utils import get_job_content_type
+from nautobot.extras.jobs import get_job
 
 
 class Command(BaseCommand):
     help = "Run a job (script, report) to validate or update data in Nautobot"
 
     def add_arguments(self, parser):
-        parser.add_argument("job", help="Job in the class path form: `<grouping_name>/<module_name>/<JobClassName>`")
+        parser.add_argument("job", help="Job in the Python module form: `<module_name>.<JobClassName>`")
         parser.add_argument(
-            "--commit",
+            "--profile",
             action="store_true",
-            help="Commit changes to DB (defaults to dry-run if unset). --username is mandatory if using this argument",
+            help="Run cProfile on the job execution and write the result to the disk under /tmp.",
         )
         parser.add_argument(
             "-u",
             "--username",
             help="User account to impersonate as the requester of this job",
+            required=True,
         )
         parser.add_argument(
             "-l",
@@ -38,30 +35,17 @@ class Command(BaseCommand):
         parser.add_argument("-d", "--data", type=str, help="JSON string that populates the `data` variable of the job.")
 
     def handle(self, *args, **options):
-        if "/" not in options["job"]:
-            raise CommandError(
-                'Job must be specified in the class path form: "<grouping_name>/<module_name>/<JobClassName>"'
-            )
+        if "." not in options["job"]:
+            raise CommandError('Job must be specified in the Python module form: "<module_name>.<JobClassName>"')
         job_class = get_job(options["job"])
         if not job_class:
             raise CommandError(f'Job "{options["job"]}" not found')
 
-        user = None
-        request = None
-        if options["commit"] and not options["username"]:
-            # Job execution with commit=True uses change_logging(), which requires a user as the author of any changes
-            raise CommandError("--username is mandatory when --commit is used")
-
-        if options["username"]:
-            User = get_user_model()
-            try:
-                user = User.objects.get(username=options["username"])
-            except User.DoesNotExist as exc:
-                raise CommandError("No such user") from exc
-
-            request = RequestFactory().request(SERVER_NAME="nautobot_server_runjob")
-            request.id = uuid.uuid4()
-            request.user = user
+        User = get_user_model()
+        try:
+            user = User.objects.get(username=options["username"])
+        except User.DoesNotExist as exc:
+            raise CommandError("No such user") from exc
 
         data = {}
         try:
@@ -70,38 +54,15 @@ class Command(BaseCommand):
         except json.decoder.JSONDecodeError as error:
             raise CommandError(f"Invalid JSON data:\n{str(error)}")
 
-        job_content_type = get_job_content_type()
+        job_model = Job.objects.get_for_class_path(options["job"])
 
         # Run the job and create a new JobResult
-        self.stdout.write(f"[{timezone.now():%H:%M:%S}] Running {job_class.class_path}...")
+        self.stdout.write(f"[{timezone.now():%H:%M:%S}] Running {options['job']}...")
 
         if options["local"]:
-            job = Job.objects.get_for_class_path(job_class.class_path)
-            job_result = JobResult.objects.create(
-                name=job.class_path,
-                obj_type=job_content_type,
-                user=user,
-                job_model=job,
-                task_id=uuid.uuid4(),
-            )
-            run_job(
-                data=data,
-                request=copy_safe_request(request) if request else None,
-                commit=options["commit"],
-                job_result_pk=job_result.pk,
-            )
-            job_result.refresh_from_db()
-
+            job_result = JobResult.execute_job(job_model, user, profile=options["profile"], **data)
         else:
-            job_result = JobResult.enqueue_job(
-                run_job,
-                job_class.class_path,
-                job_content_type,
-                user,
-                data=data,
-                request=copy_safe_request(request) if request else None,
-                commit=options["commit"],
-            )
+            job_result = JobResult.enqueue_job(job_model, user, profile=options["profile"], **data)
 
             # Wait on the job to finish
             while job_result.status not in JobResultStatusChoices.READY_STATES:
@@ -112,13 +73,14 @@ class Command(BaseCommand):
         groups = set(JobLogEntry.objects.filter(job_result=job_result).values_list("grouping", flat=True))
         for group in sorted(groups):
             logs = JobLogEntry.objects.filter(job_result__pk=job_result.pk, grouping=group)
-            success_count = logs.filter(log_level=LogLevelChoices.LOG_SUCCESS).count()
+            debug_count = logs.filter(log_level=LogLevelChoices.LOG_DEBUG).count()
             info_count = logs.filter(log_level=LogLevelChoices.LOG_INFO).count()
             warning_count = logs.filter(log_level=LogLevelChoices.LOG_WARNING).count()
-            failure_count = logs.filter(log_level=LogLevelChoices.LOG_FAILURE).count()
+            error_count = logs.filter(log_level=LogLevelChoices.LOG_ERROR).count()
+            critical_count = logs.filter(log_level=LogLevelChoices.LOG_CRITICAL).count()
 
             self.stdout.write(
-                f"\t{group}: {success_count} success, {info_count} info, {warning_count} warning, {failure_count} failure"
+                f"\t{group}: {debug_count} debug, {info_count} info, {warning_count} warning, {error_count} error, {critical_count} critical"
             )
 
             for log_entry in logs:
@@ -137,15 +99,15 @@ class Command(BaseCommand):
                 else:
                     self.stdout.write(f"\t\t{status}: {log_entry.message}")
 
-        if job_result.data["output"]:
-            self.stdout.write(job_result.data["output"])
+        if job_result.result:
+            self.stdout.write(job_result.result)
 
         if job_result.status == JobResultStatusChoices.STATUS_FAILURE:
             status = self.style.ERROR("FAILURE")
         else:
             status = self.style.SUCCESS("SUCCESS")
-        self.stdout.write(f"[{timezone.now():%H:%M:%S}] {job_class.class_path}: {status}")
+        self.stdout.write(f"[{timezone.now():%H:%M:%S}] {options['job']}: {status}")
 
         # Wrap things up
-        self.stdout.write(f"[{timezone.now():%H:%M:%S}] {job_class.class_path}: Duration {job_result.duration}")
+        self.stdout.write(f"[{timezone.now():%H:%M:%S}] {options['job']}: Duration {job_result.duration}")
         self.stdout.write(f"[{timezone.now():%H:%M:%S}] Finished")

nautobot/extras/management/commands/webhook_receiver.py

@@ -11,7 +11,6 @@ class WebhookHandler(BaseHTTPRequestHandler):
     show_headers = True
 
     def __getattr__(self, item):
-
         # Return the same method for any type of HTTP request (GET, POST, etc.)
         if item.startswith("do_"):
             return self.do_ANY

nautobot/extras/managers.py

@@ -20,7 +20,11 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
         task_name=None,
         task_args=None,
         task_kwargs=None,
+        celery_kwargs=None,
+        job_model_id=None,
+        scheduled_job_id=None,
         worker=None,
+        user_id=None,
         using=None,
         content_type=None,
         content_encoding=None,
@@ -39,15 +43,20 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
 
         Args:
             task_id (uuid): UUID of task.
-            periodic_task_name (str): Celery periodic task name.
+            periodic_task_name (str): Celery periodic task name. (not used by Nautobot)
             task_name (str): Celery task name.
-            task_args (list): JSON-serialized task arguments.
-            task_kwargs (dict): JSON-serialized task kwargs.
-            result (str): JSON-serialized return value of the task, or an exception instance raised
+            task_args (list): Task arguments.
+            task_kwargs (dict): Task kwargs.
+            celery_kwargs (dict): Celery kwargs (kwargs passed to apply_async).
+            job_model_id (uuid): UUID of the Job model instance of the task being run.
+            scheduled_job_id (uuid): UUID of the ScheduledJob model instance that initiated
+                this task, or None if not scheduled.
+            result (obj): Return value of the task, or an exception instance raised
                 by the task.
             status (str): Task status. See `JobResultStatusChoices` for a list of possible status
                 values.
             worker (str): Worker that executes the task.
+            user_id (uuid): UUID of the user that initiated the task.
             using (str): Django database connection to use.
             traceback (str): Traceback string taken at the point of exception (only passed if the
                 task failed).
@@ -66,14 +75,28 @@ class JobResultManager(BaseManager.from_queryset(RestrictedQuerySet), TaskResult
             "traceback": traceback,
             "meta": meta,
             "date_done": None,
-            "periodic_task_name": periodic_task_name,
             "task_name": task_name,
             "task_args": task_args,
             "task_kwargs": task_kwargs,
+            "celery_kwargs": celery_kwargs,
+            "job_model_id": job_model_id,
+            "scheduled_job_id": scheduled_job_id,
+            "user_id": user_id,
             "worker": worker,
         }
-
-        obj, created = self.using(using).get_or_create(task_id=task_id, defaults=fields)
+        from nautobot.extras.models.jobs import Job
+
+        # Need to have a try/except block here
+        # because sometimes job_model_id will be None.
+        try:
+            job = Job.objects.get(id=job_model_id)
+            if job.has_sensitive_variables:
+                del fields["task_args"]
+                del fields["task_kwargs"]
+        except Job.DoesNotExist:
+            pass
+
+        obj, created = self.using(using).get_or_create(id=task_id, defaults=fields)
 
         if not created:
             # Make sure `date_done` is allowed to stay null until the task reacheas a ready state.

nautobot/extras/migrations/0001_initial_part_1.py

@@ -14,7 +14,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [

nautobot/extras/migrations/0002_initial_part_2.py

@@ -8,7 +8,6 @@ import taggit.managers
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [

nautobot/extras/migrations/0003_initial_part_3.py

@@ -6,7 +6,6 @@ import nautobot.extras.utils
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [

nautobot/extras/migrations/0004_populate_default_status_records.py

@@ -25,7 +25,6 @@ def populate_status_choices(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("circuits", "0002_initial_part_2"),
         ("dcim", "0004_initial_part_4"),

nautobot/extras/migrations/0005_configcontext_device_types.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("dcim", "0004_initial_part_4"),
         ("extras", "0004_populate_default_status_records"),

nautobot/extras/migrations/0006_graphqlquery.py

@@ -6,7 +6,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0005_configcontext_device_types"),
     ]

nautobot/extras/migrations/0007_configcontextschema.py

@@ -8,7 +8,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("contenttypes", "0002_remove_content_type_name"),
         ("extras", "0006_graphqlquery"),

nautobot/extras/migrations/0008_jobresult__custom_field_data.py

@@ -5,7 +5,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0007_configcontextschema"),
     ]

nautobot/extras/migrations/0009_computedfield.py

@@ -8,7 +8,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("contenttypes", "0002_remove_content_type_name"),
         ("extras", "0008_jobresult__custom_field_data"),

nautobot/extras/migrations/0010_change_cf_validation_max_min_field_to_bigint.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0009_computedfield"),
     ]

nautobot/extras/migrations/0011_fileattachment_fileproxy.py

@@ -6,7 +6,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0010_change_cf_validation_max_min_field_to_bigint"),
     ]

nautobot/extras/migrations/0012_healthchecktestmodel.py

@@ -5,7 +5,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0011_fileattachment_fileproxy"),
     ]

nautobot/extras/migrations/0013_default_fallback_value_computedfield.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0012_healthchecktestmodel"),
     ]

nautobot/extras/migrations/0014_auto_slug.py

@@ -5,7 +5,6 @@ import nautobot.core.models.fields
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0013_default_fallback_value_computedfield"),
     ]

nautobot/extras/migrations/0015_scheduled_job.py

@@ -8,7 +8,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         ("extras", "0014_auto_slug"),

nautobot/extras/migrations/0016_secret.py

@@ -9,7 +9,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0015_scheduled_job"),
     ]

nautobot/extras/migrations/0017_joblogentry.py

@@ -7,7 +7,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0016_secret"),
     ]

nautobot/extras/migrations/0018_joblog_data_migration.py

@@ -103,7 +103,6 @@ def reverse_migrate_params(apps, schema_editor):
 
     for job_result in JobResult.objects.all():
         for entry in JobLogEntry.objects.filter(job_result=job_result):
-
             if not job_result.data:
                 job_result.data = {}
 
@@ -136,7 +135,6 @@ def reverse_migrate_params(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0017_joblogentry"),
     ]

nautobot/extras/migrations/0019_joblogentry__meta_options__related_name.py

@@ -5,7 +5,6 @@ import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0018_joblog_data_migration"),
     ]

nautobot/extras/migrations/0020_customfield_changelog.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0019_joblogentry__meta_options__related_name"),
     ]

nautobot/extras/migrations/0021_customfield_changelog_data.py

@@ -93,7 +93,6 @@ def migrate_history(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0020_customfield_changelog"),
     ]

nautobot/extras/migrations/0022_objectchange_object_datav2.py

@@ -5,7 +5,6 @@ import nautobot.core.celery
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0021_customfield_changelog_data"),
     ]

nautobot/extras/migrations/0023_job_model.py

@@ -10,7 +10,6 @@ import uuid
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0022_objectchange_object_datav2"),
     ]

nautobot/extras/migrations/0024_job_data_migration.py

@@ -89,7 +89,6 @@ def reverse_migrate_job_data(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0023_job_model"),
     ]

nautobot/extras/migrations/0025_add_advanced_ui_boolean_to_customfield_conputedfield_and_relationship.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0024_job_data_migration"),
     ]

nautobot/extras/migrations/0026_job_add_gitrepository_fk.py

@@ -6,7 +6,6 @@ import nautobot.core.models.fields
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0025_add_advanced_ui_boolean_to_customfield_conputedfield_and_relationship"),
     ]

nautobot/extras/migrations/0027_job_gitrepository_data_migration.py

@@ -32,7 +32,6 @@ def reverse_migrate_job_data(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0026_job_add_gitrepository_fk"),
     ]

nautobot/extras/migrations/0028_job_reduce_source.py

@@ -4,7 +4,6 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("extras", "0027_job_gitrepository_data_migration"),
     ]