Update iam_group_info module (#217)

Signed-off-by: rsuplina <rsuplina@cloudera.com>

Author: rsuplina

plugins/module_utils/cdp_iam.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2025 Cloudera, Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+"""
+A REST client for the Cloudera on Cloud Platform (CDP) IAM API
+"""
+
+from typing import Any, Dict, List, Optional
+
+from ansible_collections.cloudera.cloud.plugins.module_utils.cdp_client import (
+    RestClient,
+    CdpClient,
+)
+
+
+class CdpIamClient(CdpClient):
+    """CDP IAM API client."""
+
+    def __init__(self, api_client: RestClient):
+        """
+        Initialize CDP IAM client.
+
+        Args:
+            api_client: RestClient instance for managing HTTP method calls
+        """
+        super().__init__(api_client=api_client)
+
+    @RestClient.paginated()
+    def list_groups(
+        self,
+        group_names: Optional[List[str]] = None,
+        pageToken: Optional[str] = None,
+        pageSize: Optional[int] = None,
+    ) -> Dict[str, Any]:
+        """
+        List IAM groups with automatic pagination.
+
+        Args:
+            group_names: Optional list of group names or CRNs to filter by
+            pageToken: Token for pagination (automatically handled by decorator)
+            pageSize: Page size for pagination (automatically handled by decorator)
+
+        Returns:
+            Response with automatic pagination handling containing groups list
+        """
+        json_data: Dict[str, Any] = {}
+
+        # Add group names filter if provided
+        if group_names is not None:
+            json_data["groupNames"] = group_names
+
+        # Add pagination parameters if provided
+        if pageToken is not None:
+            json_data["startingToken"] = pageToken
+        if pageSize is not None:
+            json_data["pageSize"] = pageSize
+
+        return self.post(
+            "/api/v1/iam/listGroups",
+            json_data=json_data,
+        )

plugins/modules/iam_group_info.py

@@ -23,6 +23,7 @@
 author:
   - "Webster Mudge (@wmudge)"
   - "Dan Chaffelson (@chaffelson)"
+  - "Ronald Suplina (@rsuplina)"
 version_added: "1.0.0"
 options:
   name:
@@ -36,21 +37,26 @@
     aliases:
       - group_name
 extends_documentation_fragment:
-  - cloudera.cloud.cdp_sdk_options
-  - cloudera.cloud.cdp_auth_options
+  - cloudera.cloud.cdp_client
 """
 
 EXAMPLES = r"""
 # Note: These examples do not set authentication details.
 
-# Gather information about all Groups
-- cloudera.cloud.iam_group_info:
+ - name: Gather information about all Groups
+   cloudera.cloud.iam_group_info:
 
-# Gather information about a named Group
-- cloudera.cloud.iam_group_info:
-    name: example-01
+ - name: Gather information about a named Group
+   cloudera.cloud.iam_group_info:
+     name: example-01
+
+ - name: Gather information about several named Groups
+   cloudera.cloud.iam_group_info:
+     name:
+       - example-01
+       - example-02
+       - example-03
 
-# Gather information about several named Groups
 - cloudera.cloud.iam_group_info:
     name:
       - example-01
@@ -60,12 +66,15 @@
 
 RETURN = r"""
 groups:
-  description: The information about the named Group or Groups
+  description:
+    - Returns a list of group records.
+    - Each record represents a CDP IAM group and its details.
   type: list
   returned: always
   elements: dict
   contains:
     creationDate:
+    # creation_date:
       description: The date when this group record was created.
       returned: on success
       type: str
@@ -75,96 +84,86 @@
       returned: on success
       type: str
     groupName:
+    # group_name:
       description: The group name.
       returned: on success
       type: str
       sample: example-01
-    users:
-      description: List of User CRNs which are members of the group.
-      returned: on success
-      type: list
-      elements: str
-    roles:
-      description: List of Role CRNs assigned to the group.
-      returned: on success
-      type: list
-      elements: str
-    resource_roles:
-      description: List of Resource-to-Role assignments, by CRN, that are associated with the group.
-      returned: on success
-      type: list
-      elements: dict
-      contains:
-        resourceCrn:
-          description: The CRN of the resource granted the rights of the role.
-          returned: on success
-          type: str
-        resourceRoleCrn:
-          description: The CRN of the CDP Role.
-          returned: on success
-          type: str
     syncMembershipOnUserLogin:
-      description: Flag indicating whether group membership is synced when a user logs in. The default is to sync group
-        membership.
+    # sync_membership_on_user_login:
+      description: Flag indicating whether group membership is synced when a user logs in. The default is to sync group membership.
       returned: when supported
       type: bool
 sdk_out:
-  description: Returns the captured CDP SDK log.
+  description: Returns the captured API HTTP log.
   returned: when supported
   type: str
 sdk_out_lines:
-  description: Returns a list of each line of the captured CDP SDK log.
+  description: Returns a list of each line of the captured API HTTP log.
   returned: when supported
   type: list
   elements: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.cloudera.cloud.plugins.module_utils.cdp_common import CdpModule
+from typing import Any
 
+# from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict
 
-class IAMGroupInfo(CdpModule):
-    def __init__(self, module):
-        super(IAMGroupInfo, self).__init__(module)
+from ansible_collections.cloudera.cloud.plugins.module_utils.common import (
+    ServicesModule,
+)
+from ansible_collections.cloudera.cloud.plugins.module_utils.cdp_iam import (
+    CdpIamClient,
+)
 
-        # Set variables
-        self.name = self._get_param("name")
 
-        # Initialize the return values
-        self.info = []
+class IAMGroupInfo(ServicesModule):
+    def __init__(self):
+        super().__init__(
+            argument_spec=dict(
+                name=dict(
+                    required=False,
+                    type="list",
+                    elements="str",
+                    aliases=["group_name"],
+                ),
+            ),
+            supports_check_mode=True,
+        )
 
-        # Execute logic process
-        self.process()
+        # Set parameters
+        self.name = self.get_param("name")
+
+        # Initialize the return values
+        self.groups = []
 
-    @CdpModule._Decorators.process_debug
     def process(self):
-        self.info = self.cdpy.iam.gather_groups(self.name)
+        client = CdpIamClient(api_client=self.api_client)
+        result = client.list_groups(group_names=self.name)
+        self.groups = result.get("groups", [])
 
 
-def main():
-    module = AnsibleModule(
-        argument_spec=CdpModule.argument_spec(
-            name=dict(
-                required=False,
-                type="list",
-                elements="str",
-                aliases=["group_name"],
-            ),
-        ),
-        supports_check_mode=True,
-    )
+# NOTE: Snake_case conversion deferred until 4.0 to maintain backward compatibility.
+# self.groups = [
+#     camel_dict_to_snake_dict(group) for group in result.get("groups", [])
+# ]
+
 
-    result = IAMGroupInfo(module)
+def main():
+    result = IAMGroupInfo()
 
-    output = dict(
+    output: dict[str, Any] = dict(
         changed=False,
-        groups=result.info,
+        groups=result.groups,
     )
 
-    if result.debug:
-        output.update(sdk_out=result.log_out, sdk_out_lines=result.log_lines)
+    if result.debug_log:
+        output.update(
+            sdk_out=result.log_out,
+            sdk_out_lines=result.log_lines,
+        )
 
-    module.exit_json(**output)
+    result.module.exit_json(**output)
 
 
 if __name__ == "__main__":