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
//! **The structured test toolkit.** A sync Rust library for named **cases**, optional lifecycle
//! hooks, and [`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html) integration
//! via [`run`]—without a custom harness or DSL.
//!
//! # How a run works
//!
//! 1. You build a static slice of [`Case`] values with [`cases!`] and pass [`HookFns`] plus
//! [`RunConfig`] to [`run`].
//! 2. [`run`] **selects** which cases to execute: either all of them, or only the one whose
//! [`Case::name`] equals [`RunConfig::filter`].
//! 3. If nothing is selected and a filter was set, it **panics** (likely a typo). If nothing is
//! selected and there is **no** filter, it returns immediately (empty case list).
//! 4. Otherwise it runs optional hooks in order: `setup_suite` → for each selected case:
//! `before_each` → case body → `after_each` → then `teardown_suite`. Hook slots that are
//! [`None`] in [`HookFns`] are skipped.
//!
//! Panics inside a case are caught so `after_each` still runs; the panic is re-raised afterward.
//!
//! # Macros
//!
//! | Macro | Role |
//! |-------|------|
//! | [`cases!`](crate::cases) | Build `&'static [Case<S>]` from inline blocks per case |
//! | [`test_suite!`](crate::test_suite) | Emit one `#[test]` per case; all share one `Mutex` suite (optional inline [`cases!`] syntax so names are not repeated) |
//!
//! # Assertions
//!
//! The [`mod@assert`] module provides [testify](https://pkg.go.dev/github.com/stretchr/testify/assert)-style
//! helpers (`equal`, `no_error`, `contains`, …) that **panic** on failure, for use in tests and
//! suite case bodies.
//!
//! # Mocking
//!
//! The [`mod@mock`] module provides [testify/mock](https://pkg.go.dev/github.com/stretchr/testify/mock)-style
//! expectations and call recording ([`mock::Mock`], [`mock::mock_args!`]).
//!
//! # Example
//!
//! ```
//! use suitecase::{cases, run, Case, HookFns, RunConfig};
//!
//! #[derive(Default)]
//! struct Counter {
//! n: i32,
//! }
//!
//! static CASES: &[Case<Counter>] = cases![Counter, s =>
//! test_inc => { s.n += 1; },
//! ];
//!
//! let mut suite = Counter::default();
//! run(&mut suite, CASES, RunConfig::all(), &HookFns::default());
//! assert_eq!(suite.n, 1);
//! ```
pub use ;