Developer Notes

Testing

All our testing is cargo based and a simple

$ cargo test

runs the vast majority of tests. Tests require sudo to be set up properly, as some of the functionality we rely on is privileged. Test artifacts are transparently created as long as the generate-unit-test-files feature is active, which is enabled by default for testing.

Benchmarking

We use a mixture of Criterion end-to-end benchmarks and libtest based unit-test style ones.

To run the full benchmark suite, use:

$ cargo bench --features=nightly --features=generate-large-test-files

For all Criterion powered benchmarks, a run will automatically establish a new base line. You can check out a different change, re-run the above command, and it will print the performance difference.

Profiling

To get a CPU profile in the form of a flamegraph, you can use cargo-flamegraph (can be installed via cargo install flamegraph). The following command will create a profile for the bench_function_parsing_blazesym benchmark, for example:

$ cargo flamegraph --package=blazesym --unit-bench --root --features=nightly -- bench_function_parsing_blazesym