From d962939a6134768946f28f9b2a97add1830cd6c8 Mon Sep 17 00:00:00 2001 From: Thomas Woerner <twoerner@redhat.com> Date: Tue, 8 Nov 2022 16:45:12 +0100 Subject: [PATCH] ipaserver_setup_kra: Fix documentation sections and agument spec ansible-test with ansible-2.14 is adding a lot of new tests to ensure that the documentation section and the agument spec is complete. Needed changes: DOCUMENTATION section - `type: str` needs to be set for string parameters - `required` tags need to be fixed according to the `argument_spec` - `type` tag needs to match `argument_spec` - `author` needs to be given with the github user also: `Name (@user)` argument_spec - `type='str'` needs to be set for string parameters A call to ansible_ipa_server.check_imports has been added to check for import errors. The `copyright` date is extended with `-2022`. --- .../ipaserver/library/ipaserver_setup_kra.py | 33 +++++++++++-------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/roles/ipaserver/library/ipaserver_setup_kra.py b/roles/ipaserver/library/ipaserver_setup_kra.py index 78f1fe26..9f05ef5a 100644 --- a/roles/ipaserver/library/ipaserver_setup_kra.py +++ b/roles/ipaserver/library/ipaserver_setup_kra.py @@ -5,7 +5,7 @@ # # Based on ipa-client-install code # -# Copyright (C) 2017 Red Hat +# Copyright (C) 2017-2022 Red Hat # see file 'COPYING' for use and warranty information # # This program is free software; you can redistribute it and/or modify @@ -39,24 +39,30 @@ description: Setup KRA options: dm_password: description: Directory Manager password - required: no + type: str + required: yes hostname: description: Fully qualified name of this host - required: no + type: str + required: yes setup_ca: description: Configure a dogtag CA - required: no + type: bool + required: yes setup_kra: description: Configure a dogtag KRA - required: no + type: bool + required: yes realm: description: Kerberos realm name of the IPA deployment - required: no + type: str + required: yes pki_config_override: description: Path to ini file with config overrides - required: yes + type: str + required: no author: - - Thomas Woerner + - Thomas Woerner (@t-woerner) ''' EXAMPLES = ''' @@ -67,7 +73,7 @@ RETURN = ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.ansible_ipa_server import ( - AnsibleModuleLog, setup_logging, options, + check_imports, AnsibleModuleLog, setup_logging, options, api_Backend_ldap2, redirect_stdout, api, custodiainstance, kra ) @@ -76,16 +82,17 @@ def main(): ansible_module = AnsibleModule( argument_spec=dict( # basic - dm_password=dict(required=True, no_log=True), - hostname=dict(required=True), + dm_password=dict(required=True, type='str', no_log=True), + hostname=dict(required=True, type='str'), setup_ca=dict(required=True, type='bool'), setup_kra=dict(required=True, type='bool'), - realm=dict(required=True), - pki_config_override=dict(required=False), + realm=dict(required=True, type='str'), + pki_config_override=dict(required=False, type='str'), ), ) ansible_module._ansible_debug = True + check_imports(ansible_module) setup_logging() ansible_log = AnsibleModuleLog(ansible_module) -- GitLab