Skip to content

Commit 01c38bb

Browse files
committed
update README
1 parent 0a65359 commit 01c38bb

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

acceptance/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,19 @@ Any file starting with "LOG" will be logged to test log (visible with go test -v
2222

2323
See [selftest](./selftest) for more examples.
2424

25+
## Benchmarks
26+
27+
Benchmarks are regular acceptance test that log measurements in certain format. The output can be fed to `tools/bench_parse.py` to print a summary table.
28+
29+
Test runner recognizes benchmark as having "benchmark" anywhere in the path. For these tests parallel execution is disabled if and only if BENCHMARK\_PARAMS variable is set.
30+
31+
The benchmarks make use of two scripts:
32+
33+
- `gen_config.py —jobs N` to generate a config with N jobs
34+
- `benchmark.py` command to run command a few times and log the time measurements.
35+
36+
The default number of runs in benchmark.py depends on BENCHMARK\_PARAMS variable. If it’s set, the default number is 5. Otherwise it is 1.
37+
2538
## Running acceptance tests on Windows
2639

2740
To run the acceptance tests from a terminal on Windows (eg. Git Bash from VS Code),

0 commit comments

Comments
 (0)