/
util.py
403 lines (329 loc) · 11.5 KB
/
util.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
import asyncio
import contextlib
import os
import platform
import re
import subprocess
import sys
import time
import uuid
import warnings
from queue import Empty, Queue
from threading import Thread
import numpy as np
import pytest
import requests
from packaging.version import Version
import panel as pn
from panel.io.server import serve
from panel.io.state import state
# Ignore tests which are not yet working with Bokeh 3.
# Will begin to fail again when the first rc is released.
pnv = Version(pn.__version__)
try:
import holoviews as hv
hv_version = Version(hv.__version__)
except Exception:
hv, hv_version = None, None
hv_available = pytest.mark.skipif(hv is None or hv_version < Version('1.13.0a23'),
reason="requires holoviews")
try:
import matplotlib as mpl
mpl.use('Agg')
except Exception:
mpl = None
mpl_available = pytest.mark.skipif(mpl is None, reason="requires matplotlib")
try:
import streamz
except Exception:
streamz = None
streamz_available = pytest.mark.skipif(streamz is None, reason="requires streamz")
try:
import jupyter_bokeh
except Exception:
jupyter_bokeh = None
jb_available = pytest.mark.skipif(jupyter_bokeh is None, reason="requires jupyter_bokeh")
APP_PATTERN = re.compile(r'Bokeh app running at: http://localhost:(\d+)/')
ON_POSIX = 'posix' in sys.builtin_module_names
unix_only = pytest.mark.skipif(platform.system() != 'Linux', reason="Only supported on Linux")
from panel.pane.alert import Alert
from panel.pane.markup import Markdown
from panel.widgets.button import _ButtonBase
def mpl_figure():
import matplotlib.pyplot as plt
fig = plt.figure()
ax = fig.add_subplot(111)
ax.plot(np.random.rand(10, 2))
plt.close(fig)
return fig
def check_layoutable_properties(layoutable, model):
layoutable.styles = {"background": '#fffff0'}
assert model.styles["background"] == '#fffff0'
# Is deprecated, but we still support it for now.
with warnings.catch_warnings():
warnings.simplefilter("ignore")
layoutable.background = '#ffffff'
assert model.styles["background"] == '#ffffff'
layoutable.css_classes = ['custom_class']
if isinstance(layoutable, Alert):
assert model.css_classes == ['markdown', 'custom_class', 'alert', 'alert-primary']
elif isinstance(layoutable, Markdown):
assert model.css_classes == ['markdown', 'custom_class']
elif isinstance(layoutable, _ButtonBase):
assert model.css_classes == ['solid', 'custom_class']
else:
assert model.css_classes == ['custom_class']
layoutable.width = 500
assert model.width == 500
layoutable.height = 450
assert model.height == 450
layoutable.min_height = 300
assert model.min_height == 300
layoutable.min_width = 250
assert model.min_width == 250
layoutable.max_height = 600
assert model.max_height == 600
layoutable.max_width = 550
assert model.max_width == 550
layoutable.margin = 10
assert model.margin == 10
layoutable.sizing_mode = 'stretch_width'
assert model.sizing_mode == 'stretch_width'
layoutable.width_policy = 'max'
assert model.width_policy == 'max'
layoutable.height_policy = 'min'
assert model.height_policy == 'min'
def wait_until(fn, page=None, timeout=5000, interval=100):
"""
Exercice a test function in a loop until it evaluates to True
or times out.
The function can either be a simple lambda that returns True or False:
>>> wait_until(lambda: x.values() == ['x'])
Or a defined function with an assert:
>>> def _()
>>> assert x.values() == ['x']
>>> wait_until(_)
In a Playwright context test you should pass the page fixture:
>>> wait_until(lambda: x.values() == ['x'], page)
Parameters
----------
fn : callable
Callback
page : playwright.sync_api.Page, optional
Playwright page
timeout : int, optional
Total timeout in milliseconds, by default 5000
interval : int, optional
Waiting interval, by default 100
Adapted from pytest-qt.
"""
# Hide this function traceback from the pytest output if the test fails
__tracebackhide__ = True
start = time.time()
def timed_out():
elapsed = time.time() - start
elapsed_ms = elapsed * 1000
return elapsed_ms > timeout
timeout_msg = f"wait_until timed out in {timeout} milliseconds"
while True:
try:
result = fn()
except AssertionError as e:
if timed_out():
raise TimeoutError(timeout_msg) from e
else:
if result not in (None, True, False):
raise ValueError(
"`wait_until` callback must return None, True or "
f"False, returned {result!r}"
)
# None is returned when the function has an assert
if result is None:
return
# When the function returns True or False
if result:
return
if timed_out():
raise TimeoutError(timeout_msg)
if page:
# Playwright recommends against using time.sleep
# https://playwright.dev/python/docs/intro#timesleep-leads-to-outdated-state
page.wait_for_timeout(interval)
else:
time.sleep(interval / 1000)
async def async_wait_until(fn, page=None, timeout=5000, interval=100):
"""
Exercise a test function in a loop until it evaluates to True
or times out.
The function can either be a simple lambda that returns True or False:
>>> await async_wait_until(lambda: x.values() == ['x'])
Or a defined function with an assert:
>>> async def _()
>>> assert x.values() == ['x']
>>> await async_wait_until(_)
In a Playwright context test, you should pass the page fixture:
>>> await async_wait_until(lambda: x.values() == ['x'], page)
Parameters
----------
fn : callable
Callback
page : playwright.async_api.Page, optional
Playwright page
timeout : int, optional
Total timeout in milliseconds, by default 5000
interval : int, optional
Waiting interval, by default 100
Adapted from pytest-qt.
"""
# Hide this function traceback from the pytest output if the test fails
__tracebackhide__ = True
start = time.time()
def timed_out():
elapsed = time.time() - start
elapsed_ms = elapsed * 1000
return elapsed_ms > timeout
timeout_msg = f"wait_until timed out in {timeout} milliseconds"
while True:
try:
result = fn()
if asyncio.iscoroutine(result):
result = await result
except AssertionError as e:
if timed_out():
raise TimeoutError(timeout_msg) from e
else:
if result not in (None, True, False):
raise ValueError(
"`wait_until` callback must return None, True, or "
f"False, returned {result!r}"
)
# None is returned when the function has an assert
if result is None:
return
# When the function returns True or False
if result:
return
if timed_out():
raise TimeoutError(timeout_msg)
if page:
# Playwright recommends against using time.sleep
# https://playwright.dev/python/docs/intro#timesleep-leads-to-outdated-state
await page.wait_for_timeout(interval)
else:
await asyncio.sleep(interval / 1000)
def get_ctrl_modifier():
"""
Get the CTRL modifier on the current platform.
"""
if sys.platform in ['linux', 'win32']:
return 'Control'
elif sys.platform == 'darwin':
return 'Meta'
else:
raise ValueError(f'No control modifier defined for platform {sys.platform}')
def serve_and_wait(app, page=None, prefix=None, port=None, **kwargs):
server_id = uuid.uuid4().hex
serve(app, port=port or 0, threaded=True, show=False, liveness=True, server_id=server_id, prefix=prefix or "", **kwargs)
wait_until(lambda: server_id in state._servers, page)
server = state._servers[server_id][0]
port = server.port
wait_for_server(port, prefix=prefix)
return port
def serve_component(page, app, suffix='', wait=True, **kwargs):
msgs = []
page.on("console", lambda msg: msgs.append(msg))
port = serve_and_wait(app, page, **kwargs)
page.goto(f"http://localhost:{port}{suffix}")
if wait:
wait_until(lambda: any("Websocket connection 0 is now open" in str(msg) for msg in msgs), page, interval=10)
return msgs, port
def serve_and_request(app, suffix="", n=1, port=None, **kwargs):
port = serve_and_wait(app, port=port, **kwargs)
reqs = [requests.get(f"http://localhost:{port}{suffix}") for i in range(n)]
return reqs[0] if len(reqs) == 1 else reqs
def wait_for_server(port, prefix=None, timeout=3):
start = time.time()
prefix = prefix or ""
url = f"http://localhost:{port}{prefix}/liveness"
while True:
try:
if requests.get(url).ok:
return
except Exception:
pass
time.sleep(0.05)
if (time.time()-start) > timeout:
raise RuntimeError(f'{url} did not respond before timeout.')
@contextlib.contextmanager
def run_panel_serve(args, cwd=None):
cmd = [sys.executable, "-m", "panel", "serve"] + args
p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, shell=False, cwd=cwd, close_fds=ON_POSIX)
try:
yield p
except Exception as e:
p.terminate()
p.wait()
print("An error occurred: %s", e) # noqa: T201
try:
out = p.stdout.read().decode()
print("\n---- subprocess stdout follows ----\n") # noqa: T201
print(out) # noqa: T201
except Exception:
pass
raise
else:
p.terminate()
p.wait()
class NBSR:
def __init__(self, stream) -> None:
'''
NonBlockingStreamReader
stream: the stream to read from.
Usually a process' stdout or stderr.
'''
self._s = stream
self._q = Queue()
def _populateQueue(stream, queue):
'''
Collect lines from 'stream' and put them in 'queue'.
'''
for line in iter(stream.readline, b''):
queue.put(line)
stream.close()
self._t = Thread(target = _populateQueue,
args = (self._s, self._q))
self._t.daemon = True
self._t.start() #start collecting lines from the stream
def readline(self, timeout=None):
try:
return self._q.get(
block=timeout is not None,
timeout=timeout
)
except Empty:
return None
def wait_for_port(stdout):
nbsr = NBSR(stdout)
m = None
output = []
for i in range(20):
o = nbsr.readline(0.5)
if not o:
continue
out = o.decode('utf-8')
output.append(out)
m = APP_PATTERN.search(out)
if m is not None:
break
if m is None:
output = '\n '.join(output)
pytest.fail(
"No matching log line in process output, following output "
f"was captured:\n\n {output}"
)
return int(m.group(1))
def write_file(content, file_obj):
file_obj.write(content)
file_obj.flush()
os.fsync(file_obj)
file_obj.seek(0)