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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkTestingMacros_h
#define itkTestingMacros_h
#include "itkMacro.h"
#include <cstring>
/** \namespace itk
* \brief The "itk" namespace contains all Insight Segmentation and
* Registration Toolkit (ITK) classes. There are several nested namespaces
* within the itk:: namespace. */
namespace itk
{
// end namespace itk - this is here for documentation purposes
}
// DEPRECATED: These macros are left here for compatibility.
// In the future, they will be removed in favor of the "ITK_" prefixed
// versions.
#if defined(ITK_FUTURE_LEGACY_REMOVE)
# if defined(__clang__) || defined(__GNUC__)
# pragma GCC poison EXERCISE_BASIC_OBJECT_METHODS
# pragma GCC poison TRY_EXPECT_EXCEPTION
# pragma GCC poison TRY_EXPECT_NO_EXCEPTION
# pragma GCC poison TEST_EXPECT_TRUE_STATUS_VALUE
# pragma GCC poison TEST_EXPECT_TRUE
# pragma GCC poison TEST_EXPECT_EQUAL_STATUS_VALUE
# pragma GCC poison TEST_EXPECT_EQUAL
# pragma GCC poison TEST_SET_GET
# pragma GCC poison TEST_SET_GET_VALUE
# pragma GCC poison TEST_SET_GET_NULL_VALUE
# pragma GCC poison TEST_SET_GET_BOOLEAN
# else
# define EXERCISE_BASIC_OBJECT_METHODS "Replace EXERCISE_BASIC_OBJECT_METHODS with ITK_EXERCISE_BASIC_OBJECT_METHODS"
# define TRY_EXPECT_EXCEPTION "Replace TRY_EXPECT_EXCEPTION with ITK_TRY_EXPECT_EXCEPTION"
# define TRY_EXPECT_NO_EXCEPTION "Replace TRY_EXPECT_NO_EXCEPTION with ITK_TRY_EXPECT_NO_EXCEPTION"
# define TEST_EXPECT_TRUE_STATUS_VALUE "Replace TEST_EXPECT_TRUE_STATUS_VALUE with ITK_TEST_EXPECT_TRUE_STATUS_VALUE"
# define TEST_EXPECT_TRUE "Replace TEST_EXPECT_TRUE with ITK_TEST_EXPECT_TRUE"
# define TEST_EXPECT_EQUAL_STATUS_VALUE \
"Replace TEST_EXPECT_EQUAL_STATUS_VALUE with ITK_TEST_EXPECT_EQUAL_STATUS_VALUE"
# define TEST_EXPECT_EQUAL "Replace TEST_EXPECT_EQUAL with ITK_TEST_EXPECT_EQUAL"
# define TEST_SET_GET "Replace TEST_SET_GET with ITK_TEST_SET_GET"
# define TEST_SET_GET_VALUE "Replace TEST_SET_GET_VALUE with ITK_TEST_SET_GET_VALUE"
# define TEST_SET_GET_NULL_VALUE "Replace TEST_SET_GET_NULL_VALUE with ITK_TEST_SET_GET_NULL_VALUE"
# define TEST_SET_GET_BOOLEAN "Replace TEST_SET_GET_BOOLEAN with ITK_TEST_SET_GET_BOOLEAN"
# endif
#else
# define EXERCISE_BASIC_OBJECT_METHODS ITK_EXERCISE_BASIC_OBJECT_METHODS
# define TRY_EXPECT_EXCEPTION ITK_TRY_EXPECT_EXCEPTION
# define TRY_EXPECT_NO_EXCEPTION ITK_TRY_EXPECT_NO_EXCEPTION
# define TEST_EXPECT_TRUE_STATUS_VALUE ITK_TEST_EXPECT_TRUE_STATUS_VALUE
# define TEST_EXPECT_TRUE ITK_TEST_EXPECT_TRUE
# define TEST_EXPECT_EQUAL_STATUS_VALUE ITK_TEST_EXPECT_EQUAL_STATUS_VALUE
# define TEST_EXPECT_EQUAL ITK_TEST_EXPECT_EQUAL
# define TEST_SET_GET ITK_TEST_SET_GET
# define TEST_SET_GET_VALUE ITK_TEST_SET_GET_VALUE
# define TEST_SET_GET_NULL_VALUE ITK_TEST_SET_GET_NULL_VALUE
# define TEST_SET_GET_BOOLEAN ITK_TEST_SET_GET_BOOLEAN
#endif
/* clang-format off */
#if defined(__GNUC__)
#define ITK_EXERCISE_BASIC_OBJECT_METHODS(object, ClassName, SuperclassName) \
object->Print(std::cout); \
std::cout << "Name of Class = " << object->GetNameOfClass() << std::endl; \
ITK_MACROEND_NOOP_STATEMENT
#else // not GCC
#define ITK_EXERCISE_BASIC_OBJECT_METHODS(object, ClassName, SuperclassName) \
object->Print(std::cout); \
std::cout << "Name of Class = " << object->Self::GetNameOfClass() << std::endl; \
std::cout << "Name of Superclass = " << object->Superclass::GetNameOfClass() << std::endl; \
if (!std::strcmp(object->Self::GetNameOfClass(), #ClassName)) \
{ \
std::cout << "Class name is correct" << std::endl; \
} \
else \
{ \
std::cerr << "Class name provided does not match object's NameOfClass" << std::endl; \
return EXIT_FAILURE; \
} \
if (!std::strcmp(object->Superclass::GetNameOfClass(), #SuperclassName)) \
{ \
std::cout << "Superclass name is correct" << std::endl; \
} \
else \
{ \
std::cerr << "Superclass name provided does not match object's Superclass::NameOfClass" << std::endl; \
return EXIT_FAILURE; \
} \
ITK_MACROEND_NOOP_STATEMENT
#endif // GCC
/* clang-format on */
#define ITK_TRY_EXPECT_EXCEPTION(command) \
try \
{ \
std::cout << "Trying " << #command << std::endl; \
command; \
std::cerr << "Failed to catch expected exception" << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
return EXIT_FAILURE; \
} \
catch (const itk::ExceptionObject & excp) \
{ \
std::cout << "Caught expected exception" << std::endl; \
std::cout << excp << std::endl; \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TRY_EXPECT_NO_EXCEPTION(command) \
try \
{ \
std::cout << "Trying " << #command << std::endl; \
command; \
} \
catch (const itk::ExceptionObject & excp) \
{ \
std::cerr << excp << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
return EXIT_FAILURE; \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_EXPECT_TRUE_STATUS_VALUE(command, statusVal) \
{ \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
bool _ITK_TEST_EXPECT_TRUE_command(command); \
ITK_GCC_PRAGMA_POP \
if (!(_ITK_TEST_EXPECT_TRUE_command)) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "Expected true" << std::endl; \
std::cerr << " but got " << _ITK_TEST_EXPECT_TRUE_command << std::endl; \
statusVal = EXIT_FAILURE; \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_EXPECT_TRUE(command) \
{ \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
bool _ITK_TEST_EXPECT_TRUE_command(command); \
ITK_GCC_PRAGMA_POP \
if (!(_ITK_TEST_EXPECT_TRUE_command)) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "Expected true" << std::endl; \
std::cerr << " but got " << _ITK_TEST_EXPECT_TRUE_command << std::endl; \
return EXIT_FAILURE; \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_EXPECT_EQUAL_STATUS_VALUE(lh, rh, statusVal) \
{ \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
bool _ITK_TEST_EXPECT_EQUAL_result((lh) == (rh)); \
ITK_GCC_PRAGMA_POP \
if (!(_ITK_TEST_EXPECT_EQUAL_result)) \
{ \
std::cerr << "Error in " << #lh << " == " << #rh << std::endl; \
std::cerr << "\tIn " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "\tlh: " << (lh) << std::endl; \
std::cerr << "\trh: " << (rh) << std::endl; \
std::cerr << "Expression is not equal" << std::endl; \
statusVal = EXIT_FAILURE; \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_EXPECT_EQUAL(lh, rh) \
{ \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
bool _ITK_TEST_EXPECT_EQUAL_result((lh) == (rh)); \
ITK_GCC_PRAGMA_POP \
if (!(_ITK_TEST_EXPECT_EQUAL_result)) \
{ \
std::cerr << "Error in " << #lh << " == " << #rh << std::endl; \
std::cerr << "\tIn " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "\tlh: " << (lh) << std::endl; \
std::cerr << "\trh: " << (rh) << std::endl; \
std::cerr << "Expression is not equal" << std::endl; \
return EXIT_FAILURE; \
} \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_SET_GET(variable, command) \
if (variable != command) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "Expected " << variable.GetPointer() << std::endl; \
std::cerr << "but got " << command << std::endl; \
return EXIT_FAILURE; \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_SET_GET_VALUE(variable, command) \
ITK_GCC_PRAGMA_PUSH \
ITK_GCC_SUPPRESS_Wfloat_equal \
if (variable != command) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "Expected " << variable << std::endl; \
std::cerr << "but got " << command << std::endl; \
return EXIT_FAILURE; \
} \
ITK_GCC_PRAGMA_POP \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_SET_GET_NULL_VALUE(command) \
if (nullptr != command) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << " In " __FILE__ ", line " << __LINE__ << std::endl; \
std::cerr << "Expected " \
<< "nullptr" << std::endl; \
std::cerr << "but got " << command << std::endl; \
return EXIT_FAILURE; \
} \
ITK_MACROEND_NOOP_STATEMENT
#define ITK_TEST_SET_GET_BOOLEAN(object, variable, value) \
object->Set##variable(false); \
object->Set##variable(true); \
if (object->Get##variable() != 1) \
{ \
std::cerr << "Error in Set/Get" #variable << ", Get" #variable << " is " << object->Get##variable() \
<< " instead of 1" << std::endl; \
return EXIT_FAILURE; \
} \
object->Set##variable(false); \
if (object->Get##variable() != 0) \
{ \
std::cerr << "Error in Set/Get" #variable << ", Get" #variable << " is " << object->Get##variable() \
<< " instead of 0" << std::endl; \
return EXIT_FAILURE; \
} \
object->variable##On(); \
if (object->Get##variable() != 1) \
{ \
std::cerr << "Error in On/Get" #variable << ", Get" #variable << " is " << object->Get##variable() \
<< " instead of 1" << std::endl; \
return EXIT_FAILURE; \
} \
object->variable##Off(); \
if (object->Get##variable() != 0) \
{ \
std::cerr << "Error in Off/Get" #variable << ", Get" #variable << " is " << object->Get##variable() \
<< " instead of 0" << std::endl; \
return EXIT_FAILURE; \
} \
object->Set##variable(value)
/** The name of the executable, argv[0], is not always available as argv[0] may be null.
* In that case, use the name of the test function.
*/
#define itkNameOfTestExecutableMacro(argv) \
[argv](const std::string & functionName) { \
return ((argv == nullptr) || (argv[0] == nullptr) || (argv[0][0] == '\0')) ? ("<" + functionName + " executable>") \
: argv[0]; \
}(__func__)
#endif
|
