From 3850c6a0e0d51fb056fcef5cfe4908792c44e50b Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 18:11:06 +0200
Subject: [PATCH] ipasudocmdgroup: 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
- `type: list` needs to be set for list parameters
- `elements: str` needs to be given for list of string parameters
- `required` tags need to be fixed according to the `argument_spec`
- `default` tag needs to match `argument_spec`
- `author` needs to be given with the github user also: `Name (@user)`
argument_spec
- `elements="str"` needs to be added to all list of string parameters
The `copyright` date is extended with `-2022`.
---
plugins/modules/ipasudocmdgroup.py | 21 +++++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)
diff --git a/plugins/modules/ipasudocmdgroup.py b/plugins/modules/ipasudocmdgroup.py
index 2e74fd2f..d6154598 100644
--- a/plugins/modules/ipasudocmdgroup.py
+++ b/plugins/modules/ipasudocmdgroup.py
@@ -2,8 +2,9 @@
# Authors:
# Rafael Guterres Jeffman <rjeffman@redhat.com>
+# Thomas Woerner <twoerner@redhat.com>
#
-# Copyright (C) 2019 Red Hat
+# Copyright (C) 2019-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -40,10 +41,13 @@ extends_documentation_fragment:
options:
name:
description: The sudocmodgroup name
- required: false
+ type: list
+ elements: str
+ required: true
aliases: ["cn"]
description:
description: The sudocmdgroup description
+ type: str
required: false
nomembers:
description: Suppress processing of membership attributes
@@ -53,16 +57,20 @@ options:
description: List of sudocmds assigned to this sudocmdgroup.
required: false
type: list
+ elements: str
action:
description: Work on sudocmdgroup or member level
- default: hostgroup
+ type: str
+ default: sudocmdgroup
choices: ["member", "sudocmdgroup"]
state:
description: State to ensure
+ type: str
default: present
choices: ["present", "absent"]
author:
- - Rafael Guterres Jeffman
+ - Rafael Guterres Jeffman (@rjeffman)
+ - Thomas Woerner (@t-woerner)
"""
EXAMPLES = """
@@ -140,12 +148,13 @@ def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- name=dict(type="list", aliases=["cn"], default=None,
+ name=dict(type="list", elements="str", aliases=["cn"],
required=True),
# present
description=dict(type="str", default=None),
nomembers=dict(required=False, type='bool', default=None),
- sudocmd=dict(required=False, type='list', default=None),
+ sudocmd=dict(required=False, type='list', elements="str",
+ default=None),
action=dict(type="str", default="sudocmdgroup",
choices=["member", "sudocmdgroup"]),
# state
--
GitLab