feat: Add support for group query by name (#170)

Author: achimnol

changes/170.feature

@@ -0,0 +1 @@
+Add `admin groups-by-name` to resolve group information by the name

src/ai/backend/client/cli/admin/groups.py

@@ -30,21 +30,68 @@ def group(gid):
     ]
     with Session() as session:
         try:
-            resp = session.Group.detail(gid=gid,
-                                        fields=(item[1] for item in fields))
+            item = session.Group.detail(
+                gid=gid,
+                fields=(item[1] for item in fields),
+            )
         except Exception as e:
             print_error(e)
             sys.exit(1)
         rows = []
-        if resp is None:
-            print('There is no such group.')
+        if item is None:
+            print_fail('There is no such group.')
             sys.exit(1)
         for name, key in fields:
-            if key in resp:
-                rows.append((name, resp[key]))
+            if key in item:
+                rows.append((name, item[key]))
         print(tabulate(rows, headers=('Field', 'Value')))
 
 
+@admin.command()
+@click.argument('name', type=str)
+def groups_by_name(name: str):
+    '''
+    Show the information about the group(s) having the given name.
+    Two or more groups in different domains may have the same name,
+    so this may print out information of multiple groups if queried
+    by a superadmin.
+
+    \b
+    name: Group name.
+    '''
+    fields = [
+        ('ID', 'id'),
+        ('Name', 'name'),
+        ('Domain', 'domain_name'),
+        ('Description', 'description'),
+        ('Active?', 'is_active'),
+        ('Created At', 'created_at'),
+        ('Total Resource Slots', 'total_resource_slots'),
+        ('Allowed vFolder Hosts', 'allowed_vfolder_hosts'),
+    ]
+    with Session() as session:
+        try:
+            items = session.Group.from_name(
+                name,
+                fields=(item[1] for item in fields),
+            )
+        except Exception as e:
+            print_error(e)
+            sys.exit(1)
+        rows = []
+        if not items:
+            print_fail('There is no such group.')
+            sys.exit(1)
+        show_splitter = (len(items) > 1)
+        for item_idx, item in enumerate(items):
+            if show_splitter and item_idx > 0:
+                print("=" * 40)
+            for name, key in fields:
+                if key in item:
+                    rows.append((name, item[key]))
+            print(tabulate(rows, headers=('Field', 'Value')))
+
+
 @admin.group(invoke_without_command=True)
 @click.pass_context
 @click.option('-d', '--domain-name', type=str, default=None,
@@ -65,6 +112,7 @@ def groups(ctx, domain_name):
         ('Created At', 'created_at'),
         ('Total Resource Slots', 'total_resource_slots'),
         ('Allowed vFolder Hosts', 'allowed_vfolder_hosts'),
+        ('Allowed scaling groups', 'scaling_groups'),
     ]
     with Session() as session:
         try:
@@ -74,7 +122,7 @@ def groups(ctx, domain_name):
             print_error(e)
             sys.exit(1)
         if len(resp) < 1:
-            print('There is no group.')
+            print_fail('There is no group.')
             return
         fields = [field for field in fields if field[1] in resp[0]]
         print(tabulate((item.values() for item in resp),

src/ai/backend/client/func/group.py

@@ -8,6 +8,25 @@
     'Group',
 )
 
+_default_list_fields = (
+    'id',
+    'name',
+    'is_active',
+    'created_at',
+    'integration_id',
+)
+_default_detail_fields = (
+    'id',
+    'name',
+    'description',
+    'is_active',
+    'created_at',
+    'domain_name',
+    'total_resource_slots',
+    'allowed_vfolder_hosts',
+    'integration_id',
+)
+
 
 class Group(BaseFunction):
     """
@@ -22,19 +41,52 @@ class Group(BaseFunction):
 
     @api_function
     @classmethod
-    async def list(cls, domain_name: str,
-                   fields: Iterable[str] = None) -> Sequence[dict]:
+    async def from_name(
+        cls,
+        name: str,
+        *,
+        fields: Iterable[str] = None,
+        domain_name: str = None,
+    ) -> Sequence[dict]:
+        """
+        Find the group(s) by its name.
+        It may return multiple groups when there are groups with the same name
+        in different domains and it is invoked with a super-admin account
+        without setting the domain name.
+
+        :param domain_name: Name of domain to get groups from.
+        :param fields: Per-group query fields to fetch.
+        """
+        if fields is None:
+            fields = _default_detail_fields
+        query = textwrap.dedent("""\
+            query($name: String!, $domain_name: String) {
+                groups_by_name(name: $name, domain_name: $domain_name) {$fields}
+            }
+        """)
+        query = query.replace('$fields', ' '.join(fields))
+        variables = {
+            'name': name,
+            'domain_name': domain_name,
+        }
+        data = await api_session.get().Admin._query(query, variables)
+        return data['groups_by_name']
+
+    @api_function
+    @classmethod
+    async def list(
+        cls,
+        domain_name: str,
+        fields: Iterable[str] = None,
+    ) -> Sequence[dict]:
         """
         Fetches the list of groups.
 
         :param domain_name: Name of domain to list groups.
-        :param fields: Additional per-group query fields to fetch.
+        :param fields: Per-group query fields to fetch.
         """
         if fields is None:
-            fields = ('id', 'name', 'description', 'is_active',
-                      'created_at', 'domain_name',
-                      'total_resource_slots', 'allowed_vfolder_hosts',
-                      'integration_id')
+            fields = _default_list_fields
         query = textwrap.dedent("""\
             query($domain_name: String) {
                 groups(domain_name: $domain_name) {$fields}
@@ -55,8 +107,7 @@ async def detail(cls, gid: str, fields: Iterable[str] = None) -> Sequence[dict]:
         :param fields: Additional per-group query fields to fetch.
         """
         if fields is None:
-            fields = ('id', 'name', 'description', 'is_active', 'created_at', 'domain_name',
-                      'total_resource_slots', 'allowed_vfolder_hosts', 'integration_id')
+            fields = _default_detail_fields
         query = textwrap.dedent("""\
             query($gid: UUID!) {
                 group(id: $gid) {$fields}