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

//! Loggers can be attached to the Runner to log the progression and results of a test suite.
//!
//! # 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]);
//! # }
//! ```

mod serial;

use std::io;

use header::{ContextHeader, ExampleHeader, SuiteHeader};
use logger::serial::SerialLogger;
use report::{BlockReport, ContextReport, ExampleReport, SuiteReport};
use runner::{Runner, RunnerObserver};

/// Preferred logger for test suite execution.
pub struct Logger<T: io::Write> {
    serial: SerialLogger<T>,
}

impl<T: io::Write> Logger<T>
where
    T: Send + Sync,
{
    pub fn new(buffer: T) -> Logger<T> {
        Logger {
            serial: SerialLogger::new(buffer),
        }
    }

    fn replay_suite(&self, runner: &Runner, suite: &SuiteHeader, report: &SuiteReport) {
        self.serial.enter_suite(runner, suite);
        self.replay_context(runner, None, report.get_context());
        self.serial.exit_suite(runner, suite, report);
    }

    fn replay_block(&self, runner: &Runner, report: &BlockReport) {
        match report {
            BlockReport::Context(ref header, ref report) => {
                self.replay_context(runner, header.as_ref(), report);
            }
            BlockReport::Example(ref header, ref report) => {
                self.replay_example(runner, header, report);
            }
        }
    }

    fn replay_context(
        &self,
        runner: &Runner,
        context: Option<&ContextHeader>,
        report: &ContextReport,
    ) {
        if let Some(header) = context {
            self.serial.enter_context(runner, header);
        }
        for report in report.get_blocks() {
            self.replay_block(runner, report);
        }
        if let Some(header) = context {
            self.serial.exit_context(runner, header, report);
        }
    }

    fn replay_example(&self, runner: &Runner, example: &ExampleHeader, report: &ExampleReport) {
        self.serial.enter_example(runner, example);
        self.serial.exit_example(runner, example, report);
    }
}

impl<T: io::Write> RunnerObserver for Logger<T>
where
    T: Send + Sync,
{
    fn enter_suite(&self, runner: &Runner, header: &SuiteHeader) {
        if runner.configuration.parallel {
            // If the suite is being evaluated in parallel we basically wait for `exit_suite`.
        } else {
            self.serial.enter_suite(runner, header);
        }
    }

    fn exit_suite(&self, runner: &Runner, header: &SuiteHeader, report: &SuiteReport) {
        if runner.configuration.parallel {
            // If the suite is being evaluated in parallel and we have reached the end of it,
            // then it is time to forward a replay of the events to the inner serial logger:
            self.replay_suite(runner, header, report);
        } else {
            self.serial.exit_suite(runner, header, report);
        }
    }

    fn enter_context(&self, runner: &Runner, header: &ContextHeader) {
        if runner.configuration.parallel {
            // If the suite is being evaluated in parallel we basically wait for `exit_suite`.
        } else {
            self.serial.enter_context(runner, header);
        }
    }

    fn exit_context(&self, runner: &Runner, header: &ContextHeader, report: &ContextReport) {
        if runner.configuration.parallel {
            // If the suite is being evaluated in parallel we basically wait for `exit_suite`.
        } else {
            self.serial.exit_context(runner, header, report);
        }
    }

    fn enter_example(&self, runner: &Runner, header: &ExampleHeader) {
        if runner.configuration.parallel {
            // If the suite is being evaluated in parallel we basically wait for `exit_suite`.
        } else {
            self.serial.enter_example(runner, header);
        }
    }

    fn exit_example(&self, runner: &Runner, header: &ExampleHeader, report: &ExampleReport) {
        if runner.configuration.parallel {
            // If the suite is being evaluated in parallel we basically wait for `exit_suite`.
        } else {
            self.serial.exit_example(runner, header, report);
        }
    }
}