trycmd
| Crates.io | trycmd |
| lib.rs | trycmd |
| version | |
| source | src |
| created_at | 2021-11-05 20:47:17.007212+00 |
| updated_at | 2025-02-12 14:17:18.145974+00 |
| description | Snapshot testing for a herd of CLI tests |
| homepage | https://github.com/assert-rs/trycmd |
| repository | https://github.com/assert-rs/snapbox/ |
| max_upload_size | |
| id | 477497 |
| Cargo.toml error: | TOML parse error at line 28, column 1 | 28 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Maintainers (github:rust-cli:maintainers)
documentation
README
trycmd
Treat your tests like cattle, instead of pets
trycmd is a test harness that will enumerate test case files and run them to verify the
results, taking inspiration from
trybuild and cram.
Example
To create a minimal setup, create a tests/cli_tests.rs with
#[test]
fn cli_tests() {
trycmd::TestCases::new()
.case("tests/cmd/*.toml")
.case("README.md");
}
and write out your test cases in .toml files along with examples in your README.md.
Run this with cargo test like normal. TestCases will enumerate all test case files and
run the contained commands, verifying they run as expected.
See the docs for more.
Users
- typos (source code spell checker)
- cargo-edit (
Cargo.tomleditor) - clap (CLI parser) to test examples
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.