From d4d714dcf4fee610f77048465a605bbb377328c4 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 18:09:22 +0200
Subject: [PATCH] ipasudocmd: 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
- `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/ipasudocmd.py | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/plugins/modules/ipasudocmd.py b/plugins/modules/ipasudocmd.py
index 5942d510..ae55092b 100644
--- a/plugins/modules/ipasudocmd.py
+++ b/plugins/modules/ipasudocmd.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,17 +41,22 @@ extends_documentation_fragment:
options:
name:
description: The sudo command
+ type: list
+ elements: str
required: true
aliases: ["sudocmd"]
description:
description: The command description
+ type: str
required: false
state:
description: State to ensure
+ type: str
default: present
choices: ["present", "absent"]
author:
- - Rafael Jeffman
+ - Rafael Guterres Jeffman (@rjeffman)
+ - Thomas Woerner (@t-woerner)
"""
EXAMPLES = """
@@ -103,7 +109,7 @@ def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- name=dict(type="list", aliases=["sudocmd"], default=None,
+ name=dict(type="list", elements="str", aliases=["sudocmd"],
required=True),
# present
description=dict(type="str", default=None),
--
GitLab