-
Notifications
You must be signed in to change notification settings - Fork 0
/
atto.h
562 lines (521 loc) · 16.6 KB
/
atto.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
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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
/**
* @file
* Atto - the microscopic C unit test framework
*
* @copyright Copyright © 2019-2021, Matjaž Guštin <dev@matjaz.it>
* <https://matjaz.it>. All rights reserved.
* @license BSD 3-Clause License
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS “AS IS”
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ATTO_H
#define ATTO_H
#ifdef __cplusplus
extern "C"
{
#endif
/**
* Semantic version of this file and framework.
*/
#define ATTO_VERSION "1.4.0"
#include <stdio.h> /* For printf() */
#include <math.h> /* For fabs(), fabsf(), isnan(), isinf(), isfinite() */
#include <string.h> /* For strncmp(), memcmp() */
#include <stddef.h> /* For size_t */
/**
* Boolean indicating if all tests passed successfully (when 0) or not.
*
* Useful as a value to return from the main function of the test executable,
* so that the test executable returns non-zero in case at least one test
* failed.
*/
extern char atto_at_least_one_fail;
/**
* Counter of all Atto assertion macro calls that failed the check.
*
* The user should not change this value, but may freely read it.
* Useful to inspect the amount of errors (which should be 0) for changes
* during different launches of the test suite.
*/
extern size_t atto_counter_assert_failures;
/**
* Counter of all Atto assertion macro calls that passed the check.
*
* The user should not change this value, but may freely read it.
* Useful to inspect the amount of passes for changes
* during different launches of the test suite.
*/
extern size_t atto_counter_assert_passes;
/**
* Absolute tolerance when comparing two single-precision floating point
* value for approximate-equality using atto_fapprox().
*
* If the difference between the two float values is bigger than this
* tolerance, the assertion fails.
*/
#define ATTO_FLOAT_EQ_ABSTOL (1e-5f)
/**
* Absolute tolerance when comparing two double-precision floating point
* value for approximate-equality using atto_dapprox().
*
* If the difference between the two double values is bigger than this
* tolerance, the assertion fails.
*/
#define ATTO_DOUBLE_EQ_ABSTOL (1e-8)
/**
* Prints a brief report message providing the point where this report is
* and the amount of successes and failures at this point.
*
* Particularly useful to call it at the end of the test runner executable
* or after a certain group of test cases to verify that progress through the
* test suite is happening. In case of sudden crashes of the test suite,
* multiple of these reports may be added to aid debugging in understanding
* where the issue arisees.
*/
#define atto_report() \
printf("REPORT | File: %s:%d | Test case: %s" \
" | Passes: %5zu | Failures: %5zu\n", \
__FILE__, __LINE__, __func__, \
atto_counter_assert_passes, atto_counter_assert_failures)
/**
* Verifies if the given boolean expression is true.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* It's the most generic macro offered by Atto. If you need something more
* specific, try using the other macros instead.
*
* The `do-while(0)` construct allows to write multi-line macros.
*
* If your system does not support `printf()`, replace it with something
* else in this file! For example a `transmit()` function to communicate
* the result to other devices.
*
* Example:
* ```
* atto_assert(1); // Passes
* atto_assert(0); // Fails
* atto_assert(3 < 1); // Fails
* ```
*/
#define atto_assert(expression) do { \
if (!(expression)) { \
printf("FAIL | File: %s:%d | Test case: %s\n", \
__FILE__, __LINE__, __func__); \
atto_counter_assert_failures++; \
atto_at_least_one_fail = 1; \
return; \
} else { \
atto_counter_assert_passes++; \
} \
} while (0)
/**
* Verifies if the given boolean expression is true.
*
* Just a rename of atto_assert() for consistency with atto_false().
*/
#define atto_true(x) atto_assert(x)
/**
* Verifies if the given boolean expression is false.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* Example:
* ```
* atto_false(1); // Fails
* atto_false(0); // Passes
* ```
*/
#define atto_false(x) atto_assert(!(x))
/**
* Verifies if the two arguments are exactly equal.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* It is recommended to use this macro instead of calling `atto_assert(a == b)`
* to avoid mistyping the equality comparison operator `==` into the assignment
* operator `=`.
*
* Example:
* ```
* atto_eq(12, 12); // Passes
* atto_eq(12.0f, 12U); // Passes due to implicit conversion of 12U to 12.0f
* atto_eq(100, 1); // Fails
* ```
*/
#define atto_eq(a, b) atto_assert((a) == (b))
/**
* Verifies if the two arguments are not equal.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* Example:
* ```
* atto_neq(12, 12); // Fails
* atto_neq(12.0f, 12U); // Fails
* atto_neq(100, 1); // Passes
* ```
*/
#define atto_neq(a, b) atto_assert((a) != (b))
/**
* Verifies if the first argument is strictly Greater Than the second.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* Example:
* ```
* atto_gt(1, 10); // Fails
* atto_gt(10, 10); // Fails
* atto_gt(100, 10); // Passes
* ```
*/
#define atto_gt(a, b) atto_assert((a) > (b))
/**
* Verifies if the first argument is Greater or Equal to the second.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* Example:
* ```
* atto_ge(1, 10); // Fails
* atto_ge(10, 10); // Passes
* atto_ge(100, 10); // Passes
* ```
*/
#define atto_ge(a, b) atto_assert((a) >= (b))
/**
* Verifies if the first argument is strictly Less Than the second.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* Example:
* ```
* atto_lt(1, 10); // Passes
* atto_lt(10, 10); // Fails
* atto_lt(100, 10); // Fails
* ```
*/
#define atto_lt(a, b) atto_assert((a) < (b))
/**
* Verifies if the first argument is Less or Equal to the second.
*
* Otherwise stops the test case immediately and reports the failing file,
* function and line number on standard output.
*
* Example:
* ```
* atto_le(1, 10); // Passes
* atto_le(10, 10); // Fails
* atto_le(100, 10); // Fails
* ```
*/
#define atto_le(a, b) atto_assert((a) <= (b))
/**
* Verifies if two single-precision floating point values are within a given
* absolute tolerance from each other.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_fdelta(1.0f, 1.00000001f, 0.1f); // Passes
* atto_fdelta(1.0f, 1.1f, 0.15f); // Passes
* atto_fdelta(1.0f, 2.0f, 0.1f); // Fails
* ```
*/
#define atto_fdelta(a, b, delta) atto_assert(fabsf((a) - (b)) <= fabsf(delta))
/**
* Verifies if two single-precision floating point values are within a fixed
* absolute tolerance #ATTO_FLOAT_EQ_ABSTOL from each other.
*
* Useful to check for almost-equality but ignoring minor rounding errors.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_fapprox(1.0f, 1.000001f); // Passes
* atto_fapprox(1.0f, 1.1); // Fails
* ```
*/
#define atto_fapprox(a, b) atto_fdelta((a), (b), ATTO_FLOAT_EQ_ABSTOL)
/**
* Verifies if two double-precision floating point values are within a given
* absolute tolerance from each other.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_ddelta(1.0, 1.00000001, 0.1); // Passes
* atto_ddelta(1.0, 1.1, 0.15); // Passes
* atto_ddelta(1.0, 2.0, 0.1); // Fails
* ```
*/
#define atto_ddelta(a, b, delta) \
atto_assert(fabs((a) - (b)) <= fabs(delta))
/**
* Verifies if two double-precision floating point values are within a fixed
* absolute tolerance #ATTO_DOUBLE_EQ_ABSTOL from each other.
*
* Useful to check for almost-equality but ignoring minor rounding errors.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_dapprox(1.0, 1.00000001); // Passes
* atto_dapprox(1.0, 1.1); // Fails
* ```
*/
#define atto_dapprox(a, b) atto_ddelta((a), (b), ATTO_DOUBLE_EQ_ABSTOL)
/**
* Verifies that the floating point value is Not a Number (NaN).
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_nan(NAN); // Passes
* atto_nan(INFINITY); // Fails
* atto_nan(-INFINITY); // Fails
* atto_nan(1.0); // Fails
* atto_nan(1); // Fails
* ```
*/
#define atto_nan(value) atto_assert(isnan(value))
/**
* Verifies that the floating point value is infinity, either positive or
* negative.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_inf(NAN); // Fails
* atto_inf(INFINITY); // Passes
* atto_inf(-INFINITY); // Passes
* atto_inf(1.0); // Fails
* atto_inf(1); // Fails
* ```
*/
#define atto_inf(value) atto_assert(isinf(value))
/**
* Verifies that the floating point value is positive infinity.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_plusinf(NAN); // Fails
* atto_plusinf(INFINITY); // Passes
* atto_plusinf(-INFINITY); // Fails
* atto_plusinf(1.0); // Fails
* atto_plusinf(1); // Fails
* ```
*/
#define atto_plusinf(value) atto_assert((isinf(value)) && ((value) > 0))
/**
* Verifies that the floating point value is negative infinity.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_minusinf(NAN); // Fails
* atto_minusinf(INFINITY); // Fails
* atto_minusinf(-INFINITY); // Passes
* atto_minusinf(1.0); // Fails
* atto_minusinf(1); // Fails
* ```
*/
#define atto_minusinf(value) atto_assert((isinf(value)) && ((value) < 0))
/**
* Verifies that the floating point value is finite, thus not NaN or
* +/- infinity.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_finite(NAN); // Fails
* atto_finite(INFINITY); // Fails
* atto_finite(-INFINITY); // Fails
* atto_finite(1.0); // Passes
* atto_finite(1); // Passes
* ```
*/
#define atto_finite(value) atto_assert(isfinite(value))
/**
* Verifies that the floating point value is not finite, thus either NaN or
* +/- infinity.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_notfinite(NAN); // Passes
* atto_notfinite(INFINITY); // Passes
* atto_notfinite(-INFINITY); // Passes
* atto_notfinite(1.0); // Fails
* atto_notfinite(1); // Fails
* ```
*/
#define atto_notfinite(value) atto_assert(!isfinite(value))
/**
* Verifies if the bits of the value specified by a bit mask are set to 1.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_flag(0x07, 1 << 1); // Passes
* atto_flag(0x07, 0x04); // Passes
* atto_flag(0x07, 0x06); // Passes
* atto_flag(0x07, 0xF0); // Fails
* ```
*/
#define atto_flag(value, mask) atto_assert(((value) & (mask)))
/**
* Verifies if the bits of the value specified by a bit mask are set to 0.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_noflag(0x07, 1 << 5); // Passes
* atto_noflag(0x07, 0xF8); // Passes
* atto_noflag(0x07, 0x04); // Fails
* ```
*/
#define atto_noflag(value, mask) atto_assert(((value) & (mask)) == 0)
/**
* Verifies if two strings are equal up to a given length or until the shortest
* string terminates.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_streq("abcd", "abcd", 2); // Passes
* atto_streq("abcd", "abcd", 4); // Passes
* atto_streq("abcd", "abcd", 100); // Passes, reached null terminator
* atto_streq("abcd", "ABCD", 4); // Fails, different casing
* ```
*/
#define atto_streq(a, b, maxlen) \
atto_assert(strncmp((a), (b), (maxlen)) == 0)
/**
* Verifies if two memory sections are equal up to a given length.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_memeq("abcd", "abcd", 2); // Passes
* atto_memeq("abcd", "abcd", 4); // Passes
* atto_memeq("abcd", "abcd", 100); // UNDEFINED as exceeding known memory
* atto_memeq("abcd", "ABCD", 4); // Fails
* ```
*/
#define atto_memeq(a, b, len) atto_assert(memcmp((a), (b), len) == 0)
/**
* Verifies if two memory sections are different within the given length.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_memneq("abcd", "abcd", 2); // Fails
* atto_memneq("abcd", "abcd", 4); // Fails
* atto_memneq("abcd", "abcd", 100); // UNDEFINED as exceeding known memory
* atto_memneq("abcd", "abCD", 4); // Passes
* ```
*/
#define atto_memneq(a, b, len) atto_assert(memcmp((a), (b), len) != 0)
/**
* Verifies if a memory section is filled with just zeros.
*
* Useful to check whether a memory location has been cleared.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_zeros("abcd", 2); // Fails
* atto_zeros("\0\0cd", 2); // Passes
* atto_zeros("\0\0cd", 4); // Fails
* atto_zeros("\0\0\0\0", 4); // Passes
* atto_zeros("\0\0\0\0", 100); // UNDEFINED as exceeding known memory
* ```
*/
#define atto_zeros(x, len) do { \
for (size_t __atto_idx = 0; __atto_idx < (size_t)(len); __atto_idx++) \
{ atto_eq(((uint8_t*)(x))[__atto_idx], 0); } \
} while(0)
/**
* Verifies if a memory section is not completely filled with zeros
* (there is at least one non-zero byte).
*
* Useful to check whether a memory location has been initialised to non-zero
* values, especially for random strings or data from an outside
* source we don't know the exact format of.
*
* Otherwise stops the test case and reports on standard output.
*
* Example:
* ```
* atto_nzeros("abcd", 2); // Passes
* atto_nzeros("\0\0cd", 2); // Fails
* atto_nzeros("\0\0cd", 4); // Passes
* atto_nzeros("\0\0\0\0", 4); // Fails
* atto_nzeros("\0\0c\0", 4); // Passes
* atto_nzeros("a\0c\0", 3); // Passes
* atto_nzeros("\0\0\0\0", 100); // UNDEFINED as exceeding known memory
* ```
*/
#define atto_nzeros(x, len) do { \
uint8_t __atto_all_zero = 1; \
for (size_t __atto_idx = 0; __atto_idx < (size_t)(len); __atto_idx++) \
{ if(((uint8_t*)(x))[__atto_idx] != 0) \
{ __atto_all_zero = 0; break; } \
} \
atto_false(__atto_all_zero); \
} while(0)
/**
* Forces a failure of the test case, stopping it and reporting on standard
* output.
*/
#define atto_fail() atto_assert(0)
#ifdef __cplusplus
}
#endif
#endif /* ATTO_H */