mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
cc343a4376
* Using docstrings conflicts with the standard use of docstrings * PYTHON_OPTIMIZE=2 will omit docstrings. Using docstrings makes future changes to the plugin and module code subject to the requirement that we ensure it won't be run with optimization.
69 lines
3.2 KiB
Python
69 lines
3.2 KiB
Python
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
|
|
# (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
callback: oneline
|
|
type: stdout
|
|
short_description: oneline Ansible screen output
|
|
version_added: historical
|
|
description:
|
|
- This is the output callback used by the -o/--one-line command line option.
|
|
'''
|
|
|
|
from ansible.plugins.callback import CallbackBase
|
|
from ansible import constants as C
|
|
|
|
|
|
class CallbackModule(CallbackBase):
|
|
|
|
'''
|
|
This is the default callback interface, which simply prints messages
|
|
to stdout when new callback events are received.
|
|
'''
|
|
|
|
CALLBACK_VERSION = 2.0
|
|
CALLBACK_TYPE = 'stdout'
|
|
CALLBACK_NAME = 'oneline'
|
|
|
|
def _command_generic_msg(self, hostname, result, caption):
|
|
stdout = result.get('stdout', '').replace('\n', '\\n').replace('\r', '\\r')
|
|
if 'stderr' in result and result['stderr']:
|
|
stderr = result.get('stderr', '').replace('\n', '\\n').replace('\r', '\\r')
|
|
return "%s | %s | rc=%s | (stdout) %s (stderr) %s" % (hostname, caption, result.get('rc', -1), stdout, stderr)
|
|
else:
|
|
return "%s | %s | rc=%s | (stdout) %s" % (hostname, caption, result.get('rc', -1), stdout)
|
|
|
|
def v2_runner_on_failed(self, result, ignore_errors=False):
|
|
if 'exception' in result._result:
|
|
if self._display.verbosity < 3:
|
|
# extract just the actual error message from the exception text
|
|
error = result._result['exception'].strip().split('\n')[-1]
|
|
msg = "An exception occurred during task execution. To see the full traceback, use -vvv. The error was: %s" % error
|
|
else:
|
|
msg = "An exception occurred during task execution. The full traceback is:\n" + result._result['exception'].replace('\n', '')
|
|
|
|
if result._task.action in C.MODULE_NO_JSON and 'module_stderr' not in result._result:
|
|
self._display.display(self._command_generic_msg(result._host.get_name(), result._result, 'FAILED'), color=C.COLOR_ERROR)
|
|
else:
|
|
self._display.display(msg, color=C.COLOR_ERROR)
|
|
|
|
self._display.display("%s | FAILED! => %s" % (result._host.get_name(), self._dump_results(result._result, indent=0).replace('\n', '')),
|
|
color=C.COLOR_ERROR)
|
|
|
|
def v2_runner_on_ok(self, result):
|
|
if result._task.action in C.MODULE_NO_JSON:
|
|
self._display.display(self._command_generic_msg(result._host.get_name(), result._result, 'SUCCESS'), color=C.COLOR_OK)
|
|
else:
|
|
self._display.display("%s | SUCCESS => %s" % (result._host.get_name(), self._dump_results(result._result, indent=0).replace('\n', '')),
|
|
color=C.COLOR_OK)
|
|
|
|
def v2_runner_on_unreachable(self, result):
|
|
self._display.display("%s | UNREACHABLE!: %s" % (result._host.get_name(), result._result.get('msg', '')), color=C.COLOR_UNREACHABLE)
|
|
|
|
def v2_runner_on_skipped(self, result):
|
|
self._display.display("%s | SKIPPED" % (result._host.get_name()), color=C.COLOR_SKIP)
|