-
Notifications
You must be signed in to change notification settings - Fork 2
/
ok.h
356 lines (301 loc) · 9.03 KB
/
ok.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
/**
* `ok.h` - libok
*
* Copyright (C) 2014-2023 Joseph Werle <[email protected]>
*/
#ifndef OK_H
#define OK_H
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* libok version
*/
#ifndef OK_VERSION
#define OK_VERSION "0.6.5"
#endif
/**
* No-op/void `ok()` function
*/
#ifndef okx
#define okx(...) (void) (0);
#endif
/**
* Allow for custom `printf` implementation.
*/
#if !defined(LIBOK_PRINTF)
#define LIBOK_PRINTF(...) (printf(__VA_ARGS__))
#endif
/**
* Allow for custom `fprintf` implementation.
*/
#if !defined(LIBOK_FPRINTF)
#define LIBOK_FPRINTF(...) (fprintf(__VA_ARGS__))
#endif
/**
* Configure the need for a newline ('\n') in a `printf` call.
*/
#if !defined(LIBOK_PRINTF_NEEDS_NEWLINE)
#define LIBOK_PRINTF_NEEDS_NEWLINE 1
#endif
/**
* Configure the need for a newline ('\n') in a `fprintf` call.
*/
#if !defined(LIBOK_FPRINTF_NEEDS_NEWLINE)
#define LIBOK_FPRINTF_NEEDS_NEWLINE LIBOK_PRINTF_NEEDS_NEWLINE
#endif
/**
* Increments ok count and
* outputs a message to stdout
*/
#define ok(format, ...) ({ \
if (ok_count() == 0 && ok_failed() == 0) ok_begin(NULL); \
int count = ok_count_inc() + ok_failed(); \
LIBOK_PRINTF("ok %d - " format, count, ##__VA_ARGS__); \
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
})
/**
* Outputs a a "not ok" message to stdout.
* Increments not ok count.
*/
#define notok(format, ...) ({ \
if (ok_count() == 0 && ok_failed() == 0) ok_begin(NULL); \
int count = ok_count() + ok_failed_inc(); \
LIBOK_PRINTF("not ok %d - " format, count, ##__VA_ARGS__); \
\
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
\
LIBOK_PRINTF(" ---"); \
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
\
LIBOK_PRINTF(" severity: fail"); \
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
\
LIBOK_PRINTF(" stack: |-"); \
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
\
LIBOK_PRINTF(" at %s (%s:%d)", \
__FUNCTION__, \
__FILE__, \
__LINE__ \
); \
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
\
LIBOK_PRINTF(" ..."); \
if (LIBOK_PRINTF_NEEDS_NEWLINE) { \
LIBOK_PRINTF("\n"); \
} \
})
/**
* Called at the beginning of a test with an optional (NULL) label.
*/
void ok_begin (const char *label);
/**
* Can be used to printf a comment.
*/
void ok_comment (const char *comment);
/**
* Can be used to provide a multiline test explaination.
*/
void ok_explain (const char *explaination);
/**
* Can be used to issue an emergency "Bail out!" statement with an
* optional comment.
*/
void ok_bail (const char *comment);
/**
* Completes tests and asserts that
* the expected test count matches the
* actual test count if the expected
* count is greater than 0
*/
bool ok_done (void);
/**
* Sets the expectation count
*/
void ok_expect (int);
/**
* Returns the expected count
*/
int ok_expected (void);
/**
* Returns the ok count
*/
int ok_count (void);
int ok_count_inc (void);
/**
* Returns the not ok count
*/
int ok_failed (void);
int ok_failed_inc (void);
/**
* Resets count and expected counters
*/
void ok_reset (void);
#if defined(LIBOK_INCLUDE_IMPLEMENTATION)
static int ok_count_;
static int ok_failed_;
static int ok_expected_;
static bool ok_begin_;
static bool ok_header_printed_;
void ok_comment (const char *comment) {
LIBOK_PRINTF("# %s", comment);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
}
void ok_explain (const char *explaination) {
if (ok_count() == 0 && ok_failed() == 0) ok_begin(NULL);
ok_comment("");
int i = 0;
while (explaination[i] != '\0') {
const char* pointer = explaination + i;
int j = i;
while (explaination[i] != '\n' && explaination[i] != '0') {
i++;
}
j = i - j;
LIBOK_PRINTF("# %.*s", j, pointer);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
i++;
}
ok_comment("");
}
void ok_bail (const char *comment) {
LIBOK_PRINTF("Bail out!");
if (comment != NULL) {
LIBOK_PRINTF(" %s", comment);
}
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
}
void ok_begin (const char *label) {
if (ok_begin_) return;
ok_begin_ = true;
// print new line for new test
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
} else {
LIBOK_PRINTF("");
}
if (!ok_header_printed_) {
ok_header_printed_ = true;
LIBOK_PRINTF("TAP version 14");
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
}
if (label != NULL) {
LIBOK_PRINTF("# %s", label);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
}
}
bool ok_done (void) {
if (ok_count() == 0 && ok_failed() == 0) ok_begin(NULL);
const int expected = ok_expected();
const int failed = ok_failed();
const int count = ok_count();
bool success = true;
if (0 != expected && count != expected) {
if (expected > count) {
LIBOK_FPRINTF(stderr, "expected number of success conditions not met.");
if (LIBOK_FPRINTF_NEEDS_NEWLINE) {
LIBOK_FPRINTF(stderr, "\n");
}
} else {
LIBOK_FPRINTF(stderr,
"expected number of success conditions is less than the "
"number of given success conditions.");
if (LIBOK_FPRINTF_NEEDS_NEWLINE) {
LIBOK_FPRINTF(stderr, "\n");
}
}
success = false;
}
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
} else {
LIBOK_PRINTF("");
}
if (expected == 0) {
LIBOK_PRINTF("1..%d", count + failed);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
}
LIBOK_PRINTF("# tests %d", count + failed);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
LIBOK_PRINTF("# pass %d", count);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
if (failed > 0) {
LIBOK_PRINTF("# fail %d", failed);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
success = false;
}
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
} else {
LIBOK_PRINTF("");
}
return success;
}
void ok_expect (int expected) {
if (ok_count() == 0 && ok_failed() == 0) ok_begin(NULL);
ok_expected_ = expected;
LIBOK_PRINTF("1..%d", expected);
if (LIBOK_PRINTF_NEEDS_NEWLINE) {
LIBOK_PRINTF("\n");
}
}
int ok_expected (void) {
return ok_expected_;
}
int ok_count_inc (void) {
return ++ok_count_;
}
int ok_count (void) {
return ok_count_;
}
int ok_failed_inc (void) {
return ++ok_failed_;
}
int ok_failed (void) {
return ok_failed_;
}
void ok_reset (void) {
ok_begin_ = false;
ok_count_ = 0;
ok_failed_ = 0;
ok_expected_ = 0;
}
#endif
#ifdef __cplusplus
}
#endif
#endif