mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-11-16 10:00:39 +00:00
654 lines
28 KiB
Python
654 lines
28 KiB
Python
|
# Copyright: (c) 2014, James Tanner <tanner.jc@gmail.com>
|
||
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
|
|
||
|
|
from __future__ import (absolute_import, division, print_function)
|
||
|
|
__metaclass__ = type
|
||
|
|
|
||
|
|
import datetime
|
||
|
|
import json
|
||
|
|
import os
|
||
|
|
import textwrap
|
||
|
|
import traceback
|
||
|
|
import yaml
|
||
|
|
|
||
|
|
from collections import Sequence
|
||
|
|
import ansible.plugins.loader as plugin_loader
|
||
|
|
|
||
|
|
from ansible import constants as C
|
||
|
|
from ansible.cli import CLI
|
||
|
|
from ansible.errors import AnsibleError, AnsibleOptionsError
|
||
|
|
from ansible.module_utils._text import to_native
|
||
|
|
from ansible.module_utils.six import string_types
|
||
|
|
from ansible.parsing.metadata import extract_metadata
|
||
|
|
from ansible.parsing.plugin_docs import read_docstub
|
||
|
|
from ansible.parsing.yaml.dumper import AnsibleDumper
|
||
|
|
from ansible.plugins.loader import action_loader, fragment_loader
|
||
|
|
from ansible.utils.plugin_docs import BLACKLIST, get_docstring
|
||
|
|
|
||
|
|
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. '''
|
||
|
|
|
||
|
|
# default ignore list for detailed views
|
||
|
|
IGNORE = ('module', 'docuri', 'version_added', 'short_description', 'now_date', 'plainexamples', 'returndocs')
|
||
|
|
|
||
|
|
def __init__(self, args):
|
||
|
|
|
||
|
|
super(DocCLI, self).__init__(args)
|
||
|
|
self.plugin_list = set()
|
||
|
|
|
||
|
|
def parse(self):
|
||
|
|
|
||
|
|
self.parser = CLI.base_parser(
|
||
|
|
usage='usage: %prog [-l|-F|-s] [options] [-t <plugin type> ] [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("-F", "--list_files", action="store_true", default=False, dest="list_files",
|
||
|
|
help='Show plugin names and their source files without summaries (implies --list)')
|
||
|
|
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='**For internal testing only** Show documentation for all plugins.')
|
||
|
|
self.parser.add_option("-j", "--json", action="store_true", default=False, dest='json_dump',
|
||
|
|
help='**For internal testing only** Dump json metadata for all plugins.')
|
||
|
|
self.parser.add_option("-t", "--type", action="store", default='module', dest='type', type='choice',
|
||
|
|
help='Choose which plugin type (defaults to "module")',
|
||
|
|
choices=C.DOCUMENTABLE_PLUGINS)
|
||
|
|
super(DocCLI, self).parse()
|
||
|
|
|
||
|
|
if [self.options.all_plugins, self.options.json_dump, self.options.list_dir, self.options.list_files, self.options.show_snippet].count(True) > 1:
|
||
|
|
raise AnsibleOptionsError("Only one of -l, -F, -s, -j or -a can be used at the same time.")
|
||
|
|
|
||
|
|
display.verbosity = self.options.verbosity
|
||
|
|
|
||
|
|
def run(self):
|
||
|
|
|
||
|
|
super(DocCLI, self).run()
|
||
|
|
|
||
|
|
plugin_type = self.options.type
|
||
|
|
|
||
|
|
if plugin_type in C.DOCUMENTABLE_PLUGINS:
|
||
|
|
loader = getattr(plugin_loader, '%s_loader' % plugin_type)
|
||
|
|
else:
|
||
|
|
raise AnsibleOptionsError("Unknown or undocumentable plugin type: %s" % plugin_type)
|
||
|
|
|
||
|
|
# add to plugin path from command line
|
||
|
|
if self.options.module_path:
|
||
|
|
for path in self.options.module_path:
|
||
|
|
if path:
|
||
|
|
loader.add_directory(path)
|
||
|
|
|
||
|
|
# save only top level paths for errors
|
||
|
|
search_paths = DocCLI.print_paths(loader)
|
||
|
|
loader._paths = None # reset so we can use subdirs below
|
||
|
|
|
||
|
|
# list plugins names and filepath for type
|
||
|
|
if self.options.list_files:
|
||
|
|
paths = loader._get_paths()
|
||
|
|
for path in paths:
|
||
|
|
self.plugin_list.update(self.find_plugins(path, plugin_type))
|
||
|
|
|
||
|
|
list_text = self.get_plugin_list_filenames(loader)
|
||
|
|
self.pager(list_text)
|
||
|
|
return 0
|
||
|
|
|
||
|
|
# list plugins for type
|
||
|
|
if self.options.list_dir:
|
||
|
|
paths = loader._get_paths()
|
||
|
|
for path in paths:
|
||
|
|
self.plugin_list.update(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:
|
||
|
|
self.args = self.get_all_plugins_of_type(plugin_type)
|
||
|
|
|
||
|
|
# dump plugin metadata as JSON
|
||
|
|
if self.options.json_dump:
|
||
|
|
plugin_data = {}
|
||
|
|
for plugin_type in C.DOCUMENTABLE_PLUGINS:
|
||
|
|
plugin_data[plugin_type] = dict()
|
||
|
|
plugin_names = self.get_all_plugins_of_type(plugin_type)
|
||
|
|
for plugin_name in plugin_names:
|
||
|
|
plugin_info = self.get_plugin_metadata(plugin_type, plugin_name)
|
||
|
|
if plugin_info is not None:
|
||
|
|
plugin_data[plugin_type][plugin_name] = plugin_info
|
||
|
|
|
||
|
|
self.pager(json.dumps(plugin_data, sort_keys=True, indent=4))
|
||
|
|
|
||
|
|
return 0
|
||
|
|
|
||
|
|
if len(self.args) == 0:
|
||
|
|
raise AnsibleOptionsError("Incorrect options passed")
|
||
|
|
|
||
|
|
# process command line list
|
||
|
|
text = ''
|
||
|
|
for plugin in self.args:
|
||
|
|
textret = self.format_plugin_doc(plugin, loader, plugin_type, search_paths)
|
||
|
|
|
||
|
|
if textret:
|
||
|
|
text += textret
|
||
|
|
|
||
|
|
if text:
|
||
|
|
self.pager(text)
|
||
|
|
|
||
|
|
return 0
|
||
|
|
|
||
|
|
def get_all_plugins_of_type(self, plugin_type):
|
||
|
|
loader = getattr(plugin_loader, '%s_loader' % plugin_type)
|
||
|
|
plugin_list = set()
|
||
|
|
paths = loader._get_paths()
|
||
|
|
for path in paths:
|
||
|
|
plugins_to_add = self.find_plugins(path, plugin_type)
|
||
|
|
plugin_list.update(plugins_to_add)
|
||
|
|
return sorted(set(plugin_list))
|
||
|
|
|
||
|
|
def get_plugin_metadata(self, plugin_type, plugin_name):
|
||
|
|
# if the plugin lives in a non-python file (eg, win_X.ps1), require the corresponding python file for docs
|
||
|
|
loader = getattr(plugin_loader, '%s_loader' % plugin_type)
|
||
|
|
filename = loader.find_plugin(plugin_name, mod_type='.py', ignore_deprecated=True, check_aliases=True)
|
||
|
|
if filename is None:
|
||
|
|
raise AnsibleError("unable to load {0} plugin named {1} ".format(plugin_type, plugin_name))
|
||
|
|
|
||
|
|
try:
|
||
|
|
doc, __, __, metadata = get_docstring(filename, fragment_loader, verbose=(self.options.verbosity > 0))
|
||
|
|
except Exception:
|
||
|
|
display.vvv(traceback.format_exc())
|
||
|
|
raise AnsibleError(
|
||
|
|
"%s %s at %s has a documentation error formatting or is missing documentation." %
|
||
|
|
(plugin_type, plugin_name, filename))
|
||
|
|
|
||
|
|
if doc is None:
|
||
|
|
if 'removed' not in metadata.get('status', []):
|
||
|
|
raise AnsibleError(
|
||
|
|
"%s %s at %s has a documentation error formatting or is missing documentation." %
|
||
|
|
(plugin_type, plugin_name, filename))
|
||
|
|
|
||
|
|
# Removed plugins don't have any documentation
|
||
|
|
return None
|
||
|
|
|
||
|
|
return dict(
|
||
|
|
name=plugin_name,
|
||
|
|
namespace=self.namespace_from_plugin_filepath(filename, plugin_name, loader.package_path),
|
||
|
|
description=doc.get('short_description', "UNKNOWN"),
|
||
|
|
version_added=doc.get('version_added', "UNKNOWN")
|
||
|
|
)
|
||
|
|
|
||
|
|
def namespace_from_plugin_filepath(self, filepath, plugin_name, basedir):
|
||
|
|
if not basedir.endswith('/'):
|
||
|
|
basedir += '/'
|
||
|
|
rel_path = filepath.replace(basedir, '')
|
||
|
|
extension_free = os.path.splitext(rel_path)[0]
|
||
|
|
namespace_only = extension_free.rsplit(plugin_name, 1)[0].strip('/_')
|
||
|
|
clean_ns = namespace_only.replace('/', '.')
|
||
|
|
if clean_ns == '':
|
||
|
|
clean_ns = None
|
||
|
|
|
||
|
|
return clean_ns
|
||
|
|
|
||
|
|
def format_plugin_doc(self, plugin, loader, plugin_type, search_paths):
|
||
|
|
text = ''
|
||
|
|
|
||
|
|
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, check_aliases=True)
|
||
|
|
if filename is None:
|
||
|
|
display.warning("%s %s not found in:\n%s\n" % (plugin_type, plugin, search_paths))
|
||
|
|
return
|
||
|
|
|
||
|
|
if any(filename.endswith(x) for x in C.BLACKLIST_EXTS):
|
||
|
|
return
|
||
|
|
|
||
|
|
try:
|
||
|
|
doc, plainexamples, returndocs, metadata = get_docstring(filename, fragment_loader,
|
||
|
|
verbose=(self.options.verbosity > 0))
|
||
|
|
except Exception:
|
||
|
|
display.vvv(traceback.format_exc())
|
||
|
|
display.error(
|
||
|
|
"%s %s has a documentation error formatting or is missing documentation." % (plugin_type, plugin),
|
||
|
|
wrap_text=False)
|
||
|
|
return
|
||
|
|
|
||
|
|
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')
|
||
|
|
if 'docuri' in doc:
|
||
|
|
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)
|
||
|
|
|
||
|
|
return text
|
||
|
|
else:
|
||
|
|
if 'removed' in metadata.get('status', []):
|
||
|
|
display.warning("%s %s has been removed\n" % (plugin_type, plugin))
|
||
|
|
return
|
||
|
|
|
||
|
|
# 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)))
|
||
|
|
|
||
|
|
def find_plugins(self, path, ptype):
|
||
|
|
|
||
|
|
display.vvvv("Searching %s for plugins" % path)
|
||
|
|
|
||
|
|
plugin_list = set()
|
||
|
|
|
||
|
|
if not os.path.exists(path):
|
||
|
|
display.vvvv("%s does not exist" % path)
|
||
|
|
return plugin_list
|
||
|
|
|
||
|
|
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 BLACKLIST.get(bkey, ()):
|
||
|
|
plugin_list.add(plugin)
|
||
|
|
display.vvvv("Added %s" % plugin)
|
||
|
|
|
||
|
|
return plugin_list
|
||
|
|
|
||
|
|
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):
|
||
|
|
|
||
|
|
try:
|
||
|
|
# 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, check_aliases=True)
|
||
|
|
|
||
|
|
if filename is None:
|
||
|
|
continue
|
||
|
|
if filename.endswith(".ps1"):
|
||
|
|
continue
|
||
|
|
if os.path.isdir(filename):
|
||
|
|
continue
|
||
|
|
|
||
|
|
doc = None
|
||
|
|
try:
|
||
|
|
doc = read_docstub(filename)
|
||
|
|
except Exception:
|
||
|
|
display.warning("%s has a documentation formatting error" % plugin)
|
||
|
|
continue
|
||
|
|
|
||
|
|
if not doc or not isinstance(doc, dict):
|
||
|
|
with open(filename) as f:
|
||
|
|
metadata = extract_metadata(module_data=f.read())
|
||
|
|
if metadata[0]:
|
||
|
|
if 'removed' not in metadata[0].get('status', []):
|
||
|
|
display.warning("%s parsing did not produce documentation." % plugin)
|
||
|
|
else:
|
||
|
|
continue
|
||
|
|
desc = 'UNDOCUMENTED'
|
||
|
|
else:
|
||
|
|
desc = self.tty_ify(doc.get('short_description', 'INVALID 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))
|
||
|
|
except Exception as e:
|
||
|
|
raise AnsibleError("Failed reading docs at %s: %s" % (plugin, to_native(e)), orig_exc=e)
|
||
|
|
|
||
|
|
if len(deprecated) > 0:
|
||
|
|
text.append("\nDEPRECATED:")
|
||
|
|
text.extend(deprecated)
|
||
|
|
return "\n".join(text)
|
||
|
|
|
||
|
|
def get_plugin_list_filenames(self, loader):
|
||
|
|
columns = display.columns
|
||
|
|
displace = max(len(x) for x in self.plugin_list)
|
||
|
|
linelimit = columns - displace - 5
|
||
|
|
text = []
|
||
|
|
|
||
|
|
for plugin in sorted(self.plugin_list):
|
||
|
|
|
||
|
|
try:
|
||
|
|
# 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, check_aliases=True)
|
||
|
|
|
||
|
|
if filename is None:
|
||
|
|
continue
|
||
|
|
if filename.endswith(".ps1"):
|
||
|
|
continue
|
||
|
|
if os.path.isdir(filename):
|
||
|
|
continue
|
||
|
|
|
||
|
|
text.append("%-*s %-*.*s" % (displace, plugin, linelimit, len(filename), filename))
|
||
|
|
|
||
|
|
except Exception as e:
|
||
|
|
raise AnsibleError("Failed reading docs at %s: %s" % (plugin, to_native(e)), orig_exc=e)
|
||
|
|
|
||
|
|
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(subdirs=False):
|
||
|
|
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 _dump_yaml(self, struct, indent):
|
||
|
|
return CLI.tty_ify('\n'.join([indent + line for line in yaml.dump(struct, default_flow_style=False, Dumper=AnsibleDumper).split('\n')]))
|
||
|
|
|
||
|
|
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:
|
||
|
|
if len(opt['aliases']) > 0:
|
||
|
|
aliases = "(Aliases: " + ", ".join(str(i) for i in opt['aliases']) + ")"
|
||
|
|
del opt['aliases']
|
||
|
|
choices = ''
|
||
|
|
if 'choices' in opt:
|
||
|
|
if len(opt['choices']) > 0:
|
||
|
|
choices = "(Choices: " + ", ".join(str(i) for i in opt['choices']) + ")"
|
||
|
|
del opt['choices']
|
||
|
|
default = ''
|
||
|
|
if 'default' in opt or not required:
|
||
|
|
default = "[Default: %s" % 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("%soptions:\n" % opt_indent)
|
||
|
|
self.add_fields(text, opt.pop('options'), limit, opt_indent + opt_indent)
|
||
|
|
|
||
|
|
if 'spec' in opt:
|
||
|
|
text.append("%sspec:\n" % opt_indent)
|
||
|
|
self.add_fields(text, opt.pop('spec'), limit, opt_indent + opt_indent)
|
||
|
|
|
||
|
|
conf = {}
|
||
|
|
for config in ('env', 'ini', 'yaml', 'vars', 'keywords'):
|
||
|
|
if config in opt and opt[config]:
|
||
|
|
conf[config] = opt.pop(config)
|
||
|
|
for ignore in self.IGNORE:
|
||
|
|
for item in conf[config]:
|
||
|
|
if ignore in item:
|
||
|
|
del item[ignore]
|
||
|
|
|
||
|
|
if conf:
|
||
|
|
text.append(self._dump_yaml({'set_via': conf}, opt_indent))
|
||
|
|
|
||
|
|
for k in sorted(opt):
|
||
|
|
if k.startswith('_'):
|
||
|
|
continue
|
||
|
|
if isinstance(opt[k], string_types):
|
||
|
|
text.append('%s%s: %s' % (opt_indent, k, textwrap.fill(CLI.tty_ify(opt[k]), limit - (len(k) + 2), subsequent_indent=opt_indent)))
|
||
|
|
elif isinstance(opt[k], (Sequence)) and all(isinstance(x, string_types) for x in opt[k]):
|
||
|
|
text.append(CLI.tty_ify('%s%s: %s' % (opt_indent, k, ', '.join(opt[k]))))
|
||
|
|
else:
|
||
|
|
text.append(self._dump_yaml({k: opt[k]}, opt_indent))
|
||
|
|
text.append('')
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def get_support_block(doc):
|
||
|
|
# Note: 'curated' is deprecated and not used in any of the modules we ship
|
||
|
|
support_level_msg = {'core': 'The Ansible Core Team',
|
||
|
|
'network': 'The Ansible Network Team',
|
||
|
|
'certified': 'an Ansible Partner',
|
||
|
|
'community': 'The Ansible Community',
|
||
|
|
'curated': 'A Third Party',
|
||
|
|
}
|
||
|
|
if doc['metadata'].get('metadata_version') in ('1.0', '1.1'):
|
||
|
|
return [" * This module is maintained by %s" % support_level_msg[doc['metadata']['supported_by']]]
|
||
|
|
|
||
|
|
return []
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def get_metadata_block(doc):
|
||
|
|
text = []
|
||
|
|
if doc['metadata'].get('metadata_version') in ('1.0', '1.1'):
|
||
|
|
text.append("METADATA:")
|
||
|
|
text.append('\tSUPPORT LEVEL: %s' % doc['metadata']['supported_by'])
|
||
|
|
|
||
|
|
for k in (m for m in doc['metadata'] if m not in ('version', 'metadata_version', 'supported_by')):
|
||
|
|
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]))
|
||
|
|
return text
|
||
|
|
|
||
|
|
return []
|
||
|
|
|
||
|
|
def get_man_text(self, doc):
|
||
|
|
|
||
|
|
self.IGNORE = self.IGNORE + (self.options.type,)
|
||
|
|
opt_indent = " "
|
||
|
|
text = []
|
||
|
|
pad = display.columns * 0.20
|
||
|
|
limit = max(display.columns - int(pad), 70)
|
||
|
|
|
||
|
|
text.append("> %s (%s)\n" % (doc.get(self.options.type, doc.get('plugin_type')).upper(), doc.pop('filename')))
|
||
|
|
|
||
|
|
if isinstance(doc['description'], list):
|
||
|
|
desc = " ".join(doc.pop('description'))
|
||
|
|
else:
|
||
|
|
desc = doc.pop('description')
|
||
|
|
|
||
|
|
text.append("%s\n" % textwrap.fill(CLI.tty_ify(desc), limit, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
||
|
|
|
||
|
|
if 'deprecated' in doc and doc['deprecated'] is not None and len(doc['deprecated']) > 0:
|
||
|
|
text.append("DEPRECATED: \n")
|
||
|
|
if isinstance(doc['deprecated'], dict):
|
||
|
|
if 'version' in doc['deprecated'] and 'removed_in' not in doc['deprecated']:
|
||
|
|
doc['deprecated']['removed_in'] = doc['deprecated']['version']
|
||
|
|
text.append("\tReason: %(why)s\n\tWill be removed in: Ansible %(removed_in)s\n\tAlternatives: %(alternative)s" % doc.pop('deprecated'))
|
||
|
|
else:
|
||
|
|
text.append("%s" % doc.pop('deprecated'))
|
||
|
|
text.append("\n")
|
||
|
|
|
||
|
|
try:
|
||
|
|
support_block = self.get_support_block(doc)
|
||
|
|
if support_block:
|
||
|
|
text.extend(support_block)
|
||
|
|
except Exception:
|
||
|
|
pass # FIXME: not suported by plugins
|
||
|
|
|
||
|
|
if doc.pop('action', False):
|
||
|
|
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.pop('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=opt_indent[:-2] + "* ", subsequent_indent=opt_indent))
|
||
|
|
text.append('')
|
||
|
|
text.append('')
|
||
|
|
del doc['notes']
|
||
|
|
|
||
|
|
if 'seealso' in doc and doc['seealso']:
|
||
|
|
text.append("SEE ALSO:")
|
||
|
|
for item in doc['seealso']:
|
||
|
|
if 'module' in item and 'description' in item:
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('Module %s' % item['module']),
|
||
|
|
limit - 6, initial_indent=opt_indent[:-2] + "* ", subsequent_indent=opt_indent))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify(item['description']),
|
||
|
|
limit - 6, initial_indent=opt_indent, subsequent_indent=opt_indent))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('https://docs.ansible.com/ansible/latest/modules/%s_module.html' % item['module']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent))
|
||
|
|
elif 'module' in item:
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('Module %s' % item['module']),
|
||
|
|
limit - 6, initial_indent=opt_indent[:-2] + "* ", subsequent_indent=opt_indent))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('The official documentation on the %s module.' % item['module']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' '))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('https://docs.ansible.com/ansible/latest/modules/%s_module.html' % item['module']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent))
|
||
|
|
elif 'name' in item and 'link' in item and 'description' in item:
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify(item['name']),
|
||
|
|
limit - 6, initial_indent=opt_indent[:-2] + "* ", subsequent_indent=opt_indent))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify(item['description']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' '))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify(item['link']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' '))
|
||
|
|
elif 'ref' in item and 'description' in item:
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('Ansible documentation [%s]' % item['ref']),
|
||
|
|
limit - 6, initial_indent=opt_indent[:-2] + "* ", subsequent_indent=opt_indent))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify(item['description']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' '))
|
||
|
|
text.append(textwrap.fill(CLI.tty_ify('https://docs.ansible.com/ansible/latest/#stq=%s&stp=1' % item['ref']),
|
||
|
|
limit - 6, initial_indent=opt_indent + ' ', subsequent_indent=opt_indent + ' '))
|
||
|
|
|
||
|
|
text.append('')
|
||
|
|
text.append('')
|
||
|
|
del doc['seealso']
|
||
|
|
|
||
|
|
if 'requirements' in doc and doc['requirements'] is not None and len(doc['requirements']) > 0:
|
||
|
|
req = ", ".join(doc.pop('requirements'))
|
||
|
|
text.append("REQUIREMENTS:%s\n" % textwrap.fill(CLI.tty_ify(req), limit - 16, initial_indent=" ", subsequent_indent=opt_indent))
|
||
|
|
|
||
|
|
# Generic handler
|
||
|
|
for k in sorted(doc):
|
||
|
|
if k in self.IGNORE or not doc[k]:
|
||
|
|
continue
|
||
|
|
if isinstance(doc[k], string_types):
|
||
|
|
text.append('%s: %s' % (k.upper(), textwrap.fill(CLI.tty_ify(doc[k]), limit - (len(k) + 2), subsequent_indent=opt_indent)))
|
||
|
|
elif isinstance(doc[k], (list, tuple)):
|
||
|
|
text.append('%s: %s' % (k.upper(), ', '.join(doc[k])))
|
||
|
|
else:
|
||
|
|
text.append(self._dump_yaml({k.upper(): doc[k]}, opt_indent))
|
||
|
|
del doc[k]
|
||
|
|
text.append('')
|
||
|
|
|
||
|
|
if 'plainexamples' in doc and doc['plainexamples'] is not None:
|
||
|
|
text.append("EXAMPLES:")
|
||
|
|
text.append('')
|
||
|
|
if isinstance(doc['plainexamples'], string_types):
|
||
|
|
text.append(doc.pop('plainexamples').strip())
|
||
|
|
else:
|
||
|
|
text.append(yaml.dump(doc.pop('plainexamples'), indent=2, default_flow_style=False))
|
||
|
|
text.append('')
|
||
|
|
text.append('')
|
||
|
|
|
||
|
|
if 'returndocs' in doc and doc['returndocs'] is not None:
|
||
|
|
text.append("RETURN VALUES:")
|
||
|
|
if isinstance(doc['returndocs'], string_types):
|
||
|
|
text.append(doc.pop('returndocs'))
|
||
|
|
else:
|
||
|
|
text.append(yaml.dump(doc.pop('returndocs'), indent=2, default_flow_style=False))
|
||
|
|
text.append('')
|
||
|
|
|
||
|
|
try:
|
||
|
|
metadata_block = self.get_metadata_block(doc)
|
||
|
|
if metadata_block:
|
||
|
|
text.extend(metadata_block)
|
||
|
|
text.append('')
|
||
|
|
except Exception:
|
||
|
|
pass # metadata is optional
|
||
|
|
|
||
|
|
return "\n".join(text)
|