Skip to content

Commit

Permalink
Update testing docs with note on manual fixture generation
Browse files Browse the repository at this point in the history
Signed-off-by: Thane Thomson <[email protected]>
  • Loading branch information
thanethomson committed Oct 6, 2020
1 parent f71b6af commit 9c21c78
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion rpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ https://docs.tendermint.com/master/rpc/
The RPC types are directly tested through the [integration
tests](./tests/integration.rs). These tests use fixtures taken from running
Tendermint nodes to ensure compatibility without needing access to a running
node during testing. To run these tests locally:
node during testing. All of these fixtures were generated manually, and
automatic regeneration of the fixtures is [on our roadmap][autogen-fixtures].

To run these tests locally:

```bash
# From within the rpc crate
Expand Down Expand Up @@ -91,3 +94,4 @@ cargo test --all-features -- --ignored
[tendermint.rs]: https://crates.io/crates/tendermint
[Tendermint RPC]: https://docs.tendermint.com/master/rpc/
[`/subscribe` endpoint]: https://docs.tendermint.com/master/rpc/#/Websocket/subscribe
[autogen-fixtures]: https://github.com/informalsystems/tendermint-rs/issues/612

0 comments on commit 9c21c78

Please sign in to comment.