Skip to content
Snippets Groups Projects
Unverified Commit 461a9ec0 authored by Thomas Woerner's avatar Thomas Woerner Committed by GitHub
Browse files

Merge pull request #960 from rjeffman/ansbile_2_14_new_module 

new_module: Modify new_module and templates for Ansible 2.14
parents f8ca8a7b 9a8d756a
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
utils/new_module
+ 5
− 2
View file @ 461a9ec0
...@@ -26,7 +26,7 @@ topdir="$(dirname "$0")" ...@@ -26,7 +26,7 @@ topdir="$(dirname "$0")"
function usage() { function usage() {
cat <<EOF cat <<EOF
Usage: $prog [options] <module name> <author name> <author email address> Usage: $prog [options] <module name> <author name> <author email address> <github_user>
Create new ansible-freeipa module using templates. Create new ansible-freeipa module using templates.
...@@ -71,12 +71,14 @@ fi ...@@ -71,12 +71,14 @@ fi
name=$1 name=$1
author=$2 author=$2
email=$3 email=$3
github_user=$4
year=$(date +"%Y") year=$(date +"%Y")
if [ -z "$name" ] || [ -z "$author" ] || [ -z "$email" ]; then if [ -z "$name" ] || [ -z "$author" ] || [ -z "$email" ] || [ -z "$github_user" ]; then
[ -z "$name" ] && echo "ERROR: name is not valid" [ -z "$name" ] && echo "ERROR: name is not valid"
[ -z "$author" ] && echo "ERROR: author is not valid" [ -z "$author" ] && echo "ERROR: author is not valid"
[ -z "$email" ] && echo "ERROR: email is not valid" [ -z "$email" ] && echo "ERROR: email is not valid"
[ -z "$githubuser" ] && echo "ERROR: github_user is not valid"
echo echo
usage; usage;
exit 1; exit 1;
...@@ -143,6 +145,7 @@ function template() { ...@@ -143,6 +145,7 @@ function template() {
-e "s/\${name^}/${name^}/g" \ -e "s/\${name^}/${name^}/g" \
-e "s/\$author/$author/g" \ -e "s/\$author/$author/g" \
-e "s/\$email/$email/" \ -e "s/\$email/$email/" \
-e "s/\$github/$github_user/" \
-e "s/\$year/$year/" \ -e "s/\$year/$year/" \
"$topdir/templates/$s" > "$d" "$topdir/templates/$s" > "$d"
} }
......
utils/templates/README-module+member.md.in
+ 2
− 2
View file @ 461a9ec0
...@@ -119,8 +119,8 @@ Variable | Description | Required ...@@ -119,8 +119,8 @@ Variable | Description | Required
`ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no
`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no
`name` \| `ALIAS` | The list of $name name strings. | yes `name` \| `ALIAS` | The list of $name name strings. | yes
`PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL `PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | TYPE
`PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL `PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | TYPE
`action` | Work on $name or member level. It can be on of `member` or `$name` and defaults to `$name`. | no `action` | Work on $name or member level. It can be on of `member` or `$name` and defaults to `$name`. | no
`state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no `state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no
......
utils/templates/README-module.md.in
+ 2
− 2
View file @ 461a9ec0
...@@ -84,8 +84,8 @@ Variable | Description | Required ...@@ -84,8 +84,8 @@ Variable | Description | Required
`ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no `ipaapi_context` | The context in which the module will execute. Executing in a server context is preferred. If not provided context will be determined by the execution environment. Valid values are `server` and `client`. | no
`ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no `ipaapi_ldap_cache` | Use LDAP cache for IPA connection. The bool setting defaults to yes. (bool) | no
`name` \| `ALIAS` | The list of $name name strings. | yes `name` \| `ALIAS` | The list of $name name strings. | yes
`PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL `PARAMETER1` \| `API_PARAMETER_NAME` | DESCRIPTION | TYPE
`PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | BOOL `PARAMETER2` \| `API_PARAMETER_NAME` | DESCRIPTION | TYPE
`state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no `state` | The state to ensure. It can be one of `present`, `absent`, default: `present`. | no
......
utils/templates/ipamodule+member.py.in
+ 23
− 12
View file @ 461a9ec0
...@@ -41,25 +41,35 @@ options: ...@@ -41,25 +41,35 @@ options:
name: name:
description: The list of $name name strings. description: The list of $name name strings.
required: true required: true
type: list
elements: str
aliases: ["API_PARAMETER_NAME"] aliases: ["API_PARAMETER_NAME"]
PARAMETER1: PARAMETER1:
description: DESCRIPTION description: DESCRIPTION
required: REQUIRED required: false
default: None
type: TYPE
aliases: ["API_PARAMETER_NAME"] aliases: ["API_PARAMETER_NAME"]
PARAMETER2: PARAMETER2:
description: member DESCRIPTION description: member DESCRIPTION
required: REQUIRED required: false
type: list
elements: str
default: None
type: TYPE
aliases: ["API_PARAMETER_NAME"] aliases: ["API_PARAMETER_NAME"]
action: action:
description: Work on $name or member level. description: Work on $name or member level.
choices: ["$name", "member"] choices: ["$name", "member"]
default: $name default: $name
required: false type: str
state: state:
description: The state to ensure. description: The state to ensure.
choices: ["present", "absent"] choices: ["present", "absent"]
default: present default: present
required: true type: str
author:
- $author (@$github)
""" """
EXAMPLES = """ EXAMPLES = """
...@@ -139,17 +149,18 @@ def main(): ...@@ -139,17 +149,18 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["API_PARAMETER_NAME"], name=dict(type="list", elements="str", required=True
default=None, required=True), aliases=["API_PARAMETER_NAME"]),
# present # present
PARAMETER1=dict(required=False, type='str', PARAMETER1=dict(required=False, type="str",
aliases=["API_PARAMETER_NAME"], default=None), default=None, aliases=["API_PARAMETER_NAME"]),
PARAMETER2=dict(required=False, type='list', PARAMETER2=dict(required=False, type='list', elements='str',
aliases=["API_PARAMETER_NAME"], default=None), default=None, aliases=["API_PARAMETER_NAME"]),
action=dict(type="str", default="$name", # action
action=dict(type="str", default="$name", type="str",
choices=["member", "$name"]), choices=["member", "$name"]),
# state # state
state=dict(type="str", default="present", state=dict(type="str", default="present", type="str",
choices=["present", "absent"]), choices=["present", "absent"]),
), ),
supports_check_mode=True, supports_check_mode=True,
......
utils/templates/ipamodule.py.in
+ 12
− 5
View file @ 461a9ec0
...@@ -41,20 +41,27 @@ options: ...@@ -41,20 +41,27 @@ options:
name: name:
description: The list of $name name strings. description: The list of $name name strings.
required: true required: true
type: list
elements: str
aliases: ["API_PARAMETER_NAME"] aliases: ["API_PARAMETER_NAME"]
PARAMETER1: PARAMETER1:
description: DESCRIPTION description: DESCRIPTION
required: REQUIRED required: REQUIRED
type: str
aliases: ["API_PARAMETER_NAME"] aliases: ["API_PARAMETER_NAME"]
PARAMETER2: PARAMETER2:
description: DESCRIPTION description: DESCRIPTION
required: REQUIRED required: REQUIRED
type: list
elements: str
aliases: ["API_PARAMETER_NAME"] aliases: ["API_PARAMETER_NAME"]
state: state:
description: The state to ensure. description: The state to ensure.
choices: ["present", "absent"] choices: ["present", "absent"]
default: present default: present
required: true type: str
author:
- $author (@$github)
""" """
EXAMPLES = """ EXAMPLES = """
...@@ -113,15 +120,15 @@ def main(): ...@@ -113,15 +120,15 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["API_PARAMETER_NAME"], name=dict(type="list", elements="str", required=True,
default=None, required=True), aliases=["API_PARAMETER_NAME"],
# present # present
PARAMETER1=dict(required=False, type='str', PARAMETER1=dict(required=False, type='str',
aliases=["API_PARAMETER_NAME"], default=None), aliases=["API_PARAMETER_NAME"], default=None),
PARAMETER2=dict(required=False, type='list', PARAMETER2=dict(required=False, type='list', elements='str',
aliases=["API_PARAMETER_NAME"], default=None), aliases=["API_PARAMETER_NAME"], default=None),
# state # state
state=dict(type="str", default="present", state=dict(type="str", default="present", type="str",
choices=["present", "absent"]), choices=["present", "absent"]),
), ),
supports_check_mode=True, supports_check_mode=True,
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment