Test CLI Applications.


Keywords
command, cli, assert, test, duct
Licenses
MIT/Apache-2.0

Documentation

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:

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.
  • rexpect for testing interactive programs.
  • assert_fs for filesystem fixtures and assertions.
    • or tempfile for scratchpad directories.
  • dir-diff for testing file side-effects.

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.