changelogs/fragments/535-add-jsonl-callback.yml

@@ -1,2 +0,0 @@
-minor_changes:
-- Add jsonl callback plugin to ansible.posix collection

plugins/callback/jsonl.py

@@ -1,196 +0,0 @@
-# (c) 2016, Matt Martz <matt@sivel.net>
-# (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 = '''
-    name: jsonl
-    short_description: Ansible screen output as JSONL (lines in json format)
-    description:
-        - This callback converts all events into JSON output to stdout
-        - This callback in contrast with ansible.posix.json uses less memory, because it doesn't store results.
-    type: stdout
-    requirements:
-      - Set as stdout in config
-    options:
-      show_custom_stats:
-        name: Show custom stats
-        description: 'This adds the custom stats set via the set_stats plugin to the play recap'
-        default: False
-        env:
-          - name: ANSIBLE_SHOW_CUSTOM_STATS
-        ini:
-          - key: show_custom_stats
-            section: defaults
-        type: bool
-    notes:
-      - When using a strategy such as free, host_pinned, or a custom strategy, host results will
-        be added to new task results in ``.plays[].tasks[]``. As such, there will exist duplicate
-        task objects indicated by duplicate task IDs at ``.plays[].tasks[].task.id``, each with an
-        individual host result for the task.
-'''
-
-import datetime
-import json
-import copy
-
-from functools import partial
-
-from ansible.inventory.host import Host
-from ansible.module_utils._text import to_text
-from ansible.parsing.ajson import AnsibleJSONEncoder
-from ansible.plugins.callback import CallbackBase
-
-
-LOCKSTEP_CALLBACKS = frozenset(('linear', 'debug'))
-
-
-def current_time():
-    return '%sZ' % datetime.datetime.utcnow().isoformat()
-
-
-class CallbackModule(CallbackBase):
-    CALLBACK_VERSION = 2.0
-    CALLBACK_TYPE = 'stdout'
-    CALLBACK_NAME = 'ansible.posix.jsonl'
-
-    def __init__(self, display=None):
-        super(CallbackModule, self).__init__(display)
-        self.results = []
-        self._task_map = {}
-        self._is_lockstep = False
-
-    def _new_play(self, play):
-        self._is_lockstep = play.strategy in LOCKSTEP_CALLBACKS
-        return {
-            'play': {
-                'name': play.get_name(),
-                'id': to_text(play._uuid),
-                'duration': {
-                    'start': current_time()
-                }
-            },
-            'tasks': []
-        }
-
-    def _new_task(self, task):
-        return {
-            'task': {
-                'name': task.get_name(),
-                'id': to_text(task._uuid),
-                'duration': {
-                    'start': current_time()
-                }
-            },
-            'hosts': {}
-        }
-
-    def _find_result_task(self, host, task):
-        key = (host.get_name(), task._uuid)
-        return self._task_map.get(
-            key,
-            self.results[-1]['tasks'][-1]
-        )
-
-    def v2_playbook_on_play_start(self, play):
-        play_result = self._new_play(play)
-        self.results.append(play_result)
-        self._write_event('v2_playbook_on_play_start', play_result)
-
-    def v2_runner_on_start(self, host, task):
-        if self._is_lockstep:
-            return
-        key = (host.get_name(), task._uuid)
-        task_result = self._new_task(task)
-        self._task_map[key] = task_result
-        self.results[-1]['tasks'].append(task_result)
-        self._write_event('v2_runner_on_start', task_result)
-
-    def v2_playbook_on_task_start(self, task, is_conditional):
-        if not self._is_lockstep:
-            return
-        task_result = self._new_task(task)
-        self.results[-1]['tasks'].append(task_result)
-        self._write_event('v2_playbook_on_task_start', task_result)
-
-    def v2_playbook_on_handler_task_start(self, task):
-        if not self._is_lockstep:
-            return
-        task_result = self._new_task(task)
-        self.results[-1]['tasks'].append(task_result)
-        self._write_event('v2_playbook_on_handler_task_start', task_result)
-
-    def _convert_host_to_name(self, key):
-        if isinstance(key, (Host,)):
-            return key.get_name()
-        return key
-
-    def v2_playbook_on_stats(self, stats):
-        """Display info about playbook statistics"""
-
-        hosts = sorted(stats.processed.keys())
-
-        summary = {}
-        for h in hosts:
-            s = stats.summarize(h)
-            summary[h] = s
-
-        custom_stats = {}
-        global_custom_stats = {}
-
-        if self.get_option('show_custom_stats') and stats.custom:
-            custom_stats.update(dict((self._convert_host_to_name(k), v) for k, v in stats.custom.items()))
-            global_custom_stats.update(custom_stats.pop('_run', {}))
-
-        output = {
-            'stats': summary,
-            'custom_stats': custom_stats,
-            'global_custom_stats': global_custom_stats,
-        }
-
-        self._write_event('v2_playbook_on_stats', output)
-
-    def _write_event(self, event_name, output):
-        output['_event'] = event_name
-        output['_timestamp'] = current_time()
-        self._display.display(json.dumps(output, cls=AnsibleJSONEncoder, separators=',:', sort_keys=True))
-
-    def _record_task_result(self, event_name, on_info, result, **kwargs):
-        """This function is used as a partial to add failed/skipped info in a single method"""
-        host = result._host
-        task = result._task
-
-        result_copy = result._result.copy()
-        result_copy.update(on_info)
-        result_copy['action'] = task.action
-
-        task_result = self._find_result_task(host, task)
-
-        end_time = current_time()
-        task_result['task']['duration']['end'] = end_time
-        self.results[-1]['play']['duration']['end'] = end_time
-
-        task_result_copy = copy.deepcopy(task_result)
-        task_result_copy['hosts'][host.name] = result_copy
-
-        if not self._is_lockstep:
-            key = (host.get_name(), task._uuid)
-            del self._task_map[key]
-
-        self._write_event(event_name, task_result_copy)
-
-    def __getattribute__(self, name):
-        """Return ``_record_task_result`` partial with a dict containing skipped/failed if necessary"""
-        if name not in ('v2_runner_on_ok', 'v2_runner_on_failed', 'v2_runner_on_unreachable', 'v2_runner_on_skipped'):
-            return object.__getattribute__(self, name)
-
-        on = name.rsplit('_', 1)[1]
-
-        on_info = {}
-        if on in ('failed', 'skipped'):
-            on_info[on] = True
-
-        return partial(self._record_task_result, name, on_info)