guide: add a testing section to the contributing guide #598
+131
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hawkw
approved these changes
Aug 29, 2018
CONTRIBUTING.md
Outdated
|
|
||
| Ideally, every API has at least one documentation test that demonstrates how to | ||
| use the API. Documentation tests are run with `cargo test --doc`. This ensures | ||
| that the example is correct and provides additional test coverage. |
There was a problem hiding this comment.
TIOLI: might be good to link to https://doc.rust-lang.org/rustdoc/documentation-tests.html somewhere in here?
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
tobz
approved these changes
Aug 29, 2018
CONTRIBUTING.md
Outdated
| use the API. Documentation tests are run with `cargo test --doc`. This ensures | ||
| that the example is correct and provides additional test coverage. | ||
|
|
||
| The trick to documentation tests is stricking a balance between being susinct |
There was a problem hiding this comment.
nit: stricking -> striking, sucinct -> succinct
CONTRIBUTING.md
Outdated
| `FutureExt::timeout`, this is how the documentation test is structured. | ||
|
|
||
| Lines that start with `/// #` are removed when the documentation is generated. | ||
| They are onlly there to get the test to run. The `block_on_all` function is the |
CONTRIBUTING.md
Outdated
|
|
||
| #### Integration tests | ||
|
|
||
| Integration tests go in the crate that they are test. Each sub crate should have |
There was a problem hiding this comment.
Reword this slightly? Integration tests go in the same crate as the code they are testing, perhaps?
carllerche
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We would like contributors to be able to help out with documentation tests
Solution
Add some notes in the guide on how to write tests.