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

nautobot/extras/migrations/0072_job__unique_name_data_migration.py

@@ -0,0 +1,86 @@
+# Generated by Django 3.2.18 on 2023-03-15 17:19
+
+from django.db import migrations
+
+from nautobot.core.models.fields import slugify_dashes_to_underscores
+from nautobot.extras.constants import JOB_MAX_NAME_LENGTH
+
+
+def generate_unique_job_names(apps, schema_editor):
+    """
+    Make duplicate Job names unique by appending an incrementing counter to the end.
+    """
+    Job = apps.get_model("extras", "Job")
+    job_names = []
+    for job_model in Job.objects.all().order_by("created"):
+        original_job_name = job_model.name
+        job_name = original_job_name
+        append_counter = 2
+        while job_name in job_names:
+            job_name_append = f" ({append_counter})"
+            max_name_length = JOB_MAX_NAME_LENGTH - len(job_name_append)
+            job_name = original_job_name[:max_name_length] + job_name_append
+            append_counter += 1
+        if job_name != original_job_name:
+            print(
+                f'  Job class "{job_model.job_class_name}" name "{original_job_name}" is not unique, changing to "{job_name}".'
+            )
+            job_model.name = job_name
+            job_model.name_override = True
+        job_model.save()
+        job_names.append(job_name)
+
+
+def fixup_job_module_names(apps, schema_editor):
+    """
+    Fix up the `module_name` of Jobs to reflect the pending removal of the `source` and `git_repository` fields.
+    """
+    Job = apps.get_model("extras", "Job")
+    # Local jobs, plugin jobs, and system jobs already have the right module name, just need to fix up git jobs
+    for job_model in Job.objects.filter(git_repository__isnull=False):
+        job_model.module_name = f"{job_model.git_repository.slug}.jobs.{job_model.module_name}"
+        job_model.save()
+
+
+def reverse_fixup_job_module_names(apps, schema_editor):
+    GitRepository = apps.get_model("extras", "GitRepository")
+    Job = apps.get_model("extras", "Job")
+    for repo in GitRepository.objects.all():
+        if "extras.job" not in repo.provided_contents:
+            continue
+        for job_model in Job.objects.filter(module_name__istartswith=f"{repo.slug}.jobs."):
+            job_model.source = "git"
+            job_model.git_repository = repo
+            job_model.module_name = job_model.module.name.replace(f"{repo.slug}.jobs.", "")
+            job_model.save()
+
+
+def update_slug_for_git_repository(apps, schema_editor):
+    """
+    Update GitRepository.slug to be Python package name safe via slugify_dashes_to_underscores().
+    """
+    GitRepository = apps.get_model("extras", "GitRepository")
+    for git_repository in GitRepository.objects.all():
+        git_repository.slug = slugify_dashes_to_underscores(git_repository.slug)
+        git_repository.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0071_rename_model_fields"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=generate_unique_job_names,
+            reverse_code=migrations.operations.special.RunPython.noop,
+        ),
+        migrations.RunPython(
+            code=update_slug_for_git_repository,
+            reverse_code=migrations.operations.special.RunPython.noop,
+        ),
+        migrations.RunPython(
+            code=fixup_job_module_names,
+            reverse_code=reverse_fixup_job_module_names,
+        ),
+    ]

nautobot/extras/migrations/{0072_job__unique_name.py → 0073_job__unique_name.py}

@@ -1,12 +1,11 @@
 # Generated by Django 3.2.18 on 2023-03-15 17:19
 
 from django.db import migrations, models
-import nautobot.core.models.fields
 
 
 class Migration(migrations.Migration):
     dependencies = [
-        ("extras", "0071_job__unique_name_data_migration"),
+        ("extras", "0072_job__unique_name_data_migration"),
     ]
 
     operations = [
@@ -15,15 +14,20 @@ class Migration(migrations.Migration):
             name="name",
             field=models.CharField(max_length=100, unique=True),
         ),
-        migrations.AlterField(
+        migrations.AlterUniqueTogether(
+            name="job",
+            unique_together={("module_name", "job_class_name")},
+        ),
+        migrations.RemoveField(
+            model_name="job",
+            name="git_repository",
+        ),
+        migrations.RemoveField(
             model_name="job",
             name="slug",
-            field=nautobot.core.models.fields.AutoSlugField(
-                blank=True, max_length=100, populate_from="name", unique=True
-            ),
         ),
-        migrations.AlterUniqueTogether(
-            name="job",
-            unique_together={("source", "git_repository", "module_name", "job_class_name")},
+        migrations.RemoveField(
+            model_name="job",
+            name="source",
         ),
     ]

nautobot/extras/migrations/{0073_remove_gitrepository_fields.py → 0074_remove_gitrepository_fields.py}

@@ -5,7 +5,7 @@ from django.db import migrations
 
 class Migration(migrations.Migration):
     dependencies = [
-        ("extras", "0072_job__unique_name"),
+        ("extras", "0073_job__unique_name"),
     ]
 
     operations = [

nautobot/extras/migrations/{0074_rename_slug_to_key_for_custom_field.py → 0075_rename_slug_to_key_for_custom_field.py}

@@ -6,7 +6,7 @@ from django.db import migrations, models
 class Migration(migrations.Migration):
     dependencies = [
         ("dcim", "0030_migrate_region_and_site_data_to_locations"),
-        ("extras", "0073_remove_gitrepository_fields"),
+        ("extras", "0074_remove_gitrepository_fields"),
         ("ipam", "0022_aggregate_to_prefix_data_migration"),
     ]
 

nautobot/extras/migrations/{0075_migrate_custom_field_data.py → 0076_migrate_custom_field_data.py}

@@ -55,7 +55,7 @@ def generate_unique_custom_field_slug_and_migrate_custom_field_data(apps, schema
 
 class Migration(migrations.Migration):
     dependencies = [
-        ("extras", "0074_rename_slug_to_key_for_custom_field"),
+        ("extras", "0075_rename_slug_to_key_for_custom_field"),
     ]
 
     operations = [

nautobot/extras/migrations/{0076_remove_name_field_and_make_label_field_non_nullable.py → 0077_remove_name_field_and_make_label_field_non_nullable.py}

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

nautobot/extras/migrations/{0077_remove_slug.py → 0078_remove_slug.py}

@@ -10,7 +10,7 @@ class Migration(migrations.Migration):
         ("circuits", "0015_remove_circuittype_provider_slug"),
         ("tenancy", "0007_remove_tenant_tenantgroup_slug"),
         ("virtualization", "0020_remove_clustergroup_clustertype_slug"),
-        ("extras", "0076_remove_name_field_and_make_label_field_non_nullable"),
+        ("extras", "0077_remove_name_field_and_make_label_field_non_nullable"),
     ]
 
     operations = [
@@ -30,10 +30,6 @@ class Migration(migrations.Migration):
             model_name="jobhook",
             name="slug",
         ),
-        migrations.RemoveField(
-            model_name="role",
-            name="slug",
-        ),
         migrations.RemoveField(
             model_name="secret",
             name="slug",

nautobot/extras/migrations/0079_tagsfield.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2.18 on 2023-04-21 13:59
+
+from django.db import migrations
+import nautobot.core.models.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0078_remove_slug"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="gitrepository",
+            name="tags",
+            field=nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag"),
+        ),
+        migrations.AlterField(
+            model_name="job",
+            name="tags",
+            field=nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag"),
+        ),
+        migrations.AlterField(
+            model_name="secret",
+            name="tags",
+            field=nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag"),
+        ),
+    ]

nautobot/extras/migrations/0080_rename_relationship_slug_to_key.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2.18 on 2023-05-09 16:35
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0079_tagsfield"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="relationship",
+            old_name="slug",
+            new_name="key",
+        ),
+    ]

nautobot/extras/migrations/0081_rename_relationship_name_to_label.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.2.18 on 2023-05-09 16:35
+
+from django.db import migrations
+import nautobot.core.models.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0080_rename_relationship_slug_to_key"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="relationship",
+            options={"ordering": ["label"]},
+        ),
+        migrations.RenameField(
+            model_name="relationship",
+            old_name="name",
+            new_name="label",
+        ),
+        migrations.AlterField(
+            model_name="relationship",
+            name="key",
+            field=nautobot.core.models.fields.AutoSlugField(
+                blank=True, max_length=100, populate_from="label", unique=True
+            ),
+        ),
+    ]

nautobot/extras/migrations/0082_ensure_relationship_keys_are_unique.py

@@ -0,0 +1,43 @@
+# Generated by Django 3.2.18 on 2023-05-09 16:38
+
+from django.db import migrations
+from nautobot.core.models.fields import slugify_dashes_to_underscores
+
+
+def ensure_relationship_keys_are_unique(apps, schema_editor):
+    Relationship = apps.get_model("extras", "relationship")
+
+    relationship_keys = []
+
+    # Make sure that relationship keys are unique by appending counters
+    # and log messages if the old keys are changed.
+    for rel in Relationship.objects.all().order_by("created"):
+        original_rel_key = rel.key
+        rel_key = slugify_dashes_to_underscores(original_rel_key)
+        append_counter = 2
+
+        while rel_key in relationship_keys:
+            rel_key_append = f"_{append_counter}"
+            max_key_length = 50 - len(rel_key_append)
+            rel_key = original_rel_key[:max_key_length] + rel_key_append
+            append_counter += 1
+
+        if rel_key != original_rel_key:
+            print(
+                f'  Relationship instance "{rel.label}" key attribute "{original_rel_key}" is being changed to "{rel_key}".'
+            )
+            rel.key = rel_key
+            rel.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0081_rename_relationship_name_to_label"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=ensure_relationship_keys_are_unique,
+            reverse_code=migrations.operations.special.RunPython.noop,
+        )
+    ]

nautobot/extras/migrations/0083_rename_computed_field_slug_to_key.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.2.18 on 2023-05-10 14:40
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0082_ensure_relationship_keys_are_unique"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="computedfield",
+            options={"ordering": ["weight", "key"]},
+        ),
+        migrations.RenameField(
+            model_name="computedfield",
+            old_name="slug",
+            new_name="key",
+        ),
+    ]

nautobot/extras/migrations/0084_taggeditem_cleanup.py

@@ -0,0 +1,43 @@
+from django.db import migrations, models
+
+
+def cleanup_taggeditem_duplicates(apps, schema_editor):
+    TaggedItem = apps.get_model("extras", "TaggedItem")
+
+    # Get the set of distinct values for TaggedItems
+    taggeditem_values = TaggedItem.objects.values("content_type", "object_id", "tag")
+    # Discard any existing ordering, just to be safe
+    taggeditem_values = taggeditem_values.order_by()
+    # Count the number of duplicates for each value
+    taggeditem_values = taggeditem_values.annotate(count_id=models.Count("id"))
+
+    # Filter to only those that actually have duplicates (i.e. more than one record)
+    duplicate_taggeditem_values = taggeditem_values.filter(count_id__gt=1)
+
+    deleted_count = 0
+    for duplicate in duplicate_taggeditem_values:
+        # Delete all but the "first" in each duplicate set.
+        # We can't use models.Min("id") to deterministically pick which one to keep because id is a UUID and psycopg2
+        # doesn't implement a min(uuid) function.
+        # We also can't just slice the queryset before deleting it (Django doesn't allow it).
+        to_delete = TaggedItem.objects.filter(
+            content_type=duplicate["content_type"], object_id=duplicate["object_id"], tag=duplicate["tag"]
+        )
+        to_keep = to_delete.first()
+        to_delete = to_delete.exclude(id=to_keep.id)
+
+        count, _ = to_delete.delete()
+        deleted_count += count
+
+    if deleted_count:
+        print(f"    Deleted {deleted_count} redundant TaggedItem records")
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0083_rename_computed_field_slug_to_key"),
+    ]
+
+    operations = [
+        migrations.RunPython(cleanup_taggeditem_duplicates, migrations.RunPython.noop),
+    ]

nautobot/extras/migrations/0085_taggeditem_uniqueness.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.2.18 on 2023-05-26 14:06
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("extras", "0084_taggeditem_cleanup"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="taggeditem",
+            name="object_id",
+            field=models.UUIDField(db_index=True),
+        ),
+        migrations.AlterUniqueTogether(
+            name="taggeditem",
+            unique_together={("content_type", "object_id", "tag")},
+        ),
+    ]

nautobot/extras/migrations/0086_job__celery_task_fields__dryrun_support.py

@@ -0,0 +1,81 @@
+# Generated by Django 3.2.18 on 2023-04-13 14:50
+
+from django.db import migrations, models
+
+import nautobot.core.celery.encoders
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0085_taggeditem_uniqueness"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="job",
+            old_name="commit_default_override",
+            new_name="dryrun_default_override",
+        ),
+        migrations.RenameField(
+            model_name="job",
+            old_name="commit_default",
+            new_name="dryrun_default",
+        ),
+        migrations.AlterField(
+            model_name="job",
+            name="dryrun_default",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="job",
+            name="supports_dryrun",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.RemoveField(
+            model_name="job",
+            name="read_only_override",
+        ),
+        migrations.RemoveField(
+            model_name="jobresult",
+            name="obj_type",
+        ),
+        migrations.RemoveField(
+            model_name="jobresult",
+            name="periodic_task_name",
+        ),
+        migrations.RemoveField(
+            model_name="jobresult",
+            name="task_id",
+        ),
+        migrations.AddField(
+            model_name="jobresult",
+            name="celery_kwargs",
+            field=models.JSONField(
+                blank=True, default=dict, encoder=nautobot.core.celery.encoders.NautobotKombuJSONEncoder
+            ),
+        ),
+        migrations.AddField(
+            model_name="scheduledjob",
+            name="celery_kwargs",
+            field=models.JSONField(
+                blank=True, default=dict, encoder=nautobot.core.celery.encoders.NautobotKombuJSONEncoder
+            ),
+        ),
+        migrations.AlterField(
+            model_name="job",
+            name="read_only",
+            field=models.BooleanField(default=False, editable=False),
+        ),
+        migrations.AlterField(
+            model_name="job",
+            name="supports_dryrun",
+            field=models.BooleanField(default=False, editable=False),
+        ),
+        migrations.AlterField(
+            model_name="jobresult",
+            name="task_args",
+            field=models.JSONField(
+                blank=True, default=list, encoder=nautobot.core.celery.encoders.NautobotKombuJSONEncoder
+            ),
+        ),
+    ]

nautobot/extras/migrations/0087_job__commit_default_data_migration.py

@@ -0,0 +1,26 @@
+from django.db import migrations
+
+
+def migrate_commit_default_to_dryrun_default(apps, schema_editor):
+    """
+    Negate the value of dryrun_default (True becomes False, False becomes True)
+    """
+    Job = apps.get_model("extras", "Job")
+    for job_model in Job.objects.all():
+        original = job_model.dryrun_default
+        if isinstance(original, bool):
+            job_model.dryrun_default = not original
+            job_model.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0086_job__celery_task_fields__dryrun_support"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=migrate_commit_default_to_dryrun_default,
+            reverse_code=migrate_commit_default_to_dryrun_default,
+        ),
+    ]

nautobot/extras/migrations/0088_joblogentry__log_level_default.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2.18 on 2023-05-17 19:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0087_job__commit_default_data_migration"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="joblogentry",
+            name="log_level",
+            field=models.CharField(db_index=True, default="info", max_length=32),
+        ),
+    ]

nautobot/extras/migrations/0089_joblogentry__log_level_data_migration.py

@@ -0,0 +1,34 @@
+from django.db import migrations
+
+
+LOG_LEVEL_MAPPING = {
+    "default": "debug",
+    "success": "info",
+    "failure": "error",
+}
+
+
+def migrate_job_log_entry_log_levels(apps, schema_editor):
+    """
+    Migrate job log levels from 1.0 values to 2.0 values.
+    default => debug
+    success => info
+    failure => error
+    """
+    JobLogEntry = apps.get_model("extras", "JobLogEntry")
+
+    for old_log_level, new_log_level in LOG_LEVEL_MAPPING.items():
+        JobLogEntry.objects.filter(log_level=old_log_level).update(log_level=new_log_level)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0088_joblogentry__log_level_default"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=migrate_job_log_entry_log_levels,
+            reverse_code=migrations.operations.special.RunPython.noop,
+        ),
+    ]

nautobot/extras/migrations/0090_scheduledjob__data_migration.py

@@ -0,0 +1,57 @@
+# Generated by Django 3.2.18 on 2023-05-30 16:10
+
+from django.db import migrations
+
+
+def migrate_existing_scheduled_jobs(apps, schema_editor):
+    """
+    Migrate the existing ScheduledJobs to support the new format.
+    1. set sj.kwargs attribute to the old sj.kwargs["data"].
+    2. delete sj.kwargs["commit"].
+    3. set sj.user to the old sj.kwargs["user"] if the user is not already set.
+    4. set sj.queue and sj.celery_kwargs["queue"] to the old sj.kwargs["task_queue"].
+    5. change sj.job_class from old "source/module/class_name" to "module.class_name"
+    """
+    ScheduledJob = apps.get_model("extras", "ScheduledJob")
+    for sj in ScheduledJob.objects.all():
+        old_kwargs = sj.kwargs
+        sj.kwargs = old_kwargs.get("data", {})
+        del sj.kwargs["commit"]
+        if sj.user is None:
+            sj.user = old_kwargs.get("user")
+        sj.queue = old_kwargs.get("task_queue", "")
+        sj.celery_kwargs["queue"] = old_kwargs.get("task_queue", "")
+        sj.job_class = ".".join(sj.job_class.split("/")[-2:])
+        sj.save()
+
+
+def reverse_migrate_existing_scheduled_jobs(apps, schema_editor):
+    """
+    Reverse the ScheduledJob Migration / Restore the removed keys in sj.kwargs.
+    1. Restore the "data" key from sj.kwargs.
+    2. Restore the "commit" key to False.
+    3. Restore the "user" key from sj.user.
+    4. Restore the "task_queue" from sj.queue.
+    5. Restore the "job_class" to a semblance of its old form (will likely be broken)
+    """
+    ScheduledJob = apps.get_model("extras", "ScheduledJob")
+    for sj in ScheduledJob.objects.all():
+        sj.kwargs["data"] = sj.kwargs
+        sj.kwargs["commit"] = False
+        sj.kwargs["user"] = sj.user
+        sj.kwargs["task_queue"] = sj.queue or sj.celery_kwargs["queue"]
+        sj.job_class = "local/" + "/".join(sj.job_class.rsplit(".", 1))
+        sj.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0089_joblogentry__log_level_data_migration"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=migrate_existing_scheduled_jobs,
+            reverse_code=reverse_migrate_existing_scheduled_jobs,
+        )
+    ]

nautobot/extras/models/__init__.py

@@ -1,5 +1,5 @@
 from .change_logging import ChangeLoggedModel, ObjectChange
-from .roles import Role, RoleRequiredRoleModelMixin, RoleModelMixin
+from .roles import Role, RoleField
 from .statuses import Status, StatusField, StatusModel
 from .customfields import ComputedField, CustomField, CustomFieldChoice, CustomFieldModel
 from .datasources import GitRepository
@@ -62,8 +62,7 @@ __all__ = (
     "RelationshipModel",
     "RelationshipAssociation",
     "Role",
-    "RoleRequiredRoleModelMixin",
-    "RoleModelMixin",
+    "RoleField",
     "ScheduledJob",
     "ScheduledJobs",
     "Secret",