1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Improve plugin sanity (#966)

* 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.
This commit is contained in:
Felix Fontein 2020-09-28 21:21:51 +02:00 committed by GitHub
parent 71bbabb96f
commit e5da25915d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
51 changed files with 63 additions and 31 deletions

View file

@ -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:

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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)

View file

@ -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:

View file

@ -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

View file

@ -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)

View file

@ -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

View file

@ -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

View file

@ -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)

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -7,6 +7,7 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
author: Unknown (!UNKNOWN)
callback: say
type: notification
requirements:

View file

@ -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

View file

@ -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)

View file

@ -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/"

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -22,7 +22,7 @@ __metaclass__ = type
DOCUMENTATION = '''
author:
- xuxinkun
- xuxinkun (!UNKNOWN)
connection: oc

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -71,7 +71,7 @@ RETURN = '''
description:
- list of values associated with input keys
type: list
elements: strings
elements: string
'''
import json

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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.

View file

@ -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

View file

@ -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.