ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Provide a fallback value for all options in 'default' callback plugin (#42155)

Browse source 
This is necessary for plugins that subclass 'default' but don't also
include its docs fragment. This is a follow-up to #41058
This commit is contained in:
Andrew Gaffney 2018-06-30 21:31:30 -05:00 committed by GitHub
parent fc25d280be
commit f4efa2c4cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
lib/ansible/plugins/callback/default.py
View file

@ -24,6 +24,18 @@ from ansible.plugins.callback import CallbackBase
from ansible.utils.color import colorize, hostcolor from ansible.utils.color import colorize, hostcolor
# These values use ansible.constants for historical reasons, mostly to allow
# unmodified derivative plugins to work. However, newer options added to the
# plugin are not also added to ansible.constants, so authors of derivative
# callback plugins will eventually need to add a reference to the common docs
# fragment for the 'default' callback plugin
DEFAULT_SHOW_CUSTOM_STATS = C.SHOW_CUSTOM_STATS
DEFAULT_DISPLAY_SKIPPED_HOSTS = C.DISPLAY_SKIPPED_HOSTS
# These values reflect the defaults defined in the config fragment in the docs
DEFAULT_DISPLAY_OK_HOSTS = True
DEFAULT_DISPLAY_FAILED_STDERR = False
class CallbackModule(CallbackBase): class CallbackModule(CallbackBase):
''' '''
@ -50,7 +62,7 @@ class CallbackModule(CallbackBase):
if self._last_task_banner != result._task._uuid: if self._last_task_banner != result._task._uuid:
self._print_task_banner(result._task) self._print_task_banner(result._task)
use_stderr = self._plugin_options.get('display_failed_stderr', False) use_stderr = self._plugin_options.get('display_failed_stderr', DEFAULT_DISPLAY_FAILED_STDERR)
self._handle_exception(result._result, use_stderr=use_stderr) self._handle_exception(result._result, use_stderr=use_stderr)
self._handle_warnings(result._result) self._handle_warnings(result._result)
@ -71,7 +83,7 @@ class CallbackModule(CallbackBase):
self._display.display("...ignoring", color=C.COLOR_SKIP) self._display.display("...ignoring", color=C.COLOR_SKIP)
def v2_runner_on_ok(self, result): def v2_runner_on_ok(self, result):
if not self._plugin_options.get('display_ok_hosts'): if not self._plugin_options.get('display_ok_hosts', DEFAULT_DISPLAY_OK_HOSTS):
return return
delegated_vars = result._result.get('_ansible_delegated_vars', None) delegated_vars = result._result.get('_ansible_delegated_vars', None)
@ -106,7 +118,7 @@ class CallbackModule(CallbackBase):
self._display.display(msg, color=color) self._display.display(msg, color=color)
def v2_runner_on_skipped(self, result): def v2_runner_on_skipped(self, result):
if self._plugin_options.get('display_skipped_hosts', C.DISPLAY_SKIPPED_HOSTS): # fallback on constants for inherited plugins missing docs if self._plugin_options.get('display_skipped_hosts', DEFAULT_DISPLAY_SKIPPED_HOSTS):
self._clean_results(result._result, result._task.action) self._clean_results(result._result, result._task.action)
@ -146,7 +158,8 @@ class CallbackModule(CallbackBase):
self._last_task_name = task.get_name().strip() self._last_task_name = task.get_name().strip()
# Display the task banner immediately if we're not doing any filtering based on task result # Display the task banner immediately if we're not doing any filtering based on task result
if self._plugin_options.get('display_skipped_hosts') and self._plugin_options.get('display_ok_hosts'): if (self._plugin_options.get('display_skipped_hosts', DEFAULT_DISPLAY_SKIPPED_HOSTS) and
self._plugin_options.get('display_ok_hosts', DEFAULT_DISPLAY_OK_HOSTS)):
self._print_task_banner(task) self._print_task_banner(task)
def _print_task_banner(self, task): def _print_task_banner(self, task):
@ -206,7 +219,7 @@ class CallbackModule(CallbackBase):
self._display.display(diff) self._display.display(diff)
def v2_runner_item_on_ok(self, result): def v2_runner_item_on_ok(self, result):
if not self._plugin_options.get('display_ok_hosts'): if not self._plugin_options.get('display_ok_hosts', DEFAULT_DISPLAY_OK_HOSTS):
return return
delegated_vars = result._result.get('_ansible_delegated_vars', None) delegated_vars = result._result.get('_ansible_delegated_vars', None)
@ -247,7 +260,7 @@ class CallbackModule(CallbackBase):
self._display.display(msg + " (item=%s) => %s" % (self._get_item_label(result._result), self._dump_results(result._result)), color=C.COLOR_ERROR) self._display.display(msg + " (item=%s) => %s" % (self._get_item_label(result._result), self._dump_results(result._result)), color=C.COLOR_ERROR)
def v2_runner_item_on_skipped(self, result): def v2_runner_item_on_skipped(self, result):
if self._plugin_options.get('display_skipped_hosts', C.DISPLAY_SKIPPED_HOSTS): # fallback on constants for inherited plugins missing docs if self._plugin_options.get('display_skipped_hosts', DEFAULT_DISPLAY_SKIPPED_HOSTS):
self._clean_results(result._result, result._task.action) self._clean_results(result._result, result._task.action)
msg = "skipping: [%s] => (item=%s) " % (result._host.get_name(), self._get_item_label(result._result)) msg = "skipping: [%s] => (item=%s) " % (result._host.get_name(), self._get_item_label(result._result))
if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result: if (self._display.verbosity > 0 or '_ansible_verbose_always' in result._result) and '_ansible_verbose_override' not in result._result:
@ -286,7 +299,7 @@ class CallbackModule(CallbackBase):
self._display.display("", screen_only=True) self._display.display("", screen_only=True)
# print custom stats # print custom stats
if self._plugin_options.get('show_custom_stats', C.SHOW_CUSTOM_STATS) and stats.custom: # fallback on constants for inherited plugins missing docs if self._plugin_options.get('show_custom_stats', DEFAULT_SHOW_CUSTOM_STATS) and stats.custom:
self._display.banner("CUSTOM STATS: ") self._display.banner("CUSTOM STATS: ")
# per host # per host
# TODO: come up with 'pretty format' # TODO: come up with 'pretty format'