207 lines
6.5 KiB
Python
207 lines
6.5 KiB
Python
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
|
#
|
|
# 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/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division)
|
|
__metaclass__ = type
|
|
|
|
import json
|
|
|
|
from ansible import constants as C
|
|
|
|
__all__ = ["CallbackBase"]
|
|
|
|
|
|
class CallbackBase:
|
|
|
|
'''
|
|
This is a base ansible callback class that does nothing. New callbacks should
|
|
use this class as a base and override any callback methods they wish to execute
|
|
custom actions.
|
|
'''
|
|
|
|
# FIXME: the list of functions here needs to be updated once we have
|
|
# finalized the list of callback methods used in the default callback
|
|
|
|
def __init__(self, display):
|
|
self._display = display
|
|
if self._display.verbosity >= 4:
|
|
name = getattr(self, 'CALLBACK_NAME', 'with no defined name')
|
|
ctype = getattr(self, 'CALLBACK_TYPE', 'unknwon')
|
|
version = getattr(self, 'CALLBACK_VERSION', 'unknwon')
|
|
self._display.vvvv('Loaded callback %s of type %s, v%s' % (name, ctype, version))
|
|
|
|
def _dump_results(self, result, indent=4, sort_keys=True):
|
|
return json.dumps(result, indent=indent, ensure_ascii=False, sort_keys=sort_keys)
|
|
|
|
def _handle_warnings(self, res):
|
|
''' display warnings, if enabled and any exist in the result '''
|
|
if C.COMMAND_WARNINGS and 'warnings' in res and res['warnings']:
|
|
for warning in res['warnings']:
|
|
self._display.warning(warning)
|
|
|
|
def set_play_context(self, play_context):
|
|
pass
|
|
|
|
def on_any(self, *args, **kwargs):
|
|
pass
|
|
|
|
def runner_on_failed(self, host, res, ignore_errors=False):
|
|
pass
|
|
|
|
def runner_on_ok(self, host, res):
|
|
pass
|
|
|
|
def runner_on_skipped(self, host, item=None):
|
|
pass
|
|
|
|
def runner_on_unreachable(self, host, res):
|
|
pass
|
|
|
|
def runner_on_no_hosts(self):
|
|
pass
|
|
|
|
def runner_on_async_poll(self, host, res, jid, clock):
|
|
pass
|
|
|
|
def runner_on_async_ok(self, host, res, jid):
|
|
pass
|
|
|
|
def runner_on_async_failed(self, host, res, jid):
|
|
pass
|
|
|
|
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, name):
|
|
pass
|
|
|
|
def playbook_on_stats(self, stats):
|
|
pass
|
|
|
|
####### V2 METHODS, by default they call v1 counterparts if possible ######
|
|
def v2_on_any(self, *args, **kwargs):
|
|
self.on_any(args, kwargs)
|
|
|
|
def v2_runner_on_failed(self, result, ignore_errors=False):
|
|
host = result._host.get_name()
|
|
self.runner_on_failed(host, result._result, ignore_errors)
|
|
|
|
def v2_runner_on_ok(self, result):
|
|
host = result._host.get_name()
|
|
self.runner_on_ok(host, result._result)
|
|
|
|
def v2_runner_on_skipped(self, result):
|
|
host = result._host.get_name()
|
|
#FIXME, get item to pass through
|
|
item = None
|
|
self.runner_on_skipped(host, item)
|
|
|
|
def v2_runner_on_unreachable(self, result):
|
|
host = result._host.get_name()
|
|
self.runner_on_unreachable(host, result._result)
|
|
|
|
def v2_runner_on_no_hosts(self, task):
|
|
self.runner_on_no_hosts()
|
|
|
|
def v2_runner_on_async_poll(self, result):
|
|
host = result._host.get_name()
|
|
jid = result._result.get('ansible_job_id')
|
|
#FIXME, get real clock
|
|
clock = 0
|
|
self.runner_on_async_poll(host, result._result, jid, clock)
|
|
|
|
def v2_runner_on_async_ok(self, result):
|
|
host = result._host.get_name()
|
|
jid = result._result.get('ansible_job_id')
|
|
self.runner_on_async_ok(host, result._result, jid)
|
|
|
|
def v2_runner_on_async_failed(self, result):
|
|
host = result._host.get_name()
|
|
jid = result._result.get('ansible_job_id')
|
|
self.runner_on_async_failed(host, result._result, jid)
|
|
|
|
def v2_runner_on_file_diff(self, result, diff):
|
|
pass #no v1 correspondance
|
|
|
|
def v2_playbook_on_start(self):
|
|
self.playbook_on_start()
|
|
|
|
def v2_playbook_on_notify(self, result, handler):
|
|
host = result._host.get_name()
|
|
self.playbook_on_notify(host, handler)
|
|
|
|
def v2_playbook_on_no_hosts_matched(self):
|
|
self.playbook_on_no_hosts_matched()
|
|
|
|
def v2_playbook_on_no_hosts_remaining(self):
|
|
self.playbook_on_no_hosts_remaining()
|
|
|
|
def v2_playbook_on_task_start(self, task, is_conditional):
|
|
self.playbook_on_task_start(task, is_conditional)
|
|
|
|
def v2_playbook_on_cleanup_task_start(self, task):
|
|
pass #no v1 correspondance
|
|
|
|
def v2_playbook_on_handler_task_start(self, task):
|
|
pass #no v1 correspondance
|
|
|
|
def v2_playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
|
|
self.playbook_on_vars_prompt(varname, private, prompt, encrypt, confirm, salt_size, salt, default)
|
|
|
|
def v2_playbook_on_setup(self):
|
|
self.playbook_on_setup()
|
|
|
|
def v2_playbook_on_import_for_host(self, result, imported_file):
|
|
host = result._host.get_name()
|
|
self.playbook_on_import_for_host(host, imported_file)
|
|
|
|
def v2_playbook_on_not_import_for_host(self, result, missing_file):
|
|
host = result._host.get_name()
|
|
self.playbook_on_not_import_for_host(host, missing_file)
|
|
|
|
def v2_playbook_on_play_start(self, play):
|
|
self.playbook_on_play_start(play.name)
|
|
|
|
def v2_playbook_on_stats(self, stats):
|
|
self.playbook_on_stats(stats)
|
|
|