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
/// Convenience, to write more explicit tests
/// # Requirements
/// The type of the expression that you are testing should derive "Debug"
///
/// # Check your own property
/// You can write assert_that to check the value of a property (using an operator between the property name and the expected value)
/// ```
/// #[test]
/// fn test() {
/// let v = vec![1];
/// assert_that!(v, has len <= 2)
/// }
/// ```
/// And if the specified property is wrong, a clean message would be printed. For example:
/// ```
/// #[test]
/// fn test() {
/// let v = vec![1];
/// assert_that!(v, has len >= 2)
/// }
/// ```
/// would fail with a message like ``Expected `vec![1]`=[1] to have len >= 2, but len = 1.``
///
/// This macro works with two conventions: methods names should follow name patterns like `is_${property}` and `${property}s(...)`
/// That way, it is possible to have more readable messages.
///
/// # Check an existing property for the struct
/// First, the methods with name like `is_${property}()`, for example `is_empty` from Vec. These methods take 0 arguments, and returns as property.
/// For example:
/// ```
/// #[test]
/// fn test() {
/// let v = vec![1];
/// assert_that!(v, is_empty)
/// }
/// ```
/// Would fail with a message like ``Expected `v`=[1] to be empty.``
///
/// # Check an existing property for the struct with a given list of arguments
/// In the same way, any method telling if a property is right for a given list of arguments, should follow the pattern `${property}s(...)`, for example `contains` from Vec. These methods take at least one argument and give a bool as a result.
/// For example:
/// ```
/// #[test]
/// fn test() {
/// let v = vec![1];
/// assert_that!(v, contains &2)
/// }
/// ```
/// Would fail with a message like ``Expected `v`=[1] to contain 2.``
///
/// You can pass as much arguments as needed (at least one).
/// For example testing a struct like Pair:
/// ```
/// #[derive(Debug)]
/// struct Pair(i32,i32);
/// impl Pair{
/// fn contains(&self, i:i32, j:i32) -> bool{
/// // ...
/// false
/// }
/// }
/// ```
/// You can now write the following test:
/// ```
/// #[test]
/// fn test() {
/// let s = Pair(1, 2);
/// assert_that!(s, contains 2, 3)
/// }
/// ```
/// Would fail with a message like ``Expected `s`=Pair(1, 2) to contain 2,3.``