feat(usergroup): support v2 Usergroup API and manifest

Author: ankitrgadiya

riocli/apply/manifests/usergroup.yaml

@@ -8,12 +8,28 @@ metadata:
 spec:
   description: This is a sample user group description
   members:
-    - emailID: [email protected]
-    - emailID: [email protected]
-  admins:
-    - emailID: [email protected]
-  projects:
-    - name: project01
-      role: viewer
-    - name: project02
-      role: admin
+  - subject:
+      kind: User
+      name: [email protected]
+      roles:
+      - kind: Role
+        name: group_viewer
+  - subject:
+      kind: ServiceAccount
+      name: sa-paramsync
+      roles:
+      - kind: Role
+        name: group_viewer
+  roles:
+  - domain:
+      kind: Project
+      name: site-1
+    role:
+      kind: Role
+      name: project_admin
+  - domain:
+      kind: Project
+      name: site-2
+    role:
+      kind: Role
+      name: project_viewer

riocli/jsonschema/schemas/usergroup-schema.yaml

@@ -45,7 +45,6 @@ definitions:
 
     required:
       - name
-      - organization
 
   usergroupSpec:
     type: object
@@ -57,29 +56,84 @@ definitions:
         type: array
         items:
           "$ref": "#/definitions/member"
-      admins:
+      roles:
         type: array
         items:
-          "$ref": "#/definitions/member"
-      projects:
+          "$ref": "#/definitions/groupRole"
+    additionalProperties: false
+
+  groupRole:
+    type: object
+    properties:
+      domain:
+        $ref: "#/definitions/domain"
+      roles:
         type: array
         items:
-          "$ref": "#/definitions/project"
-    additionalProperties: false
+          $ref: "#/definitions/role"
+
+  domain:
+    type: object
+    properties:
+      kind:
+        type: string
+        enum:
+        - Organization
+        - Project
+      name:
+        type: string
+      guid:
+        type: string
+    oneOf:
+    - required:
+      - name
+    - required:
+      - guid
 
   member:
     type: object
     properties:
+      subject:
+        $ref: "#/definitions/subject"
+      roles:
+        type: array
+        items:
+          $ref: "#/definitions/role"
+
+  subject:
+    type: object
+    properties:
+      kind:
+        type: string
+        enum:
+        - User
+        - ServiceAccount
+      name:
+        type: string
       guid:
-        $ref: "#/definitions/uuid"
-      emailID:
         type: string
+    oneOf:
+    - required:
+      - guid
+    - required:
+      - name
 
+  role:
+    type: object
+    properties:
+      kind:
+        type: string
+        const: Role
+        default: Role
+      name:
+        type: string
+      guid:
+        type: string
     oneOf:
-      - required:
-          - guid
-      - required:
-          - emailID
+    - required:
+      - name
+    - required:
+      - guid
 
   project:
     type: object

riocli/usergroup/delete.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Rapyuta Robotics
+# Copyright 2025 Rapyuta Robotics
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 from click_help_colors import HelpColorsCommand
 from yaspin.api import Yaspin
 
-from riocli.config import new_client
+from riocli.config import get_config_from_context
 from riocli.constants import Colors, Symbols
 from riocli.usergroup.util import name_to_guid
 from riocli.utils.spinner import with_spinner
@@ -60,9 +60,9 @@ def delete_usergroup(
             )
 
     try:
-        client = new_client()
-        org_guid = ctx.obj.data.get("organization_id")
-        client.delete_usergroup(org_guid, group_guid)
+        config = get_config_from_context(ctx)
+        client = config.new_v2_client(with_project=False)
+        client.delete_usergroup(group_guid=group_guid, group_name=group_name)
         spinner.text = click.style("User group deleted successfully.", fg=Colors.GREEN)
         spinner.green.ok(Symbols.SUCCESS)
     except Exception as e:

riocli/usergroup/inspect.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Rapyuta Robotics
+# Copyright 2025 Rapyuta Robotics
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,15 +11,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-import typing
-
 import click
 from click_help_colors import HelpColorsCommand
-from rapyuta_io.clients import UserGroup
 
-from riocli.config import new_client
+from riocli.config import get_config_from_context
 from riocli.constants import Colors
-from riocli.usergroup.util import name_to_guid
 from riocli.utils import inspect_with_format
 
 
@@ -38,52 +34,23 @@
 )
 @click.argument("group-name")
 @click.pass_context
-@name_to_guid
 def inspect_usergroup(
-    ctx: click.Context, format_type: str, group_name: str, group_guid: str, spinner=None
+    ctx: click.Context,
+    format_type: str,
+    group_name: str,
 ) -> None:
     """Print the details of a usergroup
 
     You choose the format of the output using the ``--format`` flag.
     The supported formats are ``json`` and ``yaml``. Default is ``yaml``.
     """
     try:
-        client = new_client()
-        org_guid = ctx.obj.data.get("organization_id")
-        usergroup = client.get_usergroup(org_guid, group_guid)
-        inspect_with_format(to_manifest(usergroup, org_guid), format_type)
+        config = get_config_from_context(ctx)
+        client = config.new_v2_client(with_project=False)
+        usergroup = client.list_usergroups(query={"name": group_name})
+        inspect_with_format(usergroup, format_type)
     except Exception as e:
         click.secho(str(e), fg=Colors.RED)
         raise SystemExit(1)
 
 
-def to_manifest(usergroup: UserGroup, org_guid: str) -> typing.Dict:
-    """
-    Transform a usergroup resource to a rio apply manifest construct
-    """
-    role_map = {
-        i["projectGUID"]: i["groupRole"] for i in (usergroup.role_in_projects or [])
-    }
-    members = {m.email_id for m in usergroup.members}
-    admins = {a.email_id for a in usergroup.admins}
-    projects = [
-        {"name": p.name, "role": role_map.get(p.guid)}
-        for p in (usergroup.projects or [])
-        if p.guid in role_map
-    ]
-
-    return {
-        "apiVersion": "api.rapyuta.io/v2",
-        "kind": "UserGroup",
-        "metadata": {
-            "name": usergroup.name,
-            "creator": usergroup.creator,
-            "organization": org_guid,
-        },
-        "spec": {
-            "description": usergroup.description,
-            "members": [{"emailID": m} for m in list(members - admins)],
-            "admins": [{"emailID": a} for a in list(admins)],
-            "projects": projects,
-        },
-    }

riocli/usergroup/list.py

@@ -1,4 +1,4 @@
-# Copyright 2024 Rapyuta Robotics
+# Copyright 2025 Rapyuta Robotics
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@
 import click
 from click_help_colors import HelpColorsCommand
 
-from riocli.config import new_client
+from riocli.config import new_v2_client
 from riocli.constants import Colors
 from riocli.utils import tabulate_data
 
@@ -32,9 +32,8 @@
 def list_usergroup(ctx: click.Context) -> None:
     """List all user groups in current organization."""
     try:
-        client = new_client()
-        org_guid = ctx.obj.data.get("organization_id")
-        user_groups = client.list_usergroups(org_guid)
+        client = new_v2_client(with_project=False)
+        user_groups = client.list_usergroups()
         _display_usergroup_list(user_groups)
     except Exception as e:
         click.secho(str(e), fg=Colors.RED)
@@ -46,16 +45,15 @@ def _display_usergroup_list(usergroups: typing.Any, show_header: bool = True):
     if show_header:
         headers = ("ID", "Name", "Creator", "Members", "Projects", "Description")
 
-    data = [
-        [
-            group.guid,
-            group.name,
-            group.creator,
-            len(group.members) if group.members else 0,
-            len(group.projects) if group.projects else 0,
-            group.description,
-        ]
-        for group in usergroups
-    ]
-
-    tabulate_data(data, headers)
+    rows = []
+    for g in usergroups:
+        rows.append(
+            [
+                g.metadata.guid,
+                g.metadata.name,
+                g.metadata.creatorGUID,
+                g.spec.membersCount,
+                g.spec.description,
+            ]
+        )
+    tabulate_data(rows, headers)