From 1239109e4302cce75bba5a5bf40f92898c2a75f0 Mon Sep 17 00:00:00 2001 From: Thomas Woerner <twoerner@redhat.com> Date: Mon, 7 Nov 2022 13:53:42 +0100 Subject: [PATCH] ipaclient_setup_firefox: 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 - `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_client.check_imports has been added to check for import errors. The `copyright` date is extended with `-2022`. --- .../ipaclient/library/ipaclient_setup_firefox.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/roles/ipaclient/library/ipaclient_setup_firefox.py b/roles/ipaclient/library/ipaclient_setup_firefox.py index 276fe615..2852e19d 100644 --- a/roles/ipaclient/library/ipaclient_setup_firefox.py +++ b/roles/ipaclient/library/ipaclient_setup_firefox.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 @@ -40,14 +40,16 @@ description: options: domain: description: Primary DNS domain of the IPA deployment + type: str required: yes firefox_dir: description: Specify directory where Firefox is installed (for example '/usr/lib/firefox') + type: str required: no author: - - Thomas Woerner + - Thomas Woerner (@t-woerner) ''' EXAMPLES = ''' @@ -63,20 +65,21 @@ RETURN = ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.ansible_ipa_client import ( - setup_logging, sysrestore, paths, options, configure_firefox + setup_logging, check_imports, sysrestore, paths, options, configure_firefox ) def main(): module = AnsibleModule( argument_spec=dict( - domain=dict(required=True), - firefox_dir=dict(required=False), + domain=dict(required=True, type='str'), + firefox_dir=dict(required=False, type='str'), ), - supports_check_mode=True, + supports_check_mode=False, ) module._ansible_debug = True + check_imports(module) setup_logging() domain = module.params.get('domain') -- GitLab