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
|
#ifndef TEST_LIB_H
#define TEST_LIB_H
#include "git-compat-util.h"
/*
* Run a test function, returns 1 if the test succeeds, 0 if it
* fails. If test_skip_all() has been called then the test will not be
* run. The description for each test should be unique. For example:
*
* TEST(test_something(arg1, arg2), "something %d %d", arg1, arg2)
*/
#define TEST(t, ...) \
test__run_end(test__run_begin() ? 0 : (t, 1), \
TEST_LOCATION(), __VA_ARGS__)
/*
* Run a test unless test_skip_all() has been called. Acts like a
* conditional; the test body is expected as a statement or block after
* the closing parenthesis. The description for each test should be
* unique. E.g.:
*
* if_test ("something else %d %d", arg1, arg2) {
* prepare();
* test_something_else(arg1, arg2);
* cleanup();
* }
*/
#define if_test(...) \
if (test__run_begin() ? \
(test__run_end(0, TEST_LOCATION(), __VA_ARGS__), 0) : \
(test__run_describe(TEST_LOCATION(), __VA_ARGS__), 1))
/*
* Print a test plan, should be called before any tests. If the number
* of tests is not known in advance test_done() will automatically
* print a plan at the end of the test program.
*/
void test_plan(int count);
/*
* test_done() must be called at the end of main(). It will print the
* plan if plan() was not called at the beginning of the test program
* and returns the exit code for the test program.
*/
int test_done(void);
/* Skip the current test. */
__attribute__((format (printf, 1, 2)))
void test_skip(const char *format, ...);
/* Skip all remaining tests. */
__attribute__((format (printf, 1, 2)))
void test_skip_all(const char *format, ...);
/* Print a diagnostic message to stdout. */
__attribute__((format (printf, 1, 2)))
void test_msg(const char *format, ...);
/*
* Test checks are built around test_assert(). checks return 1 on
* success, 0 on failure. If any check fails then the test will fail. To
* create a custom check define a function that wraps test_assert() and
* a macro to wrap that function to provide a source location and
* stringified arguments. Custom checks that take pointer arguments
* should be careful to check that they are non-NULL before
* dereferencing them. For example:
*
* static int check_oid_loc(const char *loc, const char *check,
* struct object_id *a, struct object_id *b)
* {
* int res = test_assert(loc, check, a && b && oideq(a, b));
*
* if (!res) {
* test_msg(" left: %s", a ? oid_to_hex(a) : "NULL";
* test_msg(" right: %s", b ? oid_to_hex(a) : "NULL";
*
* }
* return res;
* }
*
* #define check_oid(a, b) \
* check_oid_loc(TEST_LOCATION(), "oideq("#a", "#b")", a, b)
*/
int test_assert(const char *location, const char *check, int ok);
/* Helper macro to pass the location to checks */
#define TEST_LOCATION() TEST__MAKE_LOCATION(__LINE__)
/* Check a boolean condition. */
#define check(x) \
check_bool_loc(TEST_LOCATION(), #x, x)
int check_bool_loc(const char *loc, const char *check, int ok);
/*
* Compare the equality of two pointers of same type. Prints a message
* with the two values if the equality fails. NB this is not thread
* safe.
*/
#define check_pointer_eq(a, b) \
(test__tmp[0].p = (a), test__tmp[1].p = (b), \
check_pointer_eq_loc(TEST_LOCATION(), #a" == "#b, \
test__tmp[0].p == test__tmp[1].p, \
test__tmp[0].p, test__tmp[1].p))
int check_pointer_eq_loc(const char *loc, const char *check, int ok,
const void *a, const void *b);
/*
* Compare two integers. Prints a message with the two values if the
* comparison fails. NB this is not thread safe.
*/
#define check_int(a, op, b) \
(test__tmp[0].i = (a), test__tmp[1].i = (b), \
check_int_loc(TEST_LOCATION(), #a" "#op" "#b, \
test__tmp[0].i op test__tmp[1].i, \
test__tmp[0].i, test__tmp[1].i))
int check_int_loc(const char *loc, const char *check, int ok,
intmax_t a, intmax_t b);
/*
* Compare two unsigned integers. Prints a message with the two values
* if the comparison fails. NB this is not thread safe.
*/
#define check_uint(a, op, b) \
(test__tmp[0].u = (a), test__tmp[1].u = (b), \
check_uint_loc(TEST_LOCATION(), #a" "#op" "#b, \
test__tmp[0].u op test__tmp[1].u, \
test__tmp[0].u, test__tmp[1].u))
int check_uint_loc(const char *loc, const char *check, int ok,
uintmax_t a, uintmax_t b);
/*
* Compare two chars. Prints a message with the two values if the
* comparison fails. NB this is not thread safe.
*/
#define check_char(a, op, b) \
(test__tmp[0].c = (a), test__tmp[1].c = (b), \
check_char_loc(TEST_LOCATION(), #a" "#op" "#b, \
test__tmp[0].c op test__tmp[1].c, \
test__tmp[0].c, test__tmp[1].c))
int check_char_loc(const char *loc, const char *check, int ok,
char a, char b);
/* Check whether two strings are equal. */
#define check_str(a, b) \
check_str_loc(TEST_LOCATION(), "!strcmp("#a", "#b")", a, b)
int check_str_loc(const char *loc, const char *check,
const char *a, const char *b);
/*
* Wrap a check that is known to fail. If the check succeeds then the
* test will fail. Returns 1 if the check fails, 0 if it
* succeeds. For example:
*
* TEST_TODO(check(0));
*/
#define TEST_TODO(check) \
(test__todo_begin(), test__todo_end(TEST_LOCATION(), #check, check))
/* Private helpers */
#define TEST__STR(x) #x
#define TEST__MAKE_LOCATION(line) __FILE__ ":" TEST__STR(line)
union test__tmp {
intmax_t i;
uintmax_t u;
char c;
const void *p;
};
extern union test__tmp test__tmp[2];
__attribute__((format (printf, 2, 3)))
void test__run_describe(const char *, const char *, ...);
int test__run_begin(void);
__attribute__((format (printf, 3, 4)))
int test__run_end(int, const char *, const char *, ...);
void test__todo_begin(void);
int test__todo_end(const char *, const char *, int);
#endif /* TEST_LIB_H */
|
