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

use block::Context;
use header::{SuiteHeader, SuiteLabel};

/// Test suites bundle a set of closely related test examples into a logical execution group.
#[derive(new)]
pub struct Suite<T> {
    pub(crate) header: SuiteHeader,
    pub(crate) environment: T,
    pub(crate) context: Context<T>,
}

impl<T> Suite<T> {
    pub fn num_blocks(&self) -> usize {
        self.context.num_blocks()
    }

    pub fn num_examples(&self) -> usize {
        self.context.num_examples()
    }

    pub fn is_empty(&self) -> bool {
        self.context.is_empty()
    }
}

unsafe impl<T> Send for Suite<T> where T: Send {}
unsafe impl<T> Sync for Suite<T> where T: Sync {}

/// Creates a test suite from a given root context.
///
/// # Examples
///
/// ```
/// # extern crate rspec;
/// #
/// # use std::io;
/// # use std::sync::Arc;
/// #
/// # pub fn main() {
/// #     let logger = Arc::new(rspec::Logger::new(io::stdout()));
/// #     let configuration = rspec::ConfigurationBuilder::default().build().unwrap();
/// #     let runner = rspec::Runner::new(configuration, vec![logger]);
/// #
/// runner.run(&rspec::suite("a test suite", (), |_ctx| {
///     // …
/// }));
/// # }
/// ```
///
/// Corresponding console output:
///
/// ```text
/// tests
/// Suite "a test suite":
///     …
/// ```
///
/// Available aliases:
///
/// - [`describe`](fn.describe.html).
/// - [`given`](fn.given.html).
pub fn suite<F, T>(name: &'static str, environment: T, body: F) -> Suite<T>
where
    F: FnOnce(&mut Context<T>),
    T: Clone + ::std::fmt::Debug,
{
    let header = SuiteHeader {
        label: SuiteLabel::Suite,
        name,
    };
    suite_internal(header, environment, body)
}

/// Alias for [`suite`](fn.suite.html), see for more info.
///
/// Available further aliases:
///
/// - [`given`](fn.describe.html).
pub fn describe<F, T>(name: &'static str, environment: T, body: F) -> Suite<T>
where
    F: FnOnce(&mut Context<T>),
    T: Clone + ::std::fmt::Debug,
{
    let header = SuiteHeader {
        label: SuiteLabel::Describe,
        name,
    };
    suite_internal(header, environment, body)
}

/// Alias for [`suite`](fn.suite.html), see for more info.
///
/// Available further aliases:
///
/// - [`describe`](fn.describe.html).
pub fn given<F, T>(name: &'static str, environment: T, body: F) -> Suite<T>
where
    F: FnOnce(&mut Context<T>),
    T: Clone + ::std::fmt::Debug,
{
    let header = SuiteHeader {
        label: SuiteLabel::Given,
        name,
    };
    suite_internal(header, environment, body)
}

fn suite_internal<F, T>(header: SuiteHeader, environment: T, body: F) -> Suite<T>
where
    F: FnOnce(&mut Context<T>),
    T: Clone + ::std::fmt::Debug,
{
    let mut ctx = Context::new(None);
    body(&mut ctx);
    Suite::new(header, environment, ctx)
}

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

    #[test]
    fn empty_suite() {
        let suite = suite("name", (), |_| {});
        assert_eq!(suite.header.label, SuiteLabel::Suite);
        assert_eq!(suite.header.name, "name");
        assert_eq!(suite.environment, ());
        assert_eq!(suite.is_empty(), true);
        assert_eq!(suite.num_examples(), 0);
    }

    #[test]
    fn empty_describe() {
        let describe = describe("name", (), |_| {});
        assert_eq!(describe.header.label, SuiteLabel::Describe);
        assert_eq!(describe.header.name, "name");
        assert_eq!(describe.environment, ());
        assert_eq!(describe.is_empty(), true);
        assert_eq!(describe.num_examples(), 0);
    }

    #[test]
    fn empty_given() {
        let given = given("name", (), |_| {});
        assert_eq!(given.header.label, SuiteLabel::Given);
        assert_eq!(given.header.name, "name");
        assert_eq!(given.environment, ());
        assert_eq!(given.is_empty(), true);
        assert_eq!(given.num_examples(), 0);
    }

    #[test]
    fn non_empty_suite() {
        let suite = suite("suite", (), |ctx| {
            ctx.context("context", |_| {});
        });
        assert_eq!(suite.header.label, SuiteLabel::Suite);
        assert_eq!(suite.header.name, "suite");
        assert_eq!(suite.environment, ());
        assert_eq!(suite.is_empty(), false);
        assert_eq!(suite.num_examples(), 0);
    }
}