[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 29d1438aca.

(cherry picked from commit aff78f4cbc)

* Undo potentially disrupting normalizations.

* Add changelog fragment for #71736. (#72323)

(cherry picked from commit 0b2b82c0b6)

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)."

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

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
 

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

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

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

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

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
 

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

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

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:

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:

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

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

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

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

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
 

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

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:

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

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

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

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

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:

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

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