Add simple integration test & infrastructure #24
Merged
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
Turns this repository into a cargo workspaces and adds a sub-crate with the wonderful name 'simple-human-panic-test' that lives in the new `tests/` directory. This should be of no consequence to the actual crate itself or its deployment to crates.io, but allows us to easily test how human-panic works when in an external crate. Especially, we can set up the sub-crate `Cargo.toml` files in a way that we can easily test that human-panic's output does not cause panics in humans. For that, I've also added a simple integration test to the `simple` test crate. It uses assert_cli to run the crate's main binary and assert its output contains certain strings (as well as that it exits with a panic- typical exit code). By the way: One benefit of using cargo workspaces is that sub-crates share a lock file and a `target/` directory. So, we can add lots of test crates without worrying of having to recompile dependencies all the time. You can easily run the tests across all sub-crates with `cargo test --all`. In general, most cargo subcommands support `--all`, and I've added it in a few places in the CI config.
for great ~~justice~~ formatting
yoshuawuyts
reviewed
Apr 19, 2018
Cargo.toml
Outdated
|
|
||
| [workspace] | ||
| members = [ | ||
| "tests/simple", |
There was a problem hiding this comment.
Instead of "simple" having a clearer specifier might be useful. Having "simple" as a category isn't very clear on what should be inside of it.
There was a problem hiding this comment.
It's meant as a first step that tests simple, obvious things :D What would you call it?
There was a problem hiding this comment.
Perhaps naming it "tests/single_panic" or something might be clearer as to what it's testing.
spacekookie
approved these changes
Apr 19, 2018
1 task
epage
added a commit
to epage/human-panic
that referenced
this pull request
Sep 27, 2024
chore: Ensure pre-commit gets non-system Python
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.
Turns this repository into a cargo workspaces and adds a sub-crate with the wonderful name 'simple-human-panic-test' that lives in the new
tests/directory. This should be of no consequence to the actual crate itself or its deployment to crates.io, but allows us to easily test how human-panic works when in an external crate. Especially, we can set up the sub-crateCargo.tomlfiles in a way that we can easily test that human-panic's output does not cause panics in humans.For that, I've also added a simple integration test to the
simpletest crate. It uses assert_cli to run the crate's main binary and assert its output contains certain strings (as well as that it exits with a panic- typical exit code). By the way: One benefit of using cargo workspaces is that sub-crates share a lock file and atarget/directory. So, we can add lots of test crates without worrying of having to recompile dependencies all the time.You can easily run the tests across all sub-crates with
cargo test --all. In general, most cargo subcommands support--all, and I've added it in a few places in the CI config.This is the first step towards #18 but I'd like to add more tests before closing this issue.