xpct

xpct is an extensible test assertion library for Rust. It's designed to be ergonomic, batteries-included, and test framework agnostic.

Want to get started? Check out the tutorial.

About

xpct is extensible. In addition to allowing you to write custom matchers, it separates the logic of matchers from how they format their output, meaning you can:

1. Hook into existing formatters to write custom matchers with pretty output without having to worry about formatting.
2. Customize the formatting of existing matchers without having to reimplement their logic.

This crate aims to provide many useful matchers out of the box. Check out the full list of provided matchers.

Docs

• API Docs
• User Docs
  • Tutorial
  • Provided Matchers
  • Cargo Features
  • Writing Custom Matchers
  • Writing Custom Formatters

Examples

A simple equality assertion, like assert_eq:

```rust,should_panic use xpct::{expect, equal};

expect!("disco").to(equal("Disco")); ```

text [src/main.rs:4:5] = "disco" Expected: "disco" to equal: "Disco"

Unwrapping a Some value to make an assertion on the wrapped value:

```rust,shouldpanic use xpct::{begt, be_some, expect};

expect!(Some(41)) .to(besome()) .to(begt(57)); ```

text [src/main.rs:6:5] = Some(41) Expected: 41 to be greater than: 57

Making assertions about individual fields of a struct:

```rust,shouldpanic use xpct::{beempty, bein, betrue, expect, fields, haveprefix, matchfields, not, why};

struct Player { id: String, name: String, level: u32, is_superstar: bool, }

let player = Player { id: String::from("REV12-62-05-JAM41"), name: String::from(""), level: 21, is_superstar: false, };

expect!(player).to(matchfields(fields!(Player { id: haveprefix("REV"), name: not(beempty()), level: bein(1..=20), issuperstar: why(betrue(), "only superstars allowed"), }))); ```

text [src/main.rs:18:5] = player Expected all of these fields to succeed: my_crate::main::Player { id: OK name: FAILED Expected: "" to not be empty level: FAILED Expected: 21 to be in: 1..=20 is_superstar: FAILED 🛈 only superstars allowed Expected this to be true }

Making assertions about elements in a collection:

```rust,shouldpanic use xpct::{bein, containsubstr, equal, expect, havelen, match_elements};

let items = vec!["apple", "pear", "banana"];

expect!(items) .to(havelen(3)) .to(matchelements([ containsubstr("ana"), equal("pear"), bein(["mango", "orange"]), ])); ```

```text [src/main.rs:6:5] = items Expected all of these to succeed: [0] FAILED Expected: "apple" to contain the substring: "ana"

    [2]  FAILED
         Expected:
             "banana"
         to be in:
             ["mango", "orange"]

```

MSRV Policy

The last two stable Rust releases are supported. Older releases may be supported as well.

The MSRV will only be increased when necessary—not every time there is a new Rust release. An increase in the MSRV will be accompanied by a minor semver bump if >=1.0.0 or a patch semver bump if <1.0.0.

Semver Policy

Prior to version 1.0.0, breaking changes will be accompanied by a minor version bump, and new features and bug fixes will be accompanied by a patch version bump.