# (c) Fastly, inc 2016
#
# This file is part of Ansible
#
# 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/>.
"""
selective.py callback plugin.
This callback only prints tasks that have been tagged with `print_action` or that have failed.
Tasks that are not printed are placed with a '.'.
For example:
- debug: msg="This will not be printed"
- debug: msg="But this will"
tags: [print_action]"
This allows operators to focus on the tasks that provide value only.
If you increase verbosity all tasks are printed.
"""
from __future__ import (absolute_import, division, print_function)
import difflib
import os
from ansible.plugins.callback import CallbackBase
__metaclass__ = type
COLORS = {
'normal': '\033[0m',
'ok': '\033[92m',
'bold': '\033[1m',
'not_so_bold': '\033[1m\033[34m',
'changed': '\033[93m',
'failed': '\033[91m',
'endc': '\033[0m',
'skipped': '\033[96m',
}
DONT_COLORIZE = os.getenv('ANSIBLY_DONT_COLORIZE', default=False)
def dict_diff(prv, nxt):
"""Return a dict of keys that differ with another config object."""
keys = set(prv.keys() + nxt.keys())
result = {}
for k in keys:
if prv.get(k) != nxt.get(k):
result[k] = (prv.get(k), nxt.get(k))
return result
def colorize(msg, color):
"""Given a string add necessary codes to format the string."""
if DONT_COLORIZE:
return msg
else:
return '{}{}{}'.format(COLORS[color], msg, COLORS['endc'])
class CallbackModule(CallbackBase):
"""selective.py callback plugin."""
CALLBACK_VERSION = 2.0
CALLBACK_TYPE = 'stdout'
CALLBACK_NAME = 'selective'
def __init__(self, display=None):
"""selective.py callback plugin."""
super(CallbackModule, self).__init__(display)
self.last_skipped = False
self.last_task_name = None
self.printed_last_task = False
def _print_task(self, task_name=None):
if task_name is None:
task_name = self.last_task_name
if not self.printed_last_task:
self.printed_last_task = True
line_length = 120
if self.last_skipped:
print()
msg = colorize("# {} {}".format(task_name,
'*' * (line_length - len(task_name))), 'bold')
print(msg)
def _indent_text(self, text, indent_level):
lines = text.splitlines()
result_lines = []
for l in lines:
result_lines.append("{}{}".format(' '*indent_level, l))
return '\n'.join(result_lines)
def _print_diff(self, diff, indent_level):
if isinstance(diff, dict):
try:
diff = '\n'.join(difflib.unified_diff(diff['before'].splitlines(),
diff['after'].splitlines(),
fromfile=diff.get('before_header',
'new_file'),
tofile=diff['after_header']))
except AttributeError:
diff = dict_diff(diff['before'], diff['after'])
if diff:
diff = colorize(diff, 'changed')
print(self._indent_text(diff, indent_level+4))
def _print_host_or_item(self, host_or_item, changed, msg, diff, is_host, error, stdout, stderr):
if is_host:
indent_level = 0
name = colorize(host_or_item.name, 'not_so_bold')
else:
indent_level = 4
name = colorize(unicode(host_or_item['key']), 'bold')
if error:
color = 'failed'
change_string = colorize('FAILED!!!', color)
else:
color = 'changed' if changed else 'ok'
change_string = colorize("changed={}".format(changed), color)
msg = colorize(msg, color)
line_length = 120
spaces = ' ' * (40-len(name)-indent_level)
line = "{} * {}{}- {}".format(' ' * indent_level, name, spaces, change_string)
if len(msg) < 50:
line += ' -- {}'.format(msg)
print("{} {}---------".format(line, '-' * (line_length - len(line))))
else:
print("{} {}".format(line, '-' * (line_length - len(line))))
print(self._indent_text(msg, indent_level+4))
if diff is not None:
self._print_diff(diff, indent_level)
if stdout is not None:
stdout = colorize(stdout, 'failed')
print(self._indent_text(stdout, indent_level+4))
if stderr is not None:
stderr = colorize(stderr, 'failed')
print(self._indent_text(stderr, indent_level+4))
def v2_playbook_on_play_start(self, play):
"""Run on start of the play."""
pass
def v2_playbook_on_task_start(self, task, **kwargs):
"""Run when a task starts."""
self.last_task_name = task.get_name()
self.printed_last_task = False
def v2_runner_on_ok(self, result, **kwargs):
"""Run when a task finishes correctly."""
failed = 'failed' in result._result
unreachable = 'unreachable' in result._result
if 'print_action' in result._task.tags or failed or unreachable or \
self._display.verbosity > 1:
self._print_task()
self.last_skipped = False
msg = unicode(result._result.get('msg', '')) or\
unicode(result._result.get('reason', ''))
self._print_host_or_item(result._host,
result._result.get('changed', False),
msg,
result._result.get('diff', None),
is_host=True,
error=failed or unreachable,
stdout=result._result.get('module_stdout', None),
stderr=result._result.get('module_stderr', None),
)
if 'results' in result._result:
for r in result._result['results']:
failed = 'failed' in r
self._print_host_or_item(r['item'],
r.get('changed', False),
unicode(r.get('msg', '')),
r.get('diff', None),
is_host=False,
error=failed,
stdout=r.get('module_stdout', None),
stderr=r.get('module_stderr', None),
)
else:
self.last_skipped = True
print('.', end="")
def v2_playbook_on_stats(self, stats):
"""Display info about playbook statistics."""
print()
self.printed_last_task = False
self._print_task('STATS')
hosts = sorted(stats.processed.keys())
for host in hosts:
s = stats.summarize(host)
if s['failures'] or s['unreachable']:
color = 'failed'
elif s['changed']:
color = 'changed'
else:
color = 'ok'
msg = '{} : ok={}\tchanged={}\tfailed={}\tunreachable={}'.format(
host, s['ok'], s['changed'], s['failures'], s['unreachable'])
print(colorize(msg, color))
def v2_runner_on_skipped(self, result, **kwargs):
"""Run when a task is skipped."""
if self._display.verbosity > 1:
self._print_task()
self.last_skipped = False
line_length = 120
spaces = ' ' * (31-len(result._host.name)-4)
line = " * {}{}- {}".format(colorize(result._host.name, 'not_so_bold'),
spaces,
colorize("skipped", 'skipped'),)
reason = result._result.get('skipped_reason', '') or \
result._result.get('skip_reason', '')
if len(reason) < 50:
line += ' -- {}'.format(reason)
print("{} {}---------".format(line, '-' * (line_length - len(line))))
else:
print("{} {}".format(line, '-' * (line_length - len(line))))
print(self._indent_text(reason, 8))
print(reason)
v2_playbook_on_handler_task_start = v2_playbook_on_task_start
v2_runner_on_failed = v2_runner_on_ok
v2_runner_on_unreachable = v2_runner_on_ok
