1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
import os
import sys
import types
import inspect
import datetime
import pkg_resources
import pytest
import tornado
import tornado.gen
import tornado.testing
import tornado.httpserver
import tornado.httpclient
if sys.version_info[:2] >= (3, 5):
iscoroutinefunction = inspect.iscoroutinefunction
else:
iscoroutinefunction = lambda f: False
_PYTEST_VERSION = pkg_resources.parse_version(pytest.__version__)
def _get_async_test_timeout():
try:
return float(os.environ.get('ASYNC_TEST_TIMEOUT'))
except (ValueError, TypeError):
return 5
def pytest_addoption(parser):
tornado_group = parser.getgroup('tornado options')
tornado_group.addoption('--async-test-timeout', type=float,
default=_get_async_test_timeout(),
help='timeout in seconds before failing the test')
tornado_group.addoption('--app-fixture', default='app',
help='fixture name returning a tornado application')
tornado_group.addoption('--ssl-options-fixture', default='ssl_options',
help='fixture name returning a certificate configuration')
def pytest_configure(config):
config.addinivalue_line("markers",
"gen_test(timeout=None): "
"mark the test as asynchronous, it will be "
"run using tornado's event loop")
def _argnames(func):
if hasattr(inspect, "signature"):
sig = inspect.signature(func)
return [name for name, param in sig.parameters.items()
if param.default is param.empty]
else:
spec = inspect.getargspec(func)
if spec.defaults:
return spec.args[:-len(spec.defaults)]
if isinstance(func, types.FunctionType):
return spec.args
# Func is a bound method, skip "self"
return spec.args[1:]
def _timeout(item):
default_timeout = item.config.getoption('async_test_timeout')
gen_test = item.get_closest_marker('gen_test')
if gen_test:
return gen_test.kwargs.get('timeout', default_timeout)
return default_timeout
@pytest.mark.tryfirst
def pytest_pycollect_makeitem(collector, name, obj):
if collector.funcnamefilter(name) and inspect.isgeneratorfunction(obj):
if _PYTEST_VERSION >= pkg_resources.parse_version("5.4.0"):
item = pytest.Function.from_parent(collector, name=name)
else:
item = pytest.Function(name, parent=collector)
if 'gen_test' in item.keywords:
return list(collector._genfunctions(name, obj))
def pytest_runtest_setup(item):
if 'gen_test' in item.keywords and 'io_loop' not in item.fixturenames:
# inject an event loop fixture for all async tests
item.fixturenames.append('io_loop')
@pytest.mark.tryfirst
def pytest_pyfunc_call(pyfuncitem):
gen_test_mark = pyfuncitem.get_closest_marker('gen_test')
if gen_test_mark:
io_loop = pyfuncitem.funcargs.get('io_loop')
run_sync = gen_test_mark.kwargs.get('run_sync', True)
funcargs = dict((arg, pyfuncitem.funcargs[arg])
for arg in _argnames(pyfuncitem.obj))
if iscoroutinefunction(pyfuncitem.obj):
coroutine = pyfuncitem.obj
future = tornado.gen.convert_yielded(coroutine(**funcargs))
else:
coroutine = tornado.gen.coroutine(pyfuncitem.obj)
future = coroutine(**funcargs)
if run_sync:
io_loop.run_sync(lambda: future, timeout=_timeout(pyfuncitem))
else:
# Run this test function as a coroutine, until the timeout. When completed, stop the IOLoop
# and reraise any exceptions
future_with_timeout = tornado.gen.with_timeout(
datetime.timedelta(seconds=_timeout(pyfuncitem)),
future)
io_loop.add_future(future_with_timeout, lambda f: io_loop.stop())
io_loop.start()
# This will reraise any exceptions that occurred.
future_with_timeout.result()
# prevent other pyfunc calls from executing
return True
@pytest.fixture
def io_loop(request):
"""Create an instance of the `tornado.ioloop.IOLoop` for each test case.
"""
io_loop = tornado.ioloop.IOLoop()
io_loop.make_current()
def _close():
io_loop.clear_current()
io_loop.close(all_fds=True)
request.addfinalizer(_close)
return io_loop
@pytest.fixture
def _unused_port():
return tornado.testing.bind_unused_port()
@pytest.fixture
def http_port(_unused_port):
"""Get a port used by the test server.
"""
return _unused_port[1]
@pytest.fixture
def https_port(_unused_port):
"""Get a port used by the test server.
"""
return _unused_port[1]
@pytest.fixture
def base_url(request):
"""Create an absolute base url (scheme://host:port)
"""
fixturenames = request.fixturenames
if 'https_port' in fixturenames or 'https_client' in fixturenames or 'https_server' in fixturenames:
return 'https://localhost:%s' % request.getfixturevalue('https_port')
return 'http://localhost:%s' % request.getfixturevalue('http_port')
@pytest.fixture
def http_server(request, io_loop, _unused_port):
"""Start a tornado HTTP server.
You must create an `app` fixture, which returns
the `tornado.web.Application` to be tested.
Raises:
FixtureLookupError: tornado application fixture not found
"""
http_app = request.getfixturevalue(request.config.option.app_fixture)
server = tornado.httpserver.HTTPServer(http_app)
server.add_socket(_unused_port[0])
def _stop():
server.stop()
if hasattr(server, 'close_all_connections'):
io_loop.run_sync(server.close_all_connections,
timeout=request.config.option.async_test_timeout)
request.addfinalizer(_stop)
return server
@pytest.fixture
def http_client(request, http_server):
"""Get an asynchronous HTTP client.
"""
client = tornado.httpclient.AsyncHTTPClient()
def _close():
client.close()
request.addfinalizer(_close)
return client
@pytest.fixture
def https_server(request, io_loop, _unused_port):
"""Start a tornado HTTPS server.
You must create an `app` fixture, which returns
the `tornado.web.Application` to be tested.
Raises:
FixtureLookupError: tornado application fixture not found
"""
https_app = request.getfixturevalue(request.config.option.app_fixture)
ssl_options = request.getfixturevalue(request.config.option.ssl_options_fixture)
server = tornado.httpserver.HTTPServer(https_app, ssl_options=ssl_options)
server.add_socket(_unused_port[0])
def _stop():
server.stop()
if hasattr(server, 'close_all_connections'):
io_loop.run_sync(server.close_all_connections,
timeout=request.config.option.async_test_timeout)
request.addfinalizer(_stop)
return server
@pytest.fixture
def https_client(request, https_server):
"""Get an asynchronous HTTPS client.
"""
# How does on get ca_certs from the user
client = tornado.httpclient.AsyncHTTPClient()
def _close():
client.close()
request.addfinalizer(_close)
return client
|