grin/p2p/fuzz/README.md
hashmap 109a426990
Add fuzz tests for p2p crate (#1931)
Add fuzz tests for p2p crate
2018-11-05 21:50:16 +01:00

38 lines
887 B
Markdown

# Fuzz testing
## Installation
You have to use Rust nightly at the moment.
Cargo-fuzz (https://github.com/rust-fuzz/cargo-fuzz) has been used.
To install it:
```
cargo install cargo-fuzz
```
## Pattern generation for corpus
This step is optional, libFuzz will generate random patterns to populate
corpus (in folder `corpus`). However we can genearete more meaningful pattern
e.g. use serialized form of a real block or transaction. To generate them:
```
cd fuzz
cargo run --bin gen-corpus
```
## Run tests
Fuzz test is basically infinite test, run it for some period of time then
stop if no failures are found.
To run the tests make sure you are in the folder `p2p` otherwise you may get
some misleading errors, then run one of the following tests:
```
cargo fuzz run <fuzz_test_name>
```
Run
```
cargo fuzz list
```
or check `fuzz/Cargo.toml` for the full list of targets.