milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

docs: Update README to replace use of mutagen with cargo-mutants

This commit is contained in:
AM 2025-03-10 12:17:04 +08:00
parent 694d926ed0
commit a65d1d8b95
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -149,7 +149,7 @@ Unit and integration tests are available for those interested, along with benchm
developers, especially new contributors looking for something to work on, we do: developers, especially new contributors looking for something to work on, we do:
- Fuzz testing with [`Hongfuzz`](https://github.com/rust-fuzz/honggfuzz-rs) - Fuzz testing with [`Hongfuzz`](https://github.com/rust-fuzz/honggfuzz-rs)
- Mutation testing with [`Mutagen`](https://github.com/llogiq/mutagen) - Mutation testing with [`cargo-mutants`](https://github.com/sourcefrog/cargo-mutants)
- Code verification with [`Kani`](https://github.com/model-checking/kani) - Code verification with [`Kani`](https://github.com/model-checking/kani)
There are always more tests to write and more bugs to find, contributions to our testing efforts There are always more tests to write and more bugs to find, contributions to our testing efforts
@ -167,9 +167,9 @@ bench marks use: `RUSTFLAGS='--cfg=bench' cargo +nightly bench`.
### Mutation tests ### Mutation tests
We have started doing mutation testing with [mutagen](https://github.com/llogiq/mutagen). To run We are doing mutation testing with [cargo-mutants](https://github.com/sourcefrog/cargo-mutants). To run
these tests first install the latest dev version with `cargo +nightly install --git https://github.com/llogiq/mutagen` these tests first install with `cargo install --locked cargo-mutants` then run with `cargo mutants --in-place --no-shuffle`.
then run with `RUSTFLAGS='--cfg=mutate' cargo +nightly mutagen`. Note that running these mutation tests will take on the order of 10's of minutes.
### Code verification ### Code verification