Merge pull request #3842 from ryanpetrello/instance-group-order

enforce a stable list order when attaching/detaching instance groups

Reviewed-by: https://github.com/softwarefactory-project-zuul[bot]

awx/main/models/ha.py

@@ -332,3 +332,54 @@ def on_job_create(sender, instance, created=False, raw=False, **kwargs):
         instance=Instance.objects.me(),
         unified_job=instance,
     )
+
+
+class UnifiedJobTemplateInstanceGroupMembership(models.Model):
+
+    unifiedjobtemplate = models.ForeignKey(
+        'UnifiedJobTemplate',
+        on_delete=models.CASCADE
+    )
+    instancegroup = models.ForeignKey(
+        'InstanceGroup',
+        on_delete=models.CASCADE
+    )
+    position = models.PositiveIntegerField(
+        null=True,
+        default=None,
+        db_index=True,
+    )
+
+
+class OrganizationInstanceGroupMembership(models.Model):
+
+    organization = models.ForeignKey(
+        'Organization',
+        on_delete=models.CASCADE
+    )
+    instancegroup = models.ForeignKey(
+        'InstanceGroup',
+        on_delete=models.CASCADE
+    )
+    position = models.PositiveIntegerField(
+        null=True,
+        default=None,
+        db_index=True,
+    )
+
+
+class InventoryInstanceGroupMembership(models.Model):
+
+    inventory = models.ForeignKey(
+        'Inventory',
+        on_delete=models.CASCADE
+    )
+    instancegroup = models.ForeignKey(
+        'InstanceGroup',
+        on_delete=models.CASCADE
+    )
+    position = models.PositiveIntegerField(
+        null=True,
+        default=None,
+        db_index=True,
+    )

awx/main/models/inventory.py

@@ -37,6 +37,7 @@ from awx.main.fields import (
     ImplicitRoleField,
     JSONBField,
     SmartFilterField,
+    OrderedManyToManyField,
 )
 from awx.main.managers import HostManager
 from awx.main.models.base import (
@@ -156,9 +157,10 @@ class Inventory(CommonModelNameNotUnique, ResourceMixin, RelatedJobsMixin):
         default=None,
         help_text=_('Filter that will be applied to the hosts of this inventory.'),
     )
-    instance_groups = models.ManyToManyField(
+    instance_groups = OrderedManyToManyField(
         'InstanceGroup',
         blank=True,
+        through='InventoryInstanceGroupMembership',
     )
     admin_role = ImplicitRoleField(
         parent_role='organization.inventory_admin_role',

awx/main/models/organization.py

@@ -15,7 +15,9 @@ from django.utils.translation import ugettext_lazy as _
 
 # AWX
 from awx.api.versioning import reverse
-from awx.main.fields import AutoOneToOneField, ImplicitRoleField
+from awx.main.fields import (
+    AutoOneToOneField, ImplicitRoleField, OrderedManyToManyField
+)
 from awx.main.models.base import (
     BaseModel, CommonModel, CommonModelNameNotUnique, CreatedModifiedModel,
     NotificationFieldsModel
@@ -39,9 +41,10 @@ class Organization(CommonModel, NotificationFieldsModel, ResourceMixin, CustomVi
         app_label = 'main'
         ordering = ('name',)
 
-    instance_groups = models.ManyToManyField(
+    instance_groups = OrderedManyToManyField(
         'InstanceGroup',
         blank=True,
+        through='OrganizationInstanceGroupMembership'
     )
     max_hosts = models.PositiveIntegerField(
         blank=True,

awx/main/models/unified_jobs.py

@@ -48,7 +48,7 @@ from awx.main.utils import polymorphic, schedule_task_manager
 from awx.main.constants import ACTIVE_STATES, CAN_CANCEL
 from awx.main.redact import UriCleaner, REPLACE_STR
 from awx.main.consumers import emit_channel_notification
-from awx.main.fields import JSONField, AskForField
+from awx.main.fields import JSONField, AskForField, OrderedManyToManyField
 
 __all__ = ['UnifiedJobTemplate', 'UnifiedJob', 'StdoutMaxBytesExceeded']
 
@@ -164,9 +164,10 @@ class UnifiedJobTemplate(PolymorphicModel, CommonModelNameNotUnique, Notificatio
         blank=True,
         related_name='%(class)s_labels'
     )
-    instance_groups = models.ManyToManyField(
+    instance_groups = OrderedManyToManyField(
         'InstanceGroup',
         blank=True,
+        through='UnifiedJobTemplateInstanceGroupMembership'
     )
 
     def get_absolute_url(self, request=None):