MCPcopy Index your code
hub / github.com/assert-rs/assert_cmd

github.com/assert-rs/assert_cmd @v2.2.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v2.2.2 ↗ · + Follow
147 symbols 421 edges 15 files 44 documented · 30%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

assert_cmd

Assert process::Command - Easy command initialization and assertions.

Documentation License Crates Status

assert_cmd aims to simplify the process for doing integration testing of CLIs, including: - Finding your crate's binary to test - Assert on the result of your program's run.

Example

Here's a trivial example:

```rust,no_run use assert_cmd::Command;

let mut cmd = Command::cargo_bin("bin_fixture").unwrap(); cmd.assert().success(); ```

See the docs for more.

Relevant crates

Other crates that might be useful in testing command line programs. * escargot for more control over configuring the crate's binary. * duct for orchestrating multiple processes. * or commandspec for easier writing of commands * rexpect for testing interactive programs. * assert_fs for filesystem fixtures and assertions. * or tempfile for scratchpad directories. * dir-diff for testing file side-effects. * cross for cross-platform testing.

License

Licensed under either of

at your option.

Testimonials

fitzgen

assert_cmd is just such a pleasure to use every single time, I fall in love all over again

bravo bravo WG-cli

passcod

Running commands and dealing with output can be complex in many many ways, so assert_cmd smoothing that is excellent, very much welcome, and improves ergonomics significantly.

volks73

I have used [assert_cmd] in other projects and I am extremely pleased with it

coreyja

[assert_cmd] pretty much IS my testing strategy so far, though my app under test is pretty small.

This library has made it really easy to add some test coverage to my project, even when I am just learning how to write Rust!

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.

Extension points exported contracts — how you extend this code

IntoOutputPredicate (Interface)
Used by [`Assert::stdout`] and [`Assert::stderr`] to convert Self into the needed [`predicates_core::Predicate<[u8]>`]. [6 …
src/assert.rs
OutputOkExt (Interface)
Converts a type to an [`OutputResult`]. This is for example implemented on [`std::process::Output`]. # Examples ```ru [3 …
src/output.rs
CommandCargoExt (Interface)
Create a [`Command`] for a `bin` in the Cargo project. `CommandCargoExt` is an extension trait for [`Command`][std::pro [2 …
src/cargo.rs
IntoCodePredicate (Interface)
Used by [`Assert::code`] to convert `Self` into the needed [`predicates_core::Predicate `]. # Examples ```rust,no_ [4 …
src/assert.rs
OutputAssertExt (Interface)
Assert the state of an [`Output`]. # Examples ```rust,no_run use assert_cmd::prelude::*; use std::process::Command; [3 …
src/assert.rs

Core symbols most depended-on inside this repo

unwrap
called by 36
src/cmd.rs
env
called by 31
src/cmd.rs
cargo_bin
called by 31
src/cargo.rs
assert
called by 26
src/cmd.rs
success
called by 13
src/assert.rs
ok
called by 11
src/cmd.rs
stdout
called by 10
src/assert.rs
code
called by 9
src/assert.rs

Shape

Method 76
Function 46
Class 18
Interface 5
Enum 2

Languages

Rust100%

Modules by API surface

src/assert.rs53 symbols
src/cmd.rs27 symbols
src/output.rs20 symbols
src/cargo.rs14 symbols
tests/assert.rs10 symbols
src/color.rs8 symbols
tests/cargo.rs6 symbols
tests/examples.rs2 symbols
src/bin/bin_fixture.rs2 symbols
examples/example_fixture.rs2 symbols
src/lib.rs1 symbols
examples/failure.rs1 symbols

For agents

$ claude mcp add assert_cmd \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact