a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
community.general/lib/ansible/plugins/callback/actionable.py

81 lines
2.5 KiB
Python
Raw Normal View History

Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
# (c) 2015, Andrew Gaffney <andrew@agaffney.org>
fixes to config/setting retrieval - better variable precedence management - universal plugin option handling - also updated comments for future directions - leverage fragments for plugins - removed fact namespacing - added 'firendly name' field - updated missing descriptions - removed some unused yaml entries, updated others to reflect possible future - documented more plugins - allow reading docs using alias - short licenses - corrected args for 'all plugins' - fixed -a option for ansible-doc - updated vars plugins to allow docs - fixed 'gathering' - only set options IF connection - added path list and renamed pathspec mostly the diff is , vs : as separator - readded removed config entries that were deprecated but had no message ... and deprecated again - now deprecated entries give warning when set
2017-08-20 15:20:30 +00:00
# (c) 2017 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
Port ansible doc for plugins to use DOCUMENTATION variables * 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.
2017-09-08 18:08:31 +00:00
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
fixes to config/setting retrieval - better variable precedence management - universal plugin option handling - also updated comments for future directions - leverage fragments for plugins - removed fact namespacing - added 'firendly name' field - updated missing descriptions - removed some unused yaml entries, updated others to reflect possible future - documented more plugins - allow reading docs using alias - short licenses - corrected args for 'all plugins' - fixed -a option for ansible-doc - updated vars plugins to allow docs - fixed 'gathering' - only set options IF connection - added path list and renamed pathspec mostly the diff is , vs : as separator - readded removed config entries that were deprecated but had no message ... and deprecated again - now deprecated entries give warning when set
2017-08-20 15:20:30 +00:00
callback: actionable
type: stdout
short_description: shows only items that need attention
description:
- Use this callback when you dont care about OK nor Skipped.
- This callback suppreses any non Failed or Changed status.
version_added: "2.1"
fixed issue with default callback inheritance (#30427) * fixed issue with default callback inheritance - callbacks need to document same options as callbacks they inherit from to get them configured - since default is also used by many 3rd party callbacks for inheritance, making the code 'tolerate' the missing docs and fallback to using the direct constant to configure it's options.
2017-09-15 18:14:47 +00:00
extends_documentation_fragment:
- default_callback
fixes to config/setting retrieval - better variable precedence management - universal plugin option handling - also updated comments for future directions - leverage fragments for plugins - removed fact namespacing - added 'firendly name' field - updated missing descriptions - removed some unused yaml entries, updated others to reflect possible future - documented more plugins - allow reading docs using alias - short licenses - corrected args for 'all plugins' - fixed -a option for ansible-doc - updated vars plugins to allow docs - fixed 'gathering' - only set options IF connection - added path list and renamed pathspec mostly the diff is , vs : as separator - readded removed config entries that were deprecated but had no message ... and deprecated again - now deprecated entries give warning when set
2017-08-20 15:20:30 +00:00
requirements:
- set as stdout callback in configuration
'''
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
from ansible.plugins.callback.default import CallbackModule as CallbackModule_default
Collated PEP8 fixes (#25293) - Make PEP8 compliant
2017-06-02 11:14:11 +00:00
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
class CallbackModule(CallbackModule_default):
CALLBACK_VERSION = 2.0
CALLBACK_TYPE = 'stdout'
changed filtered to actionable cb plugin
2016-02-18 10:32:05 +00:00
CALLBACK_NAME = 'actionable'
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
def __init__(self):
self.super_ref = super(CallbackModule, self)
self.super_ref.__init__()
self.last_task = None
self.shown_title = False
actionable.py: Do not print next task banner in handler callback (#15698) Fix actionable callback plugin to not print the banner of the previous task. When a handler is executed there is no task banner, so in case it is run, it will reference the banner from the preceding task. **Author:** @hvhaugwitz Test case: --- - name: actionable filter hosts: all handlers: - name: handler command: "true" tasks: - name: task 1 file: path=/tmp/test state=touch notify: handler - name: task 2 file: path=/tmp/test state=absent - name: task 3 file: path=/tmp/test state=absent - name: task 4 file: path=/tmp/test state=absent - name: task 5 file: path=/tmp/test state=absent - name: task 6 file: path=/tmp/test state=absent Example output: BEFORE ------ PLAY [actionable filter] ******************************************************* TASK [task 1] ****************************************************************** changed: [localhost] TASK [task 2] ****************************************************************** changed: [localhost] RUNNING HANDLER [handler] ****************************************************** TASK [task 6] ****************************************************************** changed: [localhost] PLAY RECAP ********************************************************************* localhost : ok=8 changed=3 unreachable=0 failed=0 AFTER ----- PLAY [actionable filter] ******************************************************* TASK [task 1] ****************************************************************** changed: [localhost] TASK [task 2] ****************************************************************** changed: [localhost] RUNNING HANDLER [handler] ****************************************************** changed: [localhost] PLAY RECAP ********************************************************************* localhost : ok=8 changed=3 unreachable=0 failed=0
2016-05-03 15:25:46 +00:00
def v2_playbook_on_handler_task_start(self, task):
self.super_ref.v2_playbook_on_handler_task_start(task)
self.shown_title = True
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
def v2_playbook_on_task_start(self, task, is_conditional):
self.last_task = task
self.shown_title = False
def display_task_banner(self):
if not self.shown_title:
self.super_ref.v2_playbook_on_task_start(self.last_task, None)
self.shown_title = True
def v2_runner_on_failed(self, result, ignore_errors=False):
self.display_task_banner()
self.super_ref.v2_runner_on_failed(result, ignore_errors)
def v2_runner_on_ok(self, result):
if result._result.get('changed', False):
self.display_task_banner()
self.super_ref.v2_runner_on_ok(result)
def v2_runner_on_unreachable(self, result):
self.display_task_banner()
self.super_ref.v2_runner_on_unreachable(result)
def v2_runner_on_skipped(self, result):
pass
def v2_playbook_on_include(self, included_file):
pass
Renaming per-item and retry callbacks
2016-03-18 19:15:59 +00:00
def v2_runner_item_on_ok(self, result):
For `actionable` cb plugin also hide ok for itemized results The purpose of the `actionable` callback plugin is to hide uninteresting results. Also hide the ok results when the task was itemized.
2016-03-21 13:59:57 +00:00
if result._result.get('changed', False):
self.display_task_banner()
self.super_ref.v2_runner_item_on_ok(result)
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
Renaming per-item and retry callbacks
2016-03-18 19:15:59 +00:00
def v2_runner_item_on_skipped(self, result):
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
pass
Renaming per-item and retry callbacks
2016-03-18 19:15:59 +00:00
def v2_runner_item_on_failed(self, result):
Add 'filtered' stdout callback plugin This plugin filters output for any task that is 'ok' or 'skipped'. It works by subclassing the 'default' stdout callback plugin and overriding certain functions. It will suppress display of the task banner until there is a 'changed' or 'failed' result or an unreachable host.
2015-12-18 01:56:15 +00:00
self.display_task_banner()
Renaming per-item and retry callbacks
2016-03-18 19:15:59 +00:00
self.super_ref.v2_runner_item_on_failed(result)