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
|
import sys
from collections import namedtuple
from pathlib import Path
import pytest
from _pytest.legacypath import Testdir
from _pytest.pytester import LineMatcher
pytest_plugins = ('pytester',)
THIS = Path(__file__)
STORAGE = THIS.with_name('test_storage')
@pytest.fixture
def testdir(testdir, monkeypatch):
return namedtuple('testdir', ['makepyfile', 'runpytest_subprocess', 'tmpdir', 'run'])(
testdir.makepyfile,
testdir.runpytest_subprocess,
testdir.tmpdir,
lambda bin, *args: testdir.run(bin + '.exe' if sys.platform == 'win32' else bin, *args),
)
def test_help(testdir):
result = testdir.run('py.test-benchmark', '--help')
result.stdout.fnmatch_lines(
[
'usage: py.test-benchmark *',
' {help,list,compare} ...',
'',
"pytest_benchmark's management commands.",
'',
'option*:',
' -h*, --help [[]COMMAND[]]*',
' --storage*, -s URI*',
' file://path or elasticsearch+http[s]://host1,host2/[in',
' dex/doctype?project_name=Project] (when --benchmark-',
' save or --benchmark-autosave are used). For backwards',
' compatibility unexpected values are converted to',
" file://<value>. Default: 'file://./.benchmarks'.",
' --verbose, -v Dump diagnostic and progress information.',
'',
'commands:',
' {help,list,compare}',
' help Display help and exit.',
' list List saved runs.',
' compare Compare saved runs.',
]
)
assert result.ret == 0
def test_help_command(testdir):
result = testdir.run('py.test-benchmark', 'help')
result.stdout.fnmatch_lines(
[
'usage: py.test-benchmark help [-h] [command]',
'',
'Display help and exit.',
'',
'positional arguments:',
' command',
'',
'option*:',
' -h, --help show this help message and exit',
]
)
@pytest.mark.parametrize('args', ['list --help', 'help list'])
def test_help_list(testdir, args):
result = testdir.run('py.test-benchmark', *args.split())
result.stdout.fnmatch_lines(
[
'usage: py.test-benchmark list [-h]',
'',
'List saved runs.',
'',
'option*:',
' -h, --help show this help message and exit',
]
)
assert result.ret == 0
@pytest.mark.parametrize('args', ['compare --help', 'help compare'])
def test_help_compare(testdir, args):
result = testdir.run('py.test-benchmark', *args.split())
result.stdout.fnmatch_lines(
[
'usage: py.test-benchmark compare [-h] [--sort COL] [--group-by LABEL]',
' [--columns LABELS] [--name FORMAT]',
' [--time-unit COLUMN]',
' [--histogram [FILENAME-PREFIX]]',
' [--csv [FILENAME]]',
' [[]glob_or_file *[]]',
'',
'Compare saved runs.',
'',
'positional arguments:',
' glob_or_file Glob or exact path for json files. If not specified',
' all runs are loaded.',
'',
'option*:',
' -h, --help show this help message and exit',
" --sort COL Column to sort on. Can be one of: 'min', 'max',",
" 'mean', 'stddev', 'name', 'fullname'. Default: 'min'",
" --group-by LABEL How to group tests. Can be one of: 'group', 'name',",
" 'fullname', 'func', 'fullfunc', 'param' or",
" 'param:NAME', where NAME is the name passed to",
" @pytest.parametrize. Default: 'group'",
' --columns LABELS Comma-separated list of columns to show in the result',
" table. Default: 'min, max, mean, stddev, median, iqr,",
" outliers, ops, rounds, iterations'",
" --name FORMAT How to format names in results. Can be one of 'short',",
" 'normal', 'long', or 'trial'. Default: 'normal'",
" --time-unit COLUMN Unit to scale the results to. Available units: 'ns',",
" 'us', 'ms', 's'. Default: 'auto'.",
' --histogram [FILENAME-PREFIX]',
' Plot graphs of min/max/avg/stddev over time in',
' FILENAME-PREFIX-test_name.svg. If FILENAME-PREFIX',
" contains slashes ('/') then directories will be",
" created. Default: 'benchmark_*'",
" --csv [FILENAME] Save a csv report. If FILENAME contains slashes ('/')",
' then directories will be created. Default:',
" 'benchmark_*'",
'',
'examples:',
'',
" pytest-benchmark compare 'Linux-CPython-3.5-64bit/*'",
'',
" Loads all benchmarks ran with that interpreter. Note the special quoting that disables your shell's glob",
' expansion.',
'',
' pytest-benchmark compare 0001',
'',
' Loads first run from all the interpreters.',
'',
' pytest-benchmark compare /foo/bar/0001_abc.json /lorem/ipsum/0001_sir_dolor.json',
'',
' Loads runs from exactly those files.',
]
)
assert result.ret == 0
def test_hooks(testdir: Testdir):
testdir.makepyfile(
conftest="""
def pytest_benchmark_scale_unit(config, unit, benchmarks, best, worst, sort):
return '', 1
"""
)
result = testdir.run('py.test-benchmark', '--storage', STORAGE, 'list')
assert result.stderr.lines == []
result.stdout.fnmatch_lines(
[
'*0001_*.json',
'*0002_*.json',
'*0003_*.json',
'*0004_*.json',
'*0005_*.json',
'*0006_*.json',
'*0007_*.json',
'*0008_*.json',
'*0009_*.json',
'*0010_*.json',
'*0011_*.json',
'*0012_*.json',
'*0013_*.json',
'*0014_*.json',
'*0015_*.json',
'*0016_*.json',
'*0017_*.json',
'*0018_*.json',
'*0019_*.json',
'*0020_*.json',
'*0021_*.json',
'*0022_*.json',
'*0023_*.json',
'*0024_*.json',
'*0025_*.json',
'*0026_*.json',
'*0027_*.json',
'*0028_*.json',
'*0029_*.json',
'*0030_*.json',
]
)
assert result.ret == 0
def test_list(testdir):
result = testdir.run('py.test-benchmark', '--storage', STORAGE, 'list')
assert result.stderr.lines == []
result.stdout.fnmatch_lines(
[
'*0001_*.json',
'*0002_*.json',
'*0003_*.json',
'*0004_*.json',
'*0005_*.json',
'*0006_*.json',
'*0007_*.json',
'*0008_*.json',
'*0009_*.json',
'*0010_*.json',
'*0011_*.json',
'*0012_*.json',
'*0013_*.json',
'*0014_*.json',
'*0015_*.json',
'*0016_*.json',
'*0017_*.json',
'*0018_*.json',
'*0019_*.json',
'*0020_*.json',
'*0021_*.json',
'*0022_*.json',
'*0023_*.json',
'*0024_*.json',
'*0025_*.json',
'*0026_*.json',
'*0027_*.json',
'*0028_*.json',
'*0029_*.json',
'*0030_*.json',
]
)
assert result.ret == 0
@pytest.mark.parametrize(
('name', 'name_pattern_generator'),
[
('short', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)'),
('long', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)'),
('normal', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)'),
('trial', lambda n: f'{n:04}*'),
],
)
def test_compare(testdir, name, name_pattern_generator):
result = testdir.run(
'py.test-benchmark',
'--storage',
STORAGE,
'compare',
'0001',
'0002',
'0003',
'--sort',
'min',
'--columns',
'min,max',
'--name',
name,
'--histogram',
'foobar',
'--csv',
'foobar',
)
result.stderr.fnmatch_lines(['Generated csv: *foobar.csv'])
LineMatcher(testdir.tmpdir.join('foobar.csv').readlines(cr=0)).fnmatch_lines(
[
'name,min,max',
'tests/test_normal.py::test_xfast_parametrized[[]0[]],2.15628567*e-07,1.03186158*e-05',
'tests/test_normal.py::test_xfast_parametrized[[]0[]],2.16902756*e-07,7.73929968*e-06',
'tests/test_normal.py::test_xfast_parametrized[[]0[]],2.17314542*e-07,1.14473891*e-05',
'',
]
)
result.stdout.fnmatch_lines(
[
'---*--- benchmark: 3 tests ---*---',
'Name (time in ns) * Min * Max ',
'---*---',
f'{name_pattern_generator(3)} * 215.6286 (1.0) 10*318.6159 (1.33) ',
f'{name_pattern_generator(2)} * 216.9028 (1.01) 7*739.2997 (1.0) ',
f'{name_pattern_generator(1)} * 217.3145 (1.01) 11*447.3891 (1.48) ',
'---*---',
'',
'Legend:',
' Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.',
]
)
assert result.ret == 0
@pytest.mark.parametrize(
('name', 'name_pattern_generator', 'unit'),
[
('short', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)', 's'),
('short', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)', 'ms'),
('short', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)', 'us'),
('short', lambda n: f'*xfast_parametrized[[]0[]] ({n:04}*)', 'ns'),
],
)
def test_compare_with_unit_scale(testdir, name, name_pattern_generator, unit):
result = testdir.run(
'py.test-benchmark',
'--storage',
STORAGE,
'compare',
'0001',
'0002',
'0003',
'--sort',
'min',
'--columns',
'min,max',
'--name',
name,
'--histogram',
'foobar',
'--csv',
'foobar',
'--time-unit',
unit,
)
result.stderr.fnmatch_lines(['Generated csv: *foobar.csv'])
LineMatcher(testdir.tmpdir.join('foobar.csv').readlines(cr=0)).fnmatch_lines(
[
'name,min,max',
'tests/test_normal.py::test_xfast_parametrized[[]0[]],2.15628567*e-07,1.03186158*e-05',
'tests/test_normal.py::test_xfast_parametrized[[]0[]],2.16902756*e-07,7.73929968*e-06',
'tests/test_normal.py::test_xfast_parametrized[[]0[]],2.17314542*e-07,1.14473891*e-05',
'',
]
)
result.stdout.fnmatch_lines(
[
'---*--- benchmark: 3 tests ---*---',
f'Name (time in {unit}) * Min * Max ',
]
)
assert result.ret == 0
def test_compare_csv(testdir):
test = testdir.makepyfile("""
import pytest
@pytest.mark.parametrize("arg", ["foo", "bar"])
def test1(benchmark, arg):
def func():
print(arg)
benchmark(func)
def test2(benchmark):
def func():
print("foo")
benchmark(func)
""")
result = testdir.runpytest_subprocess('--benchmark-autosave', test)
result.stderr.fnmatch_lines(
[
'Saved benchmark data in: *',
]
)
result = testdir.run('py.test-benchmark', 'compare', '--csv')
result.stderr.fnmatch_lines(['Generated csv: *.csv'])
|
