Use of GroupMetadata instead of ServerlessGroup (#1604)

* remove serverless group model

* created group metadata

Author: Tansito

gateway/api/admin.py

@@ -1,21 +1,17 @@
 """Admin module."""
 
 from django.contrib import admin
-from django.contrib.auth.models import Group
 from api.models import (
+    GroupMetadata,
     JobConfig,
     Provider,
     Program,
     ComputeResource,
     Job,
     RuntimeJob,
-    ServerlessGroup,
 )
 
 
-admin.site.unregister(Group)
-
-
 @admin.register(JobConfig)
 class JobConfigAdmin(admin.ModelAdmin):
     """JobConfigAdmin."""
@@ -62,9 +58,8 @@ class RuntimeJobAdmin(admin.ModelAdmin):
     search_fields = ["job__id"]
 
 
-@admin.register(ServerlessGroup)
-class ServerlessGroupAdmin(admin.ModelAdmin):
-    """ServerlessGroupAdmin."""
+@admin.register(GroupMetadata)
+class GroupMetadataAdmin(admin.ModelAdmin):
+    """RuntimeJobAdmin."""
 
-    search_fields = ["name", "account"]
-    filter_horizontal = ["permissions"]
+    search_fields = ["account"]

gateway/api/migrations/0035_delete_serverlessgroup.py

@@ -0,0 +1,16 @@
+# Generated by Django 4.2.19 on 2025-03-11 15:47
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("api", "0034_serverlessgroup"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="ServerlessGroup",
+        ),
+    ]

gateway/api/migrations/0036_groupmetadata.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.2.19 on 2025-03-11 16:26
+
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("auth", "0012_alter_user_first_name_max_length"),
+        ("api", "0035_delete_serverlessgroup"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="GroupMetadata",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        primary_key=True,
+                        serialize=False,
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True)),
+                (
+                    "account",
+                    models.CharField(
+                        blank=True, default=None, max_length=255, null=True
+                    ),
+                ),
+                (
+                    "group",
+                    models.OneToOneField(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="metadata",
+                        to="auth.group",
+                    ),
+                ),
+            ],
+        ),
+    ]

gateway/api/models.py

@@ -235,18 +235,20 @@ class RuntimeJob(models.Model):
     )
 
 
-class ServerlessGroup(Group):
+class GroupMetadata(models.Model):
     """
-    This model extends Group to store new fields from other resources.
+    This model will store metadata from different resources for Group
     """
 
-    parent_group = models.OneToOneField(
-        Group,
-        on_delete=models.CASCADE,
-        parent_link=True,
-        primary_key=True,
-        db_column="parent_group",
-    )
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+    created = models.DateTimeField(auto_now_add=True, editable=False)
 
     # This field will store the account_id from IBM Cloud.
     account = models.CharField(max_length=255, blank=True, null=True, default=None)
+
+    group = models.OneToOneField(
+        Group, on_delete=models.CASCADE, related_name="metadata"
+    )
+
+    def __str__(self):
+        return f"{self.id}"

gateway/api/repositories/users.py

@@ -9,7 +9,7 @@
 from django.db.models import Q
 
 from api.domain.authentication.authentication_group import AuthenticationGroup
-from api.models import ServerlessGroup
+from api.models import GroupMetadata
 
 
 User = get_user_model()
@@ -85,13 +85,16 @@ def restart_user_groups(
 
         logger.debug("Update [%s] groups", len(authentication_groups))
         for authentication_group in authentication_groups:
-            group, created = ServerlessGroup.objects.get_or_create(
-                name=authentication_group.group_name,
-                account=authentication_group.account,
+            group, created = Group.objects.get_or_create(
+                name=authentication_group.group_name
             )
             if created:
                 for permission in permissions:
                     group.permissions.add(permission)
+                if authentication_group.account is not None:
+                    GroupMetadata.objects.create(
+                        group=group, account=authentication_group.account
+                    )
             group.user_set.add(user)
             new_groups.append(group)
 

gateway/tests/api/authentication/custom_token/test_ibm_cloud.py

@@ -93,11 +93,12 @@ def test_default_authentication_workflow(
                 groups_names_list,
                 ["AccessGroupId-23afbcd24-00a0-00ab-ab0c-1a23b4c567de"],
             )
+
             groups = user.groups.all()
-            self.assertEqual(
-                groups[0].serverlessgroup.account,
-                "abc18abcd41546508b35dfe0627109c4",
-            )
+            for group in groups:
+                self.assertEqual(
+                    group.metadata.account, "abc18abcd41546508b35dfe0627109c4"
+                )
 
             for group in user.groups.all():
                 permissions = list(group.permissions.values_list("codename", flat=True))

gateway/tests/api/authentication/custom_token/test_quantum_platform.py

@@ -68,7 +68,9 @@ def test_custom_token_authentication(self, get_network_mock: MagicMock):
             self.assertListEqual(groups_names_list, ["ibm-q", "ibm-q/open"])
 
             groups = user.groups.all()
-            self.assertIsNone(groups[0].serverlessgroup.account)
+            for group in groups:
+                metadata = getattr(groups, "metadata", None)
+                self.assertIsNone(metadata)
 
             for group in user.groups.all():
                 permissions = list(group.permissions.values_list("codename", flat=True))

gateway/tests/api/authentication/mock_token/test_mock_token.py

@@ -45,7 +45,8 @@ def test_default_authentication_workflow(self):
             self.assertEqual(provider_groups, ["mockgroup"])
 
             groups = user.groups.all()
-            self.assertIsNone(groups[0].serverlessgroup.account)
+            metadata = getattr(groups[0], "metadata", None)
+            self.assertIsNone(metadata)
 
     def test_incorrect_authorization_header(self):
         """This test verifies that user is None if the authentication fails."""