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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
//! Result matchers.
use core::fmt::Debug;
use crate::error::MatchError;
use crate::expectation::Expectation;
impl<T: Debug, E: Debug> Expectation<Result<T, E>> {
/// Asserts the result is `Ok`.
///
/// Use [`to_be_ok_with`](Expectation::to_be_ok_with) when you also
/// need to check the inner value.
///
/// # Errors
///
/// Returns [`MatchError`] if the value is `Err` (or `Ok` when negated).
///
/// ```text
/// expect!(response)
/// actual: Err("not found")
/// expected: to be Ok(_)
/// ```
///
/// # Examples
///
/// ```
/// use behave::Expectation;
///
/// let val: Result<i32, &str> = Ok(1);
/// let result = Expectation::new(val, "Ok(1)").to_be_ok();
/// assert!(result.is_ok());
/// ```
pub fn to_be_ok(&self) -> Result<(), MatchError> {
self.check(self.value().is_ok(), "to be Ok(_)")
}
/// Asserts the result is `Err`.
///
/// # Errors
///
/// Returns [`MatchError`] if the value is `Ok` (or `Err` when negated).
///
/// # Examples
///
/// ```
/// use behave::Expectation;
///
/// let val: Result<i32, &str> = Err("oops");
/// let result = Expectation::new(val, "Err").to_be_err();
/// assert!(result.is_ok());
/// ```
pub fn to_be_err(&self) -> Result<(), MatchError> {
self.check(self.value().is_err(), "to be Err(_)")
}
}
impl<T: Debug, E: Debug> Expectation<Result<T, E>> {
/// Asserts the result is `Ok` and the inner value satisfies a predicate.
///
/// The `desc` argument appears in failure messages (e.g. `"to be positive"`).
///
/// # Errors
///
/// Returns [`MatchError`] if the result is `Err` or the predicate returns `false`.
///
/// ```text
/// expect!(result)
/// actual: Ok(0)
/// expected: to be Ok(_) and to be positive
/// ```
///
/// # Examples
///
/// ```
/// use behave::Expectation;
///
/// let val: Result<i32, &str> = Ok(42);
/// let result = Expectation::new(val, "x")
/// .to_be_ok_and(|v| *v > 0, "to be positive");
/// assert!(result.is_ok());
/// ```
pub fn to_be_ok_and(
&self,
predicate: impl FnOnce(&T) -> bool,
desc: &str,
) -> Result<(), MatchError> {
let is_match = self.value().as_ref().is_ok_and(predicate);
self.check(is_match, format!("to be Ok(_) and {desc}"))
}
/// Asserts the result is `Err` and the error value satisfies a predicate.
///
/// The `desc` argument appears in failure messages (e.g. `"to contain 'timeout'"`).
///
/// # Errors
///
/// Returns [`MatchError`] if the result is `Ok` or the predicate returns `false`.
///
/// ```text
/// expect!(result)
/// actual: Err("unknown")
/// expected: to be Err(_) and to contain 'timeout'
/// ```
///
/// # Examples
///
/// ```
/// use behave::Expectation;
///
/// let val: Result<i32, String> = Err("timeout error".to_string());
/// let result = Expectation::new(val, "x")
/// .to_be_err_and(|e| e.contains("timeout"), "to contain 'timeout'");
/// assert!(result.is_ok());
/// ```
pub fn to_be_err_and(
&self,
predicate: impl FnOnce(&E) -> bool,
desc: &str,
) -> Result<(), MatchError> {
let is_match = self.value().as_ref().is_err_and(predicate);
self.check(is_match, format!("to be Err(_) and {desc}"))
}
}
impl<T: Debug + PartialEq, E: Debug> Expectation<Result<T, E>> {
/// Asserts the result is `Ok` containing the expected value.
///
/// # Errors
///
/// Returns [`MatchError`] if the result is `Err` or contains a different value.
///
/// # Examples
///
/// ```
/// use behave::Expectation;
///
/// let val: Result<i32, &str> = Ok(42);
/// let result = Expectation::new(val, "Ok(42)").to_be_ok_with(42);
/// assert!(result.is_ok());
/// ```
#[allow(clippy::needless_pass_by_value)]
pub fn to_be_ok_with(&self, expected: T) -> Result<(), MatchError> {
let is_match = self.value().as_ref().is_ok_and(|val| *val == expected);
self.check(is_match, format!("to be Ok({expected:?})"))
}
}
impl<T: Debug, E: Debug + PartialEq> Expectation<Result<T, E>> {
/// Asserts the result is `Err` containing the expected error value.
///
/// # Errors
///
/// Returns [`MatchError`] if the result is `Ok` or contains a different error.
///
/// # Examples
///
/// ```
/// use behave::Expectation;
///
/// let val: Result<i32, &str> = Err("oops");
/// let result = Expectation::new(val, "Err(oops)").to_be_err_with("oops");
/// assert!(result.is_ok());
/// ```
#[allow(clippy::needless_pass_by_value)]
pub fn to_be_err_with(&self, expected: E) -> Result<(), MatchError> {
let is_match = self.value().as_ref().is_err_and(|err| *err == expected);
self.check(is_match, format!("to be Err({expected:?})"))
}
}
#[cfg(test)]
mod tests {
use crate::Expectation;
#[test]
fn to_be_ok_pass() {
let val: Result<i32, &str> = Ok(1);
assert!(Expectation::new(val, "x").to_be_ok().is_ok());
}
#[test]
fn to_be_ok_fail() {
let val: Result<i32, &str> = Err("e");
assert!(Expectation::new(val, "x").to_be_ok().is_err());
}
#[test]
fn to_be_ok_negated() {
let val: Result<i32, &str> = Err("e");
assert!(Expectation::new(val, "x").negate().to_be_ok().is_ok());
}
#[test]
fn to_be_err_pass() {
let val: Result<i32, &str> = Err("e");
assert!(Expectation::new(val, "x").to_be_err().is_ok());
}
#[test]
fn to_be_err_fail() {
let val: Result<i32, &str> = Ok(1);
assert!(Expectation::new(val, "x").to_be_err().is_err());
}
#[test]
fn to_be_err_negated() {
let val: Result<i32, &str> = Ok(1);
assert!(Expectation::new(val, "x").negate().to_be_err().is_ok());
}
#[test]
fn to_be_ok_with_pass() {
let val: Result<i32, &str> = Ok(42);
assert!(Expectation::new(val, "x").to_be_ok_with(42).is_ok());
}
#[test]
fn to_be_ok_with_wrong_value() {
let val: Result<i32, &str> = Ok(42);
assert!(Expectation::new(val, "x").to_be_ok_with(99).is_err());
}
#[test]
fn to_be_ok_with_err() {
let val: Result<i32, &str> = Err("e");
assert!(Expectation::new(val, "x").to_be_ok_with(42).is_err());
}
#[test]
fn to_be_ok_with_negated_pass() {
let val: Result<i32, &str> = Ok(42);
assert!(Expectation::new(val, "x")
.negate()
.to_be_ok_with(99)
.is_ok());
}
#[test]
fn to_be_ok_with_negated_fail() {
let val: Result<i32, &str> = Ok(42);
assert!(Expectation::new(val, "x")
.negate()
.to_be_ok_with(42)
.is_err());
}
#[test]
fn to_be_err_with_pass() {
let val: Result<i32, &str> = Err("oops");
assert!(Expectation::new(val, "x").to_be_err_with("oops").is_ok());
}
#[test]
fn to_be_err_with_wrong_value() {
let val: Result<i32, &str> = Err("oops");
assert!(Expectation::new(val, "x").to_be_err_with("other").is_err());
}
#[test]
fn to_be_err_with_ok() {
let val: Result<i32, &str> = Ok(1);
assert!(Expectation::new(val, "x").to_be_err_with("e").is_err());
}
#[test]
fn to_be_err_with_negated_pass() {
let val: Result<i32, &str> = Err("oops");
assert!(Expectation::new(val, "x")
.negate()
.to_be_err_with("other")
.is_ok());
}
#[test]
fn to_be_err_with_negated_fail() {
let val: Result<i32, &str> = Err("oops");
assert!(Expectation::new(val, "x")
.negate()
.to_be_err_with("oops")
.is_err());
}
// --- to_be_ok_and ---
#[test]
fn to_be_ok_and_pass() {
let val: Result<i32, &str> = Ok(42);
assert!(Expectation::new(val, "x")
.to_be_ok_and(|v| *v > 0, "to be positive")
.is_ok());
}
#[test]
fn to_be_ok_and_fail_err() {
let val: Result<i32, &str> = Err("e");
assert!(Expectation::new(val, "x")
.to_be_ok_and(|v| *v > 0, "to be positive")
.is_err());
}
#[test]
fn to_be_ok_and_fail_predicate() {
let val: Result<i32, &str> = Ok(-1);
assert!(Expectation::new(val, "x")
.to_be_ok_and(|v| *v > 0, "to be positive")
.is_err());
}
#[test]
fn to_be_ok_and_negated() {
let val: Result<i32, &str> = Ok(-1);
assert!(Expectation::new(val, "x")
.negate()
.to_be_ok_and(|v| *v > 0, "to be positive")
.is_ok());
}
// --- to_be_err_and ---
#[test]
fn to_be_err_and_pass() {
let val: Result<i32, String> = Err("timeout error".to_string());
assert!(Expectation::new(val, "x")
.to_be_err_and(|e| e.contains("timeout"), "to contain 'timeout'")
.is_ok());
}
#[test]
fn to_be_err_and_fail_ok() {
let val: Result<i32, String> = Ok(1);
assert!(Expectation::new(val, "x")
.to_be_err_and(|e| e.contains("timeout"), "to contain 'timeout'")
.is_err());
}
#[test]
fn to_be_err_and_fail_predicate() {
let val: Result<i32, String> = Err("other error".to_string());
assert!(Expectation::new(val, "x")
.to_be_err_and(|e| e.contains("timeout"), "to contain 'timeout'")
.is_err());
}
#[test]
fn to_be_err_and_negated() {
let val: Result<i32, String> = Err("other".to_string());
assert!(Expectation::new(val, "x")
.negate()
.to_be_err_and(|e| e.contains("timeout"), "to contain 'timeout'")
.is_ok());
}
}