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

Report detailed error when internal remote functions fail

This is a redesign in how plugins call _remote_checksum().

- _remote_stat() has been modified to report the real error as
  AnsiblError
- Action plugin **unarchive** calls _remote_stat() directly instead of
   _remote_checksum()
- Action plugin **unarchive** also handles the exceptions directly
- Ensure get_exception() returns native text

Two other action plugins, **template** and **fetch**, also do a remote checksum.
In **template** we already call _remote_stat(), just like we now do for
unarchive, in **fetch** we do call _remote_checksum() and we make the
exact same mistake as the unarchive plugin. So that one could use a
redesign as well.

This fixes #19494

Before:
```
[dag@moria ansible.testing]$ ansible-playbook -v test137.yml
Using /home/dag/home-made/ansible.testing/ansible.cfg as config file

PLAY [localhost]
******************************************************************************************************

TASK [unarchive]
******************************************************************************************************
fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg":
"python isn't present on the system.  Unable to compute checksum"}

PLAY RECAP
******************************************************************************************************
localhost                  : ok=0    changed=0    unreachable=0
failed=1
```

After:
```
[dag@moria ansible.testing]$ ansible-playbook -v test137.yml
Using /home/dag/home-made/ansible.testing/ansible.cfg as config file

PLAY [localhost]
*************************************************************************************************************

TASK [unarchive]
*************************************************************************************************************
fatal: [localhost]: FAILED! => {"changed": false, "failed": true, "msg":
"Failed to get information on remote file (/tmp/): sudo: unknown user:
foobar\nsudo: unable to initialize policy plugin\n"}

PLAY RECAP
*******************************************************************************************************************
localhost                  : ok=0    changed=0    unreachable=0
failed=1
```
This commit is contained in:
Dag Wieers 2016-12-18 19:55:21 +01:00 committed by Brian Coca
parent 2597c1236d
commit 93cfe73a76
3 changed files with 21 additions and 12 deletions

View file

@ -443,8 +443,13 @@ class ActionBase(with_metaclass(ABCMeta, object)):
) )
mystat = self._execute_module(module_name='stat', module_args=module_args, task_vars=all_vars, tmp=tmp, delete_remote_tmp=(tmp is None)) mystat = self._execute_module(module_name='stat', module_args=module_args, task_vars=all_vars, tmp=tmp, delete_remote_tmp=(tmp is None))
if 'failed' in mystat and mystat['failed']: if mystat.get('failed'):
raise AnsibleError('Failed to get information on remote file (%s): %s' % (path, mystat['msg'])) msg = mystat.get('module_stderr')
if not msg:
msg = mystat.get('module_stdout')
if not msg:
msg = mystat.get('msg')
raise AnsibleError('Failed to get information on remote file (%s): %s' % (path, msg))
if not mystat['stat']['exists']: if not mystat['stat']['exists']:
# empty might be matched, 1 should never match, also backwards compatible # empty might be matched, 1 should never match, also backwards compatible

View file

@ -25,6 +25,7 @@ import time
from ansible import constants as C from ansible import constants as C
from ansible.errors import AnsibleError from ansible.errors import AnsibleError
from ansible.module_utils._text import to_bytes, to_native, to_text from ansible.module_utils._text import to_bytes, to_native, to_text
from ansible.module_utils.pycompat24 import get_exception
from ansible.plugins.action import ActionBase from ansible.plugins.action import ActionBase
from ansible.utils.hashing import checksum_s from ansible.utils.hashing import checksum_s
@ -43,8 +44,8 @@ class ActionModule(ActionBase):
dest = os.path.join(dest, base) dest = os.path.join(dest, base)
dest_stat = self._execute_remote_stat(dest, all_vars=all_vars, follow=False, tmp=tmp) dest_stat = self._execute_remote_stat(dest, all_vars=all_vars, follow=False, tmp=tmp)
except Exception as e: except AnsibleError:
return dict(failed=True, msg=to_bytes(e)) return dict(failed=True, msg=to_native(get_exception()))
return dest_stat['checksum'] return dest_stat['checksum']
@ -69,9 +70,9 @@ class ActionModule(ActionBase):
else: else:
try: try:
source = self._find_needle('templates', source) source = self._find_needle('templates', source)
except AnsibleError as e: except AnsibleError:
result['failed'] = True result['failed'] = True
result['msg'] = to_native(e) result['msg'] = to_native(get_exception())
if 'failed' in result: if 'failed' in result:
return result return result

View file

@ -22,6 +22,7 @@ import os
from ansible.errors import AnsibleError from ansible.errors import AnsibleError
from ansible.module_utils._text import to_native from ansible.module_utils._text import to_native
from ansible.module_utils.pycompat24 import get_exception
from ansible.plugins.action import ActionBase from ansible.plugins.action import ActionBase
from ansible.constants import mk_boolean as boolean from ansible.constants import mk_boolean as boolean
@ -79,19 +80,21 @@ class ActionModule(ActionBase):
if not remote_src: if not remote_src:
try: try:
source = self._loader.get_real_file(self._find_needle('files', source)) source = self._loader.get_real_file(self._find_needle('files', source))
except AnsibleError as e: except AnsibleError:
result['failed'] = True result['failed'] = True
result['msg'] = to_native(e) result['msg'] = to_native(get_exception())
self._remove_tmp_path(tmp) self._remove_tmp_path(tmp)
return result return result
remote_checksum = self._remote_checksum(dest, all_vars=task_vars, follow=True) try:
if remote_checksum == '4': remote_stat = self._execute_remote_stat(dest, all_vars=task_vars, follow=True)
except AnsibleError:
result['failed'] = True result['failed'] = True
result['msg'] = "python isn't present on the system. Unable to compute checksum" result['msg'] = to_native(get_exception())
self._remove_tmp_path(tmp) self._remove_tmp_path(tmp)
return result return result
elif remote_checksum != '3':
if not remote_stat['exists'] or not remote_stat['isdir']:
result['failed'] = True result['failed'] = True
result['msg'] = "dest '%s' must be an existing dir" % dest result['msg'] = "dest '%s' must be an existing dir" % dest
self._remove_tmp_path(tmp) self._remove_tmp_path(tmp)