This library brings the rich assertion types of Google's C++ testing library GoogleTest to Rust. It provides:
The minimum supported Rust version is 1.59. We recommend using at least version 1.66 for the best developer experience.
:warning: The API is not fully stable and may still be changed until we publish version 1.0.
The core of GoogleTest is its matchers. Matchers indicate what aspect of an actual value one is asserting: (in-)equality, containment, regular expression matching, and so on.
To make an assertion using a matcher, GoogleTest offers three macros:
assert_that!] panics if the assertion fails, aborting the test.expect_that!] logs an assertion failure, marking the test as having
failed, but allows the test to continue running (called a non-fatal
assertion). It requires the use of the [googletest::test] attribute macro
on the test itself.verify_that!] has no side effects and evaluates to a [Result<()>] whose
Err variant describes the assertion failure, if there is one. In
combination with the
? operator,
this can be used to abort the test on assertion failure without panicking. It
is also the building block for the other two macros above.For example:
```rust use googletest::prelude::*;
fn failsandpanics() { let value = 2; assert_that!(value, eq(4)); }
fn twologgedfailures() { let value = 2; expectthat!(value, eq(4)); // Test now failed, but continues executing. expectthat!(value, eq(5)); // Second failure is also logged. }
fn failsimmediatelywithoutpanic() -> Result<()> { let value = 2; verifythat!(value, eq(4))?; // Test fails and aborts. verify_that!(value, eq(2))?; // Never executes. Ok(()) }
fn simpleassertion() -> Result<()> { let value = 2; verifythat!(value, eq(4)) // One can also just return the last assertion. } ```
This library includes a rich set of matchers, covering:
Matchers are composable:
```rust use googletest::prelude::*;
fn containsatleastoneitematleast3() { let value = vec![1, 2, 3]; expectthat!(value, contains(ge(3))); } ```
They can also be logically combined:
```rust use googletest::prelude::*;
fn strictlybetween9and11() { let value = 10; expect_that!(value, gt(9).and(not(ge(11)))); } ```
One can use the macro [matches_pattern!] to create a composite matcher for a
struct or enum that matches fields with other matchers:
```rust use googletest::prelude::*;
struct AStruct { afield: i32, anotherfield: i32, athirdfield: &'static str, }
fn structhasexpectedvalues() { let value = AStruct { afield: 10, anotherfield: 100, athirdfield: "A correct value", }; expectthat!(value, matchespattern!(AStruct { afield: eq(10), anotherfield: gt(50), athirdfield: containssubstring("correct"), })); } ```
One can extend the library by writing additional matchers. To do so, create a
struct holding the matcher's data and have it implement the trait [Matcher]:
```rust
struct MyEqMatcher
impl
fn matches(&self, actual: &Self::ActualT) -> MatcherResult {
(self.expected == *actual).into()
}
fn describe(&self, matcher_result: MatcherResult) -> String {
match matcher_result {
MatcherResult::Matches => {
format!("is equal to {:?} the way I define it", self.expected)
}
MatcherResult::DoesNotMatch => {
format!("isn't equal to {:?} the way I define it", self.expected)
}
}
}
} ```
It is recommended to expose a function which constructs the matcher:
rust
pub fn eq_my_way<T: PartialEq + Debug>(expected: T) -> impl Matcher<ActualT = T> {
MyEqMatcher { expected }
}
The new matcher can then be used in the assertion macros:
```rust
fn shouldbeequalbymydefinition() { expectthat!(10, eqmyway(10)); } ```
Using non-fatal assertions, a single test is able to log multiple assertion failures. Any single assertion failure causes the test to be considered having failed, but execution continues until the test completes or otherwise aborts.
This is analogous to the EXPECT_* family of macros in GoogleTest.
To make a non-fatal assertion, use the macro [expect_that!]. The test must
also be marked with [googletest::test] instead of the Rust-standard #[test].
```rust use googletest::prelude::*;
fn threenonfatalassertions() { let value = 2; expectthat!(value, eq(2)); // Passes; test still considered passing. expectthat!(value, eq(3)); // Fails; logs failure and marks the test failed. expectthat!(value, eq(4)); // A second failure, also logged. } ```
This can be used in the same tests as verify_that!, in which case the test
function must also return [Result<()>]:
```rust use googletest::prelude::*;
fn failingnonfatalassertion() -> Result<()> { let value = 2; expectthat!(value, eq(3)); // Just marks the test as having failed. verifythat!(value, eq(2))?; // Passes, so does not abort the test. Ok(()) // Because of the failing expectthat! call above, the // test fails despite returning Ok(()) } ```
```rust use googletest::prelude::*;
fn failingfatalassertionafternonfatalassertion() -> Result<()> { let value = 2; verifythat!(value, eq(3))?; // Fails and aborts the test. expectthat!(value, eq(3)); // Never executes, since the test already aborted. Ok(()) } ```
You can use the #[googletest::test] macro together with many other libraries
such as rstest. Just apply both attribute
macros to the test:
```rust
fn rstestworkswithgoogletest(#[case] value: u32) -> Result<()> { verify_that!(value, gt(0)) } ```
Make sure to put #[googletest::test] before #[rstest]. Otherwise the
annotated test will run twice, since both macros will attempt to register a test
with the Rust test harness.
The macro also works together with async tests with Tokio in the same way:
```rust
async fn shouldworkwithtokio() -> Result<()> { verifythat!(3, gt(0)) } ```
There is one caveat when running async tests: test failure reporting through
and_log_failure will not work properly if the assertion occurs on a different
thread than runs the test.
The macro [verify_pred!] provides predicate assertions analogous to
GoogleTest's EXPECT_PRED family of macros. Wrap an invocation of a predicate
in a verify_pred! invocation to turn that into a test assertion which passes
precisely when the predicate returns true:
```rust fn stuffiscorrect(x: i32, y: i32) -> bool { x == y }
let x = 3; let y = 4; verifypred!(stuffis_correct(x, y))?; ```
The assertion failure message shows the arguments and the values to which they evaluate:
stuff_is_correct(x, y) was false with
x = 3,
y = 4
The verify_pred! invocation evaluates to a [Result<()>] just like
[verify_that!]. There is also a macro [expect_pred!] to make a non-fatal
predicaticate assertion.
The macro [fail!] unconditionally evaluates to a Result indicating a test
failure. It can be used analogously to [verify_that!] and [verify_pred!] to
cause a test to fail, with an optional formatted message:
```rust
fn always_fails() -> Result<()> { fail!("This test must fail with {}", "today") } ```
This library is configurable through environment variables. Since the
configuration does not impact whether a test fails or not but how a failure is
displayed, we recommend setting those variables in the personal
~/.cargo/config.toml instead of in the project-scoped Cargo.toml.
| Variable name | Description | | ------------- | ------------------------------------------------------- | | NOCOLOR | Disables colored output. See https://no-color.org/. | | FORCECOLOR | Forces colors even when the output is piped to a file. |
Please read CONTRIBUTING.md for details on how to contribute to this project.