From 3f9acecaf33d73390e3f784079ab84b71cba2cd6 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 14:07:04 +0200
Subject: [PATCH] ipaautomountmap: 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
- `aliases` tag need to be consistent to `argument_spec`
- `extends_documentation_fragment: ipamodule_base_docs` needs added and
`ipaadmin_*` parameters need to be removed
argument_spec
- `elements="str"` needs to be added to all list of string parameters
- `default=.*` needs to be dropped if `required=True` is also given
The `copyright` date is extended with `-2022`.
---
plugins/modules/ipaautomountmap.py | 30 ++++++++++++++++--------------
1 file changed, 16 insertions(+), 14 deletions(-)
diff --git a/plugins/modules/ipaautomountmap.py b/plugins/modules/ipaautomountmap.py
index 67857c62..14d06dd1 100644
--- a/plugins/modules/ipaautomountmap.py
+++ b/plugins/modules/ipaautomountmap.py
@@ -2,8 +2,9 @@
# -*- coding: utf-8 -*-
# Authors:
# Chris Procter <cprocter@redhat.com>
+# Thomas Woerner <twoerner@redhat.com>
#
-# Copyright (C) 2021 Red Hat
+# Copyright (C) 2021-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -33,31 +34,34 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaautomountmap
-author: Chris Procter
+author:
+ - Chris Procter (@chr15p)
+ - Thomas Woerner (@t-woerner)
short_description: Manage FreeIPA autommount map
description:
- Add, delete, and modify an IPA automount map
+extends_documentation_fragment:
+ - ipamodule_base_docs
options:
- ipaadmin_principal:
- description: The admin principal.
- default: admin
- ipaadmin_password:
- description: The admin password.
- required: false
automountlocation:
description: automount location map is anchored to
- choices: ["location", "automountlocationcn"]
+ type: str
+ aliases: ["location", "automountlocationcn"]
required: True
name:
description: automount map to be managed.
- choices: ["mapname", "map", "automountmapname"]
+ type: list
+ elements: str
+ aliases: ["mapname", "map", "automountmapname"]
required: True
desc:
description: description of automount map.
- choices: ["description"]
+ type: str
+ aliases: ["description"]
required: false
state:
description: State to ensure
+ type: str
required: false
default: present
choices: ["present", "absent"]
@@ -169,12 +173,10 @@ def main():
),
location=dict(type="str",
aliases=["automountlocation", "automountlocationcn"],
- default=None,
required=True
),
- name=dict(type="list",
+ name=dict(type="list", elements="str",
aliases=["mapname", "map", "automountmapname"],
- default=None,
required=True
),
desc=dict(type="str",
--
GitLab