Skip to content

Fix the issue of no 'failed' field in failed ansible module result #2063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wangxin merged 3 commits into from
Aug 11, 2020
Merged

Fix the issue of no 'failed' field in failed ansible module result #2063

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f31ed10
Fix the issue of no 'failed' field in failed ansible module result
wangxin Aug 7, 2020
37c2691
Add HACK code tag
wangxin Aug 10, 2020
7d8f704
Fix the mistake of using str as tuple
wangxin Aug 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions tests/common/devices.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,21 @@
from errors import UnsupportedAnsibleModule


# HACK: This is a hack for issue https://github.com/Azure/sonic-mgmt/issues/1941 and issue
# https://github.com/ansible/pytest-ansible/issues/47
# Detailed root cause analysis of the issue: https://github.com/Azure/sonic-mgmt/issues/1941#issuecomment-670434790
# Before calling callback function of plugins to return ansible module result, ansible calls the
# ansible.executor.task_result.TaskResult.clean_copy method to remove some keys like 'failed' and 'skipped' in the
# result dict. The keys to be removed are defined in module variable ansible.executor.task_result._IGNORE. The trick
# of this hack is to override this pre-defined key list. When the 'failed' key is not included in the list, ansible
# will not remove it before returning the ansible result to plugins (pytest_ansible in our case)
try:
from ansible.executor import task_result
task_result._IGNORE = ('skipped', )
except Exception as e:
logging.error("Hack for https://github.com/ansible/pytest-ansible/issues/47 failed: {}".format(repr(e)))


class AnsibleHostBase(object):
"""
@summary: The base class for various objects.
Expand Down