tests: 🧼 document and polish penumbra-mock-consensus library
#4181
Assignees
Labels
A-docs
Area: Documentation needs for the project
A-mock-consensus
Area: Relates to the mock consensus engine
A-testing
Area: Relates to testing of Penumbra
C-enhancement
Category: an enhancement to the codebase
Milestone
Comments
This was referenced Apr 9, 2024
cratelyn
added a commit
that referenced
this issue
Apr 9, 2024
fixes #4181. see #3588. this makes a pass through the `penumbra-mock-consensus` library and further documents various interfaces. one other small tweak, logging a warning if a caller may be inadvertently discarding transactions, is made while we are here. these docs may be rendered by running: `cargo doc --package penumbra-mock-consensus --open` --------- Co-authored-by: Conor Schaefer <conor@penumbralabs.xyz>
1 task
conorsch
pushed a commit
that referenced
this issue
Apr 11, 2024
see #3588. follows #4184 and #4181. this takes a pass through the shared, Penumbra-specific test infrastructure for mock consensus tests. notably, this decomposes `init_chain.rs`, which has now become somewhat redundant with the existence of other more involved tests of e.g. validator uptime tracking. this also cleans up some unused imports, guards against future occurrences of that issue (_sharing code in `tests/` files is awkward_), and decomposes the `common/mod.rs` file into some distinct standalone components. this also belatedly removes the `common::start_test_node()` helper. at some point (_i was unable to find the link_) it was suggested that we refrain from a shared setup helper like that. this branch removes that helper, and updates its call-sites. this branch is largely code motion, and is intended to be a last bit of cleanup as we prepare for #3588 to wind down. ❤️ --------- Co-authored-by: Henry de Valence <hdevalence@penumbralabs.xyz>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
in #3588 we introduced a library for writing integration tests of our
App. while further adoptioon and extension of this library will be an ongoing process, it's time to make a pass through the library to polish and document its interfaces.The text was updated successfully, but these errors were encountered: