From 57bedd84a3c38cc5283065ea297b0ced8bf2e3f4 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 17:45:31 +0200
Subject: [PATCH] ipaprivilege: 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`
- `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/ipaprivilege.py | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/plugins/modules/ipaprivilege.py b/plugins/modules/ipaprivilege.py
index 7b4c1df1..4fb810bd 100644
--- a/plugins/modules/ipaprivilege.py
+++ b/plugins/modules/ipaprivilege.py
@@ -2,8 +2,9 @@
# Authors:
# Rafael Guterres Jeffman <rjeffman@redhat.com>
+# Thomas Woerner <twoerner@redhat.com>
#
-# Copyright (C) 2020 Red Hat
+# Copyright (C) 2020-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -42,28 +43,39 @@ extends_documentation_fragment:
options:
name:
description: The list of privilege name strings.
+ type: list
+ elements: str
required: true
aliases: ["cn"]
description:
description: Privilege description
+ type: str
required: false
rename:
description: Rename the privilege object.
+ type: str
required: false
aliases: ["new_name"]
permission:
description: Permissions to be added to the privilege.
+ type: list
+ elements: str
required: false
action:
description: Work on privilege or member level.
+ type: str
choices: ["privilege", "member"]
default: privilege
required: false
state:
description: The state to ensure.
+ type: str
choices: ["present", "absent", "renamed"]
default: present
- required: true
+ required: false
+author:
+ - Rafael Guterres Jeffman (@rjeffman)
+ - Thomas Woerner (@t-woerner)
"""
EXAMPLES = """
@@ -134,13 +146,14 @@ def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- name=dict(type="list", aliases=["cn"],
- default=None, required=True),
+ name=dict(type="list", elements="str", aliases=["cn"],
+ required=True),
# present
description=dict(required=False, type='str', default=None),
rename=dict(required=False, type='str', default=None,
aliases=["new_name"], ),
- permission=dict(required=False, type='list', default=None),
+ permission=dict(required=False, type='list', elements="str",
+ default=None),
action=dict(type="str", default="privilege",
choices=["member", "privilege"]),
# state
--
GitLab