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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
/* Convenience macros to reduce munit boiler plate. */
#ifndef TEST_RUNNER_H
#define TEST_RUNNER_H
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include "../../src/tracing.h"
#include "munit.h"
/* Top-level suites array declaration.
*
* These top-level suites hold all module-level child suites and must be defined
* and then set as child suites of a root suite created at runtime by the test
* runner's main(). This can be done using the RUNNER macro. */
extern MunitSuite _main_suites[];
extern int _main_suites_n;
/* Maximum number of test cases for each suite */
#define SUITE__CAP 128
#define TEST__CAP SUITE__CAP
#ifdef DQLITE_ASSERT_WITH_BACKTRACE
#if defined(HAVE_BACKTRACE_H)
#include <backtrace.h>
#include <stdio.h>
#define PRINT_BACKTRACE(SKIP) \
do { \
struct backtrace_state *state_; \
state_ = backtrace_create_state(NULL, SKIP, NULL, NULL); \
backtrace_print(state_, 0, stderr); \
dqlite_print_crash_trace(STDERR_FILENO); \
} while (0)
#elif defined(HAVE_EXECINFO_H) /* HAVE_BACKTRACE_H */
#include <execinfo.h>
#define PRINT_BACKTRACE(SKIP) \
do { \
void *buffer[100]; \
int nptrs = backtrace(buffer, 100); \
if (nptrs > SKIP) { \
backtrace_symbols_fd(buffer + SKIP, nptrs - SKIP, \
STDERR_FILENO); \
} \
dqlite_print_crash_trace(STDERR_FILENO); \
} while (0)
#elif defined(HAVE_LIBUNWIND_H)
#include <libunwind.h>
#include <stdio.h>
#define PRINT_BACKTRACE(SKIP) \
do { \
unw_cursor_t cursor; \
unw_context_t context; \
unw_getcontext(&context); \
unw_init_local(&cursor, &context); \
\
int skip = SKIP; \
while (unw_step(&cursor) > 0) { \
if (skip > 0) { \
skip--; \
continue; \
} \
\
unw_word_t offset, pc; \
char sym[256]; \
\
unw_get_reg(&cursor, UNW_REG_IP, &pc); \
if (pc == 0) { \
break; \
} \
fprintf(stderr, "0x%lx: ", (long)pc); \
\
if (unw_get_proc_name(&cursor, sym, sizeof(sym), \
&offset) == 0) { \
fprintf(stderr, "(%s+0x%lx)\n", sym, \
(long)offset); \
} else { \
fprintf(stderr, "??\n"); \
} \
} \
dqlite_print_crash_trace(STDERR_FILENO); \
} while (0)
#else
# error "backtrace enabled, but no library to support it"
#endif /* HAVE_EXECINFO_H */
#else
#define PRINT_BACKTRACE(SKIP) do {} while (0)
#endif /* DQLITE_ASSERT_WITH_BACKTRACE */
/* Define the top-level suites array and the main() function of the test. */
#define RUNNER(NAME) \
/* This overrides the weak symbol defined in assert.h and will remove \
* any diagnostic printed by dqlite by default. This way tests can \
* provide a global `SIGABRT` hook that will also print a trace in \
* case an assert is triggered by another library (libuv, liblz4, \
* libsqlite3) and provide useful diagnositcs there as well. */ \
void dqlite_fail(const char *__assertion, const char *__file, \
unsigned int __line, const char *__function) \
{ \
__assert_fail(__assertion, __file, __line, __function); \
} \
\
static void print_backtrace(int sig) \
{ \
(void)sig; \
/* Prevent recursive printing of backtrace in case printing \
* raises a signal (because of a bug?) */ \
static bool printing = false; \
if (!printing) { \
printing = true; \
PRINT_BACKTRACE(3); \
printing = false; \
} \
} \
\
MunitSuite _main_suites[SUITE__CAP]; \
int _main_suites_n = 0; \
\
int main(int argc, char *argv[MUNIT_ARRAY_PARAM(argc)]) \
{ \
signal(SIGPIPE, SIG_IGN); \
signal(SIGABRT, print_backtrace); \
dqliteTracingMaybeEnable(true); \
MunitSuite suite = { (char *)"", NULL, _main_suites, 1, 0 }; \
return munit_suite_main(&suite, (void *)NAME, argc, argv); \
}
/* Declare and register a new test suite #S belonging to the file's test module.
*
* A test suite is a pair of static variables:
*
* static MunitTest _##S##_suites[SUITE__CAP]
* static MunitTest _##S##_tests[SUITE__CAP]
*
* The tests and suites attributes of the next available MunitSuite slot in the
* _module_suites array will be set to the suite's tests and suites arrays, and
* the prefix attribute of the slot will be set to /S. */
#define SUITE(S) \
SUITE__DECLARE(S) \
SUITE__ADD_CHILD(main, #S, S)
/* Declare and register a new test. */
#define TEST(S, C, SETUP, TEAR_DOWN, OPTIONS, PARAMS) \
static MunitResult test_##S##_##C(const MunitParameter params[], \
void *data); \
TEST__ADD_TO_SUITE(S, C, SETUP, TEAR_DOWN, OPTIONS, PARAMS) \
static MunitResult test_##S##_##C( \
MUNIT_UNUSED const MunitParameter params[], \
MUNIT_UNUSED void *data)
#define SKIP_IF_NO_FIXTURE \
if (f == NULL) { \
return MUNIT_SKIP; \
}
/* Declare the MunitSuite[] and the MunitTest[] arrays that compose the test
* suite identified by S. */
#define SUITE__DECLARE(S) \
static MunitSuite _##S##_suites[SUITE__CAP]; \
static MunitTest _##S##_tests[SUITE__CAP]; \
static MunitTestSetup _##S##_setup = NULL; \
static MunitTestTearDown _##S##_tear_down = NULL; \
static int _##S##_suites_n = 0; \
static int _##S##_tests_n = 0; \
__attribute__((constructor(101))) static void _##S##_init(void) \
{ \
memset(_##S##_suites, 0, sizeof(_##S##_suites)); \
memset(_##S##_tests, 0, sizeof(_##S##_tests)); \
(void)_##S##_suites_n; \
(void)_##S##_tests_n; \
(void)_##S##_setup; \
(void)_##S##_tear_down; \
}
/* Set the tests and suites attributes of the next available slot of the
* MunitSuite[] array of S1 to the MunitTest[] and MunitSuite[] arrays of S2,
* using the given PREXIX. */
#define SUITE__ADD_CHILD(S1, PREFIX, S2) \
__attribute__((constructor(102))) static void _##S1##_##S2##_init( \
void) \
{ \
int n = _##S1##_suites_n; \
_##S1##_suites[n].prefix = PREFIX; \
_##S1##_suites[n].tests = _##S2##_tests; \
_##S1##_suites[n].suites = _##S2##_suites; \
_##S1##_suites[n].iterations = 0; \
_##S1##_suites[n].options = 0; \
_##S1##_suites_n = n + 1; \
}
/* Add a test case to the MunitTest[] array of suite S. */
#define TEST__ADD_TO_SUITE(S, C, SETUP, TEAR_DOWN, OPTIONS, PARAMS) \
__attribute__((constructor(103))) static void _##S##_tests_##C##_init( \
void) \
{ \
MunitTest *tests = _##S##_tests; \
int n = _##S##_tests_n; \
TEST__SET_IN_ARRAY(tests, n, "/" #C, test_##S##_##C, SETUP, \
TEAR_DOWN, OPTIONS, PARAMS); \
_##S##_tests_n = n + 1; \
}
/* Set the values of the I'th test case slot in the given test array */
#define TEST__SET_IN_ARRAY(TESTS, I, NAME, FUNC, SETUP, TEAR_DOWN, OPTIONS, \
PARAMS) \
TESTS[I].name = NAME; \
TESTS[I].test = FUNC; \
TESTS[I].setup = SETUP; \
TESTS[I].tear_down = TEAR_DOWN; \
TESTS[I].options = OPTIONS; \
TESTS[I].parameters = PARAMS
/**
* Declare and register a new test module #M.
*
* A test module is a test suite (i.e. a pair of MunitTest[] and MunitSuite[]
* arrays), directly or indirectly containing all test cases in a test file.
*
* This macro uses hard-coded names to declare the module's tests and suites
* arrays static, so they can be easly referenced in other static declarations
* generated by the macros below:
*
* static MunitTest _module_tests[TEST__CAP];
* static MunitSuite _module_suites[TEST__CAP];
*
* The tests and suites attributes of the next available MunitSuite slot in the
* top-level suites array will be set to the module's tests and suites arrays,
* and the prefix attribute of the slot will be set to #M.
*
* Each test file should declare one and only one test module.
*/
#define TEST_MODULE(M) \
TEST_SUITE__DECLARE(module); \
TEST_SUITE__ADD_CHILD(main, #M, module);
/**
* Declare and register a new test suite #S belonging to the file's test module.
*
* A test suite is a pair of static variables:
*
* static MunitTest _##S##_suites[TEST__CAP]
* static MunitTest _##S##_tests[TEST__CAP]
*
* The tests and suites attributes of the next available MunitSuite slot in the
* #_module_suites array will be set to the suite's tests and suites arrays, and
* the prefix attribute of the slot will be set to /S.
*
* All tests in the suite will use the same setup and tear down functions.
*/
#define TEST_SUITE(S) \
TEST_SUITE__DECLARE(S); \
TEST_SUITE__ADD_CHILD(module, "/" #S, S);
/**
* Declare a setup function.
*
* Possible signatures are:
*
* - TEST_SETUP(S): Declare the setup function for suite S inline.
* - TEST_SETUP(S, F): Set the setup function for suite S to F.
*/
#define TEST_SETUP(...) TEST_SETUP__MACRO_CHOOSER(__VA_ARGS__)(__VA_ARGS__)
#define TEST_SETUP_(S) \
static void *S##_setup(const MunitParameter[], void *); \
_##S##_setup = S##_setup; \
static void *S##_setup(const MunitParameter params[], void *user_data)
/**
* Declare a tear down function.
*
* Possible signatures are:
*
* - TEST_SETUP(S): Declare the tear down function for suite S inline.
* - TEST_SETUP(S, F): Set the tear down function for suite S to F.
*/
#define TEST_TEAR_DOWN(...) \
TEST_TEAR_DOWN__MACRO_CHOOSER(__VA_ARGS__)(__VA_ARGS__)
/**
* Declare and register a new group of tests #G, belonging to suite #S in the
* file's test module.
*/
#define TEST_GROUP(C, T) \
static MunitTest _##C##_##T##_tests[TEST__CAP]; \
static int _##C##_##T##_tests_n = 0; \
TEST_SUITE__ADD_GROUP(C, T);
/**
* Declare and register a new test case.
*
* Possible signatures are:
*
* - TEST_CASE(C): C gets added to the tests array of the file module.
* - TEST_CASE(S, C): C gets added to the tests array of suite S.
* - TEST_CASE(S, G, C): C gets added to the tests array of group G in suite S.
*
* The test body declaration must follow the macro.
*/
#define TEST_CASE(...) TEST_CASE__MACRO_CHOOSER(__VA_ARGS__)(__VA_ARGS__)
/* Declare the MunitSuite[] and the MunitTest[] arrays that compose the test
* suite identified by S. */
#define TEST_SUITE__DECLARE(S) \
static MunitSuite _##S##_suites[TEST__CAP]; \
static MunitTest _##S##_tests[TEST__CAP]; \
static MunitTestSetup _##S##_setup = NULL; \
static MunitTestTearDown _##S##_tear_down = NULL; \
static int _##S##_suites_n = 0; \
static int _##S##_tests_n = 0; \
__attribute__((constructor)) static void _##S##_init(void) \
{ \
memset(_##S##_suites, 0, sizeof(_##S##_suites)); \
memset(_##S##_tests, 0, sizeof(_##S##_tests)); \
(void)_##S##_suites_n; \
(void)_##S##_tests_n; \
(void)_##S##_setup; \
(void)_##S##_tear_down; \
}
/* Set the tests and suites attributes of the next available slot of the
* MunitSuite[] array of S1 to the MunitTest[] and MunitSuite[] arrays of S2,
* using the given PREXIX. */
#define TEST_SUITE__ADD_CHILD(S1, PREFIX, S2) \
__attribute__((constructor)) static void _##S1##_##S2##_init(void) \
{ \
int n = _##S1##_suites_n; \
_##S1##_suites[n].prefix = PREFIX; \
_##S1##_suites[n].tests = _##S2##_tests; \
_##S1##_suites[n].suites = _##S2##_suites; \
_##S1##_suites[n].iterations = 0; \
_##S1##_suites[n].options = 0; \
_##S1##_suites_n = n + 1; \
}
/* Set the tests attribute of the next available slot of the MunitSuite[] array
* of S to the MunitTest[] array of G, using /G as prefix. */
#define TEST_SUITE__ADD_GROUP(S, G) \
__attribute__((constructor)) static void _##S##_##G##_init(void) \
{ \
int n = _##S##_suites_n; \
_##S##_suites[n].prefix = "/" #G; \
_##S##_suites[n].tests = _##S##_##G##_tests; \
_##S##_suites[n].suites = NULL; \
_##S##_suites[n].iterations = 0; \
_##S##_suites[n].options = 0; \
_##S##_suites_n = n + 1; \
}
/* Choose the appropriate TEST_SETUP__N_ARGS() macro depending on the number of
* arguments passed to TEST_SETUP(). */
#define TEST_SETUP__MACRO_CHOOSER(...) \
TEST__GET_3RD_ARG(__VA_ARGS__, TEST_SETUP__2_ARGS, TEST_SETUP__1_ARGS)
#define TEST_SETUP__1_ARGS(S) \
static void *S##__setup(const MunitParameter[], void *); \
__attribute__((constructor)) static void _##S##_setup_init(void) \
{ \
_##S##_setup = S##__setup; \
} \
static void *S##__setup(const MunitParameter params[], void *user_data)
#define TEST_SETUP__2_ARGS(S, F) \
__attribute__((constructor)) static void _##S##_setup_init(void) \
{ \
_##S##_setup = F; \
}
/* Choose the appropriate TEST_TEAR_DOWN__N_ARGS() macro depending on the number
* of arguments passed to TEST_TEAR_DOWN(). */
#define TEST_TEAR_DOWN__MACRO_CHOOSER(...) \
TEST__GET_3RD_ARG(__VA_ARGS__, TEST_TEAR_DOWN__2_ARGS, \
TEST_TEAR_DOWN__1_ARGS)
#define TEST_TEAR_DOWN__1_ARGS(S) \
static void S##__tear_down(void *data); \
__attribute__((constructor)) static void _##S##__tear_down_init(void) \
{ \
_##S##_tear_down = S##__tear_down; \
} \
static void S##__tear_down(void *data)
#define TEST_TEAR_DOWN__2_ARGS(S, F) \
__attribute__((constructor)) static void _##S##_tear_down_init(void) \
{ \
_##S##_tear_down = F; \
}
/* Choose the appropriate TEST_CASE__N_ARGS() macro depending on the number of
* arguments passed to TEST_CASE(). */
#define TEST_CASE__MACRO_CHOOSER(...) \
TEST__GET_5TH_ARG(__VA_ARGS__, TEST_CASE__4_ARGS, TEST_CASE__3_ARGS, \
TEST_CASE__2_ARGS)
/* Add the test case to the module's MunitTest[] array. */
#define TEST_CASE__2_ARGS(C, PARAMS) \
static MunitResult test_##C(const MunitParameter[], void *); \
TEST_CASE__ADD_TO_MODULE(C, PARAMS); \
static MunitResult test_##C(const MunitParameter params[], void *data)
/* Add test case C to the MunitTest[] array of suite S. */
#define TEST_CASE__3_ARGS(S, C, PARAMS) \
static MunitResult test_##S##_##C(const MunitParameter[], void *); \
TEST_CASE__ADD_TO_SUITE(S, C, PARAMS); \
static MunitResult test_##S##_##C(const MunitParameter params[], \
void *data)
/* Add test case C to the MunitTest[] array of group G of suite S. */
#define TEST_CASE__4_ARGS(S, G, C, PARAMS) \
static MunitResult test_##S##_##G##_##C(const MunitParameter[], \
void *); \
TEST_CASE__ADD_TO_GROUP(S, G, C, PARAMS); \
static MunitResult test_##S##_##G##_##C(const MunitParameter params[], \
void *data)
/* Add a test case to the MunitTest[] array of the file module. */
#define TEST_CASE__ADD_TO_MODULE(C, PARAMS) \
__attribute__((constructor)) static void _module_tests_##C##_init( \
void) \
{ \
MunitTest *tests = _module_tests; \
int n = _module_tests_n; \
TEST_CASE__SET_IN_ARRAY(tests, n, "/" #C, test_##C, NULL, \
NULL, PARAMS); \
_module_tests_n = n + 1; \
}
/* Add a test case to the MunitTest[] array of suite S. */
#define TEST_CASE__ADD_TO_SUITE(S, C, PARAMS) \
__attribute__((constructor)) static void _##S##_tests_##C##_init(void) \
{ \
MunitTest *tests = _##S##_tests; \
int n = _##S##_tests_n; \
TEST_CASE__SET_IN_ARRAY(tests, n, "/" #C, test_##S##_##C, \
_##S##_setup, _##S##_tear_down, \
PARAMS); \
_##S##_tests_n = n + 1; \
}
/* Add a test case to MunitTest[] array of group G in suite S. */
#define TEST_CASE__ADD_TO_GROUP(S, G, C, PARAMS) \
__attribute__(( \
constructor)) static void _##S##_##G##_tests_##C##_init(void) \
{ \
MunitTest *tests = _##S##_##G##_tests; \
int n = _##S##_##G##_tests_n; \
TEST_CASE__SET_IN_ARRAY(tests, n, "/" #C, \
test_##S##_##G##_##C, _##S##_setup, \
_##S##_tear_down, PARAMS); \
_##S##_##G##_tests_n = n + 1; \
}
/* Set the values of the I'th test case slot in the given test array */
#define TEST_CASE__SET_IN_ARRAY(TESTS, I, NAME, FUNC, SETUP, TEAR_DOWN, \
PARAMS) \
TESTS[I].name = NAME; \
TESTS[I].test = FUNC; \
TESTS[I].setup = SETUP; \
TESTS[I].tear_down = TEAR_DOWN; \
TESTS[I].options = 0; \
TESTS[I].parameters = PARAMS
#define TEST__GET_3RD_ARG(arg1, arg2, arg3, ...) arg3
#define TEST__GET_5TH_ARG(arg1, arg2, arg3, arg4, arg5, ...) arg5
#endif /* TEST_RUNNER_H */
|
