zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Explain how to derive arbitrary impls

This commit is contained in:
teor 2021-04-28 11:14:02 +10:00 committed by Deirdre Connolly
parent f33db69267
commit 661a8d57dc
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
book/src/dev/proptests.md
View File

@ -4,6 +4,13 @@ Zebra uses the [proptest](https://docs.rs/proptest/) crate for randomised proper
Most types in `zebra-chain` have an `Arbitrary` implementation, which generates randomised test cases.
We try ti derive `Arbitrary` impls whenever possible, so that they autoamtically update when we make structural changes.
To derive, add the following attribute to the struct or enum:
```rust
#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
struct Example(u32);
```
When we want to use those `Arbitrary` impls in proptests in other crates, we use the `proptest-impl` feature as a dev dependency:
1. in `zebra-chain`: make the `Arbitrary` impl depend on `#[cfg(any(test, feature = "proptest-impl"))]`
2. in the other crate: add zebra-chain as a dev dependency: `zebra-chain = { path = "../zebra-chain", features = ["proptest-impl"] }`