From 8c81ac0f5f0b57bd8fa730c353f7e6eb423b03cf Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Tue, 8 Nov 2022 13:03:18 +0100
Subject: [PATCH] ipareplica_add_to_ipaservers: 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
supports_check_mode is turned off as it is not supported.
A call to ansible_ipa_replica.check_imports has been added to check for import
errors.
The `copyright` date is extended with `-2022`.
---
.../library/ipareplica_add_to_ipaservers.py | 32 +++++++++++--------
1 file changed, 19 insertions(+), 13 deletions(-)
diff --git a/roles/ipareplica/library/ipareplica_add_to_ipaservers.py b/roles/ipareplica/library/ipareplica_add_to_ipaservers.py
index e44464c4..66c1615b 100644
--- a/roles/ipareplica/library/ipareplica_add_to_ipaservers.py
+++ b/roles/ipareplica/library/ipareplica_add_to_ipaservers.py
@@ -5,7 +5,7 @@
#
# Based on ipa-replica-install code
#
-# Copyright (C) 2018 Red Hat
+# Copyright (C) 2018-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -40,21 +40,26 @@ description:
options:
setup_kra:
description: Configure a dogtag KRA
- required: no
+ type: bool
+ required: yes
config_master_host_name:
description: The config master_host_name setting
- required: no
+ type: str
+ required: yes
ccache:
description: The local ccache
- required: no
+ type: str
+ required: yes
installer_ccache:
description: The installer ccache setting
- required: no
+ type: str
+ required: yes
_top_dir:
description: The installer _top_dir setting
- required: no
+ type: str
+ required: yes
author:
- - Thomas Woerner
+ - Thomas Woerner (@t-woerner)
'''
EXAMPLES = '''
@@ -67,7 +72,7 @@ import os
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_replica import (
- AnsibleModuleLog, setup_logging, installer, paths,
+ check_imports, AnsibleModuleLog, setup_logging, installer, paths,
gen_env_boostrap_finalize_core, constants, api_bootstrap_finalize,
gen_remote_api, api
)
@@ -84,15 +89,16 @@ def main():
# server
setup_kra=dict(required=True, type='bool'),
# additional
- config_master_host_name=dict(required=True),
- ccache=dict(required=True),
- installer_ccache=dict(required=True),
- _top_dir=dict(required=True),
+ config_master_host_name=dict(required=True, type='str'),
+ ccache=dict(required=True, type='str'),
+ installer_ccache=dict(required=True, type='str'),
+ _top_dir=dict(required=True, type='str'),
),
- supports_check_mode=True,
+ supports_check_mode=False,
)
ansible_module._ansible_debug = True
+ check_imports(ansible_module)
setup_logging()
ansible_log = AnsibleModuleLog(ansible_module)
--
GitLab