-
-
Notifications
You must be signed in to change notification settings - Fork 477
/
conftest.py
486 lines (417 loc) · 12.5 KB
/
conftest.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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
"""
A module containing testing utilities and fixtures.
"""
import asyncio
import atexit
import os
import pathlib
import re
import shutil
import signal
import socket
import tempfile
import time
import unittest
import warnings
from contextlib import contextmanager
from subprocess import PIPE, Popen
import pandas as pd
import pytest
from bokeh.client import pull_session
from bokeh.document import Document
from bokeh.io.doc import curdoc, set_curdoc as set_bkdoc
from pyviz_comms import Comm
from panel import config, serve
from panel.config import panel_extension
from panel.io.reload import (
_local_modules, _modules, _watched_files, async_file_watcher, watch,
)
from panel.io.state import set_curdoc, state
from panel.pane import HTML, Markdown
CUSTOM_MARKS = ('ui', 'jupyter', 'subprocess', 'docs')
config.apply_signatures = False
JUPYTER_PORT = 8887
JUPYTER_TIMEOUT = 15 # s
JUPYTER_PROCESS = None
try:
with warnings.catch_warnings():
warnings.filterwarnings("error", category=DeprecationWarning)
asyncio.get_event_loop()
except (RuntimeError, DeprecationWarning):
asyncio.set_event_loop(asyncio.new_event_loop())
def port_open(port):
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.settimeout(1)
is_open = sock.connect_ex(("127.0.0.1", port)) == 0
sock.close()
return is_open
def get_default_port():
worker_count = int(os.environ.get("PYTEST_XDIST_WORKER_COUNT", "1"))
worker_id = os.environ.get("PYTEST_XDIST_WORKER", "0")
worker_idx = int(re.sub(r"\D", "", worker_id))
return 9001 + (worker_idx * worker_count * 10)
def start_jupyter():
global JUPYTER_PORT, JUPYTER_PROCESS
args = ['jupyter', 'server', '--port', str(JUPYTER_PORT), "--NotebookApp.token=''"]
JUPYTER_PROCESS = process = Popen(args, stdout=PIPE, stderr=PIPE, bufsize=1, encoding='utf-8')
deadline = time.monotonic() + JUPYTER_TIMEOUT
while True:
line = process.stderr.readline()
time.sleep(0.02)
if "http://127.0.0.1:" in line:
host = "http://127.0.0.1:"
break
if "http://localhost:" in line:
host = "http://localhost:"
break
if time.monotonic() > deadline:
raise TimeoutError(
'jupyter server did not start within {timeout} seconds.'
)
JUPYTER_PORT = int(line.split(host)[-1][:4])
def cleanup_jupyter():
if JUPYTER_PROCESS is not None:
os.kill(JUPYTER_PROCESS.pid, signal.SIGTERM)
@pytest.fixture
def jupyter_preview(request):
path = pathlib.Path(request.fspath.dirname)
rel = path.relative_to(pathlib.Path(request.config.invocation_dir).absolute())
return f'http://localhost:{JUPYTER_PORT}/panel-preview/render/{str(rel)}'
atexit.register(cleanup_jupyter)
optional_markers = {
"ui": {
"help": "Runs UI related tests",
"marker-descr": "UI test marker",
"skip-reason": "Test only runs with the --ui option."
},
"jupyter": {
"help": "Runs Jupyter related tests",
"marker-descr": "Jupyter test marker",
"skip-reason": "Test only runs with the --jupyter option."
},
"subprocess": {
"help": "Runs tests that fork the process",
"marker-descr": "Subprocess test marker",
"skip-reason": "Test only runs with the --subprocess option."
},
"docs": {
"help": "Runs docs specific tests",
"marker-descr": "Docs test marker",
"skip-reason": "Test only runs with the --docs option."
}
}
def pytest_addoption(parser):
for marker, info in optional_markers.items():
parser.addoption(f"--{marker}", action="store_true",
default=False, help=info['help'])
def pytest_configure(config):
for marker, info in optional_markers.items():
config.addinivalue_line("markers",
"{}: {}".format(marker, info['marker-descr']))
if config.option.jupyter and not port_open(JUPYTER_PORT):
start_jupyter()
def pytest_collection_modifyitems(config, items):
skipped, selected = [], []
markers = [m for m in optional_markers if config.getoption(f"--{m}")]
empty = not markers
for item in items:
if empty and any(m in item.keywords for m in optional_markers):
skipped.append(item)
elif empty:
selected.append(item)
elif not empty and any(m in item.keywords for m in markers):
selected.append(item)
else:
skipped.append(item)
config.hook.pytest_deselected(items=skipped)
items[:] = selected
@pytest.fixture
def context(context):
# Set the default timeout to 20 secs
context.set_default_timeout(20_000)
yield context
PORT = [get_default_port()]
@pytest.fixture
def document():
return Document()
@pytest.fixture
def server_document():
doc = Document()
session_context = unittest.mock.Mock()
doc._session_context = lambda: session_context
with set_curdoc(doc):
yield doc
doc._session_context = None
@pytest.fixture
def bokeh_curdoc():
old_doc = curdoc()
doc = Document()
session_context = unittest.mock.Mock()
doc._session_context = lambda: session_context
set_bkdoc(doc)
try:
yield doc
finally:
set_bkdoc(old_doc)
@pytest.fixture
def comm():
return Comm()
@pytest.fixture
def stop_event():
event = asyncio.Event()
try:
yield event
finally:
event.set()
@pytest.fixture
async def watch_files():
tasks = []
stop_event = asyncio.Event()
def watch_files(*files):
watch(*files)
tasks.append(asyncio.create_task(async_file_watcher(stop_event)))
try:
yield watch_files
finally:
if tasks:
try:
stop_event.set()
await tasks[0]
except FileNotFoundError:
# Watched files may be deleted before autoreloader
# is shut down, therefore we catch the error on deletion.
pass
@pytest.fixture
def port():
worker_id = os.environ.get("PYTEST_XDIST_WORKER", "0")
worker_count = int(os.environ.get("PYTEST_XDIST_WORKER_COUNT", "1"))
new_port = PORT[0] + int(re.sub(r"\D", "", worker_id))
PORT[0] += worker_count
return new_port
@pytest.fixture
def dataframe():
return pd.DataFrame({
'int': [1, 2, 3],
'float': [3.14, 6.28, 9.42],
'str': ['A', 'B', 'C']
}, index=[1, 2, 3], columns=['int', 'float', 'str'])
@pytest.fixture
def hv_bokeh():
import holoviews as hv
hv.renderer('bokeh')
prev_backend = hv.Store.current_backend
hv.Store.current_backend = 'bokeh'
yield
hv.Store.current_backend = prev_backend
@pytest.fixture
def get_display_handle():
cleanup = []
def display_handle(model):
cleanup.append(model.ref['id'])
handle = {}
state._handles[model.ref['id']] = (handle, [])
return handle
yield display_handle
for ref in cleanup:
if ref in state._handles:
del state._handles[ref]
@pytest.fixture
def hv_plotly():
import holoviews as hv
hv.renderer('plotly')
prev_backend = hv.Store.current_backend
hv.Store.current_backend = 'plotly'
yield
hv.Store.current_backend = prev_backend
@pytest.fixture
def hv_mpl():
import holoviews as hv
hv.renderer('matplotlib')
prev_backend = hv.Store.current_backend
hv.Store.current_backend = 'matplotlib'
yield
hv.Store.current_backend = prev_backend
@pytest.fixture
def tmpdir(request, tmpdir_factory):
name = request.node.name
name = re.sub(r"[\W]", "_", name)
MAXVAL = 30
if len(name) > MAXVAL:
name = name[:MAXVAL]
tmp_dir = tmpdir_factory.mktemp(name, numbered=True)
yield tmp_dir
shutil.rmtree(str(tmp_dir))
@pytest.fixture()
def html_server_session():
port = 5050
html = HTML('<h1>Title</h1>')
server = serve(html, port=port, show=False, start=False)
session = pull_session(
session_id='Test',
url=f"http://localhost:{server.port:d}/",
io_loop=server.io_loop
)
yield html, server, session, port
try:
server.stop()
except AssertionError:
pass # tests may already close this
@pytest.fixture()
def markdown_server_session():
port = 5051
html = Markdown('#Title')
server = serve(html, port=port, show=False, start=False)
session = pull_session(
session_id='Test',
url=f"http://localhost:{server.port:d}/",
io_loop=server.io_loop
)
yield html, server, session, port
try:
server.stop()
except AssertionError:
pass # tests may already close this
@pytest.fixture
def multiple_apps_server_sessions(port):
"""Serve multiple apps and yield a factory to allow
parameterizing the slugs and the titles."""
servers = []
def create_sessions(slugs, titles):
app1_slug, app2_slug = slugs
apps = {
app1_slug: Markdown('First app'),
app2_slug: Markdown('Second app')
}
server = serve(apps, port=port, title=titles, show=False, start=False)
servers.append(server)
session1 = pull_session(
url=f"http://localhost:{server.port:d}/app1",
io_loop=server.io_loop
)
session2 = pull_session(
url=f"http://localhost:{server.port:d}/app2",
io_loop=server.io_loop
)
return session1, session2
yield create_sessions
for server in servers:
try:
server.stop()
except AssertionError:
continue # tests may already close this
@pytest.fixture
def with_curdoc():
old_curdoc = state.curdoc
state.curdoc = Document()
try:
yield
finally:
state.curdoc = old_curdoc
@contextmanager
def set_env_var(env_var, value):
old_value = os.environ.get(env_var)
os.environ[env_var] = value
yield
if old_value is None:
del os.environ[env_var]
else:
os.environ[env_var] = old_value
@pytest.fixture(autouse=True)
def module_cleanup():
"""
Cleanup Panel extensions after each test.
"""
from bokeh.core.has_props import _default_resolver
to_reset = list(panel_extension._imports.values())
_default_resolver._known_models = {
name: model for name, model in _default_resolver._known_models.items()
if not any(model.__module__.startswith(tr) for tr in to_reset)
}
@pytest.fixture(autouse=True)
def server_cleanup():
"""
Clean up server state after each test.
"""
try:
yield
finally:
state.reset()
_watched_files.clear()
_modules.clear()
_local_modules.clear()
@pytest.fixture(autouse=True)
def cache_cleanup():
state.clear_caches()
@pytest.fixture
def autoreload():
config.autoreload = True
def watch(files):
if isinstance(files, (str, os.PathLike)):
files = [files]
_watched_files.update({str(f) for f in files})
try:
yield watch
finally:
config.autoreload = False
@pytest.fixture
def py_file():
tf = tempfile.NamedTemporaryFile(mode='w', suffix='.py', delete=False)
try:
yield tf
finally:
tf.close()
os.unlink(tf.name)
@pytest.fixture
def py_files():
tf = tempfile.NamedTemporaryFile(mode='w', suffix='.py', delete=False)
tf2 = tempfile.NamedTemporaryFile(mode='w', suffix='.py', dir=os.path.split(tf.name)[0], delete=False)
try:
yield tf, tf2
finally:
tf.close()
tf2.close()
os.unlink(tf.name)
os.unlink(tf2.name)
@pytest.fixture
def html_file():
tf = tempfile.NamedTemporaryFile(mode='w', suffix='.html')
try:
yield tf
finally:
tf.close()
@pytest.fixture
def threads():
config.nthreads = 4
try:
yield 4
finally:
config.nthreads = None
@pytest.fixture
def reuse_sessions():
config.reuse_sessions = True
try:
yield
finally:
config.reuse_sessions = False
config.session_key_func = None
state._sessions.clear()
state._session_key_funcs.clear()
@pytest.fixture
def nothreads():
yield
@pytest.fixture
def change_test_dir(request):
os.chdir(request.fspath.dirname)
yield
os.chdir(request.config.invocation_dir)
@pytest.fixture
def exception_handler_accumulator():
exceptions = []
def eh(exception):
exceptions.append(exception)
old_eh = config.exception_handler
config.exception_handler = eh
try:
yield exceptions
finally:
config.exception_handler = old_eh