Mercurial > hg > terminal-chess / file comparison

comparison: test/ucxtest.h

test/ucxtest.h

changeset 148
6cc15ba51424
child 149
ea2448961441
equal deleted inserted replaced
147:7e3f2d462bb6 148:6cc15ba51424
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 <stdlib.h>
71 #include <stdio.h>
72 #include <string.h>
73 #include <setjmp.h>
74
75 typedef size_t (*cx_write_func)(const void*, size_t, size_t, void*);
76
77 #ifndef __FUNCTION__
78 /**
79 * Alias for the <code>__func__</code> preprocessor macro.
80 * Some compilers use <code>__func__</code> and others use __FUNCTION__.
81 * We use __FUNCTION__ so we define it for those compilers which use
82 * <code>__func__</code>.
83 */
84 #define __FUNCTION__ __func__
85 #endif
86
87 #if !defined(__clang__) && __GNUC__ > 3
88 #pragma GCC diagnostic ignored "-Wclobbered"
89 #endif
90
91 /** Type for the CxTestSuite. */
92 typedef struct CxTestSuite CxTestSuite;
93
94 /** Pointer to a test function. */
95 typedef void(*CxTest)(CxTestSuite *, void *, cx_write_func);
96
97 /** Type for the internal list of test cases. */
98 typedef struct CxTestSet CxTestSet;
99
100 /** Structure for the internal list of test cases. */
101 struct CxTestSet {
102
103 /** Test case. */
104 CxTest test;
105
106 /** Pointer to the next list element. */
107 CxTestSet *next;
108 };
109
110 /**
111 * A test suite containing multiple test cases.
112 */
113 struct CxTestSuite {
114
115 /** The number of successful tests after the suite has been run. */
116 unsigned int success;
117
118 /** The number of failed tests after the suite has been run. */
119 unsigned int failure;
120
121 /** The optional name of this test suite. */
122 const char *name;
123
124 /**
125 * Internal list of test cases.
126 * Use cx_test_register() to add tests to this list.
127 */
128 CxTestSet *tests;
129 };
130
131 /**
132 * Creates a new test suite.
133 * @param name optional name of the suite
134 * @return a new test suite
135 */
136 static CxTestSuite* cx_test_suite_new(const char *name) {
137 CxTestSuite* suite = (CxTestSuite*) malloc(sizeof(CxTestSuite));
138 if (suite != NULL) {
139 suite->name = name;
140 suite->success = 0;
141 suite->failure = 0;
142 suite->tests = NULL;
143 }
144
145 return suite;
146 }
147
148 /**
149 * Deallocates a test suite.
150 *
151 * @param suite the test suite to free
152 */
153 static void cx_test_suite_free(CxTestSuite* suite) {
154 if (suite == NULL) return;
155 CxTestSet *l = suite->tests;
156 while (l != NULL) {
157 CxTestSet *e = l;
158 l = l->next;
159 free(e);
160 }
161 free(suite);
162 }
163
164 /**
165 * Registers a test function with the specified test suite.
166 *
167 * @param suite the suite the test function shall be added to
168 * @param test the test function to register
169 * @retval zero success
170 * @retval non-zero failure
171 */
172 static int cx_test_register(CxTestSuite* suite, CxTest test) {
173 CxTestSet *t = (CxTestSet*) malloc(sizeof(CxTestSet));
174 if (t) {
175 t->test = test;
176 t->next = NULL;
177 if (suite->tests == NULL) {
178 suite->tests = t;
179 } else {
180 CxTestSet *last = suite->tests;
181 while (last->next) {
182 last = last->next;
183 }
184 last->next = t;
185 }
186 return 0;
187 } else {
188 return 1;
189 }
190 }
191
192 /**
193 * Runs a test suite and writes the test log to the specified stream.
194 * @param suite the test suite to run
195 * @param out_target the target buffer or file to write the output to
196 * @param out_writer the write function writing to @p out_target
197 */
198 static void cx_test_run(CxTestSuite *suite, void *out_target, cx_write_func out_writer) {
199 if (suite->name == NULL) {
200 out_writer("*** Test Suite ***\n", 1, 19, out_target);
201 } else {
202 out_writer("*** Test Suite : ", 1, 17, out_target);
203 out_writer(suite->name, 1, strlen(suite->name), out_target);
204 out_writer(" ***\n", 1, 5, out_target);
205 }
206 suite->success = 0;
207 suite->failure = 0;
208 for (CxTestSet *elem = suite->tests; elem; elem = elem->next) {
209 elem->test(suite, out_target, out_writer);
210 }
211 out_writer("\nAll test completed.\n", 1, 21, out_target);
212 char total[80];
213 int len = snprintf(
214 total, 80,
215 " Tests: %5u\n Success: %5u\n Failure: %5u\n\n",
216 suite->success + suite->failure, suite->success, suite->failure
217 );
218 out_writer(total, 1, len, out_target);
219 }
220
221 /**
222 * Runs a test suite and writes the test log to the specified FILE stream.
223 * @param suite (@c CxTestSuite*) the test suite to run
224 * @param file (@c FILE*) the target file to write the output to
225 */
226 #define cx_test_run_f(suite, file) cx_test_run(suite, (void*)file, (cx_write_func)fwrite)
227
228 /**
229 * Runs a test suite and writes the test log to stdout.
230 * @param suite (@c CxTestSuite*) the test suite to run
231 */
232 #define cx_test_run_stdout(suite) cx_test_run_f(suite, stdout)
233
234 /**
235 * Macro for a #CxTest function header.
236 *
237 * Use this macro to declare and/or define a #CxTest function.
238 *
239 * @param name the name of the test function
240 */
241 #define CX_TEST(name) void name(CxTestSuite* _suite_,void *_output_, cx_write_func _writefnc_)
242
243 /**
244 * Defines the scope of a test.
245 *
246 * @code
247 * CX_TEST(my_test_name) {
248 * // setup code
249 * CX_TEST_DO {
250 * // your tests go here
251 * }
252 * // tear down code
253 * }
254 * @endcode
255 *
256 * @attention Any CX_TEST_ASSERT() calls must be performed in the scope of
257 * #CX_TEST_DO.
258 */
259 #define CX_TEST_DO _writefnc_("Running ", 1, 8, _output_);\
260 _writefnc_(__FUNCTION__, 1, strlen(__FUNCTION__), _output_);\
261 _writefnc_("... ", 1, 4, _output_);\
262 jmp_buf _env_;\
263 for (unsigned int _cx_test_loop_ = 0 ;\
264 _cx_test_loop_ == 0 && !setjmp(_env_);\
265 _writefnc_("success.\n", 1, 9, _output_),\
266 _suite_->success++, _cx_test_loop_++)
267
268 /**
269 * Checks a test assertion.
270 * If the assertion is correct, the test carries on. If the assertion is not
271 * correct, the specified message (terminated by a dot and a line break) is
272 * written to the test suites output stream.
273 * @param condition (@c bool) the condition to check
274 * @param message (@c char*) the message that shall be printed out on failure
275 */
276 #define CX_TEST_ASSERTM(condition,message) if (!(condition)) { \
277 const char *_assert_msg_ = message; \
278 _writefnc_(_assert_msg_, 1, strlen(_assert_msg_), _output_); \
279 _writefnc_(".\n", 1, 2, _output_); \
280 _suite_->failure++; \
281 longjmp(_env_, 1);\
282 } (void) 0
283
284 /**
285 * Checks a test assertion.
286 * If the assertion is correct, the test carries on. If the assertion is not
287 * correct, the specified message (terminated by a dot and a line break) is
288 * written to the test suites output stream.
289 * @param condition (@c bool) the condition to check
290 */
291 #define CX_TEST_ASSERT(condition) CX_TEST_ASSERTM(condition, #condition " failed")
292
293 /**
294 * Macro for a test subroutine function header.
295 *
296 * Use this to declare and/or define a subroutine that can be called by using
297 * CX_TEST_CALL_SUBROUTINE().
298 *
299 * @param name the name of the subroutine
300 * @param ... the parameter list
301 *
302 * @see CX_TEST_CALL_SUBROUTINE()
303 */
304 #define CX_TEST_SUBROUTINE(name,...) void name(CxTestSuite* _suite_,\
305 void *_output_, cx_write_func _writefnc_, jmp_buf _env_, __VA_ARGS__)
306
307 /**
308 * Macro for calling a test subroutine.
309 *
310 * Subroutines declared with CX_TEST_SUBROUTINE() can be called by using this
311 * macro.
312 *
313 * @remark You may <b>only</b> call subroutines within a #CX_TEST_DO block.
314 *
315 * @param name the name of the subroutine
316 * @param ... the argument list
317 *
318 * @see CX_TEST_SUBROUTINE()
319 */
320 #define CX_TEST_CALL_SUBROUTINE(name,...) \
321 name(_suite_,_output_,_writefnc_,_env_,__VA_ARGS__)
322
323 #endif /* UCX_TEST_H */
324

Mercurial Repository: terminal-chess

mercurial