xpct 0.5.1

An extensible test assertion library
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
170
171
172
173
174
175
176
177

use std::borrow::Borrow;
use std::fmt;

use crate::core::Matcher;
use crate::matchers::collections::{
    BeInMatcher, ConsistOfMatcher, ContainElementsMatcher, Contains, Len,
};

use super::MismatchFormat;

/// Succeeds when the actual value contains the given element.
///
/// You can use this matcher for your own types by implementing [`Contains`] on them.
///
/// # Examples
///
/// ```
/// use xpct::{expect, contain_element};
///
/// expect!("foo").to(contain_element('f'));
/// expect!(["foo", "bar"]).to(contain_element("foo"));
/// ```
pub fn contain_element<'a, T, Actual>(element: T) -> Matcher<'a, Actual, Actual>
where
    T: fmt::Debug + Clone + 'a,
    Actual: fmt::Debug + Contains<T> + 'a,
{
    Matcher::new(
        ContainElementsMatcher::new([element]),
        MismatchFormat::new("to contain elements", "to not contain elements"),
    )
}

/// Succeeds when the actual value contains all the given elements.
///
/// You can use this matcher for your own types by implementing [`Contains`] on them.
///
/// # Examples
///
/// ```
/// use xpct::{expect, contain_elements};
///
/// expect!("foobar").to(contain_elements(['f', 'b']));
/// expect!(["foo", "bar", "baz"]).to(contain_elements(["bar", "foo"]));
/// ```
pub fn contain_elements<'a, T, Expected, Actual>(elements: Expected) -> Matcher<'a, Actual, Actual>
where
    T: fmt::Debug + 'a,
    Actual: fmt::Debug + Contains<T> + 'a,
    Expected: fmt::Debug + IntoIterator + Clone + 'a,
    Expected::Item: Borrow<T>,
{
    Matcher::new(
        ContainElementsMatcher::new(elements),
        MismatchFormat::new("to contain elements", "to not contain elements"),
    )
}

/// Succeeds when the actual value contains exactly the given elements, in any order.
///
/// You can use this matcher for your own types by implementing [`Contains`] and [`Len`] on them.
///
/// # Examples
///
/// ```
/// use xpct::{expect, consist_of};
///
/// expect!(["foo", "bar", "baz"]).to(consist_of(["bar", "foo", "baz"]));
/// ```
pub fn consist_of<'a, T, Expected, Actual>(elements: Expected) -> Matcher<'a, Actual, Actual>
where
    T: 'a,
    Expected: fmt::Debug + Contains<T> + Len + 'a,
    Actual: fmt::Debug + IntoIterator + Len + Clone + 'a,
    Actual::Item: Borrow<T>,
{
    Matcher::new(
        ConsistOfMatcher::new(elements),
        MismatchFormat::new("to consist of elements", "to consist of elements"),
    )
}

/// Succeeds when the actual value is contained in the expected collection.
///
/// You can use this matcher for your own types by implementing [`Contains`] on them.
///
/// # Examples
///
/// ```
/// use xpct::{be_in, expect};
///
/// expect!("Mañana").to(be_in(["Evrart", "Mañana"]));
/// expect!('C').to(be_in("Cuno"));
/// expect!(50).to(be_in(41..57));
/// ```
pub fn be_in<'a, Collection, Actual>(collection: Collection) -> Matcher<'a, Actual, Actual>
where
    Actual: fmt::Debug + 'a,
    Collection: fmt::Debug + Contains<Actual> + 'a,
{
    Matcher::new(
        BeInMatcher::new(collection),
        MismatchFormat::new("to be in", "to not be in"),
    )
}

#[cfg(test)]
mod tests {
    use super::{be_in, consist_of, contain_element};
    use crate::expect;

    #[test]
    fn succeeds_when_contains_elements() {
        expect!(["foo"]).to(contain_element("foo"));
    }

    #[test]
    fn succeeds_when_not_contains_elements() {
        expect!(["foo"]).to_not(contain_element("not contained in the collection"));
    }

    #[test]
    #[should_panic]
    fn fails_when_contains_elements() {
        expect!(["foo"]).to_not(contain_element("foo"));
    }

    #[test]
    #[should_panic]
    fn fails_when_not_contains_elements() {
        expect!(["foo"]).to(contain_element("not contained in the collection"));
    }

    #[test]
    fn succeeds_when_consists_of() {
        expect!(["foo", "bar"]).to(consist_of(["bar", "foo"]));
    }

    #[test]
    fn succeeds_when_not_consists_of() {
        expect!(["foo", "bar"]).to_not(consist_of(["foo"]));
    }

    #[test]
    #[should_panic]
    fn fails_when_consists_of() {
        expect!(["foo", "bar"]).to_not(consist_of(["bar", "foo"]));
    }

    #[test]
    #[should_panic]
    fn fails_when_not_consists_of() {
        expect!(["foo", "bar"]).to(consist_of(["foo"]));
    }

    #[test]
    fn succeeds_when_in_collection() {
        expect!("foo").to(be_in(["foo", "bar"]));
    }

    #[test]
    fn succeeds_when_not_in_collection() {
        expect!("not in collection").to_not(be_in(["foo", "bar"]));
    }

    #[test]
    #[should_panic]
    fn fails_when_in_collection() {
        expect!("foo").to_not(be_in(["foo", "bar"]));
    }

    #[test]
    #[should_panic]
    fn fails_when_not_in_collection() {
        expect!("not in collection").to(be_in(["foo", "bar"]));
    }
}