2 * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #ifndef HEADER_TESTUTIL_H
11 # define HEADER_TESTUTIL_H
15 #include <openssl/err.h>
16 #include <openssl/e_os2.h>
19 * Simple unit tests should implement register_tests().
20 * To register tests, call ADD_TEST or ADD_ALL_TESTS:
22 * void register_tests(void)
25 * ADD_ALL_TESTS(test_bar, num_test_bar);
28 * Tests that need to perform custom setup or read command-line arguments should
29 * implement test_main():
31 * int test_main(int argc, char *argv[])
38 * ADD_ALL_TESTS(test_bar, num_test_bar);
39 * // Add more tests ...
41 * ret = run_tests(argv[0]);
43 * // Custom teardown ...
49 /* Adds a simple test case. */
50 # define ADD_TEST(test_function) add_test(#test_function, test_function)
53 * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num.
55 # define ADD_ALL_TESTS(test_function, num) \
56 add_all_tests(#test_function, test_function, num)
59 * Test cases that share common setup should use the helper
60 * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
62 * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE
63 * object called "fixture". It will also allocate the "result" variable used
64 * by EXECUTE_TEST. set_up() should take a const char* specifying the test
65 * case name and return a TEST_FIXTURE_TYPE by value.
67 * EXECUTE_TEST will pass fixture to execute_func() by value, call
68 * tear_down(), and return the result of execute_func(). execute_func() should
69 * take a TEST_FIXTURE_TYPE by value and return 1 on success and 0 on
72 * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST
75 * #define SETUP_FOOBAR_TEST_FIXTURE()\
76 * SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar)
78 * #define EXECUTE_FOOBAR_TEST()\
79 * EXECUTE_TEST(execute_foobar, tear_down_foobar)
81 * Then test case functions can take the form:
83 * static int test_foobar_feature()
85 * SETUP_FOOBAR_TEST_FIXTURE();
86 * [...set individual members of fixture...]
87 * EXECUTE_FOOBAR_TEST();
90 # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
91 TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME); \
94 # define EXECUTE_TEST(execute_func, tear_down)\
95 result = execute_func(fixture);\
99 /* Shorthand if tear_down does nothing. */
100 # define EXECUTE_TEST_NO_TEARDOWN(execute_func)\
101 result = execute_func(fixture);\
105 * TEST_CASE_NAME is defined as the name of the test case function where
106 * possible; otherwise we get by with the file name and line number.
108 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
109 # if defined(_MSC_VER)
110 # define TEST_CASE_NAME __FUNCTION__
112 # define testutil_stringify_helper(s) #s
113 # define testutil_stringify(s) testutil_stringify_helper(s)
114 # define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__)
115 # endif /* _MSC_VER */
117 # define TEST_CASE_NAME __func__
118 # endif /* __STDC_VERSION__ */
121 * Internal helpers. Test programs shouldn't use these directly, but should
122 * rather link to one of the helper main() methods.
125 /* setup_test() should be called as the first thing in a test main(). */
126 void setup_test(void);
128 * finish_test() should be called as the last thing in a test main().
129 * The result of run_tests() should be the input to finish_test().
131 __owur int finish_test(int ret);
133 void add_test(const char *test_case_name, int (*test_fn) ());
134 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num);
135 __owur int run_tests(const char *test_prog_name);
138 * Declarations for user defined functions
140 void register_tests(void);
141 int test_main(int argc, char *argv[]);
145 * Test assumption verification helpers.
148 #define PRINTF_FORMAT(a, b)
149 #if defined(__GNUC__) && defined(__STDC_VERSION__)
151 * Because we support the 'z' modifier, which made its appearance in C99,
152 * we can't use __attribute__ with pre C99 dialects.
154 # if __STDC_VERSION__ >= 199901L
155 # undef PRINTF_FORMAT
156 # define PRINTF_FORMAT(a, b) __attribute__ ((format(printf, a, b)))
160 # define DECLARE_COMPARISON(type, name, opname) \
161 int test_ ## name ## _ ## opname(const char *, int, \
162 const char *, const char *, \
163 const type, const type);
165 # define DECLARE_COMPARISONS(type, name) \
166 DECLARE_COMPARISON(type, name, eq) \
167 DECLARE_COMPARISON(type, name, ne) \
168 DECLARE_COMPARISON(type, name, lt) \
169 DECLARE_COMPARISON(type, name, le) \
170 DECLARE_COMPARISON(type, name, gt) \
171 DECLARE_COMPARISON(type, name, ge)
173 DECLARE_COMPARISONS(int, int)
174 DECLARE_COMPARISONS(unsigned int, uint)
175 DECLARE_COMPARISONS(char, char)
176 DECLARE_COMPARISONS(unsigned char, uchar)
177 DECLARE_COMPARISONS(long, long)
178 DECLARE_COMPARISONS(unsigned long, ulong)
180 * Because this comparison uses a printf format specifier that's not
181 * universally known (yet), we provide an option to not have it declared.
183 # ifndef TESTUTIL_NO_size_t_COMPARISON
184 DECLARE_COMPARISONS(size_t, size_t)
188 * Pointer comparisons against other pointers and null.
189 * These functions return 1 if the test is true.
190 * Otherwise, they return 0 and pretty-print diagnostics.
191 * These should not be called directly, use the TEST_xxx macros below instead.
193 DECLARE_COMPARISON(void *, ptr, eq)
194 DECLARE_COMPARISON(void *, ptr, ne)
195 int test_ptr(const char *file, int line, const char *s, const void *p);
196 int test_ptr_null(const char *file, int line, const char *s, const void *p);
199 * Equality tests for strings where NULL is a legitimate value.
200 * These calls return 1 if the two passed strings compare true.
201 * Otherwise, they return 0 and pretty-print diagnostics.
202 * These should not be called directly, use the TEST_xxx macros below instead.
204 DECLARE_COMPARISON(char *, str, eq)
205 DECLARE_COMPARISON(char *, str, ne)
208 * Same as above, but for strncmp.
210 int test_strn_eq(const char *file, int line, const char *, const char *,
211 const char *a, const char *b, size_t s);
212 int test_strn_ne(const char *file, int line, const char *, const char *,
213 const char *a, const char *b, size_t s);
216 * Equality test for memory blocks where NULL is a legitimate value.
217 * These calls return 1 if the two memory blocks compare true.
218 * Otherwise, they return 0 and pretty-print diagnostics.
219 * These should not be called directly, use the TEST_xxx macros below instead.
221 int test_mem_eq(const char *, int, const char *, const char *,
222 const void *, size_t, const void *, size_t);
223 int test_mem_ne(const char *, int, const char *, const char *,
224 const void *, size_t, const void *, size_t);
227 * Check a boolean result for being true or false.
228 * They return 1 if the condition is true (i.e. the value is non-zro).
229 * Otherwise, they return 0 and pretty-prints diagnostics using |desc|.
230 * These should not be called directly, use the TEST_xxx macros below instead.
232 int test_true(const char *file, int line, const char *s, int b);
233 int test_false(const char *file, int line, const char *s, int b);
236 * Pretty print a failure message.
237 * These should not be called directly, use the TEST_xxx macros below instead.
239 void test_error(const char *file, int line, const char *desc, ...)
241 void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
242 void test_info(const char *file, int line, const char *desc, ...)
244 void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
247 * The following macros provide wrapper calls to the test functions with
248 * a default description that indicates the file and line number of the error.
250 * The following macros guarantee to evaluate each argument exactly once.
251 * This allows constructs such as: if(!TEST_ptr(ptr = OPENSSL_malloc(..)))
252 * to produce better contextual output than:
253 * ptr = OPENSSL_malloc(..);
254 * if (!TEST_ptr(ptr))
256 # define TEST_int_eq(a, b) test_int_eq(__FILE__, __LINE__, #a, #b, a, b)
257 # define TEST_int_ne(a, b) test_int_ne(__FILE__, __LINE__, #a, #b, a, b)
258 # define TEST_int_lt(a, b) test_int_lt(__FILE__, __LINE__, #a, #b, a, b)
259 # define TEST_int_le(a, b) test_int_le(__FILE__, __LINE__, #a, #b, a, b)
260 # define TEST_int_gt(a, b) test_int_gt(__FILE__, __LINE__, #a, #b, a, b)
261 # define TEST_int_ge(a, b) test_int_ge(__FILE__, __LINE__, #a, #b, a, b)
263 # define TEST_int_eq(a, b) test_int_eq(__FILE__, __LINE__, #a, #b, a, b)
264 # define TEST_int_ne(a, b) test_int_ne(__FILE__, __LINE__, #a, #b, a, b)
265 # define TEST_int_lt(a, b) test_int_lt(__FILE__, __LINE__, #a, #b, a, b)
266 # define TEST_int_le(a, b) test_int_le(__FILE__, __LINE__, #a, #b, a, b)
267 # define TEST_int_gt(a, b) test_int_gt(__FILE__, __LINE__, #a, #b, a, b)
268 # define TEST_int_ge(a, b) test_int_ge(__FILE__, __LINE__, #a, #b, a, b)
270 # define TEST_uint_eq(a, b) test_uint_eq(__FILE__, __LINE__, #a, #b, a, b)
271 # define TEST_uint_ne(a, b) test_uint_ne(__FILE__, __LINE__, #a, #b, a, b)
272 # define TEST_uint_lt(a, b) test_uint_lt(__FILE__, __LINE__, #a, #b, a, b)
273 # define TEST_uint_le(a, b) test_uint_le(__FILE__, __LINE__, #a, #b, a, b)
274 # define TEST_uint_gt(a, b) test_uint_gt(__FILE__, __LINE__, #a, #b, a, b)
275 # define TEST_uint_ge(a, b) test_uint_ge(__FILE__, __LINE__, #a, #b, a, b)
277 # define TEST_char_eq(a, b) test_char_eq(__FILE__, __LINE__, #a, #b, a, b)
278 # define TEST_char_ne(a, b) test_char_ne(__FILE__, __LINE__, #a, #b, a, b)
279 # define TEST_char_lt(a, b) test_char_lt(__FILE__, __LINE__, #a, #b, a, b)
280 # define TEST_char_le(a, b) test_char_le(__FILE__, __LINE__, #a, #b, a, b)
281 # define TEST_char_gt(a, b) test_char_gt(__FILE__, __LINE__, #a, #b, a, b)
282 # define TEST_char_ge(a, b) test_char_ge(__FILE__, __LINE__, #a, #b, a, b)
284 # define TEST_uchar_eq(a, b) test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b)
285 # define TEST_uchar_ne(a, b) test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b)
286 # define TEST_uchar_lt(a, b) test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b)
287 # define TEST_uchar_le(a, b) test_uchar_le(__FILE__, __LINE__, #a, #b, a, b)
288 # define TEST_uchar_gt(a, b) test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b)
289 # define TEST_uchar_ge(a, b) test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b)
291 # define TEST_long_eq(a, b) test_long_eq(__FILE__, __LINE__, #a, #b, a, b)
292 # define TEST_long_ne(a, b) test_long_ne(__FILE__, __LINE__, #a, #b, a, b)
293 # define TEST_long_lt(a, b) test_long_lt(__FILE__, __LINE__, #a, #b, a, b)
294 # define TEST_long_le(a, b) test_long_le(__FILE__, __LINE__, #a, #b, a, b)
295 # define TEST_long_gt(a, b) test_long_gt(__FILE__, __LINE__, #a, #b, a, b)
296 # define TEST_long_ge(a, b) test_long_ge(__FILE__, __LINE__, #a, #b, a, b)
298 # define TEST_ulong_eq(a, b) test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b)
299 # define TEST_ulong_ne(a, b) test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b)
300 # define TEST_ulong_lt(a, b) test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b)
301 # define TEST_ulong_le(a, b) test_ulong_le(__FILE__, __LINE__, #a, #b, a, b)
302 # define TEST_ulong_gt(a, b) test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b)
303 # define TEST_ulong_ge(a, b) test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b)
305 # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b)
306 # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b)
307 # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b)
308 # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b)
309 # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b)
310 # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b)
312 # define TEST_ptr_eq(a, b) test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b)
313 # define TEST_ptr_ne(a, b) test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b)
314 # define TEST_ptr(a) test_ptr(__FILE__, __LINE__, #a, a)
315 # define TEST_ptr_null(a) test_ptr_null(__FILE__, __LINE__, #a, a)
317 # define TEST_str_eq(a, b) test_str_eq(__FILE__, __LINE__, #a, #b, a, b)
318 # define TEST_str_ne(a, b) test_str_ne(__FILE__, __LINE__, #a, #b, a, b)
319 # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, b, n)
320 # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, b, n)
322 # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n)
323 # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n)
325 # define TEST_true(a) test_true(__FILE__, __LINE__, #a, (a) != 0)
326 # define TEST_false(a) test_false(__FILE__, __LINE__, #a, (a) != 0)
329 * TEST_error(desc, ...) prints an informative error message in the standard
330 * format. |desc| is a printf format string.
332 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
333 # define TEST_error test_error_c90
334 # define TEST_info test_info_c90
336 # define TEST_error(...) test_error(__FILE__, __LINE__, __VA_ARGS__)
337 # define TEST_info(...) test_info(__FILE__, __LINE__, __VA_ARGS__)
341 * For "impossible" conditions such as malloc failures or bugs in test code,
342 * where continuing the test would be meaningless. Note that OPENSSL_assert
343 * is fatal, and is never compiled out.
345 # define TEST_check(condition) \
347 if (!(condition)) { \
348 ERR_print_errors_fp(stderr); \
349 OPENSSL_assert(!#condition); \
352 #endif /* HEADER_TESTUTIL_H */
356 * The basic I/O functions used by the test framework. These can be
357 * overriden when needed. Note that if one is, then all must be.
359 void test_open_streams(void);
360 void test_close_streams(void);
361 /* The following ALL return the number of characters written */
362 int test_puts_stdout(const char *str);
363 int test_puts_stderr(const char *str);
364 int test_vprintf_stdout(const char *fmt, va_list ap);
365 int test_vprintf_stderr(const char *fmt, va_list ap);
366 /* These return failure or success */
367 int test_flush_stdout(void);
368 int test_flush_stderr(void);