rspec 1.0.0

Write Rspec-like tests with stable 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
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

use std::convert::From;

use time::Duration;

use report::Report;

#[cfg(feature = "expectest_compat")]
use expectest::core::TestResult as ExpectestResult;

#[derive(Clone, PartialEq, Eq, Debug)]
pub enum ExampleResult {
    Success,
    Failure(Option<String>),
    Ignored,
}

impl ExampleResult {
    fn is_success(&self) -> bool {
        &ExampleResult::Success == self
    }

    fn is_failure(&self) -> bool {
        matches!(self, &ExampleResult::Failure(_))
    }

    fn get_passed(&self) -> u32 {
        if &ExampleResult::Success == self {
            1
        } else {
            0
        }
    }

    fn get_failed(&self) -> u32 {
        if let ExampleResult::Failure(_) = self {
            1
        } else {
            0
        }
    }

    fn get_ignored(&self) -> u32 {
        if &ExampleResult::Ignored == self {
            1
        } else {
            0
        }
    }
}

/// rspec considers examples returning `()` a success.
impl From<()> for ExampleResult {
    fn from(_other: ()) -> ExampleResult {
        ExampleResult::Success
    }
}

/// rspec considers examples returning `true` a success, `false` a failure.
impl From<bool> for ExampleResult {
    fn from(other: bool) -> ExampleResult {
        if other {
            ExampleResult::Success
        } else {
            ExampleResult::Failure(Some(
                "assertion failed: `expected condition to be true`".to_owned(),
            ))
        }
    }
}

/// rspec considers examples returning `Result::Ok(…)` a success, `Result::Err(…)` a failure.
impl<T1, T2> From<Result<T1, T2>> for ExampleResult
where
    T2: ::std::fmt::Debug,
{
    fn from(other: Result<T1, T2>) -> ExampleResult {
        match other {
            Ok(_) => ExampleResult::Success,
            Err(error) => ExampleResult::Failure(Some(format!("{:?}", error))),
        }
    }
}

/// rspec considers examples returning `ExpectestResult::Ok(…)` a success, `ExpectestResult::Err(…)` a failure.
#[cfg(feature = "expectest_compat")]
impl From<ExpectestResult> for ExampleResult {
    fn from(other: ExpectestResult) -> ExampleResult {
        match other {
            ExpectestResult::Success => ExampleResult::Success,
            ExpectestResult::Failure(failure) => {
                ExampleResult::Failure(Some(format!("{:?}", failure)))
            }
        }
    }
}

/// `ExampleReport` holds the results of a context example's test execution.
#[derive(Clone, PartialEq, Eq, Debug, new)]
pub struct ExampleReport {
    result: ExampleResult,
    duration: Duration,
}

impl ExampleReport {
    pub fn get_result(&self) -> &ExampleResult {
        &self.result
    }
}

impl Report for ExampleReport {
    fn is_success(&self) -> bool {
        self.result.is_success()
    }

    fn is_failure(&self) -> bool {
        self.result.is_failure()
    }

    fn get_passed(&self) -> u32 {
        self.result.get_passed()
    }

    fn get_failed(&self) -> u32 {
        self.result.get_failed()
    }

    fn get_ignored(&self) -> u32 {
        self.result.get_ignored()
    }

    fn get_duration(&self) -> Duration {
        self.duration
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn from_void() {
        assert!(ExampleResult::from(()).is_success());
    }

    #[test]
    fn from_bool() {
        assert!(ExampleResult::from(true).is_success());
        assert!(ExampleResult::from(false).is_failure());
    }

    #[test]
    fn from_result() {
        let ok_result: Result<(), ()> = Ok(());
        let err_result: Result<(), ()> = Err(());
        assert!(ExampleResult::from(ok_result).is_success());
        assert!(ExampleResult::from(err_result).is_failure());
    }

    #[cfg(feature = "expectest_compat")]
    #[test]
    #[should_panic]
    fn from_expectest_result() {
        let ok_result = ExpectestResult::new_success();
        // A failure ExpectestResult panics on drop, hence the `#[should_panic]`.
        let err_result = ExpectestResult::new_failure("dummy".to_owned(), None);
        assert!(ExampleResult::from(ok_result).is_success());
        assert!(ExampleResult::from(err_result).is_failure());
    }
}