human_log.py

# from https://gist.github.com/cliffano/9868180
# makes Ansible command output readable if added as a callback plugin

from __future__ import print_function
from __future__ import unicode_literals

import cgitb

cgitb.enable(format="text")


FIELDS = ['cmd', 'command', 'start', 'end', 'delta', 'msg', 'stdout', 'stderr']


def human_log(res):
    for field in FIELDS:
        try:
            # res[field] can be a list
            output = res[field]
        except KeyError:
            continue
        except TypeError:
            # res is not a dict
            output = res
        print(u'\n{0}:\n{1}'.format(field, output.encode('utf-8')))


class CallbackModule(object):

    def on_any(self, *args, **kwargs):
        pass

    def runner_on_failed(self, host, res, ignore_errors=False):
        human_log(res)

    def runner_on_ok(self, host, res):
        human_log(res)

    def runner_on_error(self, host, msg):
        pass

    def runner_on_skipped(self, host, item=None):
        pass

    def runner_on_unreachable(self, host, res):
        human_log(res)

    def runner_on_no_hosts(self):
        pass

    def runner_on_async_poll(self, host, res, jid, clock):
        human_log(res)

    def runner_on_async_ok(self, host, res, jid):
        human_log(res)

    def runner_on_async_failed(self, host, res, jid):
        human_log(res)

    def playbook_on_start(self):
        pass

    def playbook_on_notify(self, host, handler):
        pass

    def playbook_on_no_hosts_matched(self):
        pass

    def playbook_on_no_hosts_remaining(self):
        pass

    def playbook_on_task_start(self, name, is_conditional):
        pass

    def playbook_on_vars_prompt(self, varname, private=True, prompt=None,
                                encrypt=None, confirm=False, salt_size=None,
                                salt=None, default=None):
        pass

    def playbook_on_setup(self):
        pass

    def playbook_on_import_for_host(self, host, imported_file):
        pass

    def playbook_on_not_import_for_host(self, host, missing_file):
        pass

    def playbook_on_play_start(self, pattern):
        pass

    def playbook_on_stats(self, stats):
        pass