| commit | 39c4ee819a0a9b93d76692a9b893ec88f92ff98f | [log] [tgz] |
|---|---|---|
| author | Camillo Bruni <cbruni@chromium.org> | Wed Oct 19 09:02:59 2022 |
| committer | Camillo Bruni <cbruni@chromium.org> | Wed Oct 19 09:02:59 2022 |
| tree | 10a5d23dee9a086022a563d32b5e59b59a5f8b35 | |
| parent | 899bcc87167b67d15dd1fb98feec4f649d460c84 [diff] |
Improve test documentation Change-Id: I505b114f04d3d689010b41c2774243237cfcc8cb Reviewed-on: https://chromium-review.googlesource.com/c/crossbench/+/3961054 Reviewed-by: Victor Gomes <victorgomes@chromium.org>
Crossbench is a cross-browser/cross-benchmark runner to extract performance numbers.
This project uses poetry deps and package scripts to setup the correct environment for testing and debugging.
pip3 install poetry
Install the necessary dependencies from lock file via poetry
poetry install
poetry run crossbench speedometer_2.0 \
--browser=/path/to/chromium \
--stories=VanillaJS.* \
--probe=profiling \
--probe=v8.log
poetry run pytest
Run detailed test coverage:
poetry run pytest --cov=crossbench --cov-report=html
Run pytype type checker:
poetry run pytype -j auto crossbench
Crossbench supports running benchmarks on one or multiple browser configurations. The main implementation uses selenium for maximum system independence.
You can specify a single browser with --browser=<name>
poetry run crossbench speedometer_2.0 \
--browser=/path/to/chromium \
-- \
--browser-flag-foo \
--browser-flag-bar \
For more complex scenarios you can use a browser.config.hjson file. It allows you to specify multiple browser and multiple flag configurations in a single file and produce performance numbers with a single invocation.
poetry run crossbench speedometer_2.0 \
--browser-config=config.hjson
The example file lists and explains all configuration details.
Probes define a way to extract arbitrary (performance) numbers from a host or running browser. This can reach from running simple JS-snippets to extract page-specific numbers to system-wide profiling.
Multiple probes can be added with repeated --probe=XXX options. You can use the describe subcommand to list all probes:
poetry run crossbench describe probes
Use the describe command to list all benchmark details:
poetry run crossbench describe benchmarks
Stories define sequences of browser interactions. This can be simply loading a URL and waiting for a given period of time, or in more complex scenarios, actively interact with a page and navigate multiple times.
Use --help or describe to list all stories for a benchmark:
poetry run crossbench speedometer_2.0 --help
Use --stories to list individual comma-separated story names, or use a regular expression as filter.
poetry run crossbench speedometer_2.0 \
--browser=/path/to/chromium \
--stories=VanillaJS.*