Update service and service_info modules to align with current utilities

meta/runtime.yml

@@ -39,3 +39,49 @@ action_groups:
           - cm
     - cluster_info
     - cluster
+  service:
+    - metadata:
+        extend_group:
+          - cm
+    - service_info
+    - service
+  role:
+    - metadata:
+        extend_group:
+          - cm
+    - service_role_info
+    - service_role
+  role_config_group:
+    - metadata:
+        extend_group:
+          - cm
+    - service_role_config_group_info
+    - service_role_config_group
+  host:
+    - metadata:
+        extend_group:
+          - cm
+    - host_info
+    - host
+  host_template:
+    - metadata:
+        extend_group:
+          - cm
+    - host_template_info
+    - host_template
+  parcel:
+    - metadata:
+        extend_group:
+          - cm
+    - parcel_info
+    - parcel
+  deployment:
+    - metadata:
+        extend_group:
+          - cluster
+          - service
+          - role
+          - role_config_group
+          - host
+          - host_template
+          - parcel

plugins/module_utils/cluster_utils.py

@@ -51,6 +51,7 @@ def parse_cluster_result(cluster: ApiCluster) -> dict:
     return output
 
 
+# TODO Convert to use cluster_name vs the ApiCluster object for broader usage in pytest fixtures
 def get_cluster_hosts(api_client: ApiClient, cluster: ApiCluster) -> list[ApiHost]:
     return (
         ClustersResourceApi(api_client)

plugins/module_utils/role_config_group_utils.py

@@ -14,12 +14,20 @@
 
 from ansible_collections.cloudera.cluster.plugins.module_utils.cm_utils import (
     normalize_output,
+    ConfigListUpdates,
+)
+from ansible_collections.cloudera.cluster.plugins.module_utils.role_utils import (
+    InvalidRoleTypeException,
 )
 
 from cm_client import (
     ApiClient,
+    ApiConfig,
+    ApiConfigList,
     ApiRoleConfigGroup,
+    ApiRoleConfigGroupList,
     RoleConfigGroupsResourceApi,
+    ServicesResourceApi,
     MgmtRoleConfigGroupsResourceApi,
 )
 
@@ -41,6 +49,7 @@ def parse_role_config_group_result(role_config_group: ApiRoleConfigGroup) -> dic
     - base (bool)
     - display_name (str)
     - config (dict)
+    - service_name (str)
 
     Args:
         role_config_group (ApiRoleConfigGroup): Role Config Group
@@ -55,23 +64,105 @@ def parse_role_config_group_result(role_config_group: ApiRoleConfigGroup) -> dic
     return output
 
 
-def get_base_role_config_group(
-    api_client: ApiClient, cluster_name: str, service_name: str, role_type: str
+def create_role_config_group(
+    api_client: ApiClient,
+    cluster_name: str,
+    service_name: str,
+    name: str,
+    role_type: str,
+    display_name: str = None,
+    config: dict = None,
 ) -> ApiRoleConfigGroup:
-    rcg_api = RoleConfigGroupsResourceApi(api_client)
-    return next(
-        iter(
-            [
-                r
-                for r in rcg_api.read_role_config_groups(
-                    cluster_name, service_name
-                ).items
-                if r.role_type == role_type and r.base
-            ]
-        ),
-        None,
+    if (
+        role_type.upper()
+        not in ServicesResourceApi(api_client)
+        .list_role_types(
+            cluster_name=cluster_name,
+            service_name=service_name,
+        )
+        .items
+    ):
+        raise InvalidRoleTypeException(
+            f"Invalid role type '{role_type}' for service '{service_name}'"
+        )
+
+    role_config_group = ApiRoleConfigGroup(
+        name=name,
+        role_type=role_type.upper(),
     )
 
+    if display_name:
+        role_config_group.display_name = display_name
+
+    if config:
+        role_config_group.config = ApiConfigList(
+            items=[ApiConfig(name=k, value=v) for k, v in config.items()]
+        )
+
+    return role_config_group
+
+
+def provision_role_config_groups(
+    api_client: ApiClient,
+    cluster_name: str,
+    service_name: str,
+    role_config_groups: list[ApiRoleConfigGroup],
+) -> ApiRoleConfigGroup:
+    return RoleConfigGroupsResourceApi(api_client).create_role_config_groups(
+        cluster_name=cluster_name,
+        service_name=service_name,
+        body=ApiRoleConfigGroupList(items=role_config_groups),
+    )
+
+
+def update_role_config_group(
+    role_config_group: ApiRoleConfigGroup,
+    display_name: str = None,
+    config: dict = None,
+    purge: bool = False,
+) -> tuple[ApiRoleConfigGroup, dict, dict]:
+    before, after = dict(), dict()
+
+    # Check for display name changes
+    if display_name is not None and display_name != role_config_group.display_name:
+        before.update(display_name=role_config_group.display_name)
+        after.update(display_name=display_name)
+        role_config_group.display_name = display_name
+
+    # Reconcile configurations
+    if config or purge:
+        if config is None:
+            config = dict()
+
+        updates = ConfigListUpdates(role_config_group.config, config, purge)
+
+        if updates.changed:
+            before.update(config=updates.diff["before"])
+            after.update(config=updates.diff["after"])
+            role_config_group.config = updates.config
+
+    return (role_config_group, before, after)
+
+
+# TODO Normalize the return value to be a list
+def get_base_role_config_group(
+    api_client: ApiClient, cluster_name: str, service_name: str, role_type: str = None
+) -> ApiRoleConfigGroup:
+    base_rcg_list = [
+        r
+        for r in RoleConfigGroupsResourceApi(api_client)
+        .read_role_config_groups(
+            cluster_name=cluster_name,
+            service_name=service_name,
+        )
+        .items
+        if (r.base and role_type is None) or (r.base and r.role_type == role_type)
+    ]
+    if role_type is not None:
+        return next(iter(base_rcg_list), None)
+    else:
+        return base_rcg_list
+
 
 def get_mgmt_base_role_config_group(
     api_client: ApiClient, role_type: str

plugins/module_utils/role_utils.py

@@ -33,6 +33,7 @@
     ApiRoleConfigGroupRef,
     ApiRoleNameList,
     ApiRoleState,
+    ServicesResourceApi,
     RoleCommandsResourceApi,
     RoleConfigGroupsResourceApi,
     RolesResourceApi,
@@ -47,6 +48,22 @@ class RoleException(Exception):
     pass
 
 
+class RoleHostNotFoundException(RoleException):
+    pass
+
+
+class RoleConfigGroupNotFoundException(RoleException):
+    pass
+
+
+class RoleMaintenanceStateException(RoleException):
+    pass
+
+
+class InvalidRoleTypeException(RoleException):
+    pass
+
+
 ROLE_OUTPUT = [
     "commission_state",
     "config_staleness_status",
@@ -214,14 +231,6 @@ def read_cm_roles(api_client: ApiClient) -> ApiRoleList:
     return ApiRoleList(items=roles)
 
 
-class HostNotFoundException(RoleException):
-    pass
-
-
-class RoleConfigGroupNotFoundException(RoleException):
-    pass
-
-
 def create_role(
     api_client: ApiClient,
     role_type: str,
@@ -233,14 +242,26 @@ def create_role(
     role_config_group: str = None,
     tags: dict = None,
 ) -> ApiRole:
+    if (
+        role_type.upper()
+        not in ServicesResourceApi(api_client)
+        .list_role_types(
+            cluster_name=cluster_name,
+            service_name=service_name,
+        )
+        .items
+    ):
+        raise InvalidRoleTypeException(
+            f"Invalid role type '{role_type}' for service '{service_name}'"
+        )
 
     # Set up the role type
     role = ApiRole(type=str(role_type).upper())
 
     # Host assignment
     host_ref = get_host_ref(api_client, hostname, host_id)
     if host_ref is None:
-        raise HostNotFoundException(
+        raise RoleHostNotFoundException(
             f"Host not found: hostname='{hostname}', host_id='{host_id}'"
         )
     else:
@@ -315,10 +336,6 @@ def provision_service_role(
         raise RoleException(str(e))
 
 
-class MaintenanceStateException(RoleException):
-    pass
-
-
 def toggle_role_maintenance(
     api_client: ApiClient, role: ApiRole, maintenance: bool, check_mode: bool
 ) -> bool:
@@ -340,7 +357,7 @@ def toggle_role_maintenance(
         )
 
         if maintenance_cmd.success is False:
-            raise MaintenanceStateException(
+            raise RoleMaintenanceStateException(
                 f"Unable to set Maintenance mode to '{maintenance}': {maintenance_cmd.result_message}"
             )