mirror of https://github.com/rosenpass/rosenpass.git synced 2025-12-28 21:54:41 -08:00

Files

Karolin Varner d8839ba341 feat(coverage): Reduce coverage false-negatives using grcov

Previously, we would report some tag style macros such as
`#[repr(packed)]` as being uncovered.

We are now also including doctests in our coverage reports.

Finally, a new script `coverage_report.sh` makes coverage checking
easier.

2024-12-07 15:26:47 +01:00

634 B

Raw Blame History

Contributing to Rosenpass

Common operations

Spawn a development environment with nix

nix develop .#fullEnv

You need to install this nix package manager first.

Run our test

Make sure to increase the stack size available; some of our cryptography operations require a lot of stack memory.

RUST_MIN_STACK=8388608 cargo test --workspace --all-features

Generate coverage reports

Keep in mind that many of Rosenpass' tests are doctests, so to get an accurate read on our code coverage, you have to include doctests:

./coverage_report.sh