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

Add extra crate dependencies to the proptest docs (#2071)

This commit is contained in:
teor 2021-04-27 22:42:22 +10:00 committed by GitHub
parent 3377a486c6
commit 4b948e67a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -5,5 +5,12 @@ 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.
When we want to use those `Arbitrary` impls in proptests in other crates, we use the `proptest-impl` feature as a dev dependency:
* in `zebra-chain`: make the `Arbitrary` impl depend on `#[cfg(any(test, feature = "proptest-impl"))]`
* in the other crate: add zebra-chain as a dev dependency: `zebra-chain = { path = "../zebra-chain", features = ["proptest-impl"] }`
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"] }`
If we need to add another dependency as part of the `proptest-impl` feature:
1. Add the crate name to the list of crates in the `proptest-impl` `features` entry
2. Add the crate as an optional `dependencies` entry
3. Add the crate as a required `dev-dependencies` entry
For an example of these changes, see [PR 2070](https://github.com/ZcashFoundation/zebra/pull/2070/files).