shoulds 0.3.0

An intuitive, fluent assertion library for writing expressive test expectations in Rust.
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

use crate::Should;
use std::fmt::Debug;

impl<'a, T, E> Should<'a, Result<T, E>>
where
    T: Debug,
    E: Debug,
{
    /// Asserts that the Result is Ok.
    ///
    /// # Examples
    /// ```
    /// use shoulds::Shouldable;
    ///
    /// let result: Result<i32, &str> = Ok(42);
    /// result.should().be_ok();
    /// ```
    ///
    /// # Panics
    /// Panics if the Result is an Err.
    pub fn be_ok(&self) {
        assert!(
            self.actual().is_ok(),
            "Expected Result to be Ok, but got Err({:?})",
            self.actual().as_ref().err()
        )
    }

    /// Asserts that the Result is Err.
    ///
    /// # Examples
    /// ```
    /// use shoulds::Shouldable;
    ///
    /// let result: Result<i32, &str> = Err("error");
    /// result.should().be_err();
    /// ```
    ///
    /// # Panics
    /// Panics if the Result is Ok.
    pub fn be_err(&self) {
        assert!(
            self.actual().is_err(),
            "Expected Result to be Err, but got Ok({:?})",
            self.actual().as_ref().ok()
        )
    }
}

#[cfg(test)]
mod tests {
    use crate::Shouldable;

    #[test]
    fn be_ok_success_should_not_panic() {
        let result: Result<i32, &str> = Ok(42);
        result.should().be_ok();
    }

    #[test]
    #[should_panic(expected = "Expected Result to be Ok, but got Err")]
    fn be_ok_fail_should_panic() {
        let result: Result<i32, &str> = Err("error");
        result.should().be_ok();
    }

    #[test]
    fn be_err_success_should_not_panic() {
        let result: Result<i32, &str> = Err("error");
        result.should().be_err();
    }

    #[test]
    #[should_panic(expected = "Expected Result to be Err, but got Ok")]
    fn be_err_fail_should_panic() {
        let result: Result<i32, &str> = Ok(42);
        result.should().be_err();
    }
}