441 lines
18 KiB
Python
441 lines
18 KiB
Python
# (c) 2014, James Tanner <tanner.jc@gmail.com>
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# ansible-vault is a script that encrypts/decrypts YAML files. See
|
|
# http://docs.ansible.com/playbooks_vault.html for more details.
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import datetime
|
|
import os
|
|
import textwrap
|
|
import traceback
|
|
import yaml
|
|
|
|
from ansible import constants as C
|
|
from ansible.cli import CLI
|
|
from ansible.errors import AnsibleError, AnsibleOptionsError
|
|
from ansible.module_utils.six import string_types
|
|
from ansible.parsing.yaml.dumper import AnsibleDumper
|
|
from ansible.plugins import module_loader, action_loader, lookup_loader, callback_loader, cache_loader, connection_loader, strategy_loader, PluginLoader
|
|
from ansible.utils import plugin_docs
|
|
try:
|
|
from __main__ import display
|
|
except ImportError:
|
|
from ansible.utils.display import Display
|
|
display = Display()
|
|
|
|
|
|
class DocCLI(CLI):
|
|
''' displays information on modules installed in Ansible libraries.
|
|
It displays a terse listing of plugins and their short descriptions,
|
|
provides a printout of their DOCUMENTATION strings,
|
|
and it can create a short "snippet" which can be pasted into a playbook. '''
|
|
|
|
def __init__(self, args):
|
|
|
|
super(DocCLI, self).__init__(args)
|
|
self.plugin_list = set()
|
|
|
|
def parse(self):
|
|
|
|
self.parser = CLI.base_parser(
|
|
usage='usage: %prog [options] [plugin]',
|
|
module_opts=True,
|
|
desc="plugin documentation tool",
|
|
epilog="See man pages for Ansible CLI options or website for tutorials https://docs.ansible.com"
|
|
)
|
|
|
|
self.parser.add_option("-l", "--list", action="store_true", default=False, dest='list_dir',
|
|
help='List available plugins')
|
|
self.parser.add_option("-s", "--snippet", action="store_true", default=False, dest='show_snippet',
|
|
help='Show playbook snippet for specified plugin(s)')
|
|
self.parser.add_option("-a", "--all", action="store_true", default=False, dest='all_plugins',
|
|
help='Show documentation for all plugins')
|
|
self.parser.add_option("-t", "--type", action="store", default='module', dest='type', type='choice',
|
|
help='Choose which plugin type', choices=['cache', 'callback', 'connection', 'inventory', 'lookup', 'module', 'strategy'])
|
|
|
|
super(DocCLI, self).parse()
|
|
|
|
display.verbosity = self.options.verbosity
|
|
|
|
def run(self):
|
|
|
|
super(DocCLI, self).run()
|
|
|
|
plugin_type = self.options.type
|
|
|
|
# choose plugin type
|
|
if plugin_type == 'cache':
|
|
loader = cache_loader
|
|
elif plugin_type == 'callback':
|
|
loader = callback_loader
|
|
elif plugin_type == 'connection':
|
|
loader = connection_loader
|
|
elif plugin_type == 'lookup':
|
|
loader = lookup_loader
|
|
elif plugin_type == 'strategy':
|
|
loader = strategy_loader
|
|
elif plugin_type == 'inventory':
|
|
loader = PluginLoader('InventoryModule', 'ansible.plugins.inventory', 'inventory_plugins', 'inventory_plugins')
|
|
else:
|
|
loader = module_loader
|
|
|
|
# add to plugin path from command line
|
|
if self.options.module_path is not None:
|
|
for i in self.options.module_path.split(os.pathsep):
|
|
loader.add_directory(i)
|
|
|
|
# list plugins for type
|
|
if self.options.list_dir:
|
|
paths = loader._get_paths()
|
|
for path in paths:
|
|
self.find_plugins(path, plugin_type)
|
|
|
|
self.pager(self.get_plugin_list_text(loader))
|
|
return 0
|
|
|
|
# process all plugins of type
|
|
if self.options.all_plugins:
|
|
paths = loader._get_paths()
|
|
for path in paths:
|
|
self.find_plugins(path, plugin_type)
|
|
|
|
if len(self.args) == 0:
|
|
raise AnsibleOptionsError("Incorrect options passed")
|
|
|
|
# process command line list
|
|
text = ''
|
|
for plugin in self.args:
|
|
|
|
try:
|
|
# if the plugin lives in a non-python file (eg, win_X.ps1), require the corresponding python file for docs
|
|
filename = loader.find_plugin(plugin, mod_type='.py', ignore_deprecated=True)
|
|
if filename is None:
|
|
display.warning("%s %s not found in %s\n" % (plugin_type, plugin, DocCLI.print_paths(loader)))
|
|
continue
|
|
|
|
if any(filename.endswith(x) for x in C.BLACKLIST_EXTS):
|
|
continue
|
|
|
|
try:
|
|
doc, plainexamples, returndocs, metadata = plugin_docs.get_docstring(filename, verbose=(self.options.verbosity > 0))
|
|
except:
|
|
display.vvv(traceback.format_exc())
|
|
display.error("%s %s has a documentation error formatting or is missing documentation." % (plugin_type, plugin))
|
|
continue
|
|
|
|
if doc is not None:
|
|
|
|
# assign from other sections
|
|
doc['plainexamples'] = plainexamples
|
|
doc['returndocs'] = returndocs
|
|
doc['metadata'] = metadata
|
|
|
|
# generate extra data
|
|
if plugin_type == 'module':
|
|
# is there corresponding action plugin?
|
|
if plugin in action_loader:
|
|
doc['action'] = True
|
|
else:
|
|
doc['action'] = False
|
|
doc['filename'] = filename
|
|
doc['now_date'] = datetime.date.today().strftime('%Y-%m-%d')
|
|
doc['docuri'] = doc[plugin_type].replace('_', '-')
|
|
|
|
if self.options.show_snippet and plugin_type == 'module':
|
|
text += self.get_snippet_text(doc)
|
|
else:
|
|
text += self.get_man_text(doc)
|
|
else:
|
|
# this typically means we couldn't even parse the docstring, not just that the YAML is busted,
|
|
# probably a quoting issue.
|
|
raise AnsibleError("Parsing produced an empty object.")
|
|
except Exception as e:
|
|
display.vvv(traceback.format_exc())
|
|
raise AnsibleError("%s %s missing documentation (or could not parse documentation): %s\n" % (plugin_type, plugin, str(e)))
|
|
|
|
if text:
|
|
self.pager(text)
|
|
return 0
|
|
|
|
def find_plugins(self, path, ptype):
|
|
|
|
display.vvvv("Searching %s for plugins" % path)
|
|
|
|
if not os.path.exists(path):
|
|
display.vvvv("%s does not exist" % path)
|
|
return
|
|
|
|
bkey = ptype.upper()
|
|
for plugin in os.listdir(path):
|
|
display.vvvv("Found %s" % plugin)
|
|
full_path = '/'.join([path, plugin])
|
|
|
|
if plugin.startswith('.'):
|
|
continue
|
|
elif os.path.isdir(full_path):
|
|
continue
|
|
elif any(plugin.endswith(x) for x in C.BLACKLIST_EXTS):
|
|
continue
|
|
elif plugin.startswith('__'):
|
|
continue
|
|
elif plugin in C.IGNORE_FILES:
|
|
continue
|
|
elif plugin .startswith('_'):
|
|
if os.path.islink(full_path): # avoids aliases
|
|
continue
|
|
|
|
plugin = os.path.splitext(plugin)[0] # removes the extension
|
|
plugin = plugin.lstrip('_') # remove underscore from deprecated plugins
|
|
|
|
if plugin not in plugin_docs.BLACKLIST.get(bkey, ()):
|
|
self.plugin_list.add(plugin)
|
|
display.vvvv("Added %s" % plugin)
|
|
|
|
def get_plugin_list_text(self, loader):
|
|
columns = display.columns
|
|
displace = max(len(x) for x in self.plugin_list)
|
|
linelimit = columns - displace - 5
|
|
text = []
|
|
deprecated = []
|
|
for plugin in sorted(self.plugin_list):
|
|
|
|
# if the module lives in a non-python file (eg, win_X.ps1), require the corresponding python file for docs
|
|
filename = loader.find_plugin(plugin, mod_type='.py', ignore_deprecated=True)
|
|
|
|
if filename is None:
|
|
continue
|
|
if filename.endswith(".ps1"):
|
|
continue
|
|
if os.path.isdir(filename):
|
|
continue
|
|
|
|
try:
|
|
doc, plainexamples, returndocs, metadata = plugin_docs.get_docstring(filename)
|
|
except:
|
|
display.warning("%s has a documentation formatting error" % plugin)
|
|
|
|
if not doc:
|
|
desc = 'UNDOCUMENTED'
|
|
display.warning("%s parsing did not produce documentation." % plugin)
|
|
else:
|
|
desc = self.tty_ify(doc.get('short_description', '?')).strip()
|
|
|
|
if len(desc) > linelimit:
|
|
desc = desc[:linelimit] + '...'
|
|
|
|
if plugin.startswith('_'): # Handle deprecated
|
|
deprecated.append("%-*s %-*.*s" % (displace, plugin[1:], linelimit, len(desc), desc))
|
|
else:
|
|
text.append("%-*s %-*.*s" % (displace, plugin, linelimit, len(desc), desc))
|
|
|
|
if len(deprecated) > 0:
|
|
text.append("\nDEPRECATED:")
|
|
text.extend(deprecated)
|
|
return "\n".join(text)
|
|
|
|
@staticmethod
|
|
def print_paths(finder):
|
|
''' Returns a string suitable for printing of the search path '''
|
|
|
|
# Uses a list to get the order right
|
|
ret = []
|
|
for i in finder._get_paths():
|
|
if i not in ret:
|
|
ret.append(i)
|
|
return os.pathsep.join(ret)
|
|
|
|
def get_snippet_text(self, doc):
|
|
|
|
text = []
|
|
desc = CLI.tty_ify(doc['short_description'])
|
|
text.append("- name: %s" % (desc))
|
|
text.append(" %s:" % (doc['module']))
|
|
pad = 31
|
|
subdent = " " * pad
|
|
limit = display.columns - pad
|
|
|
|
for o in sorted(doc['options'].keys()):
|
|
opt = doc['options'][o]
|
|
if isinstance(opt['description'], string_types):
|
|
desc = CLI.tty_ify(opt['description'])
|
|
else:
|
|
desc = CLI.tty_ify(" ".join(opt['description']))
|
|
|
|
required = opt.get('required', False)
|
|
if not isinstance(required, bool):
|
|
raise("Incorrect value for 'Required', a boolean is needed.: %s" % required)
|
|
if required:
|
|
desc = "(required) %s" % desc
|
|
o = '%s:' % o
|
|
text.append(" %-20s # %s" % (o, textwrap.fill(desc, limit, subsequent_indent=subdent)))
|
|
text.append('')
|
|
|
|
return "\n".join(text)
|
|
|
|
def add_fields(self, text, fields, limit, opt_indent):
|
|
|
|
for o in sorted(fields):
|
|
opt = fields[o]
|
|
|
|
required = opt.pop('required', False)
|
|
if not isinstance(required, bool):
|
|
raise AnsibleError("Incorrect value for 'Required', a boolean is needed.: %s" % required)
|
|
if required:
|
|
opt_leadin = "="
|
|
else:
|
|
opt_leadin = "-"
|
|
|
|
text.append("%s %s" % (opt_leadin, o))
|
|
|
|
if isinstance(opt['description'], list):
|
|
for entry in opt['description']:
|
|
text.append(textwrap.fill(CLI.tty_ify(entry), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
else:
|
|
text.append(textwrap.fill(CLI.tty_ify(opt['description']), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
del opt['description']
|
|
|
|
aliases = ''
|
|
if 'aliases' in opt:
|
|
choices = "(Aliases: " + ", ".join(str(i) for i in opt['aliases']) + ")"
|
|
del opt['aliases']
|
|
choices = ''
|
|
if 'choices' in opt:
|
|
choices = "(Choices: " + ", ".join(str(i) for i in opt['choices']) + ")"
|
|
del opt['choices']
|
|
default = ''
|
|
if 'default' in opt or not required:
|
|
default = "[Default: " + str(opt.pop('default', '(null)')) + "]"
|
|
text.append(textwrap.fill(CLI.tty_ify(aliases + choices + default), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
|
|
if 'options' in opt:
|
|
text.append(opt_indent + "options:\n")
|
|
self.add_fields(text, opt['options'], limit, opt_indent + opt_indent)
|
|
text.append('')
|
|
del opt['options']
|
|
|
|
if 'spec' in opt:
|
|
text.append(opt_indent + "spec:\n")
|
|
self.add_fields(text, opt['spec'], limit, opt_indent + opt_indent)
|
|
text.append('')
|
|
del opt['spec']
|
|
|
|
for conf in ('config', 'env_vars', 'host_vars'):
|
|
if conf in opt:
|
|
text.append(textwrap.fill(CLI.tty_ify("%s: " % conf), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
for entry in opt[conf]:
|
|
if isinstance(entry, dict):
|
|
pre = " -"
|
|
for key in entry:
|
|
text.append(textwrap.fill(CLI.tty_ify("%s %s: %s" % (pre, key, entry[key])),
|
|
limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
pre = " "
|
|
else:
|
|
text.append(textwrap.fill(CLI.tty_ify(" - %s" % entry), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
del opt[conf]
|
|
|
|
# unspecified keys
|
|
for k in opt:
|
|
if k.startswith('_'):
|
|
continue
|
|
if isinstance(opt[k], string_types):
|
|
text.append(textwrap.fill(CLI.tty_ify("%s: %s" % (k, opt[k])), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
elif isinstance(opt[k], (list, dict)):
|
|
text.append(textwrap.fill(CLI.tty_ify("%s: %s" % (k, yaml.dump(opt[k], Dumper=AnsibleDumper, default_flow_style=False))),
|
|
limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
|
else:
|
|
display.vv("Skipping %s key cuase we don't know how to handle eet" % k)
|
|
|
|
def get_man_text(self, doc):
|
|
opt_indent = " "
|
|
text = []
|
|
text.append("> %s (%s)\n" % (doc[self.options.type].upper(), doc['filename']))
|
|
pad = display.columns * 0.20
|
|
limit = max(display.columns - int(pad), 70)
|
|
|
|
if isinstance(doc['description'], list):
|
|
desc = " ".join(doc['description'])
|
|
else:
|
|
desc = doc['description']
|
|
|
|
text.append("%s\n" % textwrap.fill(CLI.tty_ify(desc), limit, initial_indent=" ", subsequent_indent=" "))
|
|
|
|
if 'deprecated' in doc and doc['deprecated'] is not None and len(doc['deprecated']) > 0:
|
|
text.append("DEPRECATED: \n%s\n" % doc['deprecated'])
|
|
|
|
if 'action' in doc and doc['action']:
|
|
text.append(" * note: %s\n" % "This module has a corresponding action plugin.")
|
|
|
|
if 'options' in doc and doc['options']:
|
|
text.append("Options (= is mandatory):\n")
|
|
self.add_fields(text, doc['options'], limit, opt_indent)
|
|
text.append('')
|
|
|
|
if 'notes' in doc and doc['notes'] and len(doc['notes']) > 0:
|
|
text.append("Notes:")
|
|
for note in doc['notes']:
|
|
text.append(textwrap.fill(CLI.tty_ify(note), limit - 6, initial_indent=" * ", subsequent_indent=opt_indent))
|
|
|
|
if 'requirements' in doc and doc['requirements'] is not None and len(doc['requirements']) > 0:
|
|
req = ", ".join(doc['requirements'])
|
|
text.append("Requirements:%s\n" % textwrap.fill(CLI.tty_ify(req), limit - 16, initial_indent=" ", subsequent_indent=opt_indent))
|
|
|
|
if 'examples' in doc and len(doc['examples']) > 0:
|
|
text.append("Example%s:\n" % ('' if len(doc['examples']) < 2 else 's'))
|
|
for ex in doc['examples']:
|
|
text.append("%s\n" % (ex['code']))
|
|
|
|
if 'plainexamples' in doc and doc['plainexamples'] is not None:
|
|
text.append("EXAMPLES:\n")
|
|
if isinstance(doc['plainexamples'], string_types):
|
|
text.append(doc['plainexamples'])
|
|
else:
|
|
text.append(yaml.dump(doc['plainexamples'], indent=2, default_flow_style=False))
|
|
|
|
if 'returndocs' in doc and doc['returndocs'] is not None:
|
|
text.append("RETURN VALUES:\n")
|
|
if isinstance(doc['returndocs'], string_types):
|
|
text.append(doc['returndocs'])
|
|
else:
|
|
text.append(yaml.dump(doc['returndocs'], indent=2, default_flow_style=False))
|
|
text.append('')
|
|
|
|
maintainers = set()
|
|
if 'author' in doc:
|
|
if isinstance(doc['author'], string_types):
|
|
maintainers.add(doc['author'])
|
|
else:
|
|
maintainers.update(doc['author'])
|
|
|
|
if 'maintainers' in doc:
|
|
if isinstance(doc['maintainers'], string_types):
|
|
maintainers.add(doc['author'])
|
|
else:
|
|
maintainers.update(doc['author'])
|
|
|
|
text.append('MAINTAINERS: ' + ', '.join(maintainers))
|
|
text.append('')
|
|
|
|
if 'metadata' in doc and doc['metadata']:
|
|
text.append("METADATA:")
|
|
for k in doc['metadata']:
|
|
if isinstance(k, list):
|
|
text.append("\t%s: %s" % (k.capitalize(), ", ".join(doc['metadata'][k])))
|
|
else:
|
|
text.append("\t%s: %s" % (k.capitalize(), doc['metadata'][k]))
|
|
text.append('')
|
|
return "\n".join(text)
|