7699 Add Scope to Cluster (#17848)

* 7699 Add Scope to Cluster

* 7699 Serializer

* 7699 filterset

* 7699 bulk_edit

* 7699 bulk_import

* 7699 model_form

* 7699 graphql, tables

* 7699 fixes

* 7699 fixes

* 7699 fixes

* 7699 fixes

* 7699 fix tests

* 7699 fix graphql tests for clusters reference

* 7699 fix dcim tests

* 7699 fix ipam tests

* 7699 fix tests

* 7699 use mixin for model

* 7699 change mixin name

* 7699 scope form

* 7699 scope form

* 7699 scoped form, fitlerset

* 7699 review changes

* 7699 move ScopedFilterset

* 7699 move CachedScopeMixin

* 7699 review changes

* 7699 review changes

* 7699 refactor mixins

* 7699 _sitegroup -> _site_group

* 7699 update docstring

* Misc cleanup

* Update migrations

---------

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>

netbox/virtualization/migrations/0044_cluster_scope.py

@@ -0,0 +1,51 @@
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def copy_site_assignments(apps, schema_editor):
+     """
+     Copy site ForeignKey values to the scope GFK.
+     """
+     ContentType = apps.get_model('contenttypes', 'ContentType')
+     Cluster = apps.get_model('virtualization', 'Cluster')
+     Site = apps.get_model('dcim', 'Site')
+
+     Cluster.objects.filter(site__isnull=False).update(
+         scope_type=ContentType.objects.get_for_model(Site),
+         scope_id=models.F('site_id')
+     )
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('virtualization', '0043_qinq_svlan'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='cluster',
+            name='scope_id',
+            field=models.PositiveBigIntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='cluster',
+            name='scope_type',
+            field=models.ForeignKey(
+                blank=True,
+                limit_choices_to=models.Q(('model__in', ('region', 'sitegroup', 'site', 'location'))),
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name='+',
+                to='contenttypes.contenttype',
+            ),
+        ),
+
+        # Copy over existing site assignments
+        migrations.RunPython(
+            code=copy_site_assignments,
+            reverse_code=migrations.RunPython.noop
+        ),
+
+    ]

netbox/virtualization/migrations/0045_clusters_cached_relations.py

@@ -0,0 +1,94 @@
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def populate_denormalized_fields(apps, schema_editor):
+    """
+    Copy the denormalized fields for _region, _site_group and _site from existing site field.
+    """
+    Cluster = apps.get_model('virtualization', 'Cluster')
+
+    clusters = Cluster.objects.filter(site__isnull=False).prefetch_related('site')
+    for cluster in clusters:
+        cluster._region_id = cluster.site.region_id
+        cluster._site_group_id = cluster.site.group_id
+        cluster._site_id = cluster.site_id
+        # Note: Location cannot be set prior to migration
+
+    Cluster.objects.bulk_update(clusters, ['_region', '_site_group', '_site'])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('virtualization', '0044_cluster_scope'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='cluster',
+            name='_location',
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name='_%(class)ss',
+                to='dcim.location',
+            ),
+        ),
+        migrations.AddField(
+            model_name='cluster',
+            name='_region',
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name='_%(class)ss',
+                to='dcim.region',
+            ),
+        ),
+        migrations.AddField(
+            model_name='cluster',
+            name='_site',
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name='_%(class)ss',
+                to='dcim.site',
+            ),
+        ),
+        migrations.AddField(
+            model_name='cluster',
+            name='_site_group',
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name='_%(class)ss',
+                to='dcim.sitegroup',
+            ),
+        ),
+
+        # Populate denormalized FK values
+        migrations.RunPython(
+            code=populate_denormalized_fields,
+            reverse_code=migrations.RunPython.noop
+        ),
+
+        migrations.RemoveConstraint(
+            model_name='cluster',
+            name='virtualization_cluster_unique_site_name',
+        ),
+        # Delete the site ForeignKey
+        migrations.RemoveField(
+            model_name='cluster',
+            name='site',
+        ),
+        migrations.AddConstraint(
+            model_name='cluster',
+            constraint=models.UniqueConstraint(
+                fields=('_site', 'name'), name='virtualization_cluster_unique__site_name'
+            ),
+        ),
+    ]