-
Notifications
You must be signed in to change notification settings - Fork 0
/
tests.h
270 lines (245 loc) · 14.6 KB
/
tests.h
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
/**
* Copyright (c) 2020 Robert M. Vunabandi
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#pragma once
#include "./colors.h"
#include "./util.h"
#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>
#define PASSED_EXIT_CODE 0
#define FAILED_EXIT_CODE 1
///
/// Testing API
///
/**
* This declares a new test group. Each groups is essentially a set
* of tests that are similar. One could think of test groups about the
* same way as they think of test suites.
*/
void Test_group(char *test_group_name);
/**
* Runs the test
*/
void Test_run(bool (*test_f)(), char *test_f_name);
// The functions below are indicated as @private. This means that the
// client is not supposed to call them. Only the testing framework does.
/**
* This is called at the beginning of the `main` function in the test
* binary to begin testing. This would set up any necessary variable
* needed to start testing, so it must be called before everything
* else.
* @private
*/
void Test_begin();
/**
* Begins the test by the given name
* @private
*/
void Test_start(char *test_f_name);
/**
* Tells the program that the given test passed. This may result in
* printing things in the terminal and updating global variables. This
* is called inside Test_run.
* @private
*/
void Test_pass(char *test_f_name);
/**
* Similarly, this tells the program that the given test failed. It's
* pretty much the same as Test_pass but for failing tests.
* @private
*/
void Test_fail(char *test_f_name);
/**
* Called at the end of the program, this prints the overal results and
* returns an exit code for the program. PASSED_EXIT_CODE if all tests
* pass, and FAILED_EXIT_CODE otherwise. This must be called after all
* tests run.
* @private
*/
bool Test_conclude();
//
// Testing Macros:
// Instead of using "assert", we're using "ensure" because these
// macros don't actually "assert" anything. They check that they
// match and if they don't, they return false. However, these can
// generally be used the same way one would use `assert` statements
// in other programming languages when testing.
//
#define Test_ensureTrue(boolean) { \
if (!boolean) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " Expected %strue%s\n", C_BOLD_CYAN, C_NC); \
fprintf(stderr, " Received %sfalse%s\n", C_BOLD_RED, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureTrueMsg(boolean, ...) { \
if (!boolean) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " Expected %strue%s\n", C_BOLD_CYAN, C_NC); \
fprintf(stderr, " Received %sfalse%s\n", C_BOLD_RED, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureFalse(boolean) { \
if (boolean) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " Expected %sfalse%s\n", C_BOLD_CYAN, C_NC); \
fprintf(stderr, " Received %strue%s\n", C_BOLD_RED, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureFalseMsg(boolean, ...) { \
if (boolean) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " Expected %sfalse%s\n", C_BOLD_CYAN, C_NC); \
fprintf(stderr, " Received %strue%s\n", C_BOLD_RED, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureEqualInt(expected, received) { \
if (received != expected) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " Expected %s%d%s\n", C_BOLD_CYAN, expected, C_NC); \
fprintf(stderr, " Received %s%d%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureEqualIntMsg(expected, received, ...) { \
if (received != expected) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " Expected %s%d%s\n", C_BOLD_CYAN, expected, C_NC); \
fprintf(stderr, " Received %s%d%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureEqualChar(expected, received) { \
if (received != expected) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " Expected %s%c%s\n", C_BOLD_CYAN, expected, C_NC); \
fprintf(stderr, " Received %s%c%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureEqualCharMsg(expected, received, ...) { \
if (received != expected) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " Expected %s%c%s\n", C_BOLD_CYAN, expected, C_NC); \
fprintf(stderr, " Received %s%c%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureEqualString(expected, received) { \
if (!String_equal(received, expected)) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " Expected %s%s%s\n", C_BOLD_CYAN, expected, C_NC); \
fprintf(stderr, " Received %s%s%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureEqualStringMsg(expected, received, ...) { \
if (!String_equal(received, expected)) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " Expected %s%s%s\n", C_BOLD_CYAN, expected, C_NC); \
fprintf(stderr, " Received %s%s%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}
#define Test_ensureStringInArrayMsg(expected_array, array_size, received, ...) { \
if (!String_in_array(received, expected_array, array_size)) { \
fprintf(stderr, "\n"); \
fprintf( \
stderr, " %s[%s:%s:%d]%s\n", \
C_BOLD_WHITE, __FILE__, __func__, __LINE__, C_NC \
); \
fprintf(stderr, " "); \
fprintf(stderr, __VA_ARGS__); \
fprintf(stderr, " Expected argument to be in set %s{", C_BOLD_CYAN); \
for (int idx_ = 0; idx_ < array_size - 1; idx_++) { \
fprintf(stderr, "%s, ", expected_array[idx_]); \
} \
fprintf(stderr, "%s}%s\n", expected_array[array_size - 1], C_NC); \
fprintf(stderr, " Received %s%s%s\n", C_BOLD_RED, received, C_NC); \
fprintf(stderr, "\n"); \
return false; \
} \
}