-
-
Notifications
You must be signed in to change notification settings - Fork 2k
/
pytest_plugin.py
265 lines (202 loc) · 7.22 KB
/
pytest_plugin.py
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
import asyncio
import contextlib
import tempfile
import warnings
import pytest
from py import path
from aiohttp.web import Application
from .test_utils import unused_port as _unused_port
from .test_utils import (RawTestServer, TestClient, TestServer, loop_context,
setup_test_loop, teardown_test_loop)
try:
import uvloop
except: # pragma: no cover
uvloop = None
try:
import tokio
except: # pragma: no cover
tokio = None
def pytest_addoption(parser):
parser.addoption(
'--fast', action='store_true', default=False,
help='run tests faster by disabling extra checks')
parser.addoption(
'--loop', action='append', default=[],
help='run tests with specific loop: pyloop, uvloop, tokio')
parser.addoption(
'--enable-loop-debug', action='store_true', default=False,
help='enable event loop debug mode')
@pytest.fixture
def fast(request):
""" --fast config option """
return request.config.getoption('--fast') # pragma: no cover
@contextlib.contextmanager
def _runtime_warning_context():
"""
Context manager which checks for RuntimeWarnings, specifically to
avoid "coroutine 'X' was never awaited" warnings being missed.
If RuntimeWarnings occur in the context a RuntimeError is raised.
"""
with warnings.catch_warnings(record=True) as _warnings:
yield
rw = ['{w.filename}:{w.lineno}:{w.message}'.format(w=w)
for w in _warnings if w.category == RuntimeWarning]
if rw:
raise RuntimeError('{} Runtime Warning{},\n{}'.format(
len(rw),
'' if len(rw) == 1 else 's',
'\n'.join(rw)
))
@contextlib.contextmanager
def _passthrough_loop_context(loop, fast=False):
"""
setups and tears down a loop unless one is passed in via the loop
argument when it's passed straight through.
"""
if loop:
# loop already exists, pass it straight through
yield loop
else:
# this shadows loop_context's standard behavior
loop = setup_test_loop()
yield loop
teardown_test_loop(loop, fast=fast)
def pytest_pycollect_makeitem(collector, name, obj):
"""
Fix pytest collecting for coroutines.
"""
if collector.funcnamefilter(name) and asyncio.iscoroutinefunction(obj):
return list(collector._genfunctions(name, obj))
def pytest_pyfunc_call(pyfuncitem):
"""
Run coroutines in an event loop instead of a normal function call.
"""
fast = pyfuncitem.config.getoption("--fast")
if asyncio.iscoroutinefunction(pyfuncitem.function):
existing_loop = pyfuncitem.funcargs.get('loop', None)
with _runtime_warning_context():
with _passthrough_loop_context(existing_loop, fast=fast) as _loop:
testargs = {arg: pyfuncitem.funcargs[arg]
for arg in pyfuncitem._fixtureinfo.argnames}
task = _loop.create_task(pyfuncitem.obj(**testargs))
_loop.run_until_complete(task)
return True
def pytest_configure(config):
loops = config.getoption('--loop')
factories = {'pyloop': asyncio.new_event_loop}
if uvloop is not None: # pragma: no cover
factories['uvloop'] = uvloop.new_event_loop
if tokio is not None: # pragma: no cover
factories['tokio'] = tokio.new_event_loop
LOOP_FACTORIES.clear()
LOOP_FACTORY_IDS.clear()
if loops:
for names in (name.split(',') for name in loops):
for name in names:
name = name.strip()
if name not in factories:
raise ValueError(
"Unknown loop '%s', available loops: %s" % (
name, list(factories.keys())))
LOOP_FACTORIES.append(factories[name])
LOOP_FACTORY_IDS.append(name)
else:
LOOP_FACTORIES.append(asyncio.new_event_loop)
LOOP_FACTORY_IDS.append('pyloop')
if uvloop is not None: # pragma: no cover
LOOP_FACTORIES.append(uvloop.new_event_loop)
LOOP_FACTORY_IDS.append('uvloop')
if tokio is not None:
LOOP_FACTORIES.append(tokio.new_event_loop)
LOOP_FACTORY_IDS.append('tokio')
asyncio.set_event_loop(None)
LOOP_FACTORIES = []
LOOP_FACTORY_IDS = []
@pytest.fixture(params=LOOP_FACTORIES, ids=LOOP_FACTORY_IDS)
def loop(request):
"""Return an instance of the event loop."""
fast = request.config.getoption('--fast')
debug = request.config.getoption('--enable-loop-debug')
with loop_context(request.param, fast=fast) as _loop:
if debug:
_loop.set_debug(True) # pragma: no cover
yield _loop
@pytest.fixture
def unused_port():
"""Return a port that is unused on the current host."""
return _unused_port
@pytest.yield_fixture
def test_server(loop):
"""Factory to create a TestServer instance, given an app.
test_server(app, **kwargs)
"""
servers = []
@asyncio.coroutine
def go(app, **kwargs):
server = TestServer(app)
yield from server.start_server(loop=loop, **kwargs)
servers.append(server)
return server
yield go
@asyncio.coroutine
def finalize():
while servers:
yield from servers.pop().close()
loop.run_until_complete(finalize())
@pytest.yield_fixture
def raw_test_server(loop):
"""Factory to create a RawTestServer instance, given a web handler.
raw_test_server(handler, **kwargs)
"""
servers = []
@asyncio.coroutine
def go(handler, **kwargs):
server = RawTestServer(handler)
yield from server.start_server(loop=loop, **kwargs)
servers.append(server)
return server
yield go
@asyncio.coroutine
def finalize():
while servers:
yield from servers.pop().close()
loop.run_until_complete(finalize())
@pytest.yield_fixture
def test_client(loop):
"""Factory to create a TestClient instance.
test_client(app, **kwargs)
test_client(server, **kwargs)
test_client(raw_server, **kwargs)
"""
clients = []
@asyncio.coroutine
def go(__param, *args, **kwargs):
if isinstance(__param, Application):
assert not args, "args should be empty"
client = TestClient(__param, loop=loop, **kwargs)
elif isinstance(__param, TestServer):
assert not args, "args should be empty"
client = TestClient(__param, loop=loop, **kwargs)
elif isinstance(__param, RawTestServer):
assert not args, "args should be empty"
client = TestClient(__param, loop=loop, **kwargs)
else:
__param = __param(loop, *args, **kwargs)
client = TestClient(__param, loop=loop)
yield from client.start_server()
clients.append(client)
return client
yield go
@asyncio.coroutine
def finalize():
while clients:
yield from clients.pop().close()
loop.run_until_complete(finalize())
@pytest.fixture
def shorttmpdir():
"""Provides a temporary directory with a shorter file system path than the
tmpdir fixture.
"""
tmpdir = path.local(tempfile.mkdtemp())
yield tmpdir
tmpdir.remove(rec=1)