Add README with instructions for code coverage
This commit is contained in:
parent
4f28d97cf3
commit
1776f9938a
32
README.md
Normal file
32
README.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Music Hoard
|
||||||
|
|
||||||
|
## Code Coverage
|
||||||
|
|
||||||
|
### Pre-requisites
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
rustup component add llvm-tools-preview
|
||||||
|
cargo install grcov
|
||||||
|
```
|
||||||
|
|
||||||
|
### Generating Code Coverage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo clean
|
||||||
|
env RUSTFLAGS="-C instrument-coverage" \
|
||||||
|
LLVM_PROFILE_FILE="target/debug/profraw/musichoard-%p-%m.profraw" \
|
||||||
|
cargo test
|
||||||
|
grcov target/debug/profraw \
|
||||||
|
--binary-path ./target/debug/ \
|
||||||
|
--output-types html \
|
||||||
|
--source-dir . \
|
||||||
|
--ignore-not-existing \
|
||||||
|
--ignore "tests/*" \
|
||||||
|
--ignore "src/main.rs" \
|
||||||
|
--excl-start "#\[cfg\(test\)\]" \
|
||||||
|
--output-path ./target/debug/coverage/
|
||||||
|
xdg-open target/debug/coverage/index.html
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that some changes may not be visible until `target/debug/coverage` is removed and the `grcov`
|
||||||
|
command is rerun.
|
Loading…
Reference in New Issue
Block a user