Ensure Unique Config Plans during migrations

changes/781.fixed

@@ -0,0 +1 @@
+Fixed UniqueViolation error when applying migration 0029 with multiple config plans sharing same device, date and plan_type.

nautobot_golden_config/migrations/0029_alter_configplan_unique_together.py

@@ -1,6 +1,31 @@
 # Generated by Django 3.2.20 on 2023-09-16 17:31
 
-from django.db import migrations
+import secrets
+from datetime import timedelta
+
+from django.db import migrations, models
+
+
+def ensure_config_plan_created_timestamps_are_unique(apps, schema_editor):
+    ConfigPlan = apps.get_model("nautobot_golden_config", "ConfigPlan")
+    natural_key_fields = ["plan_type", "device", "created"]
+
+    # We append some random milliseconds of time to avoid duplicate timestamps for Config Plan objects created field
+
+    duplicate_records = (
+        ConfigPlan.objects.values(*natural_key_fields)
+        .order_by()
+        .annotate(
+            count=models.Count("pk"),
+        )
+        .filter(count__gt=1)
+    )
+
+    for duplicate_record in duplicate_records:
+        duplicate_record.pop("count")
+        for record in ConfigPlan.objects.filter(**duplicate_record):
+            record.created += timedelta(milliseconds=secrets.randbelow(1000))
+            record.save()
 
 
 class Migration(migrations.Migration):
@@ -10,6 +35,13 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
+        # I know that data migrations are not recommended in the same migration as schema changes,
+        # but since there are already released migrations with users that had successful migrations
+        # doing this is the only way to ensure that we don't break their data, but are also able to fix the issue.
+        migrations.RunPython(
+            code=ensure_config_plan_created_timestamps_are_unique,
+            reverse_code=migrations.RunPython.noop,
+        ),
         migrations.AlterUniqueTogether(
             name="configplan",
             unique_together={("plan_type", "device", "created")},

nautobot_golden_config/utilities/helper.py

@@ -16,8 +16,8 @@
 from nautobot.core.utils.data import render_jinja2
 from nautobot.dcim.filters import DeviceFilterSet
 from nautobot.dcim.models import Device
-from nautobot.extras.models import Job
 from nautobot.extras.choices import DynamicGroupTypeChoices
+from nautobot.extras.models import Job
 from nornir_nautobot.exceptions import NornirNautobotException
 
 from nautobot_golden_config import config as app_config
@@ -71,7 +71,9 @@ def get_job_filter(data=None):
 
     raw_qs = Q()
     # If scope is set to {} do not loop as all devices are in scope.
-    if not models.GoldenConfigSetting.objects.filter(dynamic_group__filter__iexact="{}", dynamic_group__group_type=DynamicGroupTypeChoices.TYPE_DYNAMIC_FILTER).exists():
+    if not models.GoldenConfigSetting.objects.filter(
+        dynamic_group__filter__iexact="{}", dynamic_group__group_type=DynamicGroupTypeChoices.TYPE_DYNAMIC_FILTER
+    ).exists():
         for obj in models.GoldenConfigSetting.objects.all():
             raw_qs = raw_qs | obj.dynamic_group.generate_query()