1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# vim: expandtab:tabstop=4:shiftwidth=4
'''
Ansible callback plugin.
'''
from pprint import pformat
from ansible.plugins.callback import CallbackBase
from ansible import constants as C
from ansible.utils.color import stringc
class CallbackModule(CallbackBase):
'''
This callback plugin stores task results and summarizes failures.
The file name is prefixed with `zz_` to make this plugin be loaded last by
Ansible, thus making its output the last thing that users see.
'''
CALLBACK_VERSION = 2.0
CALLBACK_TYPE = 'aggregate'
CALLBACK_NAME = 'failure_summary'
CALLBACK_NEEDS_WHITELIST = False
def __init__(self):
super(CallbackModule, self).__init__()
self.__failures = []
def v2_runner_on_failed(self, result, ignore_errors=False):
super(CallbackModule, self).v2_runner_on_failed(result, ignore_errors)
self.__failures.append(dict(result=result, ignore_errors=ignore_errors))
def v2_playbook_on_stats(self, stats):
super(CallbackModule, self).v2_playbook_on_stats(stats)
# TODO: update condition to consider a host var or env var to
# enable/disable the summary, so that we can control the output from a
# play.
if self.__failures:
self._print_failure_summary()
def _print_failure_summary(self):
'''Print a summary of failed tasks (including ignored failures).'''
self._display.display(u'\nFailure summary:\n')
# TODO: group failures by host or by task. If grouped by host, it is
# easy to see all problems of a given host. If grouped by task, it is
# easy to see what hosts needs the same fix.
width = len(str(len(self.__failures)))
initial_indent_format = u' {{:>{width}}}. '.format(width=width)
initial_indent_len = len(initial_indent_format.format(0))
subsequent_indent = u' ' * initial_indent_len
subsequent_extra_indent = u' ' * (initial_indent_len + 10)
for i, failure in enumerate(self.__failures, 1):
entries = _format_failure(failure)
self._display.display(u'\n{}{}'.format(initial_indent_format.format(i), entries[0]))
for entry in entries[1:]:
entry = entry.replace(u'\n', u'\n' + subsequent_extra_indent)
indented = u'{}{}'.format(subsequent_indent, entry)
self._display.display(indented)
# Reason: disable pylint protected-access because we need to access _*
# attributes of a task result to implement this method.
# Status: permanently disabled unless Ansible's API changes.
# pylint: disable=protected-access
def _format_failure(failure):
'''Return a list of pretty-formatted text entries describing a failure, including
relevant information about it. Expect that the list of text entries will be joined
by a newline separator when output to the user.'''
result = failure['result']
host = result._host.get_name()
play = _get_play(result._task)
if play:
play = play.get_name()
task = result._task.get_name()
msg = result._result.get('msg', u'???')
fields = (
(u'Host', host),
(u'Play', play),
(u'Task', task),
(u'Message', stringc(msg, C.COLOR_ERROR)),
)
if 'checks' in result._result:
fields += ((u'Details', _format_failed_checks(result._result['checks'])),)
row_format = '{:10}{}'
return [row_format.format(header + u':', body) for header, body in fields]
def _format_failed_checks(checks):
'''Return pretty-formatted text describing checks that failed.'''
failed_check_msgs = []
for check, body in checks.items():
if body.get('failed', False): # only show the failed checks
msg = body.get('msg', u"Failed without returning a message")
failed_check_msgs.append('check "%s":\n%s' % (check, msg))
if failed_check_msgs:
return stringc("\n\n".join(failed_check_msgs), C.COLOR_ERROR)
else: # something failed but no checks will admit to it, so dump everything
return stringc(pformat(checks), C.COLOR_ERROR)
# Reason: disable pylint protected-access because we need to access _*
# attributes of obj to implement this function.
# This is inspired by ansible.playbook.base.Base.dump_me.
# Status: permanently disabled unless Ansible's API changes.
# pylint: disable=protected-access
def _get_play(obj):
'''Given a task or block, recursively tries to find its parent play.'''
if hasattr(obj, '_play'):
return obj._play
if getattr(obj, '_parent'):
return _get_play(obj._parent)
|
