summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelix Fontein <felix@fontein.de>2020-10-24 13:03:18 +0200
committerGitHub <noreply@github.com>2020-10-24 06:03:18 -0500
commit69744aa0a7fdafb6a0b988f66ec835dad39fefbc (patch)
treec0dd2ccf318ea8454ac260bb6117e24df3f1de27
parent8471814f86f90974b33e96c267b59445828120b3 (diff)
downloadansible-69744aa0a7fdafb6a0b988f66ec835dad39fefbc.tar.gz
[2.10] Fix various sanity errors in plugins (#72168)
* Fix various sanity errors in plugins (#71736) * Fix various sanity errors in plugins. * Revert callback_type -> type transform. * Undo paramiko_ssh 'connection' change, since this discrepancy is hardcoded in the plugin loader. * Standardize on name and type (for callbacks). * Fix existing author entries. * Add 'Unknown (!UNKNOWN)' as author when author is missing. * These are actually parsed as integers in the code. * Revert "Add 'Unknown (!UNKNOWN)' as author when author is missing." This reverts commit 29d1438aca4cb1988ac81c9f6cb3c4e0403b5fae. (cherry picked from commit aff78f4cbc9a1afe70ca447e17e4c99582ad16b3) * Undo potentially disrupting normalizations. * Add changelog fragment for #71736. (#72323) (cherry picked from commit 0b2b82c0b6eb6466c18cd6feea2222ec756b8f48)
-rw-r--r--changelogs/fragments/url-lookup-ini.yml2
-rw-r--r--lib/ansible/plugins/inventory/auto.py3
-rw-r--r--lib/ansible/plugins/inventory/toml.py2
-rw-r--r--lib/ansible/plugins/lookup/config.py3
-rw-r--r--lib/ansible/plugins/lookup/csvfile.py2
-rw-r--r--lib/ansible/plugins/lookup/file.py4
-rw-r--r--lib/ansible/plugins/lookup/fileglob.py4
-rw-r--r--lib/ansible/plugins/lookup/first_found.py4
-rw-r--r--lib/ansible/plugins/lookup/indexed_items.py3
-rw-r--r--lib/ansible/plugins/lookup/ini.py4
-rw-r--r--lib/ansible/plugins/lookup/inventory_hostnames.py4
-rw-r--r--lib/ansible/plugins/lookup/items.py2
-rw-r--r--lib/ansible/plugins/lookup/lines.py4
-rw-r--r--lib/ansible/plugins/lookup/list.py4
-rw-r--r--lib/ansible/plugins/lookup/password.py8
-rw-r--r--lib/ansible/plugins/lookup/pipe.py4
-rw-r--r--lib/ansible/plugins/lookup/random_choice.py3
-rw-r--r--lib/ansible/plugins/lookup/sequence.py11
-rw-r--r--lib/ansible/plugins/lookup/subelements.py2
-rw-r--r--lib/ansible/plugins/lookup/template.py4
-rw-r--r--lib/ansible/plugins/lookup/together.py4
-rw-r--r--lib/ansible/plugins/lookup/unvault.py4
-rw-r--r--lib/ansible/plugins/lookup/url.py20
-rw-r--r--lib/ansible/plugins/lookup/varnames.py2
-rw-r--r--lib/ansible/plugins/lookup/vars.py4
-rw-r--r--lib/ansible/plugins/strategy/debug.py2
26 files changed, 74 insertions, 39 deletions
diff --git a/changelogs/fragments/url-lookup-ini.yml b/changelogs/fragments/url-lookup-ini.yml
new file mode 100644
index 0000000000..0d8b68349b
--- /dev/null
+++ b/changelogs/fragments/url-lookup-ini.yml
@@ -0,0 +1,2 @@
+bugfixes:
+- "url lookup - make sure that options supplied in ansible.cfg are actually used (https://github.com/ansible/ansible/pull/71736)."
diff --git a/lib/ansible/plugins/inventory/auto.py b/lib/ansible/plugins/inventory/auto.py
index cf4ed0c347..bbb52bae5a 100644
--- a/lib/ansible/plugins/inventory/auto.py
+++ b/lib/ansible/plugins/inventory/auto.py
@@ -8,7 +8,8 @@ DOCUMENTATION = '''
name: auto
plugin_type: inventory
author:
- - Matt Davis <@nitzmahone>
+ - Matt Davis (@nitzmahone)
+ version_added: "2.5"
short_description: Loads and executes an inventory plugin specified in a YAML config
description:
- By whitelisting C(auto) inventory plugin, any YAML inventory config file with a
diff --git a/lib/ansible/plugins/inventory/toml.py b/lib/ansible/plugins/inventory/toml.py
index 8a3e7f7a62..26ad600ae8 100644
--- a/lib/ansible/plugins/inventory/toml.py
+++ b/lib/ansible/plugins/inventory/toml.py
@@ -159,7 +159,7 @@ class InventoryModule(BaseFileInventoryPlugin):
NAME = 'toml'
def _parse_group(self, group, group_data):
- if not isinstance(group_data, (MutableMapping, type(None))):
+ if group_data is not None and not isinstance(group_data, MutableMapping):
self.display.warning("Skipping '%s' as this is not a valid group definition" % group)
return
diff --git a/lib/ansible/plugins/lookup/config.py b/lib/ansible/plugins/lookup/config.py
index 20ec25427f..ceea80c3d8 100644
--- a/lib/ansible/plugins/lookup/config.py
+++ b/lib/ansible/plugins/lookup/config.py
@@ -5,7 +5,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: config
- author: Ansible Core
+ author: Ansible Core Team
version_added: "2.5"
short_description: Lookup current Ansible configuration values
description:
@@ -53,6 +53,7 @@ RETURN = """
_raw:
description:
- value(s) of the key(s) in the config
+ type: raw
"""
from ansible import constants as C
diff --git a/lib/ansible/plugins/lookup/csvfile.py b/lib/ansible/plugins/lookup/csvfile.py
index 03d9e6e9f5..af76ed1b08 100644
--- a/lib/ansible/plugins/lookup/csvfile.py
+++ b/lib/ansible/plugins/lookup/csvfile.py
@@ -56,6 +56,8 @@ RETURN = """
_raw:
description:
- value(s) stored in file column
+ type: list
+ elements: str
"""
import codecs
diff --git a/lib/ansible/plugins/lookup/file.py b/lib/ansible/plugins/lookup/file.py
index 3ce41559bd..7b426a6c52 100644
--- a/lib/ansible/plugins/lookup/file.py
+++ b/lib/ansible/plugins/lookup/file.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: file
- author: Daniel Hokka Zakrisson <daniel@hozac.com>
+ author: Daniel Hokka Zakrisson (!UNKNOWN) <daniel@hozac.com>
version_added: "0.9"
short_description: read file contents
description:
@@ -45,6 +45,8 @@ RETURN = """
_raw:
description:
- content of file(s)
+ type: list
+ elements: str
"""
from ansible.errors import AnsibleError, AnsibleParserError
diff --git a/lib/ansible/plugins/lookup/fileglob.py b/lib/ansible/plugins/lookup/fileglob.py
index 05628defd8..aa5d7d34d8 100644
--- a/lib/ansible/plugins/lookup/fileglob.py
+++ b/lib/ansible/plugins/lookup/fileglob.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: fileglob
- author: Michael DeHaan <michael.dehaan@gmail.com>
+ author: Michael DeHaan
version_added: "1.4"
short_description: list files matching a pattern
description:
@@ -41,6 +41,8 @@ RETURN = """
_list:
description:
- list of files
+ type: list
+ elements: path
"""
import os
diff --git a/lib/ansible/plugins/lookup/first_found.py b/lib/ansible/plugins/lookup/first_found.py
index 1668f51f2b..54bc6849ca 100644
--- a/lib/ansible/plugins/lookup/first_found.py
+++ b/lib/ansible/plugins/lookup/first_found.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: first_found
- author: Seth Vidal <skvidal@fedoraproject.org>
+ author: Seth Vidal (!UNKNOWN) <skvidal@fedoraproject.org>
version_added: historical
short_description: return first file found from list
description:
@@ -99,6 +99,8 @@ RETURN = """
_raw:
description:
- path to file found
+ type: list
+ elements: path
"""
import os
diff --git a/lib/ansible/plugins/lookup/indexed_items.py b/lib/ansible/plugins/lookup/indexed_items.py
index cd25ba15fa..967e3999bf 100644
--- a/lib/ansible/plugins/lookup/indexed_items.py
+++ b/lib/ansible/plugins/lookup/indexed_items.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: indexed_items
- author: Michael DeHaan <michael.dehaan@gmail.com>
+ author: Michael DeHaan
version_added: "1.3"
short_description: rewrites lists to return 'indexed items'
description:
@@ -31,6 +31,7 @@ RETURN = """
description:
- list with each item.0 giving you the position and item.1 the value
type: list
+ elements: list
"""
from ansible.errors import AnsibleError
diff --git a/lib/ansible/plugins/lookup/ini.py b/lib/ansible/plugins/lookup/ini.py
index f886a8d9b1..b53468b363 100644
--- a/lib/ansible/plugins/lookup/ini.py
+++ b/lib/ansible/plugins/lookup/ini.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: ini
- author: Yannig Perre <yannig.perre(at)gmail.com>
+ author: Yannig Perre (!UNKNOWN) <yannig.perre(at)gmail.com>
version_added: "2.0"
short_description: read data from a ini file
description:
@@ -56,6 +56,8 @@ RETURN = """
_raw:
description:
- value(s) of the key(s) in the ini file
+ type: list
+ elements: str
"""
import os
import re
diff --git a/lib/ansible/plugins/lookup/inventory_hostnames.py b/lib/ansible/plugins/lookup/inventory_hostnames.py
index 001abdbab3..a9f521cc00 100644
--- a/lib/ansible/plugins/lookup/inventory_hostnames.py
+++ b/lib/ansible/plugins/lookup/inventory_hostnames.py
@@ -9,8 +9,8 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: inventory_hostnames
author:
- - Michael DeHaan <michael.dehaan@gmail.com>
- - Steven Dossett <sdossett@panath.com>
+ - Michael DeHaan
+ - Steven Dossett (!UNKNOWN) <sdossett@panath.com>
version_added: "1.3"
short_description: list of inventory hosts matching a host pattern
description:
diff --git a/lib/ansible/plugins/lookup/items.py b/lib/ansible/plugins/lookup/items.py
index 6a4299e70b..3410e74624 100644
--- a/lib/ansible/plugins/lookup/items.py
+++ b/lib/ansible/plugins/lookup/items.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: items
- author: Michael DeHaan <michael.dehaan@gmail.com>
+ author: Michael DeHaan
version_added: historical
short_description: list of items
description:
diff --git a/lib/ansible/plugins/lookup/lines.py b/lib/ansible/plugins/lookup/lines.py
index 2707d6cbf3..b7fb875b30 100644
--- a/lib/ansible/plugins/lookup/lines.py
+++ b/lib/ansible/plugins/lookup/lines.py
@@ -7,7 +7,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: lines
- author: Daniel Hokka Zakrisson <daniel@hozac.com>
+ author: Daniel Hokka Zakrisson (!UNKNOWN) <daniel@hozac.com>
version_added: "0.9"
short_description: read lines from command
description:
@@ -37,6 +37,8 @@ RETURN = """
_list:
description:
- lines of stdout from command
+ type: list
+ elements: str
"""
import subprocess
diff --git a/lib/ansible/plugins/lookup/list.py b/lib/ansible/plugins/lookup/list.py
index 60ea53151a..e57cdd64b9 100644
--- a/lib/ansible/plugins/lookup/list.py
+++ b/lib/ansible/plugins/lookup/list.py
@@ -8,7 +8,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: list
- author: Ansible core team
+ author: Ansible Core Team
version_added: "2.0"
short_description: simply returns what it is given.
description:
@@ -27,6 +27,8 @@ EXAMPLES = """
RETURN = """
_list:
description: basically the same as you fed in
+ type: list
+ elements: raw
"""
from ansible.module_utils.common._collections_compat import Sequence
diff --git a/lib/ansible/plugins/lookup/password.py b/lib/ansible/plugins/lookup/password.py
index 21ab78ec05..81b5d5004f 100644
--- a/lib/ansible/plugins/lookup/password.py
+++ b/lib/ansible/plugins/lookup/password.py
@@ -10,9 +10,9 @@ DOCUMENTATION = """
lookup: password
version_added: "1.1"
author:
- - Daniel Hokka Zakrisson <daniel@hozac.com>
- - Javier Candeira <javier@candeira.com>
- - Maykel Moya <mmoya@speedyrails.com>
+ - Daniel Hokka Zakrisson (!UNKNOWN) <daniel@hozac.com>
+ - Javier Candeira (!UNKNOWN) <javier@candeira.com>
+ - Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
short_description: retrieve or generate a random password, stored in a file
description:
- Generates a random plaintext password and stores it in a file at a given filepath.
@@ -90,6 +90,8 @@ RETURN = """
_raw:
description:
- a password
+ type: list
+ elements: str
"""
import os
diff --git a/lib/ansible/plugins/lookup/pipe.py b/lib/ansible/plugins/lookup/pipe.py
index 94ad010434..a640a0cff6 100644
--- a/lib/ansible/plugins/lookup/pipe.py
+++ b/lib/ansible/plugins/lookup/pipe.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = r"""
lookup: pipe
- author: Daniel Hokka Zakrisson <daniel@hozac.com>
+ author: Daniel Hokka Zakrisson (!UNKNOWN) <daniel@hozac.com>
version_added: "0.9"
short_description: read output from a command
description:
@@ -40,6 +40,8 @@ RETURN = r"""
_string:
description:
- stdout from command
+ type: list
+ elements: str
"""
import subprocess
diff --git a/lib/ansible/plugins/lookup/random_choice.py b/lib/ansible/plugins/lookup/random_choice.py
index 05b4080d48..348a41d617 100644
--- a/lib/ansible/plugins/lookup/random_choice.py
+++ b/lib/ansible/plugins/lookup/random_choice.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: random_choice
- author: Michael DeHaan <michael.dehaan@gmail.com>
+ author: Michael DeHaan
version_added: "1.1"
short_description: return random element from list
description:
@@ -30,6 +30,7 @@ RETURN = """
_raw:
description:
- random item
+ type: raw
"""
import random
diff --git a/lib/ansible/plugins/lookup/sequence.py b/lib/ansible/plugins/lookup/sequence.py
index 12625c0505..ddf656762e 100644
--- a/lib/ansible/plugins/lookup/sequence.py
+++ b/lib/ansible/plugins/lookup/sequence.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: sequence
- author: Jayson Vantuyl <jayson@aggressive.ly>
+ author: Jayson Vantuyl (!UNKNOWN) <jayson@aggressive.ly>
version_added: "1.0"
short_description: generate a list based on a number sequence
description:
@@ -21,18 +21,18 @@ DOCUMENTATION = """
start:
description: number at which to start the sequence
default: 0
- type: number
+ type: integer
end:
description: number at which to end the sequence, dont use this with count
- type: number
+ type: integer
default: 0
count:
description: number of elements in the sequence, this is not to be used with end
- type: number
+ type: integer
default: 0
stride:
description: increments between sequence numbers, the default is 1 unless the end is less than the start, then it is -1.
- type: number
+ type: integer
format:
description: return a string with the generated number formatted in
"""
@@ -74,6 +74,7 @@ RETURN = """
description:
- A list containing generated sequence of items
type: list
+ elements: str
"""
from re import compile as re_compile, IGNORECASE
diff --git a/lib/ansible/plugins/lookup/subelements.py b/lib/ansible/plugins/lookup/subelements.py
index a948f0204e..b05856bf47 100644
--- a/lib/ansible/plugins/lookup/subelements.py
+++ b/lib/ansible/plugins/lookup/subelements.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: subelements
- author: Serge van Ginderachter <serge@vanginderachter.be>
+ author: Serge van Ginderachter (!UNKNOWN) <serge@vanginderachter.be>
version_added: "1.4"
short_description: traverse nested key from a list of dictionaries
description:
diff --git a/lib/ansible/plugins/lookup/template.py b/lib/ansible/plugins/lookup/template.py
index 666fe91ecd..dd4a274916 100644
--- a/lib/ansible/plugins/lookup/template.py
+++ b/lib/ansible/plugins/lookup/template.py
@@ -7,7 +7,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: template
- author: Michael DeHaan <michael.dehaan@gmail.com>
+ author: Michael DeHaan
version_added: "0.9"
short_description: retrieve contents of file after templating with Jinja2
description:
@@ -43,6 +43,8 @@ EXAMPLES = """
RETURN = """
_raw:
description: file(s) content after templating
+ type: list
+ elements: raw
"""
from copy import deepcopy
diff --git a/lib/ansible/plugins/lookup/together.py b/lib/ansible/plugins/lookup/together.py
index 1234ac6204..a20e205aa2 100644
--- a/lib/ansible/plugins/lookup/together.py
+++ b/lib/ansible/plugins/lookup/together.py
@@ -6,7 +6,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: together
- author: Bradley Young <young.bradley@gmail.com>
+ author: Bradley Young (!UNKNOWN) <young.bradley@gmail.com>
version_added: '1.3'
short_description: merges lists into synchronized list
description:
@@ -32,6 +32,8 @@ EXAMPLES = """
RETURN = """
_list:
description: synchronized list
+ type: list
+ elements: list
"""
from ansible.errors import AnsibleError
from ansible.module_utils.six.moves import zip_longest
diff --git a/lib/ansible/plugins/lookup/unvault.py b/lib/ansible/plugins/lookup/unvault.py
index 820da6c2d8..234a52a791 100644
--- a/lib/ansible/plugins/lookup/unvault.py
+++ b/lib/ansible/plugins/lookup/unvault.py
@@ -5,7 +5,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: unvault
- author: ansible core team
+ author: Ansible Core Team
version_added: "2.10"
short_description: read vaulted file(s) contents
description:
@@ -26,6 +26,8 @@ RETURN = """
_raw:
description:
- content of file(s) as bytes
+ type: list
+ elements: raw
"""
from ansible.errors import AnsibleParserError
diff --git a/lib/ansible/plugins/lookup/url.py b/lib/ansible/plugins/lookup/url.py
index 3896c8b57c..1c24ebf8e5 100644
--- a/lib/ansible/plugins/lookup/url.py
+++ b/lib/ansible/plugins/lookup/url.py
@@ -50,7 +50,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_FORCE
ini:
- section: url_lookup
- - key: force
+ key: force
timeout:
description: How long to wait for the server to send data before giving up
type: float
@@ -62,7 +62,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_TIMEOUT
ini:
- section: url_lookup
- - key: timeout
+ key: timeout
http_agent:
description: User-Agent to use in the request
type: string
@@ -73,7 +73,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_AGENT
ini:
- section: url_lookup
- - key: agent
+ key: agent
force_basic_auth:
description: Force basic authentication
type: boolean
@@ -85,7 +85,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_AGENT
ini:
- section: url_lookup
- - key: agent
+ key: agent
follow_redirects:
description: String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information
type: string
@@ -97,7 +97,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS
ini:
- section: url_lookup
- - key: follow_redirects
+ key: follow_redirects
use_gssapi:
description: Use GSSAPI handler of requests
type: boolean
@@ -109,7 +109,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_USE_GSSAPI
ini:
- section: url_lookup
- - key: use_gssapi
+ key: use_gssapi
unix_socket:
description: String of file system path to unix socket file to use when establishing connection to the provided url
type: string
@@ -120,7 +120,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_UNIX_SOCKET
ini:
- section: url_lookup
- - key: unix_socket
+ key: unix_socket
ca_path:
description: String of file system path to CA cert bundle to use
type: string
@@ -131,7 +131,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_CA_PATH
ini:
- section: url_lookup
- - key: ca_path
+ key: ca_path
unredirected_headers:
description: A list of headers to not attach on a redirected request
type: list
@@ -142,7 +142,7 @@ options:
- name: ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS
ini:
- section: url_lookup
- - key: unredirected_headers
+ key: unredirected_headers
"""
EXAMPLES = """
@@ -166,6 +166,8 @@ EXAMPLES = """
RETURN = """
_list:
description: list of list of lines or content of url(s)
+ type: list
+ elements: str
"""
from ansible.errors import AnsibleError
diff --git a/lib/ansible/plugins/lookup/varnames.py b/lib/ansible/plugins/lookup/varnames.py
index c786903dd8..32862951c6 100644
--- a/lib/ansible/plugins/lookup/varnames.py
+++ b/lib/ansible/plugins/lookup/varnames.py
@@ -5,7 +5,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: varnames
- author: Ansible Core
+ author: Ansible Core Team
version_added: "2.8"
short_description: Lookup matching variable names
description:
diff --git a/lib/ansible/plugins/lookup/vars.py b/lib/ansible/plugins/lookup/vars.py
index 5895b93f9f..da3848ba70 100644
--- a/lib/ansible/plugins/lookup/vars.py
+++ b/lib/ansible/plugins/lookup/vars.py
@@ -5,7 +5,7 @@ __metaclass__ = type
DOCUMENTATION = """
lookup: vars
- author: Ansible Core
+ author: Ansible Core Team
version_added: "2.5"
short_description: Lookup templated value of variables
description:
@@ -63,6 +63,8 @@ RETURN = """
_value:
description:
- value of the variables requested.
+ type: list
+ elements: raw
"""
from ansible.errors import AnsibleError, AnsibleUndefinedVariable
diff --git a/lib/ansible/plugins/strategy/debug.py b/lib/ansible/plugins/strategy/debug.py
index 5daea894b2..1b23c7dfe6 100644
--- a/lib/ansible/plugins/strategy/debug.py
+++ b/lib/ansible/plugins/strategy/debug.py
@@ -21,7 +21,7 @@ DOCUMENTATION = '''
description:
- Task execution is 'linear' but controlled by an interactive debug session.
version_added: "2.1"
- author: Kishin Yagami
+ author: Kishin Yagami (!UNKNOWN)
'''
import cmd