52449cc01a
Now that we don't need to worry about python-2.4 and 2.5, we can make
some improvements to the way AnsiballZ handles modules.
* Change AnsiballZ wrapper to use import to invoke the module
We need the module to think of itself as a script because it could be
coded as:
main()
or as:
if __name__ == '__main__':
main()
Or even as:
if __name__ == '__main__':
random_function_name()
A script will invoke all of those. Prior to this change, we invoked
a second Python interpreter on the module so that it really was
a script. However, this means that we have to run python twice (once
for the AnsiballZ wrapper and once for the module). This change makes
the module think that it is a script (because __name__ in the module ==
'__main__') but it's actually being invoked by us importing the module
code.
There's three ways we've come up to do this.
* The most elegant is to use zipimporter and tell the import mechanism
that the module being loaded is __main__:
* 5959f11c9d/lib/ansible/executor/module_common.py (L175)
* zipimporter is nice because we do not have to extract the module from
the zip file and save it to the disk when we do that. The import
machinery does it all for us.
* The drawback is that modules do not have a __file__ which points
to a real file when they do this. Modules could be using __file__
to for a variety of reasons, most of those probably have
replacements (the most common one is to find a writable directory
for temporary files. AnsibleModule.tmpdir should be used instead)
We can monkeypatch __file__ in fom AnsibleModule initialization
but that's kind of gross. There's no way I can see to do this
from the wrapper.
* Next, there's imp.load_module():
* https://github.com/abadger/ansible/blob/340edf7489/lib/ansible/executor/module_common.py#L151
* imp has the nice property of allowing us to set __name__ to
__main__ without changing the name of the file itself
* We also don't have to do anything special to set __file__ for
backwards compatibility (although the reason for that is the
drawback):
* Its drawback is that it requires the file to exist on disk so we
have to explicitly extract it from the zipfile and save it to
a temporary file
* The last choice is to use exec to execute the module:
* https://github.com/abadger/ansible/blob/f47a4ccc76/lib/ansible/executor/module_common.py#L175
* The code we would have to maintain for this looks pretty clean.
In the wrapper we create a ModuleType, set __file__ on it, read
the module's contents in from the zip file and then exec it.
* Drawbacks: We still have to explicitly extract the file's contents
from the zip archive instead of letting python's import mechanism
handle it.
* Exec also has hidden performance issues and breaks certain
assumptions that modules could be making about their own code:
http://lucumr.pocoo.org/2011/2/1/exec-in-python/
Our plan is to use imp.load_module() for now, deprecate the use of
__file__ in modules, and switch to zipimport once the deprecation
period for __file__ is over (without monkeypatching a fake __file__ in
via AnsibleModule).
* Rename the name of the AnsiBallZ wrapped module
This makes it obvious that the wrapped module isn't the module file that
we distribute. It's part of trying to mitigate the fact that the module
is now named __main)).py in tracebacks.
* Shield all wrapper symbols inside of a function
With the new import code, all symbols in the wrapper become visible in
the module. To mitigate the chance of collisions, move most symbols
into a toplevel function. The only symbols left in the global namespace
are now _ANSIBALLZ_WRAPPER and _ansiballz_main.
revised porting guide entry
Integrate code coverage collection into AnsiballZ.
ci_coverage
ci_complete
139 lines
6.2 KiB
Python
139 lines
6.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# (c) 2017, Michael De La Rue
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
from pytest import importorskip
|
|
import unittest
|
|
from ansible.module_utils import basic
|
|
from ansible.module_utils.aws.core import AnsibleAWSModule
|
|
from ansible.module_utils._text import to_bytes
|
|
from ansible.compat.tests.mock import Mock, patch
|
|
import json
|
|
|
|
importorskip("boto3")
|
|
botocore = importorskip("botocore")
|
|
|
|
|
|
class AWSModuleTestCase(unittest.TestCase):
|
|
|
|
basic._ANSIBLE_ARGS = to_bytes(json.dumps({'ANSIBLE_MODULE_ARGS': {'_ansible_tmpdir': '/tmp/ansible-abc'}}))
|
|
|
|
def test_create_aws_module_should_set_up_params(self):
|
|
m = AnsibleAWSModule(argument_spec=dict(
|
|
win_string_arg=dict(type='list', default=['win'])
|
|
))
|
|
m_noretry_no_customargs = AnsibleAWSModule(
|
|
auto_retry=False, default_args=False,
|
|
argument_spec=dict(
|
|
success_string_arg=dict(type='list', default=['success'])
|
|
)
|
|
)
|
|
assert m, "module wasn't true!!"
|
|
assert m_noretry_no_customargs, "module wasn't true!!"
|
|
|
|
m_params = m.params
|
|
m_no_defs_params = m_noretry_no_customargs.params
|
|
assert 'region' in m_params
|
|
assert 'win' in m_params["win_string_arg"]
|
|
assert 'success' in m_no_defs_params["success_string_arg"]
|
|
assert 'aws_secret_key' not in m_no_defs_params
|
|
|
|
|
|
class ErrorReportingTestcase(unittest.TestCase):
|
|
|
|
def test_botocore_exception_reports_nicely_via_fail_json_aws(self):
|
|
|
|
basic._ANSIBLE_ARGS = to_bytes(json.dumps({'ANSIBLE_MODULE_ARGS': {'_ansible_tmpdir': '/tmp/ansible-abc'}}))
|
|
module = AnsibleAWSModule(argument_spec=dict(
|
|
fail_mode=dict(type='list', default=['success'])
|
|
))
|
|
|
|
fail_json_double = Mock()
|
|
err_msg = {'Error': {'Code': 'FakeClass.FakeError'}}
|
|
with patch.object(basic.AnsibleModule, 'fail_json', fail_json_double):
|
|
try:
|
|
raise botocore.exceptions.ClientError(err_msg, 'Could not find you')
|
|
except Exception as e:
|
|
print("exception is " + str(e))
|
|
module.fail_json_aws(e, msg="Fake failure for testing boto exception messages")
|
|
|
|
assert(len(fail_json_double.mock_calls) >
|
|
0), "failed to call fail_json when should have"
|
|
assert(len(fail_json_double.mock_calls) <
|
|
2), "called fail_json multiple times when once would do"
|
|
assert("test_botocore_exception_reports_nicely"
|
|
in fail_json_double.mock_calls[0][2]["exception"]), \
|
|
"exception traceback doesn't include correct function, fail call was actually: " \
|
|
+ str(fail_json_double.mock_calls[0])
|
|
|
|
assert("Fake failure for testing boto exception messages:"
|
|
in fail_json_double.mock_calls[0][2]["msg"]), \
|
|
"error message doesn't include the local message; was: " \
|
|
+ str(fail_json_double.mock_calls[0])
|
|
assert("Could not find you" in fail_json_double.mock_calls[0][2]["msg"]), \
|
|
"error message doesn't include the botocore exception message; was: " \
|
|
+ str(fail_json_double.mock_calls[0])
|
|
try:
|
|
fail_json_double.mock_calls[0][2]["error"]
|
|
except KeyError:
|
|
raise Exception("error was missing; call was: " + str(fail_json_double.mock_calls[0]))
|
|
assert("FakeClass.FakeError" == fail_json_double.mock_calls[0][2]["error"]["code"]), \
|
|
"Failed to find error/code; was: " + str(fail_json_double.mock_calls[0])
|
|
|
|
def test_botocore_exception_without_response_reports_nicely_via_fail_json_aws(self):
|
|
basic._ANSIBLE_ARGS = to_bytes(json.dumps({'ANSIBLE_MODULE_ARGS': {'_ansible_tmpdir': '/tmp/ansible-abc'}}))
|
|
module = AnsibleAWSModule(argument_spec=dict(
|
|
fail_mode=dict(type='list', default=['success'])
|
|
))
|
|
|
|
fail_json_double = Mock()
|
|
err_msg = None
|
|
with patch.object(basic.AnsibleModule, 'fail_json', fail_json_double):
|
|
try:
|
|
raise botocore.exceptions.ClientError(err_msg, 'Could not find you')
|
|
except Exception as e:
|
|
print("exception is " + str(e))
|
|
module.fail_json_aws(e, msg="Fake failure for testing boto exception messages")
|
|
|
|
assert(len(fail_json_double.mock_calls) > 0), "failed to call fail_json when should have"
|
|
assert(len(fail_json_double.mock_calls) < 2), "called fail_json multiple times"
|
|
|
|
assert("test_botocore_exception_without_response_reports_nicely_via_fail_json_aws"
|
|
in fail_json_double.mock_calls[0][2]["exception"]), \
|
|
"exception traceback doesn't include correct function, fail call was actually: " \
|
|
+ str(fail_json_double.mock_calls[0])
|
|
|
|
assert("Fake failure for testing boto exception messages"
|
|
in fail_json_double.mock_calls[0][2]["msg"]), \
|
|
"error message doesn't include the local message; was: " \
|
|
+ str(fail_json_double.mock_calls[0])
|
|
|
|
# I would have thought this should work, however the botocore exception comes back with
|
|
# "argument of type 'NoneType' is not iterable" so it's probably not really designed
|
|
# to handle "None" as an error response.
|
|
#
|
|
# assert("Could not find you" in fail_json_double.mock_calls[0][2]["msg"]), \
|
|
# "error message doesn't include the botocore exception message; was: " \
|
|
# + str(fail_json_double.mock_calls[0])
|
|
|
|
|
|
# TODO:
|
|
# - an exception without a message
|
|
# - plain boto exception
|
|
# - socket errors and other standard things.
|