-
Notifications
You must be signed in to change notification settings - Fork 2
/
test.h
418 lines (368 loc) · 16.8 KB
/
test.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
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
/**
* `libssc` - Socket SDK Client Library
*
* This file is part of libssc.
*
* MIT License
*
* Copyright (c) 2022 Socket Supply Co.
*
* 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.
*
* SPDX-License-Identifier: MIT
* SPDX-FileCopyrightText: 2022 Socket Supply Co. <socketsupply.co>
*/
#ifndef SSC_TEST_H
#define SSC_TEST_H
#include <ssc/ssc.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#if defined(__cplusplus) && !defined(SSC_CPLUSPLUS)
extern "C" {
#endif
/**
* Tests stats
*/
static int total_test_count;
static int total_pass_count;
static int expected_pass_count;
/**
* Simple `ok()` emission for a passed test.
*/
void
ok (const char *format, ...) {
va_list args;
va_start(args, format);
if (!format) {
format = (const char *) "";
}
total_pass_count++;
SSC_PRINTF("ok %d - ", ++total_test_count);
// NOLINTNEXTLINE
SSC_VPRINTF(format, args);
SSC_PRINTF("\n");
va_end(args);
}
/**
* Simple `notok()` emission for a failed test.
*/
void
notok (const char *format, ...) {
va_list args;
va_start(args, format);
if (format == 0) {
format = (const char *) "";
}
SSC_PRINTF("not ok %d - ", ++total_test_count);
// NOLINTNEXTLINE
SSC_VPRINTF(format, args);
SSC_PRINTF("\n");
va_end(args);
}
/**
* Simple skipped `ok()` with '#SKIP' emission for a pending test.
*/
void
okskip (const char *format, ...) {
va_list args;
va_start(args, format);
if (format == 0) {
format = (const char *) "";
}
SSC_PRINTF("ok %d - ", ++total_test_count);
// NOLINTNEXTLINE
SSC_VPRINTF(format, args);
SSC_PRINTF(" #SKIP");
SSC_PRINTF("\n");
va_end(args);
}
/**
* Simple skipped `notok()` with '#SKIP' emission for a pending test.
*/
void
notokskip (const char *format, ...) {
va_list args;
va_start(args, format);
if (format == 0) {
format = (const char *) "";
}
SSC_PRINTF("not ok %d - ", ++total_test_count);
// NOLINTNEXTLINE
SSC_VPRINTF(format, args);
SSC_PRINTF(" #SKIP");
SSC_PRINTF("\n");
va_end(args);
}
/**
* Simple skipped `ok()` with '#TODO' emission for a pending test.
*/
void
oktodo (const char *format, ...) {
va_list args;
va_start(args, format);
if (format == 0) {
format = (const char *) "";
}
SSC_PRINTF("ok %d - ", ++total_test_count);
// NOLINTNEXTLINE
SSC_VPRINTF(format, args);
SSC_PRINTF(" #TODO");
SSC_PRINTF("\n");
va_end(args);
}
/**
* Simple skipped `notok()` with '#TODO' emission for a pending test.
*/
void
notoktodo (const char *format, ...) {
va_list args;
va_start(args, format);
if (format == 0) {
format = (const char *) "";
}
SSC_PRINTF("not ok %d - ", ++total_test_count);
// NOLINTNEXTLINE
SSC_VPRINTF(format, args);
SSC_PRINTF(" #TODO");
SSC_PRINTF("\n");
va_end(args);
}
/**
* Marks tests suite as done.
*/
void
okdone (void) {
int rc = 0;
if (0 != expected_pass_count && total_pass_count != expected_pass_count) {
if (expected_pass_count > total_pass_count) {
SSC_FPRINTF(stderr, "expected number of success conditions not met.\n");
} else {
SSC_FPRINTF(
stderr,
"expected number of success conditions is less than the "
"number of given success conditions.\n"
);
}
rc = 1;
} else if (total_pass_count != total_test_count) {
rc = 1;
}
if (expected_pass_count == 0) {
SSC_PRINTF("1..%d\n", total_test_count);
}
SSC_PRINTF("# tests %d\n", total_test_count);
SSC_PRINTF("# fail %d\n", total_test_count - total_pass_count);
SSC_PRINTF("# pass %d\n", total_pass_count);
SSC_EXIT(rc);
}
/**
* A simple TAP test runner context.
* @param test_name The name of the test
* @param expected_pass_count The expected number of passed tests where 0 means
* no expectation
*/
#define test(test_name, ...) \
void runner(); \
int main(const int argc, const char **argv) { \
ssc_init(argc, argv); \
{ __VA_ARGS__; }; \
SSC_PRINTF("TAP version 14\n"); \
SSC_PRINTF("# %s\n", test_name); \
if (expected_pass_count > 0) { \
SSC_PRINTF("1..%d\n", expected_pass_count); \
expected_pass_count = expected_pass_count; \
} \
runner(); \
okdone(); \
if (expected_pass_count > 0) { \
return expected_pass_count - total_pass_count; \
} \
return total_test_count - total_pass_count; \
} \
void runner()
/**
* A simple macro to skip tests instead of running them marked by the leading
* `x` character in `test()`
*/
#define xtest(test_name, ...) \
void runner(); \
int main(void) { \
SSC_PRINTF("TAP version 14\n"); \
SSC_PRINTF("# %s\n", test_name); \
SSC_PRINTF("1..0\n"); \
return 0; \
} \
void runner()
/**
* A simple assertion that emits `ok ...` or `not ok ...`
* @param condition The condition to test
* @param ...
*/
#define assert(condition, ...) \
if ((condition)) { \
ok("%s", SSC_PP_STRING(condition)); \
} else { \
notok("%s", SSC_PP_STRING(condition)); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
/**
* A simple assertion that emits `ok ...` or `not ok ...` along with a caught
* error that is printed as a TAP error
* @param condition The condition to test
*/
#define assert_ok(condition, ...) \
if ((condition) == SSC_OK) { \
ok(SSC_PP_STRING(condition)##__VA_ARGS__); \
} else { \
notok( \
"%s [%s %s]", \
SSC_PP_STRING(condition), \
ssc_callsite_function_name(), \
ssc_callsite_file_location() \
); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
/**
* A simple negated assertion that emits `ok ...` or `not ok ...` along with a
* caught error that is printed as a TAP error
* @param condition The condition to test
*/
#define assert_notok(condition, ...) \
if ((condition) != SSC_OK) { \
ok(SSC_PP_STRING(condition)##__VA_ARGS__); \
} else { \
notok( \
"%s [%s %s]", \
SSC_PP_STRING(condition), \
ssc_callsite_function_name(), \
ssc_callsite_file_location() \
); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
/**
* A simple assertion that emits `ok ...` or `not ok ...` based on the given
* `left` and `right` values inequality being true.
* @param left Left operand
* @param right Right operand
*/
#define assert_equal(left, right, ...) \
if ((left) == (right)) { \
ok("%s equals %s", SSC_PP_STRING(left), SSC_PP_STRING(right)); \
} else { \
notok("%s not equals %s", SSC_PP_STRING(left), SSC_PP_STRING(right)); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
/**
* A simple assertion that emits `ok ...` or `not ok ...` based on the given
* `left` and `right` values equality being true.
* @param left Left operand
* @param right Right operand
*/
#define assert_not_equal(left, right, ...) \
if ((left) != (right)) { \
ok("%s not equals %s", SSC_PP_STRING(left), SSC_PP_STRING(right)); \
} else { \
notok("%s equals %s", SSC_PP_STRING(left), SSC_PP_STRING(right)); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
/**
* A simple assertion that tests for a truthy `result` and emits `ok ...` or
* `not ok ...` based on the given result being `SSC_TRUE` (`true`, `1`).
* @param result Result to test for `SSC_TRUE`
*/
#define assert_true(result) \
if ((result) != SSC_FALSE) { \
ok("%s", SSC_PP_STRING(result)); \
} else { \
notok("%s is not true", SSC_PP_STRING(result)); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
/**
* A simple assertion that tests for a falsy `result` and emits `ok ...` or
* `not ok ...` based on the given result being `SSC_FALSE` (`false`, `0`).
* @param result Result to test for `SSC_FALSE`
*/
#define assert_false(result) \
if ((result) == SSC_FALSE) { \
ok("%s", SSC_PP_STRING(result)); \
} else { \
notok("%s is not true", SSC_PP_STRING(result)); \
ssc_catch(err) { \
SSC_PRINTF(" ---\n"); \
SSC_PRINTF(" message: %s\n", err.string); \
SSC_PRINTF(" severity: fail\n"); \
SSC_PRINTF(" at:\n"); \
SSC_PRINTF(" file: %s\n", __FILE__); \
SSC_PRINTF(" line: %d\n", __LINE__); \
SSC_PRINTF(" ---\n"); \
} \
}
#ifdef __cplusplus
}
#endif
#endif