1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! Companinon crate to 'BinTest', implements test facilities
//!
//!
//! # Description
//!
//! A TestCall uses BinTest and std::process::Command to wrap process execution in a way that
//! is ergonomic to use for (repeated) testing. Few more test facilities are provided and will
//! grow in future.
//!
//!
//! # Initial Example
//!
//! ```rust
//! #[test]
//! fn myprogram_test() {
//!     let executables = BinTest::new();
//!     let mut myprogram = TestCall::new(&executables, "myprogram");
//!
//!     myprogram
//!         .call(["--version"])
//!         .assert_success()
//!         .assert_stdout_utf8("myprogram 0.1.*");
//! }
//! ```
//!
//!
//! # Panics vs. Results
//!
//! 'testcall' is made explicitly for writing tests. To ease this it prefers aborting by panic
//! over error handling. When anything goes wrong the test is aborted and the cause is
//! reported.
//!
//!
//! # Concepts and Facilities
//!
//! augmenting standard/existing things assert capture regex
//! ## Regular Expressions and Captures
//!
//!
//!
//!
//! ## TestCall
//!
//! Allows setting up and calling programs build by your project through the 'bintest' crate
//! or any other executable. Augments 'std::process::Command'. The result of running tests is
//! collected and returned in a 'std::process::Output'.
//!
//!
//! ## TestOutput
//!
//! A Trait that augments 'std::process::Output' with assertions and regex capturing functions
//! to validate the result of a test run. Note that 'std::process::Output' stores the results
//! of a call in memory. Thus testing should not generate excessive outputs (on
//! stdout/stderr).
//!
//!
//! # Future Plans
//!
//! New features will be added as needed, PR's are welcome. This is work in progress.
//!
//!
mod output;
pub mod regex;
mod testcall;

pub use crate::output::TestOutput;
pub use crate::regex::Captured;
pub use crate::testcall::{TestCall, TestChild};
pub use crate::testcall::{NO_ARGS, NO_ENVS};