noir 0.2.0

rust based, DSL alike and request driven, black box testing library for HTTP APIs.
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

// Copyright (c) 2016 Ivo Wetzel

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// STD Dependencies -----------------------------------------------------------
use std::cell::RefCell;
use std::sync::{Arc, Mutex};
use std::io::{Error, ErrorKind};


// Internal Dependencies ------------------------------------------------------
use mock::{MockRequest, MockResponse};


// Global Mocked Response Provider --------------------------------------------
pub struct ResponseProvider {
    response_index: usize,
    provided_responses: Vec<(Box<MockResponse + 'static>, usize, usize)>,
    request_index: usize,
    additional_requests: Vec<Box<MockRequest>>
}

impl ResponseProvider {

    pub fn reset() {
        let handler = PROVIDER_INSTANCE.clone();
        match handler.lock() {
            Ok(handler) => {
                let mut provider = handler.borrow_mut();
                provider.response_index = 0;
                provider.request_index = 0;
            },
            _ => unreachable!()
        };
    }

    pub fn provide(resources: Vec<Box<MockResponse + 'static>>) {
        let handler = PROVIDER_INSTANCE.clone();
        match handler.lock() {
            Ok(handler) => {
                let mut provider = handler.borrow_mut();
                for resource in resources {
                    let index = provider.response_index;
                    provider.provided_responses.push((resource, index, 0));
                    provider.response_index += 1;
                }
            },
            _ => unreachable!()
        };
    }

    #[cfg_attr(feature = "clippy", allow(needless_return))]
    pub fn provided_responses() -> Vec<(Box<MockResponse + 'static>, usize, usize)> {
        let handler = PROVIDER_INSTANCE.clone();
        return match handler.lock() {
            Ok(handler) => {
                let mut provider = handler.borrow_mut();
                return provider.provided_responses.drain(0..).collect();
            },
            _ => Vec::new()
        };
    }

    #[cfg_attr(feature = "clippy", allow(needless_return))]
    pub fn additional_requests() -> Vec<Box<MockRequest + 'static>> {
        let handler = PROVIDER_INSTANCE.clone();
        return match handler.lock() {
            Ok(handler) => {
                let mut provider = handler.borrow_mut();
                return provider.additional_requests.drain(0..).collect();
            },
            _ => Vec::new()
        };
    }

    #[cfg_attr(feature = "clippy", allow(needless_return))]
    pub fn request(
        request: Box<MockRequest>

    ) -> Result<Result<Vec<u8>, Error>, Error> {

        let handler = PROVIDER_INSTANCE.clone();
        return match handler.lock() {
            Ok(handler) => {

                let mut provider = handler.borrow_mut();

                // Increase internal request counter for order validation
                let index = provider.request_index;
                provider.request_index += 1;

                // Check all responses for a potential match
                for &mut(
                    ref mut response,
                    _,
                    ref mut request_index

                ) in &mut provider.provided_responses {
                    if response.matches(&request) {
                        *request_index = index;
                        return Ok(response.respond(request));
                    }
                }

                // Track requests which are missing their response
                provider.additional_requests.push(request);

                Err(Error::new(
                    ErrorKind::ConnectionRefused,
                    "Noir: No response provided in test."
                ))

            },
            _ => Err(Error::new(
                ErrorKind::ConnectionReset,
                "Noir: Handler lock failed."
            ))
        };

    }

}


// Statics --------------------------------------------------------------------
lazy_static! {
    static ref PROVIDER_INSTANCE: Arc<Mutex<RefCell<ResponseProvider>>> = {
        Arc::new(Mutex::new(RefCell::new(ResponseProvider {
            response_index: 0,
            provided_responses: Vec::new(),
            request_index: 0,
            additional_requests: Vec::new()
        })))
    };
}