suitecase 0.0.5

The structured test toolkit. A sync Rust crate for named cases, optional suite and per-case hooks, and macros so each case appears in cargo test—without a custom harness or DSL.
Documentation 
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::fmt::Debug;

/// Asserts that `expected` and `actual` compare equal with `==`.
///
/// # Panics
///
/// Panics when `expected != actual`.
///
/// # Examples
///
/// ```
/// use suitecase::assert::equal;
///
/// equal(&"hello", &"hello");
/// ```
#[track_caller]
pub fn equal<T: PartialEq + Debug + ?Sized>(expected: &T, actual: &T) {
    equal_msg(expected, actual, "");
}

/// Like [`equal`], but includes `msg` in the panic message when the assertion fails.
///
/// # Panics
///
/// Panics when `expected != actual`.
///
/// # Examples
///
/// ```
/// use suitecase::assert::equal_msg;
///
/// equal_msg(&10_i32, &10, "count");
/// ```
#[track_caller]
pub fn equal_msg<T: PartialEq + Debug + ?Sized>(expected: &T, actual: &T, msg: &str) {
    if expected != actual {
        if msg.is_empty() {
            panic!(
                "assertion failed: `equal`\n  expected: `{:?}`\n    actual: `{:?}`",
                expected, actual
            );
        }
        panic!(
            "assertion failed: `equal`: {msg}\n  expected: `{:?}`\n    actual: `{:?}`",
            expected, actual
        );
    }
}

/// Asserts that `expected` and `actual` compare unequal with `==`.
///
/// # Panics
///
/// Panics when `expected == actual`.
///
/// # Examples
///
/// ```
/// use suitecase::assert::not_equal;
///
/// not_equal(&1, &2);
/// ```
#[track_caller]
pub fn not_equal<T: PartialEq + Debug + ?Sized>(expected: &T, actual: &T) {
    not_equal_msg(expected, actual, "");
}

/// Like [`not_equal`], but includes `msg` in the panic message when the assertion fails.
///
/// # Panics
///
/// Panics when `expected == actual`.
///
/// # Examples
///
/// ```
/// use suitecase::assert::not_equal_msg;
///
/// not_equal_msg(&1, &2, "must differ");
/// ```
#[track_caller]
pub fn not_equal_msg<T: PartialEq + Debug + ?Sized>(expected: &T, actual: &T, msg: &str) {
    if expected == actual {
        if msg.is_empty() {
            panic!(
                "assertion failed: `not_equal`\n  both values: `{:?}`",
                expected
            );
        }
        panic!(
            "assertion failed: `not_equal`: {msg}\n  both values: `{:?}`",
            expected
        );
    }
}

/// Converts both values to a common type `V` via [`Into`] and asserts they are equal.
///
/// # Panics
///
/// Panics when the converted values are not equal.
///
/// # Examples
///
/// ```
/// use suitecase::assert::equal_values;
///
/// equal_values::<u32, u64, u64>(1_u32, 1_u64);
/// ```
#[track_caller]
pub fn equal_values<T, U, V>(expected: T, actual: U)
where
    T: Into<V>,
    U: Into<V>,
    V: PartialEq + Debug,
{
    equal_values_msg(expected, actual, "");
}

/// Like [`equal_values`], but includes `msg` in the panic message when the assertion fails.
///
/// # Panics
///
/// Panics when the converted values are not equal.
///
/// # Examples
///
/// ```
/// use suitecase::assert::equal_values_msg;
///
/// equal_values_msg::<u32, u64, u64>(1_u32, 1_u64, "same magnitude");
/// ```
#[track_caller]
pub fn equal_values_msg<T, U, V>(expected: T, actual: U, msg: &str)
where
    T: Into<V>,
    U: Into<V>,
    V: PartialEq + Debug,
{
    let e: V = expected.into();
    let a: V = actual.into();
    equal_msg(&e, &a, msg);
}