Add yaml output plugin #32246

leedm777 · 2017-10-27T12:26:42Z

SUMMARY

Using YAML instead of JSON for detailed output can (IMO) improve
readability; especially for tasks with either lots of output, or
multi-line output.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

yaml callback plugin

ANSIBLE VERSION

ansible 2.5.0 (yaml-output b385c7d57a) last updated 2017/10/27 07:25:14 (GMT -500)
  config file = /Users/dlee/.ansible.cfg
  configured module search path = [u'/Users/dlee/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/dlee/prj/ansible/lib/ansible
  executable location = /Users/dlee/prj/ansible/bin/ansible
  python version = 2.7.14 (default, Sep 25 2017, 09:53:22) [GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.37)]

ADDITIONAL INFORMATION

ansibot · 2017-10-27T12:55:49Z

The test ansible-test sanity --test ansible-var-precedence-check [?] failed with the following error:

Command "test/sanity/code-smell/ansible-var-precedence-check.py" returned exit status 1.
>>> Standard Output
CHECKING: extra_vars (var passed via the cli)
ERROR !!!
playbook failed (rc=250), stdout: 'b'ansible-playbook 2.5.0 (detached HEAD b385c7d57a) last updated 2017/10/27 12:27:23 (GMT +000)\n  config file = /root/ansible/test/sanity/ansible.cfg\n  configured module search path = [\'/root/.ansible/plugins/modules\', \'/usr/share/ansible/plugins/modules\']\n  ansible python module location = /root/ansible/lib/ansible\n  executable location = /root/ansible/bin/ansible-playbook\n  python version = 3.6.3 (default, Oct  4 2017, 02:55:45) [GCC 5.4.0 20160609]\nUsing /root/ansible/test/sanity/ansible.cfg as config file\nsetting up inventory plugins\nParsed /tmp/tmp3debmzpt/inventory/hosts inventory source with ini plugin\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nRead vars_file \'varsfile.yml\'\nstatically imported: /tmp/tmp3debmzpt/included_tasks.yml\nLoading callback plugin default of type stdout, v2.0 from /root/ansible/lib/ansible/plugins/callback/__init__.py\nthe full traceback was:\n\nTraceback (most recent call last):\n  File "/root/ansible/bin/ansible-playbook", line 109, in <module>\n    exit_code = cli.run()\n  File "/root/ansible/lib/ansible/cli/playbook.py", line 130, in run\n    results = pbex.run()\n  File "/root/ansible/lib/ansible/executor/playbook_executor.py", line 90, in run\n    self._tqm.load_callbacks()\n  File "/root/ansible/lib/ansible/executor/task_queue_manager.py", line 190, in load_callbacks\n    for callback_plugin in callback_loader.all(class_only=True):\n  File "/root/ansible/lib/ansible/plugins/loader.py", line 455, in all\n    self._update_object(obj, name, path)\n  File "/root/ansible/lib/ansible/plugins/loader.py", line 346, in _update_object\n    self._load_config_defs(name, path)\n  File "/root/ansible/lib/ansible/plugins/loader.py", line 214, in _load_config_defs\n    dstring = read_docstring(path, verbose=False, ignore_errors=False)\n  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 68, in read_docstring\n    data[\'metadata\'] = extract_metadata(module_ast=M)[0]\n  File "/root/ansible/lib/ansible/parsing/metadata.py", line 194, in extract_metadata\n    if target.id == \'ANSIBLE_METADATA\':\nAttributeError: \'Attribute\' object has no attribute \'id\'\n'' stderr: 'b" [WARNING]: Failed to assign id for <_ast.Attribute object at 0x7f8e3a0dcc88>\non /root/ansible/lib/ansible/plugins/callback/yaml.py, skipping\nERROR! Unexpected Exception, this is probably a bug: 'Attribute' object has no attribute 'id'\n"'
feature: extra_vars failed

The test ansible-test sanity --test pep8 [?] failed with the following error:

lib/ansible/plugins/callback/yaml.py:11:73: W291 trailing whitespace

click here for bot help

bcoca · 2017-10-28T05:47:29Z

lib/ansible/plugins/callback/yaml.py

@@ -0,0 +1,118 @@
+# Make coding more python3-ish


missing license/copyright headers

# (c) 2017 Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

bcoca · 2017-10-28T05:47:45Z

CHANGELOG.md

@@ -28,6 +28,7 @@ Ansible Changes By Release
 * Updated the bundled copy of the six library to 1.11.0
 * Added support to `become` `NT AUTHORITY\System`, `NT AUTHORITY\LocalService`, and `NT AUTHORITY\NetworkService` on Windows hosts
 * Added `aws_ssm` lookup plugin
+* Added `yaml` output plugin


plugins get their own section, should not be under 'minor'

bcoca · 2017-10-28T05:50:02Z

lib/ansible/plugins/callback/yaml.py

+
+        if abridged_result:
+            dumped += '\n'
+            dumped += yaml.safe_dump(json.loads(json.dumps(abridged_result, ensure_ascii=False)), width=1000, default_flow_style=False)


there is an ansible specific dumper we create, not sure if pertinent to this plugin, but worth looking into as i think it can save you work

Using this now

Using YAML instead of JSON for detailed output can (IMO) improve readability; especially for tasks with either lots of output, or multi-line output.

* Added copyright header to yaml.py * Moved mention of yaml output plugin to `New Modules` section

Also moved the `represent_scalar` setup into the init method. As a global statement, it was causing exceptions trying to get an `id` field that does not exist.

bcoca · 2017-11-06T16:22:39Z

lib/ansible/plugins/callback/yaml.py

+
+        if abridged_result:
+            dumped += '\n'
+            dumped += yaml.dump(json.loads(json.dumps(abridged_result, ensure_ascii=False)), width=1000, Dumper=AnsibleDumper, default_flow_style=False)


why the json load + dump? this is effectively a noop, you can just use yaml.dump directly

ansibot added affects_2.5 This issue/PR affects Ansible v2.5 feature_pull_request needs_triage Needs a first human triage before being processed. plugins/callback support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 27, 2017

ansibot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Oct 27, 2017

s-hertel removed the needs_triage Needs a first human triage before being processed. label Oct 27, 2017

gundalow added the ci_verified Changes made in this PR are causing tests to fail. label Oct 27, 2017

bcoca requested changes Oct 28, 2017

View reviewed changes

bcoca reviewed Oct 28, 2017

View reviewed changes

ansibot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Nov 5, 2017

leedm777 added 3 commits November 6, 2017 08:14

Add yaml output plugin

68f0cdd

Using YAML instead of JSON for detailed output can (IMO) improve readability; especially for tasks with either lots of output, or multi-line output.

Fix yaml output plugin documentation

eb0946a

* Added copyright header to yaml.py * Moved mention of yaml output plugin to `New Modules` section

Use AnsibleDumper in yaml output plugin

fedfe25

Also moved the `represent_scalar` setup into the init method. As a global statement, it was causing exceptions trying to get an `id` field that does not exist.

leedm777 force-pushed the yaml-output branch from b385c7d to fedfe25 Compare November 6, 2017 14:17

Remove trailing whitespace

b9d8c73

ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Nov 6, 2017

bcoca requested changes Nov 6, 2017

View reviewed changes

Remove useless json.loads/dumps from yaml output

7f57cb1

bcoca approved these changes Nov 6, 2017

View reviewed changes

bcoca merged commit 1fd454e into ansible:devel Nov 8, 2017

ansibot added feature This issue/PR relates to a feature request. and removed feature_pull_request labels Mar 5, 2018

ansible locked and limited conversation to collaborators Apr 26, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add yaml output plugin #32246

Add yaml output plugin #32246

leedm777 commented Oct 27, 2017

ansibot commented Oct 27, 2017

bcoca Oct 28, 2017

leedm777 Nov 6, 2017

bcoca Oct 28, 2017

bcoca Oct 28, 2017

leedm777 Nov 6, 2017

bcoca Nov 6, 2017

leedm777 Nov 6, 2017

Add yaml output plugin #32246

Add yaml output plugin #32246

Conversation

leedm777 commented Oct 27, 2017

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

ansibot commented Oct 27, 2017

bcoca Oct 28, 2017

Choose a reason for hiding this comment

leedm777 Nov 6, 2017

Choose a reason for hiding this comment

bcoca Oct 28, 2017

Choose a reason for hiding this comment

bcoca Oct 28, 2017

Choose a reason for hiding this comment

leedm777 Nov 6, 2017

Choose a reason for hiding this comment

bcoca Nov 6, 2017

Choose a reason for hiding this comment

leedm777 Nov 6, 2017

Choose a reason for hiding this comment