Improve plugin sanity (#966) (#984)

* callback_type -> type. * Mark authors as unknown. * Add author field forgotten in #627. * Fix author entries. * Add author field forgotten in #127. * Fix some types. (cherry picked from commit e5da25915d) Co-authored-by: Felix Fontein <felix@fontein.de>
2024-09-14 20:13:21 +02:00 · 2020-09-29 04:04:05 +00:00 · 2020-09-29 04:04:05 +00:00 · 01bbab6b2c
commit 01bbab6b2c
parent 59a7064392
51 changed files with 63 additions and 31 deletions
--- a/plugins/cache/memcached.py
+++ b/plugins/cache/memcached.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    cache: memcached
    short_description: Use memcached DB for cache
    description:
--- a/plugins/cache/redis.py
+++ b/plugins/cache/redis.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    cache: redis
    short_description: Use Redis DB for cache
    description:
--- a/plugins/callback/actionable.py
+++ b/plugins/callback/actionable.py
@ -7,6 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: actionable
    type: stdout
    short_description: shows only items that need attention
--- a/plugins/callback/cgroup_memory_recap.py
+++ b/plugins/callback/cgroup_memory_recap.py
@ -7,8 +7,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: cgroup_memory_recap
-    callback_type: aggregate
+    type: aggregate
    requirements:
      - whitelist in configuration
      - cgroups
--- a/plugins/callback/context_demo.py
+++ b/plugins/callback/context_demo.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: context_demo
    type: aggregate
    short_description: demo callback that adds play/task context
--- a/plugins/callback/counter_enabled.py
+++ b/plugins/callback/counter_enabled.py
@ -8,6 +8,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: counter_enabled
    type: stdout
    short_description: adds counters to the output items (tasks and hosts/task)
--- a/plugins/callback/diy.py
+++ b/plugins/callback/diy.py
@ -8,7 +8,7 @@ __metaclass__ = type

 DOCUMENTATION = r'''
  callback: diy
-  callback_type: stdout
+  type: stdout
  short_description: Customize the output
  version_added: 0.2.0
  description:
--- a/plugins/callback/full_skip.py
+++ b/plugins/callback/full_skip.py
@ -7,6 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: full_skip
    type: stdout
    short_description: suppresses tasks if all hosts skipped
--- a/plugins/callback/hipchat.py
+++ b/plugins/callback/hipchat.py
@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: hipchat
-    callback_type: notification
+    type: notification
    requirements:
      - whitelist in configuration.
      - prettytable (python lib)
--- a/plugins/callback/jabber.py
+++ b/plugins/callback/jabber.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: jabber
    type: notification
    short_description: post task events to a jabber server
--- a/plugins/callback/log_plays.py
+++ b/plugins/callback/log_plays.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: log_plays
    type: notification
    short_description: write playbook output to log file
--- a/plugins/callback/logdna.py
+++ b/plugins/callback/logdna.py
@ -5,8 +5,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: logdna
-    callback_type: aggregate
+    type: aggregate
    short_description: Sends playbook logs to LogDNA
    description:
      - This callback will report logs from playbook actions, tasks, and events to LogDNA (https://app.logdna.com)
--- a/plugins/callback/logentries.py
+++ b/plugins/callback/logentries.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: logentries
    type: notification
    short_description: Sends events to Logentries
--- a/plugins/callback/logstash.py
+++ b/plugins/callback/logstash.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: logstash
    type: notification
    short_description: Sends events to Logstash
--- a/plugins/callback/null.py
+++ b/plugins/callback/null.py
@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: 'null'
-    callback_type: stdout
+    type: stdout
    requirements:
      - set as main display callback
    short_description: Don't display stuff to screen
--- a/plugins/callback/say.py
+++ b/plugins/callback/say.py
@ -7,6 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: say
    type: notification
    requirements:
--- a/plugins/callback/selective.py
+++ b/plugins/callback/selective.py
@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: selective
-    callback_type: stdout
+    type: stdout
    requirements:
      - set as main display callback
    short_description: only print certain tasks
--- a/plugins/callback/slack.py
+++ b/plugins/callback/slack.py
@ -7,8 +7,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: slack
-    callback_type: notification
+    type: notification
    requirements:
      - whitelist in configuration
      - prettytable (python library)
--- a/plugins/callback/splunk.py
+++ b/plugins/callback/splunk.py
@ -21,7 +21,7 @@ DOCUMENTATION = '''
    callback: splunk
    type: aggregate
    short_description: Sends task result events to Splunk HTTP Event Collector
-    author: "Stuart Hirst <support@convergingdata.com>"
+    author: "Stuart Hirst (!UNKNOWN) <support@convergingdata.com>"
    description:
      - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
      - The companion Splunk Monitoring & Diagnostics App is available here "https://splunkbase.splunk.com/app/4023/"
--- a/plugins/callback/stderr.py
+++ b/plugins/callback/stderr.py
@ -7,8 +7,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: stderr
-    callback_type: stdout
+    type: stdout
    requirements:
      - set as main display callback
    short_description: Splits output, sending failed tasks to stderr
--- a/plugins/callback/syslog_json.py
+++ b/plugins/callback/syslog_json.py
@ -6,8 +6,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: syslog_json
-    callback_type: notification
+    type: notification
    requirements:
      - whitelist in configuration
    short_description: sends JSON events to syslog
--- a/plugins/callback/unixy.py
+++ b/plugins/callback/unixy.py
@ -9,7 +9,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    callback: unixy
    type: stdout
-    author: Allyson Bowles <@akatch>
+    author: Allyson Bowles (@akatch)
    short_description: condensed Ansible output
    description:
      - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
--- a/plugins/callback/yaml.py
+++ b/plugins/callback/yaml.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    callback: yaml
    type: stdout
    short_description: yaml-ized Ansible screen output
--- a/plugins/connection/chroot.py
+++ b/plugins/connection/chroot.py
@ -9,7 +9,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    author: Maykel Moya <mmoya@speedyrails.com>
+    author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
    connection: chroot
    short_description: Interact with local chroot
    description:
--- a/plugins/connection/docker.py
+++ b/plugins/connection/docker.py
@ -11,8 +11,8 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author:
-        - Lorin Hochestein
-        - Leendert Brouwer
+        - Lorin Hochestein (!UNKNOWN)
+        - Leendert Brouwer (!UNKNOWN)
    connection: docker
    short_description: Run tasks in docker containers
    description:
--- a/plugins/connection/iocage.py
+++ b/plugins/connection/iocage.py
@ -9,7 +9,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    author: Stephan Lohse <dev-github@ploek.org>
+    author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
    connection: iocage
    short_description: Run tasks in iocage jails
    description:
--- a/plugins/connection/lxc.py
+++ b/plugins/connection/lxc.py
@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    author: Joerg Thalheim <joerg@higgsboson.tk>
+    author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
    connection: lxc
    short_description: Run tasks in lxc containers via lxc python library
    description:
--- a/plugins/connection/lxd.py
+++ b/plugins/connection/lxd.py
@ -6,7 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
-    author: Matt Clay <matt@mystile.com>
+    author: Matt Clay (@mattclay) <matt@mystile.com>
    connection: lxd
    short_description: Run tasks in lxc containers via lxc CLI
    description:
--- a/plugins/connection/oc.py
+++ b/plugins/connection/oc.py
@ -22,7 +22,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author:
-        - xuxinkun
+        - xuxinkun (!UNKNOWN)

    connection: oc

--- a/plugins/inventory/cobbler.py
+++ b/plugins/inventory/cobbler.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Orion Poplawski (@opoplawski)
    name: cobbler
    plugin_type: inventory
    short_description: Cobbler inventory source
--- a/plugins/inventory/nmap.py
+++ b/plugins/inventory/nmap.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    name: nmap
    plugin_type: inventory
    short_description: Uses nmap to find hosts to target
--- a/plugins/inventory/virtualbox.py
+++ b/plugins/inventory/virtualbox.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    name: virtualbox
    plugin_type: inventory
    short_description: virtualbox inventory source
--- a/plugins/lookup/cartesian.py
+++ b/plugins/lookup/cartesian.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    lookup: cartesian
    short_description: returns the cartesian product of lists
    description:
@ -36,7 +37,8 @@ RETURN = """
  _list:
    description:
      - list of lists composed of elements of the input lists
-    type: lists
+    type: list
+    elements: list
 """

 from itertools import product
--- a/plugins/lookup/chef_databag.py
+++ b/plugins/lookup/chef_databag.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    lookup: chef_databag
    short_description: fetches data from a Chef Databag
    description:
--- a/plugins/lookup/consul_kv.py
+++ b/plugins/lookup/consul_kv.py
@ -6,6 +6,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    lookup: consul_kv
    short_description: Fetch metadata from a Consul key value store.
    description:
--- a/plugins/lookup/credstash.py
+++ b/plugins/lookup/credstash.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    lookup: credstash
    short_description: retrieve secrets from Credstash on AWS
    requirements:
--- a/plugins/lookup/cyberarkpassword.py
+++ b/plugins/lookup/cyberarkpassword.py
@ -5,6 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type

 DOCUMENTATION = '''
+    author: Unknown (!UNKNOWN)
    lookup: cyberarkpassword
    short_description: get secrets from CyberArk AIM
    requirements:
--- a/plugins/lookup/etcd.py
+++ b/plugins/lookup/etcd.py
@ -71,7 +71,7 @@ RETURN = '''
        description:
            - list of values associated with input keys
        type: list
-        elements: strings
+        elements: string
 '''

 import json
--- a/plugins/lookup/etcd3.py
+++ b/plugins/lookup/etcd3.py
@ -8,7 +8,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author:
-    - Eric Belhomme <ebelhomme@fr.scc.com>
+    - Eric Belhomme (@eric-belhomme) <ebelhomme@fr.scc.com>
    version_added: '0.2.0'
    lookup: etcd3
    short_description: Get key values from etcd3 server
--- a/plugins/lookup/flattened.py
+++ b/plugins/lookup/flattened.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    lookup: flattened
-    author: Serge van Ginderachter <serge@vanginderachter.be>
+    author: Serge van Ginderachter (!UNKNOWN) <serge@vanginderachter.be>
    short_description: return single list completely flattened
    description:
      - given one or more lists, this lookup will flatten any list elements found recursively until only 1 list is left.
--- a/plugins/lookup/gcp_storage_file.py
+++ b/plugins/lookup/gcp_storage_file.py
@ -9,7 +9,7 @@ lookup: gcp_storage_file
 description:
  - This lookup returns the contents from a file residing on Google Cloud Storage
 short_description: Return GC Storage content
-author: Eric Anderson <eanderson@avinetworks.com>
+author: Eric Anderson (!UNKNOWN) <eanderson@avinetworks.com>
 requirements:
  - python >= 2.6
  - requests >= 2.18.4
--- a/plugins/lookup/hashi_vault.py
+++ b/plugins/lookup/hashi_vault.py
@ -9,7 +9,7 @@ __metaclass__ = type
 DOCUMENTATION = """
  lookup: hashi_vault
  author:
-    - Jonathan Davila <jdavila(at)ansible.com>
+    - Jonathan Davila (!UNKNOWN) <jdavila(at)ansible.com>
    - Brian Scholer (@briantist)
  short_description: Retrieve secrets from HashiCorp's vault
  requirements:
--- a/plugins/lookup/keyring.py
+++ b/plugins/lookup/keyring.py
@ -8,7 +8,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    lookup: keyring
    author:
-      - Samuel Boucher <boucher.samuel.c@gmail.com>
+      - Samuel Boucher (!UNKNOWN) <boucher.samuel.c@gmail.com>
    requirements:
      - keyring (python library)
    short_description: grab secrets from the OS keyring
--- a/plugins/lookup/lastpass.py
+++ b/plugins/lookup/lastpass.py
@ -7,7 +7,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    lookup: lastpass
    author:
-      -  Andrew Zenk <azenk@umn.edu>
+      - Andrew Zenk (!UNKNOWN) <azenk@umn.edu>
    requirements:
      - lpass (command line utility)
      - must have already logged into lastpass
--- a/plugins/lookup/manifold.py
+++ b/plugins/lookup/manifold.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    author:
-        - Kyrylo Galanov (galanoff@gmail.com)
+        - Kyrylo Galanov (!UNKNOWN) <galanoff@gmail.com>
    lookup: manifold
    short_description: get credentials from Manifold.co
    description:
--- a/plugins/lookup/nios.py
+++ b/plugins/lookup/nios.py
@ -22,6 +22,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
 ---
+author: Unknown (!UNKNOWN)
 lookup: nios
 short_description: Query Infoblox NIOS objects
 description:
@ -83,7 +84,7 @@ RETURN = """
 obj_type:
  description:
    - The object type specified in the terms argument
-  type: complex
+  type: dictionary
  contains:
    obj_field:
      description:
--- a/plugins/lookup/nios_next_ip.py
+++ b/plugins/lookup/nios_next_ip.py
@ -22,6 +22,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
 ---
+author: Unknown (!UNKNOWN)
 lookup: nios_next_ip
 short_description: Return the next available IP address for a network
 description:
--- a/plugins/lookup/nios_next_network.py
+++ b/plugins/lookup/nios_next_network.py
@ -22,6 +22,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
 ---
+author: Unknown (!UNKNOWN)
 lookup: nios_next_network
 short_description: Return the next available network range for a network-container
 description:
--- a/plugins/lookup/passwordstore.py
+++ b/plugins/lookup/passwordstore.py
@ -8,7 +8,7 @@ __metaclass__ = type
 DOCUMENTATION = '''
    lookup: passwordstore
    author:
-      - Patrick Deelman <patrick@patrickdeelman.nl>
+      - Patrick Deelman (!UNKNOWN) <patrick@patrickdeelman.nl>
    short_description: manage passwords with passwordstore.org's pass utility
    description:
      - Enables Ansible to retrieve, create or update passwords from the passwordstore.org pass utility.
--- a/plugins/lookup/redis.py
+++ b/plugins/lookup/redis.py
@ -8,7 +8,7 @@ DOCUMENTATION = '''
    lookup: redis
    author:
      - Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
-      - Ansible Core
+      - Ansible Core Team
    short_description: fetch data from Redis
    description:
      - This lookup returns a list of results from a Redis DB corresponding to a list of items given to it
--- a/plugins/lookup/shelvefile.py
+++ b/plugins/lookup/shelvefile.py
@ -6,7 +6,7 @@ __metaclass__ = type

 DOCUMENTATION = '''
    lookup: shelvefile
-    author: Alejandro Guirao <lekumberri@gmail.com>
+    author: Alejandro Guirao (!UNKNOWN) <lekumberri@gmail.com>
    short_description: read keys from Python shelve file
    description:
      - Read keys from Python shelve file.