From c37be7416c853501ac010b7d617b07f053e95238 Mon Sep 17 00:00:00 2001 From: Thomas Woerner <twoerner@redhat.com> Date: Mon, 7 Nov 2022 13:30:40 +0100 Subject: [PATCH] ipaclient_fstore: 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` - `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_client.check_imports has been added to check for import errors. The `copyright` date is extended with `-2022`. --- roles/ipaclient/library/ipaclient_fstore.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/roles/ipaclient/library/ipaclient_fstore.py b/roles/ipaclient/library/ipaclient_fstore.py index 62f230b7..1b4da4ea 100644 --- a/roles/ipaclient/library/ipaclient_fstore.py +++ b/roles/ipaclient/library/ipaclient_fstore.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,9 +39,10 @@ description: Backup files using IPA client sysrestore options: backup: description: File to backup - required: no + type: str + required: yes author: - - Thomas Woerner + - Thomas Woerner (@t-woerner) ''' EXAMPLES = ''' @@ -55,18 +56,19 @@ RETURN = ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.ansible_ipa_client import ( - setup_logging, paths, sysrestore + setup_logging, check_imports, paths, sysrestore ) def main(): module = AnsibleModule( argument_spec=dict( - backup=dict(required=True), + backup=dict(required=True, type='str'), ), ) module._ansible_debug = True + check_imports(module) setup_logging() backup = module.params.get('backup') -- GitLab