ipagroup: 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: int` needs to be set for integer 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`
- `aliases` tag needs to match `argument_spec`
- `authors` 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`.
This commit is contained in:
Thomas Woerner
2022-09-30 15:01:41 +02:00
parent 07c8bb1efb
commit 93c134b68b

View File

@@ -3,7 +3,7 @@
# Authors: # Authors:
# Thomas Woerner <twoerner@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 # 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,13 +39,17 @@ extends_documentation_fragment:
options: options:
name: name:
description: The group name description: The group name
required: false type: list
elements: str
required: true
aliases: ["cn"] aliases: ["cn"]
description: description:
description: The group description description: The group description
type: str
required: false required: false
gid: gid:
description: The GID description: The GID
type: int
required: false required: false
aliases: ["gidnumber"] aliases: ["gidnumber"]
nonposix: nonposix:
@@ -69,49 +73,58 @@ options:
description: List of user names assigned to this group. description: List of user names assigned to this group.
required: false required: false
type: list type: list
elements: str
group: group:
description: List of group names assigned to this group. description: List of group names assigned to this group.
required: false required: false
type: list type: list
elements: str
service: service:
description: description:
- List of service names assigned to this group. - List of service names assigned to this group.
- Only usable with IPA versions 4.7 and up. - Only usable with IPA versions 4.7 and up.
required: false required: false
type: list type: list
elements: str
membermanager_user: membermanager_user:
description: description:
- List of member manager users assigned to this group. - List of member manager users assigned to this group.
- Only usable with IPA versions 4.8.4 and up. - Only usable with IPA versions 4.8.4 and up.
required: false required: false
type: list type: list
elements: str
membermanager_group: membermanager_group:
description: description:
- List of member manager groups assigned to this group. - List of member manager groups assigned to this group.
- Only usable with IPA versions 4.8.4 and up. - Only usable with IPA versions 4.8.4 and up.
required: false required: false
type: list type: list
elements: str
externalmember: externalmember:
description: description:
- List of members of a trusted domain in DOM\\name or name@domain form. - List of members of a trusted domain in DOM\\name or name@domain form.
required: false required: false
type: list type: list
ailases: ["ipaexternalmember", "external_member"] elements: str
aliases: ["ipaexternalmember", "external_member"]
idoverrideuser: idoverrideuser:
description: description:
- User ID overrides to add - User ID overrides to add
required: false required: false
type: list type: list
elements: str
action: action:
description: Work on group or member level description: Work on group or member level
type: str
default: group default: group
choices: ["member", "group"] choices: ["member", "group"]
state: state:
description: State to ensure description: State to ensure
type: str
default: present default: present
choices: ["present", "absent"] choices: ["present", "absent"]
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
@@ -275,7 +288,7 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["cn"], default=None, name=dict(type="list", elements="str", aliases=["cn"],
required=True), required=True),
# present # present
description=dict(type="str", default=None), description=dict(type="str", default=None),
@@ -284,14 +297,20 @@ def main():
external=dict(required=False, type='bool', default=None), external=dict(required=False, type='bool', default=None),
posix=dict(required=False, type='bool', default=None), posix=dict(required=False, type='bool', default=None),
nomembers=dict(required=False, type='bool', default=None), nomembers=dict(required=False, type='bool', default=None),
user=dict(required=False, type='list', default=None), user=dict(required=False, type='list', elements="str",
group=dict(required=False, type='list', default=None), default=None),
service=dict(required=False, type='list', default=None), group=dict(required=False, type='list', elements="str",
idoverrideuser=dict(required=False, type='list', default=None), default=None),
membermanager_user=dict(required=False, type='list', default=None), service=dict(required=False, type='list', elements="str",
default=None),
idoverrideuser=dict(required=False, type='list', elements="str",
default=None),
membermanager_user=dict(required=False, type='list',
elements="str", default=None),
membermanager_group=dict(required=False, type='list', membermanager_group=dict(required=False, type='list',
default=None), elements="str", default=None),
externalmember=dict(required=False, type='list', default=None, externalmember=dict(required=False, type='list', elements="str",
default=None,
aliases=[ aliases=[
"ipaexternalmember", "ipaexternalmember",
"external_member" "external_member"