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

iparole: 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`
- all parameters need to be defined
- `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`.
parent 07c8bb1e
Branches
Tags
No related merge requests found
...@@ -3,8 +3,9 @@ ...@@ -3,8 +3,9 @@
# Authors: # Authors:
# Rafael Guterres Jeffman <rjeffman@redhat.com> # 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 # 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
...@@ -39,42 +40,66 @@ description: Manage FreeIPA role ...@@ -39,42 +40,66 @@ description: Manage FreeIPA role
extends_documentation_fragment: extends_documentation_fragment:
- ipamodule_base_docs - ipamodule_base_docs
options: options:
role: name:
description: The list of role name strings. description: The list of role name strings.
type: list
elements: str
required: true required: true
aliases: ["cn"] aliases: ["cn"]
description: description:
description: A description for the role. description: A description for the role.
type: str
required: false required: false
rename: rename:
description: Rename the role object. description: Rename the role object.
type: str
required: false required: false
aliases: ["new_name"] aliases: ["new_name"]
privilege:
description: List of privileges
type: list
elements: str
required: false
user: user:
description: List of users. description: List of users.
type: list
elements: str
required: false required: false
group: group:
description: List of groups. description: List of groups.
type: list
elements: str
required: false required: false
host: host:
description: List of hosts. description: List of hosts.
type: list
elements: str
required: false required: false
hostgroup: hostgroup:
description: List of hostgroups. description: List of hostgroups.
type: list
elements: str
required: false required: false
service: service:
description: List of services. description: List of services.
type: list
elements: str
required: false required: false
action: action:
description: Work on role or member level. description: Work on role or member level.
type: str
choices: ["role", "member"] choices: ["role", "member"]
default: role default: role
required: false required: false
state: state:
description: The state to ensure. description: The state to ensure.
type: str
choices: ["present", "absent", "renamed"] choices: ["present", "absent", "renamed"]
default: present default: present
required: true required: false
author:
- Rafael Guterres Jeffman (@rjeffman)
- Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
...@@ -394,19 +419,25 @@ def create_module(): ...@@ -394,19 +419,25 @@ def create_module():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# generalgroups # generalgroups
name=dict(type="list", aliases=["cn"], default=None, name=dict(type="list", elements="str", aliases=["cn"],
required=True), required=True),
# present # present
description=dict(required=False, type="str", default=None), description=dict(required=False, type="str", default=None),
rename=dict(required=False, type="str", default=None, rename=dict(required=False, type="str", default=None,
aliases=["new_name"]), aliases=["new_name"]),
# members # members
privilege=dict(required=False, type='list', default=None), privilege=dict(required=False, type='list', elements="str",
user=dict(required=False, type='list', default=None), default=None),
group=dict(required=False, type='list', default=None), user=dict(required=False, type='list', elements="str",
host=dict(required=False, type='list', default=None), default=None),
hostgroup=dict(required=False, type='list', default=None), group=dict(required=False, type='list', elements="str",
service=dict(required=False, type='list', default=None), default=None),
host=dict(required=False, type='list', elements="str",
default=None),
hostgroup=dict(required=False, type='list', elements="str",
default=None),
service=dict(required=False, type='list', elements="str",
default=None),
# state # state
action=dict(type="str", default="role", action=dict(type="str", default="role",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment