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

// 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.

//! **noir** is a request driven, black box testing library for HTTP based APIs.
#![cfg_attr(feature="clippy", feature(plugin))]
#![cfg_attr(feature="clippy", plugin(clippy))]
#![deny(
    missing_docs,
    trivial_casts, trivial_numeric_casts,
    unsafe_code,
    unused_import_braces, unused_qualifications
)]


// Crates ---------------------------------------------------------------------
extern crate url;
#[macro_use]
extern crate json;
extern crate rand;
extern crate hyper;
extern crate colored;
extern crate httparse;
#[macro_use]
extern crate lazy_static;
extern crate difference;


// Modules --------------------------------------------------------------------
mod api;
#[doc(hidden)]
pub mod mock;
mod resource;
mod util;


// Exports --------------------------------------------------------------------
pub use api::options::Options;
pub use api::http::{HttpApi, HttpRequest};
pub use mock::{
    MockResponse, MockRequest, MockProvider,
    MockResponseProvider, MockRequestResponse
};
pub use resource::http::{
    HttpEndpoint,
    HttpResponse,
    HttpHeader,
    HttpBody,
    HttpQueryString,
    HttpFormData
};


/// A convenience macro for creating a vector of `Box<MockResponse>` items.
#[macro_export]
macro_rules! responses {
    ( $( $x:expr ),* ) => (
        {
            let mut temp_vec = Vec::<Box<$crate::MockResponse>>::new();
            $(
                temp_vec.push(Box::new($x));
            )*
            temp_vec
        }
    );
    ( $( $x:expr, )* ) => ( responses![ $($x ),* ] )
}

/// A convenience macro for creating a vector of `Box<MockProvider>` items.
#[macro_export]
macro_rules! mocks {
    ( $( $x:expr ),* ) => (
        {
            let mut temp_vec = Vec::<Box<$crate::MockProvider>>::new();
            $(
                temp_vec.push(Box::new($x));
            )*
            temp_vec
        }
    );
    ( $( $x:expr, )* ) => ( mocks![ $($x ),* ] )
}

/// A convenience macro for creating a vector of `HttpHeader` items.
#[macro_export]
macro_rules! headers {
    ( $( $x:expr ),* ) => (
        {
            let mut temp_vec = Vec::<$crate::HttpHeader>::new();
            $(
                temp_vec.push($x.into());
            )*
            temp_vec
        }
    );
    ( $( $x:expr, )* ) => ( headers![ $($x ),* ] )
}

/// A macro for creating a `HttpQueryString` instance.
#[macro_export]
macro_rules! query {
    {} => ($crate::HttpQueryString::new(vec![]));
    { $( $key:expr => $value:expr ),* } => ({

        let mut items = Vec::new();

        $(
            items.push(($key, $value).into());
        )*

        $crate::HttpQueryString::new(items)
    });
    ( $( $key:expr => $value:expr, )* ) => ( query![ $($key => $value),* ] )
}

/// A macro for creating a `HttpFormData ` instance.
#[macro_export]
macro_rules! form {
    {} => ($crate::HttpFormData::new(vec![]));
    { $( $key:expr => $value:expr ),* } => ({

        let mut fields = Vec::new();

        $(
            fields.push(($key, $value).into());
        )*

        $crate::HttpFormData::new(fields)
    });
    ( $( $key:expr => $value:expr, )* ) => ( form![ $($key => $value),* ] )
}