cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

better module error handling

Browse source 
* now module errors clearly state msg=MODULE FAILURE
* module's stdout and stderr go into module_stdout and module_stderr keys
which only appear during parsing failure
* invocation module_args are deleted from results provided by action
plugin as errors can keep us from overwriting and then disclosing info that
was meant to be kept hidden due to no_log
* fixed invocation module_args set by basic.py as it was creating different
keys as the invocation in action plugin base.
* results now merge
This commit is contained in:
Brian Coca 2015-12-22 22:45:25 -05:00
parent 010839aedc
commit 957b376f9e
3 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/ansible/module_utils/basic.py
View file

@ -1530,7 +1530,7 @@ class AnsibleModule(object):
if not 'changed' in kwargs: if not 'changed' in kwargs:
kwargs['changed'] = False kwargs['changed'] = False
if 'invocation' not in kwargs: if 'invocation' not in kwargs:
kwargs['invocation'] = self.params kwargs['invocation'] = {'module_args': self.params}
kwargs = remove_values(kwargs, self.no_log_values) kwargs = remove_values(kwargs, self.no_log_values)
self.do_cleanup_files() self.do_cleanup_files()
print(self.jsonify(kwargs)) print(self.jsonify(kwargs))
@ -1542,7 +1542,7 @@ class AnsibleModule(object):
assert 'msg' in kwargs, "implementation error -- msg to explain the error is required" assert 'msg' in kwargs, "implementation error -- msg to explain the error is required"
kwargs['failed'] = True kwargs['failed'] = True
if 'invocation' not in kwargs: if 'invocation' not in kwargs:
kwargs['invocation'] = self.params kwargs['invocation'] = {'module_args': self.params}
kwargs = remove_values(kwargs, self.no_log_values) kwargs = remove_values(kwargs, self.no_log_values)
self.do_cleanup_files() self.do_cleanup_files()
print(self.jsonify(kwargs)) print(self.jsonify(kwargs))

5
lib/ansible/plugins/action/__init__.py
View file

@ -460,9 +460,10 @@ class ActionBase(with_metaclass(ABCMeta, object)):
if 'stderr' in res and res['stderr'].startswith(u'Traceback'): if 'stderr' in res and res['stderr'].startswith(u'Traceback'):
data['exception'] = res['stderr'] data['exception'] = res['stderr']
else: else:
data['msg'] = res.get('stdout', u'') data['msg'] = "MODULE FAILURE"
data['module_stdout'] = res.get('stdout', u'')
if 'stderr' in res: if 'stderr' in res:
data['msg'] += res['stderr'] data['module_stderr'] = res['stderr']
# pre-split stdout into lines, if stdout is in the data and there # pre-split stdout into lines, if stdout is in the data and there
# isn't already a stdout_lines value there # isn't already a stdout_lines value there

5
lib/ansible/plugins/action/normal.py
View file

@ -18,6 +18,7 @@ from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
from ansible.plugins.action import ActionBase from ansible.plugins.action import ActionBase
from ansible.utils.vars import merge_hash
class ActionModule(ActionBase): class ActionModule(ActionBase):
@ -27,7 +28,9 @@ class ActionModule(ActionBase):
task_vars = dict() task_vars = dict()
results = super(ActionModule, self).run(tmp, task_vars) results = super(ActionModule, self).run(tmp, task_vars)
results.update(self._execute_module(tmp=tmp, task_vars=task_vars)) # remove as modules might hide due to nolog
del results['invocation']['module_args']
results = merge_hash(results, self._execute_module(tmp=tmp, task_vars=task_vars))
# Remove special fields from the result, which can only be set # Remove special fields from the result, which can only be set
# internally by the executor engine. We do this only here in # internally by the executor engine. We do this only here in
# the 'normal' action, as other action plugins may set this. # the 'normal' action, as other action plugins may set this.