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
178
179
180
181
182
183
184
185
186
187
188
189
190
|
[/
/ Copyright (c) 2015 Boost.Test contributors
/
/ Distributed under the Boost Software License, Version 1.0. (See accompanying
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
[section:summary Summary of the API for writing tests]
[table
[
[Assertions]
[Short description]
]
[/ ###############################################################################################]
[
[__BOOST_TEST__, __BOOST_TEST_LEVEL__]
[General purpose assertion macro.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL__]
[Simple validation of a boolean predicate value.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_BITWISE_EQUAL__]
[Bitwise equality test of two elements.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_EQUAL__]
[Equality test of two elements.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_EQUAL_COLLECTIONS__]
[Element-wise equality test of two collections.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_CLOSE__]
[Floating point comparison using a percentage of deviation.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_CLOSE_FRACTION__]
[Floating point comparison using the fraction of the compared operands.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_EXCEPTION__]
[Exception detection and validation check.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_GE__]
[Comparison of two values (with convenient reporting).]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_GT__]
[Comparison of two values (with convenient reporting).]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_LE__]
[Comparison of two values (with convenient reporting).]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_LT__]
[Comparison of two values (with convenient reporting).]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_MESSAGE__]
[Same as __BOOST_LEVEL__ with a custom message in case of failure.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_NE__]
[Comparison of two values (with convenient reporting).]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_NO_THROW__]
[Checks an expression does not throw any exception.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_PREDICATE__]
[Checks a list of arguments against a predicate functor.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_SMALL__]
[Checks a value is small according to a tolerance.]
]
[/ ###############################################################################################]
[
[__BOOST_LEVEL_THROW__]
[Checks an expression throws a specific type of expression.]
]
[/ ###############################################################################################]
[
[__BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES__]
[Indicates the number of expected failures for a test case]
]
[/ ###############################################################################################]
[
[__BOOST_ERROR__]
[Logs an error message, fails but does not abort the current test.]
]
[/ ###############################################################################################]
[
[__BOOST_FAIL__]
[Logs an error message, fails and aborts the current test.]
]
[/ ###############################################################################################]
[
[__BOOST_IS_DEFINED__]
[Checks at runtime whether or not the supplied preprocessor symbol is defined.]
]
]
[table
[
[Decorators]
[Short description]
]
[
[__decorator_expected_failures__]
[Indicates the expected failures of a test unit.]
]
[
[__decorator_timeout__]
[Sets the maximum amount of time a test unit should take.]
]
[
[__decorator_tolerance__]
[Sets the floating point comparison tolerance for a test unit.]
]
]
[table
[
[Control macros]
[Short description]
]
[
[__BOOST_TEST_TOOLS_UNDER_DEBUGGER__]
[When defined, test assertions are compiled in debugger-friendly mode.]
]
[
[__BOOST_TEST_TOOLS_DEBUGGABLE__]
[When defined, test assertions are compiled in two modes (debugger-friendly and full-featured), and the version is selected at run-time.]
]
]
[endsect] [/ testing tools]
|
