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

Fix for traceback when we encounter non-utf8 characters in diff

Browse source 
We can diff non-utf8 files (as part of copy, for instance) but when we
try to turn the bytes into text for display, the characters cause
a traceback.  Since diff output is only informational, we can replace
those problematic bytes with replacement characters.  We do not want to
do this to other fields because those fields may be used inside of the
playbook (for templating another variable or matching in a conditional).

Fixes #21803
Fixes #21804
This commit is contained in:
Toshio Kuratomi 2017-02-24 10:01:21 -08:00
parent b714f1fc4b
commit 49db03c384
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lib/ansible/executor/task_executor.py
View file

@ -129,17 +129,26 @@ class TaskExecutor:
if 'changed' not in res: if 'changed' not in res:
res['changed'] = False res['changed'] = False
def _clean_res(res): def _clean_res(res, errors='surrogate_or_strict'):
if isinstance(res, UnsafeProxy): if isinstance(res, UnsafeProxy):
return res._obj return res._obj
elif isinstance(res, binary_type): elif isinstance(res, binary_type):
return to_text(res, errors='surrogate_or_strict') return to_text(res, errors=errors)
elif isinstance(res, dict): elif isinstance(res, dict):
for k in res: for k in res:
res[k] = _clean_res(res[k]) try:
res[k] = _clean_res(res[k], errors=errors)
except UnicodeError:
if k == 'diff':
# If this is a diff, substitute a replacement character if the value
# is undecodable as utf8. (Fix #21804)
display.warning("We were unable to decode all characters, replaced some in an effort to return as much as possible")
res[k] = _clean_res(res[k], errors='surrogate_then_replace')
else:
raise
elif isinstance(res, list): elif isinstance(res, list):
for idx,item in enumerate(res): for idx,item in enumerate(res):
res[idx] = _clean_res(item) res[idx] = _clean_res(item, errors=errors)
return res return res
display.debug("dumping result to json") display.debug("dumping result to json")