ansible/test/units/modules/cloud/amazon/test_aws_api_gateway.py

70 lines
1.9 KiB
Python
Raw Normal View History

[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
#
# (c) 2016 Michael De La Rue
#
# This file is part of Ansible
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
import sys
import pytest
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
from ansible.module_utils.ec2 import HAS_BOTO3
from units.modules.utils import set_module_args
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
if not HAS_BOTO3:
pytestmark = pytest.mark.skip("test_api_gateway.py requires the `boto3` and `botocore` modules")
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
import ansible.modules.cloud.amazon.aws_api_gateway as agw
from ansible.module_utils.aws import core
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
exit_return_dict = {}
def fake_exit_json(self, **kwargs):
""" store the kwargs given to exit_json rather than putting them out to stdout"""
global exit_return_dict
exit_return_dict = kwargs
sys.exit(0)
def test_upload_api(monkeypatch):
class FakeConnection:
def put_rest_api(self, *args, **kwargs):
assert kwargs["body"] == "the-swagger-text-is-fake"
return {"msg": "success!"}
def return_fake_connection(*args, **kwargs):
return FakeConnection()
monkeypatch.setattr(core, "boto3_conn", return_fake_connection)
monkeypatch.setattr(core.AnsibleAWSModule, "exit_json", fake_exit_json)
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
set_module_args({
"api_id": "fred",
"state": "present",
"swagger_text": "the-swagger-text-is-fake",
"region": 'mars-north-1',
AnsiballZ improvements 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__: * https://github.com/abadger/ansible/blob/5959f11c9ddb7b6eaa9c3214560bd85e631d4055/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
2018-06-20 20:23:59 +02:00
"_ansible_tmpdir": "/tmp/ansibl-abcdef",
[cloud] New module: AWS API Gageway module (#20230) * Ultra basic api-gateway module based of lambda.py * Ultra basic deployment added to api-gateway module * ApiGateway module Allow creation of APIs, more documentation and better return value * ApiGateway module incorporate review feedback * ApiGateway module flake8 cleanup * APIGateway module - more review fixes. * slightly better messages in api_gateway module * AWS api_gateway module - try to improve messages in case of exceptions * rename api_gateway module to aws_api_gateway as discussed in PR 20230 * aws_api_gateway - Allow delivery of swagger either as text or dictionary. * aws_api_gateway module - introduce 'unit' tests, improve imports using them and small fixes * aws_api_gateway module - move path expand_user to avoid early typecheck * aws_api_gateway - version means version of metadata not module - fix to 1.0 * aws_api_gateway module - Rely on module_utils.ec2 for imports & path type for expanduser / cleanups * aws_api_gateway module - heavy cleanup and refactor of code + cloud retry functionality. * api_gateway_module - failing test case for handling more than one deployment in succession and API deletion * add TooManyRequestsException to AWSRetry exception list - makes API deployment work. * api_gateway_module - Fixes for various review comments + errors from various linters * api_gateway_module - Fixes for more review comments + linter error * api_gateway_module - Major refactor into sensible functions - create_response becomes configure_response * api_gateway_module - should be working under python3; remove test exclusion * api_gateway_module - finish off remaining review fixes - use ansible defaults and fix mutually exclusive * api_gateway_module - attempt to improve handling of botocore errors in python3 * api_gateway_module - implement state=absent / API deletion
2017-06-05 16:25:56 +02:00
})
with pytest.raises(SystemExit):
agw.main()
assert exit_return_dict["changed"]
def test_warn_if_region_not_specified():
set_module_args({
"name": "aws_api_gateway",
"state": "present",
"runtime": 'python2.7',
"role": 'arn:aws:iam::987654321012:role/lambda_basic_execution',
"handler": 'lambda_python.my_handler'})
with pytest.raises(SystemExit):
print(agw.main())