Skip to content
Snippets Groups Projects
Commit 1239109e authored by Thomas Woerner's avatar Thomas Woerner
Browse files

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`.
parent 4baeaa1e
No related branches found
No related tags found
No related merge requests found
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
# #
# Based on ipa-client-install code # 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 # see file 'COPYING' for use and warranty information
# #
# This program is free software; you can redistribute it and/or modify # This program is free software; you can redistribute it and/or modify
...@@ -40,14 +40,16 @@ description: ...@@ -40,14 +40,16 @@ description:
options: options:
domain: domain:
description: Primary DNS domain of the IPA deployment description: Primary DNS domain of the IPA deployment
type: str
required: yes required: yes
firefox_dir: firefox_dir:
description: description:
Specify directory where Firefox is installed (for example Specify directory where Firefox is installed (for example
'/usr/lib/firefox') '/usr/lib/firefox')
type: str
required: no required: no
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
''' '''
EXAMPLES = ''' EXAMPLES = '''
...@@ -63,20 +65,21 @@ RETURN = ''' ...@@ -63,20 +65,21 @@ RETURN = '''
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_client import ( 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(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
domain=dict(required=True), domain=dict(required=True, type='str'),
firefox_dir=dict(required=False), firefox_dir=dict(required=False, type='str'),
), ),
supports_check_mode=True, supports_check_mode=False,
) )
module._ansible_debug = True module._ansible_debug = True
check_imports(module)
setup_logging() setup_logging()
domain = module.params.get('domain') domain = module.params.get('domain')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment