1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file: test.h
31 *
32 * UCX Test Framework.
33 *
34 * Usage of this test framework:
35 *
36 * **** IN HEADER FILE: ****
37 *
38 * <code>
39 * CX_TEST(function_name);
40 * CX_TEST_SUBROUTINE(subroutine_name, paramlist); // optional
41 * </code>
42 *
43 * **** IN SOURCE FILE: ****
44 * <code>
45 * CX_TEST_SUBROUTINE(subroutine_name, paramlist) {
46 * // tests with CX_TEST_ASSERT()
47 * }
48 *
49 * CX_TEST(function_name) {
50 * // memory allocation and other stuff here
51 * #CX_TEST_DO {
52 * // tests with CX_TEST_ASSERT() and/or
53 * // calls with CX_TEST_CALL_SUBROUTINE() here
54 * }
55 * // cleanup of memory here
56 * }
57 * </code>
58 *
59 * @attention Do not call own functions within a test, that use
60 * CX_TEST_ASSERT() macros and are not defined by using CX_TEST_SUBROUTINE().
61 *
62 * @author Mike Becker
63 * @author Olaf Wintermann
64 *
65 */
66
67 #ifndef UCX_TEST_H
68 #define UCX_TEST_H
69
70 #include "common.h"
71
72 #include <stdio.h>
73 #include <string.h>
74 #include <setjmp.h>
75
76 #ifdef __cplusplus
77 extern "C" {
78 #endif
79
80 #ifndef __FUNCTION__
81 /**
82 * Alias for the <code>__func__</code> preprocessor macro.
83 * Some compilers use <code>__func__</code> and others use __FUNCTION__.
84 * We use __FUNCTION__ so we define it for those compilers which use
85 * <code>__func__</code>.
86 */
87 #define __FUNCTION__ __func__
88 #endif
89
90 #if !defined(__clang__) && __GNUC__ > 3
91 #pragma GCC diagnostic ignored "-Wclobbered"
92 #endif
93
94 /** Type for the CxTestSuite. */
95 typedef struct CxTestSuite CxTestSuite;
96
97 /** Pointer to a test function. */
98 typedef void(*CxTest)(CxTestSuite *, void *, cx_write_func);
99
100 /** Type for the internal list of test cases. */
101 typedef struct CxTestSet CxTestSet;
102
103 /** Structure for the internal list of test cases. */
104 struct CxTestSet {
105
106 /** Test case. */
107 CxTest test;
108
109 /** Pointer to the next list element. */
110 CxTestSet *next;
111 };
112
113 /**
114 * A test suite containing multiple test cases.
115 */
116 struct CxTestSuite {
117
118 /** The number of successful tests after the suite has been run. */
119 unsigned int success;
120
121 /** The number of failed tests after the suite has been run. */
122 unsigned int failure;
123
124 /** The optional name of this test suite. */
125 const char *name;
126
127 /**
128 * Internal list of test cases.
129 * Use cx_test_register() to add tests to this list.
130 */
131 CxTestSet *tests;
132 };
133
134 /**
135 * Creates a new test suite.
136 * @param name optional name of the suite
137 * @return a new test suite
138 */
139 cx_attr_nonnull
140 cx_attr_nodiscard
141 cx_attr_cstr_arg(1)
142 cx_attr_malloc
143 static inline CxTestSuite* cx_test_suite_new(const char *name) {
144 CxTestSuite* suite = (CxTestSuite*) malloc(sizeof(CxTestSuite));
145 if (suite != NULL) {
146 suite->name = name;
147 suite->success = 0;
148 suite->failure = 0;
149 suite->tests = NULL;
150 }
151
152 return suite;
153 }
154
155 /**
156 * Deallocates a test suite.
157 *
158 * @param suite the test suite to free
159 */
160 static inline void cx_test_suite_free(CxTestSuite* suite) {
161 if (suite == NULL) return;
162 CxTestSet *l = suite->tests;
163 while (l != NULL) {
164 CxTestSet *e = l;
165 l = l->next;
166 free(e);
167 }
168 free(suite);
169 }
170
171 /**
172 * Registers a test function with the specified test suite.
173 *
174 * @param suite the suite, the test function shall be added to
175 * @param test the test function to register
176 * @retval zero success
177 * @retval non-zero failure
178 */
179 cx_attr_nonnull
180 static inline int cx_test_register(CxTestSuite* suite, CxTest test) {
181 CxTestSet *t = (CxTestSet*) malloc(sizeof(CxTestSet));
182 if (t) {
183 t->test = test;
184 t->next = NULL;
185 if (suite->tests == NULL) {
186 suite->tests = t;
187 } else {
188 CxTestSet *last = suite->tests;
189 while (last->next) {
190 last = last->next;
191 }
192 last->next = t;
193 }
194 return 0;
195 } else {
196 return 1;
197 }
198 }
199
200 /**
201 * Runs a test suite and writes the test log to the specified stream.
202 * @param suite the test suite to run
203 * @param out_target the target buffer or file to write the output to
204 * @param out_writer the write function writing to @p out_target
205 */
206 cx_attr_nonnull
207 static inline void cx_test_run(CxTestSuite *suite,
208 void *out_target, cx_write_func out_writer) {
209 if (suite->name == NULL) {
210 out_writer("*** Test Suite ***\n", 1, 19, out_target);
211 } else {
212 out_writer("*** Test Suite : ", 1, 17, out_target);
213 out_writer(suite->name, 1, strlen(suite->name), out_target);
214 out_writer(" ***\n", 1, 5, out_target);
215 }
216 suite->success = 0;
217 suite->failure = 0;
218 for (CxTestSet *elem = suite->tests; elem; elem = elem->next) {
219 elem->test(suite, out_target, out_writer);
220 }
221 out_writer("\nAll test completed.\n", 1, 21, out_target);
222 char total[80];
223 int len = snprintf(
224 total, 80,
225 " Total: %u\n Success: %u\n Failure: %u\n\n",
226 suite->success + suite->failure, suite->success, suite->failure
227 );
228 out_writer(total, 1, len, out_target);
229 }
230
231 /**
232 * Runs a test suite and writes the test log to the specified FILE stream.
233 * @param suite (@c CxTestSuite*) the test suite to run
234 * @param file (@c FILE*) the target file to write the output to
235 */
236 #define cx_test_run_f(suite, file) cx_test_run(suite, (void*)file, (cx_write_func)fwrite)
237
238 /**
239 * Runs a test suite and writes the test log to stdout.
240 * @param suite (@c CxTestSuite*) the test suite to run
241 */
242 #define cx_test_run_stdout(suite) cx_test_run_f(suite, stdout)
243
244 /**
245 * Macro for a #CxTest function header.
246 *
247 * Use this macro to declare and/or define a #CxTest function.
248 *
249 * @param name the name of the test function
250 */
251 #define CX_TEST(name) void name(CxTestSuite* _suite_,void *_output_, cx_write_func _writefnc_)
252
253 /**
254 * Defines the scope of a test.
255 *
256 * @code
257 * CX_TEST(my_test_name) {
258 * // setup code
259 * CX_TEST_DO {
260 * // your tests go here
261 * }
262 * // tear down code
263 * }
264 * @endcode
265 *
266 * @attention Any CX_TEST_ASSERT() calls must be performed in scope of
267 * #CX_TEST_DO.
268 */
269 #define CX_TEST_DO _writefnc_("Running ", 1, 8, _output_);\
270 _writefnc_(__FUNCTION__, 1, strlen(__FUNCTION__), _output_);\
271 _writefnc_("... ", 1, 4, _output_);\
272 jmp_buf _env_;\
273 for (unsigned int _cx_test_loop_ = 0 ;\
274 _cx_test_loop_ == 0 && !setjmp(_env_);\
275 _writefnc_("success.\n", 1, 9, _output_),\
276 _suite_->success++, _cx_test_loop_++)
277
278 /**
279 * Checks a test assertion.
280 * If the assertion is correct, the test carries on. If the assertion is not
281 * correct, the specified message (terminated by a dot and a line break) is
282 * written to the test suites output stream.
283 * @param condition (@c bool) the condition to check
284 * @param message (@c char*) the message that shall be printed out on failure
285 */
286 #define CX_TEST_ASSERTM(condition,message) if (!(condition)) { \
287 const char *_assert_msg_ = message; \
288 _writefnc_(_assert_msg_, 1, strlen(_assert_msg_), _output_); \
289 _writefnc_(".\n", 1, 2, _output_); \
290 _suite_->failure++; \
291 longjmp(_env_, 1);\
292 } (void) 0
293
294 /**
295 * Checks a test assertion.
296 * If the assertion is correct, the test carries on. If the assertion is not
297 * correct, the specified message (terminated by a dot and a line break) is
298 * written to the test suites output stream.
299 * @param condition (@c bool) the condition to check
300 */
301 #define CX_TEST_ASSERT(condition) CX_TEST_ASSERTM(condition, #condition " failed")
302
303 /**
304 * Macro for a test subroutine function header.
305 *
306 * Use this to declare and/or define a subroutine that can be called by using
307 * CX_TEST_CALL_SUBROUTINE().
308 *
309 * @param name the name of the subroutine
310 * @param ... the parameter list
311 *
312 * @see CX_TEST_CALL_SUBROUTINE()
313 */
314 #define CX_TEST_SUBROUTINE(name,...) void name(CxTestSuite* _suite_,\
315 void *_output_, cx_write_func _writefnc_, jmp_buf _env_, __VA_ARGS__)
316
317 /**
318 * Macro for calling a test subroutine.
319 *
320 * Subroutines declared with CX_TEST_SUBROUTINE() can be called by using this
321 * macro.
322 *
323 * @remark You may <b>only</b> call subroutines within a #CX_TEST_DO block.
324 *
325 * @param name the name of the subroutine
326 * @param ... the argument list
327 *
328 * @see CX_TEST_SUBROUTINE()
329 */
330 #define CX_TEST_CALL_SUBROUTINE(name,...) \
331 name(_suite_,_output_,_writefnc_,_env_,__VA_ARGS__)
332
333 #ifdef __cplusplus
334 }
335 #endif
336
337 #endif /* UCX_TEST_H */
338
339