From 31ee4f9b69f941a715fda6654958a18bc6d8b595 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 27 Aug 2021 14:10:58 +0200
Subject: [PATCH] group: Use IPAAnsibleModule class
ipaadmin_variables are handled by IPAAnsibleModule,
ansible_module.params_get is used to get the parameters and
ansible_module.ipa_connect is used to simplify the module.
---
plugins/modules/ipagroup.py | 85 +++++++++++++------------------------
1 file changed, 30 insertions(+), 55 deletions(-)
diff --git a/plugins/modules/ipagroup.py b/plugins/modules/ipagroup.py
index fa0d8942..c19644c2 100644
--- a/plugins/modules/ipagroup.py
+++ b/plugins/modules/ipagroup.py
@@ -31,13 +31,9 @@ DOCUMENTATION = """
module: ipagroup
short description: Manage FreeIPA groups
description: Manage FreeIPA groups
+extends_documentation_fragment:
+ - ipamodule_base_docs
options:
- ipaadmin_principal:
- description: The admin principal
- default: admin
- ipaadmin_password:
- description: The admin password
- required: false
name:
description: The group name
required: false
@@ -182,10 +178,8 @@ EXAMPLES = """
RETURN = """
"""
-from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.ansible_freeipa_module import temp_kinit, \
- temp_kdestroy, valid_creds, api_connect, api_command, compare_args_ipa, \
- api_check_param, module_params_get, gen_add_del_lists, api_check_command, \
+from ansible.module_utils.ansible_freeipa_module import \
+ IPAAnsibleModule, compare_args_ipa, gen_add_del_lists, \
gen_add_list, gen_intersection_list
@@ -195,7 +189,7 @@ def find_group(module, name):
"cn": name,
}
- _result = api_command(module, "group_find", name, _args)
+ _result = module.ipa_command("group_find", name, _args)
if len(_result["result"]) > 1:
module.fail_json(
@@ -278,12 +272,9 @@ def should_modify_group(module, res_find, args, nonposix, posix, external):
def main():
- ansible_module = AnsibleModule(
+ ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- ipaadmin_principal=dict(type="str", default="admin"),
- ipaadmin_password=dict(type="str", required=False, no_log=True),
-
name=dict(type="list", aliases=["cn"], default=None,
required=True),
# present
@@ -319,31 +310,24 @@ def main():
# Get parameters
# general
- ipaadmin_principal = module_params_get(
- ansible_module,
- "ipaadmin_principal",
- )
- ipaadmin_password = module_params_get(ansible_module, "ipaadmin_password")
- names = module_params_get(ansible_module, "name")
+ names = ansible_module.params_get("name")
# present
- description = module_params_get(ansible_module, "description")
- gid = module_params_get(ansible_module, "gid")
- nonposix = module_params_get(ansible_module, "nonposix")
- external = module_params_get(ansible_module, "external")
- posix = module_params_get(ansible_module, "posix")
- nomembers = module_params_get(ansible_module, "nomembers")
- user = module_params_get(ansible_module, "user")
- group = module_params_get(ansible_module, "group")
- service = module_params_get(ansible_module, "service")
- membermanager_user = module_params_get(ansible_module,
- "membermanager_user")
- membermanager_group = module_params_get(ansible_module,
- "membermanager_group")
- externalmember = module_params_get(ansible_module, "externalmember")
- action = module_params_get(ansible_module, "action")
+ description = ansible_module.params_get("description")
+ gid = ansible_module.params_get("gid")
+ nonposix = ansible_module.params_get("nonposix")
+ external = ansible_module.params_get("external")
+ posix = ansible_module.params_get("posix")
+ nomembers = ansible_module.params_get("nomembers")
+ user = ansible_module.params_get("user")
+ group = ansible_module.params_get("group")
+ service = ansible_module.params_get("service")
+ membermanager_user = ansible_module.params_get("membermanager_user")
+ membermanager_group = ansible_module.params_get("membermanager_group")
+ externalmember = ansible_module.params_get("externalmember")
+ action = ansible_module.params_get("action")
# state
- state = module_params_get(ansible_module, "state")
+ state = ansible_module.params_get("state")
# Check parameters
@@ -378,21 +362,19 @@ def main():
changed = False
exit_args = {}
- ccache_dir = None
- ccache_name = None
- try:
- if not valid_creds(ansible_module, ipaadmin_principal):
- ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
- ipaadmin_password)
- api_connect()
-
- has_add_member_service = api_check_param("group_add_member", "service")
+
+ # Connect to IPA API
+ with ansible_module.ipa_connect():
+
+ has_add_member_service = ansible_module.ipa_command_param_exists(
+ "group_add_member", "service")
if service is not None and not has_add_member_service:
ansible_module.fail_json(
msg="Managing a service as part of a group is not supported "
"by your IPA version")
- has_add_membermanager = api_check_command("group_add_member_manager")
+ has_add_membermanager = ansible_module.ipa_command_exists(
+ "group_add_member_manager")
if ((membermanager_user is not None or
membermanager_group is not None) and not has_add_membermanager):
ansible_module.fail_json(
@@ -684,8 +666,7 @@ def main():
for name, command, args in commands:
try:
- result = api_command(ansible_module, command, name,
- args)
+ result = ansible_module.ipa_command(command, name, args)
if "completed" in result:
if result["completed"] > 0:
changed = True
@@ -706,12 +687,6 @@ def main():
if len(errors) > 0:
ansible_module.fail_json(msg=", ".join(errors))
- except Exception as e:
- ansible_module.fail_json(msg=str(e))
-
- finally:
- temp_kdestroy(ccache_dir, ccache_name)
-
# Done
ansible_module.exit_json(changed=changed, **exit_args)
--
GitLab