-
Notifications
You must be signed in to change notification settings - Fork 0
/
microut.h
394 lines (346 loc) · 20.1 KB
/
microut.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
/*!
\file microut.h
\brief Unit-testing (micro) tool (for C projects)
\version 0.1.0
\author Alexander Kurakin <kuraga333@mail.ru>
\copyright © Alexander Kurakin, 2016
\license MIT
\see <http://www.jera.com/techinfo/jtns/jtn002.html>
\see <https://git.fairy-project.org/hauspie/minunit>
*/
#ifndef __MICROUT_H
#define __MICROUT_H
#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
#endif
struct __ut_test_desc;
/*!
\brief Тип функции теста
\protected
*/
typedef void (*__ut_test_func)(struct __ut_test_desc *desc);
/*!
\brief Структура теста
\protected
*/
struct __ut_test_desc
{
const char * const name; //!< Указатель на строку, наименование теста
const char * const description; //!< Указатель на строку, описание теста
const char * const file; //!< Указатель на строку, файл, в котором определен набор тестов
const unsigned int line; //!< Строка файла, в котором определен набор тестов
const __ut_test_func func; //!< Указатель на функцию набора тестов
bool started; //!< Флаг старта набора тестов
unsigned int performed_count; //!< Количество запущенныых проверок
unsigned int successed_count; //!< Количество успешных проверок
};
struct __ut_test_suite_desc;
/*!
\brief Тип функции набора тестов
\protected
*/
typedef void (*__ut_test_suite_func)(struct __ut_test_suite_desc *desc);
/*!
\brief Структура набора тестов
\protected
*/
struct __ut_test_suite_desc
{
const char * const name; //!< Указатель на строку, наименование набора тестов
const char * const description; //!< Указатель на строку, описание набора тестов
const __ut_test_suite_func startup; //!< Указатель на функцию, которая будет выполнена перед запуском набора тестов
const __ut_test_suite_func teardown; //!< Указатель на функцию, которая будет выполнена после отработки набора тестов
const __ut_test_func before_each; //!< Указатель на функцию, которая будет выполнена перед каждым тестом
const __ut_test_func after_each; //!< Указатель на функцию, которая будет выполнена после каждого теста
struct __ut_test_desc * const test_descs; //!< Массив структур тестов
bool started; //!< Флаг запуска набора тестов
unsigned int performed_count; //!< Количество запущенныых тестов
unsigned int successed_count; //!< Количество успешных тестов
};
/*!
\brief Совершить проверку
\details
- Если значение выражения истинно, то вызывает #UT_ON_SUCCESSFUL_ASSERT
- Иначе вызывает #UT_ON_FAILED_ASSERT и завершает текущую функцию
- Сообщает запустившему тесту/набору тестов, о запуске проверки и ее успешности
\param[in] assertion выражение, значение которого проверяется
\param[in] message указатель на строку-сообщение
\pre Может быть вызван на любой стадии тестирования
*/
#define UT_ASSERT(assertion, message) do { \
/* Помечаем, что проверка запущена */ \
desc->performed_count++; \
\
/* Проверяем значение выражения... */ \
if ((assertion)) { \
/* ...если истинно, */ \
/* то помечаем это... */ \
desc->successed_count++; \
/* и вызываем макрос-обработчик успеха */ \
UT_ON_SUCCESSFUL_ASSERT(desc, message); \
} \
else \
{ \
/* ...иначе */ \
/* запускаем макрос-обработчик неудачи... */ \
UT_ON_FAILED_ASSERT(desc, message); \
/* и прерываем выполнение текущей функции */ \
return; \
} \
} while (0)
#define UT_FAIL(message) UT_ASSERT(false, message)
/*!
\brief Определить функцию, которая будет вызвана перед запуском каждого
из тестов (из указанного набора тестов)
\param[in] test_suite набор тестов
*/
#define UT_BEFORE_EACH(test_suite) void test_suite##_before_each(struct __ut_test_desc *desc)
/*!
\brief Определить функцию, которая будет вызвана после запуска каждого
из тестов (из указанного набора тестов)
\param[in] test_suite набор тестов
*/
#define UT_AFTER_EACH(test_suite) void test_suite##_after_each(struct __ut_test_desc *desc)
/*!
\brief Определить функцию теста
\param[in] test_suite набор тестов
\param[in] test тест
*/
#define UT_TEST(test_suite, test) void test_suite##_##test(struct __ut_test_desc *desc)
/*!
\brief Определить функцию, которая будет вызвана перед запуском набора тестов
\param[in] test_suite набор тестов
*/
#define UT_STARTUP(test_suite) void test_suite##_startup(struct __ut_test_suite_desc *desc)
/*!
\brief Определить функцию, которая будет вызвана перед запуском набора тестов
\param[in] test_suite набор тестов
*/
#define UT_TEARDOWN(test_suite) void test_suite##_teardown(struct __ut_test_suite_desc *desc)
/*!
\brief Макрос для добавления теста в список тестов набора тестов
\param[in] test_suite набор тестов
\param[in] test тест
\param[in] description указатель на строку-описание теста
*/
#define UT_ADD_TEST(test_suite, test, description) { #test, description, __FILE__, __LINE__, test_suite##_##test, false, 0, 0 }
/*!
\brief Макрос для завершения списка тестов
*/
#define UT_TEST_SUITE_END { NULL, NULL, __FILE__, __LINE__, NULL, false, 0, 0 }
/*!
\brief Макрос для определения набора тестов
\param[in] test_suite набор тестов
\param[in] description указатель на строку-описание набора тестов
\param[in] ... список тестов.
Формулируется путем вызова, через запятую, макросов #UT_ADD_TEST,
для каждого из тестов, и завершающим макросом #UT_TEST_SUITE_END.
\warning Необходимо вызывать макрос без заверщающего разделителя \p ;
*/
#define UT_DECLARE_TEST_SUITE(test_suite, description, ...) \
/* Объявляем массив структур тесов */ \
static struct __ut_test_desc test_suite##_test_descs[] = { \
__VA_ARGS__ \
}; \
\
/* Объявляем структуру набора тестов */ \
static struct __ut_test_suite_desc test_suite##_desc = { \
#test_suite, description, \
test_suite##_startup, test_suite##_teardown, \
test_suite##_before_each, test_suite##_after_each, \
test_suite##_test_descs, \
false, 0, 0 \
};
/*!
\brief Получить структуру набора тестов
\param[in] test_suite набор тестов
*/
#define UT_TEST_SUITE_DESC(test_suite) ( test_suite##_desc )
/*!
\brief Проверить, был ли тест запущен
\param[in] test_desc структура теста
\return \p true, если тест был запущен; \p false иначе
*/
#define UT_IS_TEST_STARTED(test_desc) ( (test_desc)->started )
/*!
\brief Проверить, был ли тест пропущен
\param[in] test_desc структура теста
\return \p true, если тест не был запущен; \p false иначе
*/
#define UT_IS_TEST_SKIPPED(test_desc) ( !UT_IS_TEST_STARTED(test_desc) )
/*!
\brief Проверить, был ли тест успешен
\param[in] test_desc структура теста
\return \p true, если тест был запущен и успешно завершился; \p false иначе
*/
#define UT_IS_TEST_SUCCESSED(test_desc) ( UT_IS_TEST_STARTED(test_desc) && (test_desc)->performed_count == (test_desc)->successed_count )
/*!
\brief Проверить, был ли тест провален
\param[in] test_desc структура теста
\return \p true, если тест был запущен и не завершился успешно; \p false иначе
*/
#define UT_IS_TEST_FAILED(test_desc) ( !UT_IS_TEST_SUCCESSED(test_desc) )
/*!
\brief Проверить, был ли набор тестов запущен
\param[in] test_suite_desc структура набора тестов
\return \p true, если набор тестов был запущен; \p false иначе
*/
#define UT_IS_TEST_SUITE_STARTED(test_suite_desc) ( (test_suite_desc)->started )
/*!
\brief Проверить, был ли набор тестов пропущен
\param[in] test_suite_desc структура набора тестов
\return \p true, если набор тестов не был запущен; \p false иначе
*/
#define UT_IS_TEST_SUITE_SKIPPED(test_suite_desc) ( !UT_IS_TEST_SUITE_STARTED(test_suite_desc) )
/*!
\brief Проверить, был ли набор тестов успешен
\param[in] test_suite_desc структура набора тестов
\return \p true, если набор тестов был запущен и завершился успешно; \p false иначе
*/
#define UT_IS_TEST_SUITE_SUCCESSED(test_suite_desc) ( UT_IS_TEST_SUITE_STARTED(test_suite_desc) && (test_suite_desc)->performed_count == (test_suite_desc)->successed_count )
/*!
\brief Проверить, был ли набор тестов провален
\param[in] test_suite_desc структура набора тестов
\return \p true, если набор тестов был запущен и не завершился успешно; \p false иначе
*/
#define UT_IS_TEST_SUITE_FAILED(test_suite_desc) ( !UT_IS_TEST_SUITE_SUCCESSED(test_suite_desc) )
/*!
\brief Запустить набор тестов
\param[in] test_suite_desc указатель на структуру набора тестов
\return Флаг успешного выполнения набора тестов
\protected
*/
static bool __ut_run_test_suite(struct __ut_test_suite_desc *test_suite_desc)
{
// \name Объявляем набор тестов запущенным
// @{
test_suite_desc->started = true;
test_suite_desc->successed_count = test_suite_desc->performed_count = 0;
// @}
// Вызываем startu-функцию
test_suite_desc->startup(test_suite_desc);
// Если в ходе ее выполнения были неуспешные проверки, то прерываем выполнение набора тестов
if (!UT_IS_TEST_SUITE_SUCCESSED(test_suite_desc))
{
return false;
}
// Запускаем тесты
for (unsigned int i = 0; test_suite_desc->test_descs[i].func != NULL; ++i)
{
// Получаем указатель на структуру теста
struct __ut_test_desc *test_desc = &(test_suite_desc->test_descs[i]);
// Объявляем тест запущенным
// @{
test_desc->started = true;
test_desc->successed_count = test_desc->performed_count = 0;
// @}
// Объявляем (в наборе тестов) тест запущенным
++test_suite_desc->performed_count;
// Запускаем before each-функцию
test_suite_desc->before_each(test_desc);
// Если в ходе ее выполнения не было неуспешных проверки, то продолжаем выполнение теста
if (UT_IS_TEST_SUCCESSED(test_desc))
{
// Запускаем функцию теста
test_desc->func(test_desc);
}
// Запускаем after each-функцию
test_suite_desc->after_each(test_desc);
// Если тест был успешен, то помачаем этот факт в наборе тестов
// Выполняем обработчик успехов
if (UT_IS_TEST_SUCCESSED(test_desc))
{
++test_suite_desc->successed_count;
UT_ON_SUCCESSFUL_TEST(test_desc);
}
// Иначе выполняем обработчик неудач
else
{
UT_ON_FAILED_TEST(test_desc);
}
}
// Запускаем teardown-функцию набора тестов
test_suite_desc->teardown(test_suite_desc);
// Возвращаем флаг успешности набора тестов
return UT_IS_TEST_SUITE_SUCCESSED(test_suite_desc);
}
/*!
\brief Запустить набор тестов
\param[in] test_suite набор тестов
*/
#define UT_RUN_TEST_SUITE(test_suite) __ut_run_test_suite(&test_suite##_desc)
/*!
\brief Проверить равенство двух знаковых десятичных чисел
\details Проводит проверку, формируя сообщение, специфичное для сравнения
двух знаковых десятичных чисел
\param[in] actual реальное значение
\param[in] expected ожидаемое значение
\param[in] message указатель на строку-сообщение
*/
#define UT_DECIMAL_EQUALS(actual, expected, message) do { \
const __auto_type actual_ = (actual); \
const __auto_type expected_ = (expected); \
char __ut_buf[UT_BUFFER_SIZE]; \
\
sprintf(__ut_buf, "%s (status equality check failed: expected %d, got %d)", \
message, expected_, actual_); \
UT_ASSERT(expected == actual, __ut_buf); \
} while(0)
/*!
\brief Проверить равенство двух беззнаковых десятичных чисел
\details Проводит проверку, формируя сообщение, специфичное для сравнения
двух беззнаковых десятичных чисел
\param[in] actual реальное значение
\param[in] expected ожидаемое значение
\param[in] message указатель на строку-сообщение
*/
#define UT_UNSIGNED_DECIMAL_EQUALS(actual, expected, message) do \
const __auto_type actual_ = (actual); \
const __auto_type expected_ = (expected); \
char __ut_buf[UT_BUFFER_SIZE]; \
\
sprintf(__ut_buf, "%s (status equality check failed: expected %u, got %u)", \
message, expected_, actual_); \
UT_ASSERT(expected == actual, __ut_buf); \
} while(0)
/*!
\brief Проверить равенство двух беззнаковых шестнадцатиричных чисел
\details Проводит проверку, формируя сообщение, специфичное для сравнения
двух беззнаковых шестнадцатиричных чисел
\param[in] actual реальное значение
\param[in] expected ожидаемое значение
\param[in] message указатель на строку-сообщение
*/
#define UT_UNSIGNED_HEXADECIMAL_EQUALS(actual, expected, message) do { \
const __auto_type actual_ = (actual); \
const __auto_type expected_ = (expected); \
char __ut_buf[UT_BUFFER_SIZE]; \
\
sprintf(__ut_buf, "%s (status equality check failed: expected %X, got %X)", \
message, expected_, actual_); \
UT_ASSERT(expected == actual, __ut_buf); \
} while(0)
/*!
\brief Проверить равенство двух символов
\details Проводит проверку, формируя сообщение, специфичное для сравнения
двух символов
\param[in] actual реальное значение
\param[in] expected ожидаемое значение
\param[in] message указатель на строку-сообщение
*/
#define UT_CHAR_EQUALS(actual, expected, message) do { \
const __auto_type actual_ = (actual); \
const __auto_type expected_ = (expected); \
char __ut_buf[UT_BUFFER_SIZE]; \
\
sprintf(__ut_buf, "%s (status equality check failed: expected %c, got %c)", \
message, expected_, actual_); \
UT_ASSERT(expected == actual, __ut_buf); \
} while(0)
#ifdef __cplusplus
}
#endif
#endif // __MICROUT_H