ecf993445de11a916cf9295166b816caed57f68a
[openssl.git] / test / testutil.h
1 /*
2  * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #ifndef HEADER_TESTUTIL_H
11 # define HEADER_TESTUTIL_H
12
13 #include <stdarg.h>
14
15 #include <openssl/err.h>
16 #include <openssl/e_os2.h>
17
18 /*-
19  * Simple unit tests should implement register_tests().
20  * To register tests, call ADD_TEST or ADD_ALL_TESTS:
21  *
22  * void register_tests(void)
23  * {
24  *     ADD_TEST(test_foo);
25  *     ADD_ALL_TESTS(test_bar, num_test_bar);
26  * }
27  *
28  * Tests that need to perform custom setup or read command-line arguments should
29  * implement test_main():
30  *
31  * int test_main(int argc, char *argv[])
32  * {
33  *     int ret;
34  *
35  *     // Custom setup ...
36  *
37  *     ADD_TEST(test_foo);
38  *     ADD_ALL_TESTS(test_bar, num_test_bar);
39  *     // Add more tests ...
40  *
41  *     ret = run_tests(argv[0]);
42  *
43  *     // Custom teardown ...
44  *
45  *     return ret;
46  * }
47  */
48
49 /* Adds a simple test case. */
50 # define ADD_TEST(test_function) add_test(#test_function, test_function)
51
52 /*
53  * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num.
54  */
55 # define ADD_ALL_TESTS(test_function, num) \
56     add_all_tests(#test_function, test_function, num, 1)
57 /*
58  * A variant of the same without TAP output.
59  */
60 # define ADD_ALL_TESTS_NOSUBTEST(test_function, num) \
61     add_all_tests(#test_function, test_function, num, 0)
62
63 /*-
64  * Test cases that share common setup should use the helper
65  * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
66  *
67  * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE
68  * object called "fixture". It will also allocate the "result" variable used
69  * by EXECUTE_TEST. set_up() should take a const char* specifying the test
70  * case name and return a TEST_FIXTURE_TYPE by value.
71  *
72  * EXECUTE_TEST will pass fixture to execute_func() by value, call
73  * tear_down(), and return the result of execute_func(). execute_func() should
74  * take a TEST_FIXTURE_TYPE by value and return 1 on success and 0 on
75  * failure.
76  *
77  * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST
78  * variations like so:
79  *
80  * #define SETUP_FOOBAR_TEST_FIXTURE()\
81  *   SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar)
82  *
83  * #define EXECUTE_FOOBAR_TEST()\
84  *   EXECUTE_TEST(execute_foobar, tear_down_foobar)
85  *
86  * Then test case functions can take the form:
87  *
88  * static int test_foobar_feature()
89  *      {
90  *      SETUP_FOOBAR_TEST_FIXTURE();
91  *      [...set individual members of fixture...]
92  *      EXECUTE_FOOBAR_TEST();
93  *      }
94  */
95 # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
96     TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME); \
97     int result = 0
98
99 # define EXECUTE_TEST(execute_func, tear_down)\
100         result = execute_func(fixture);\
101         tear_down(fixture);\
102         return result
103
104 /* Shorthand if tear_down does nothing. */
105 # define EXECUTE_TEST_NO_TEARDOWN(execute_func)\
106         result = execute_func(fixture);\
107         return result
108
109 /*
110  * TEST_CASE_NAME is defined as the name of the test case function where
111  * possible; otherwise we get by with the file name and line number.
112  */
113 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
114 #  if defined(_MSC_VER)
115 #   define TEST_CASE_NAME __FUNCTION__
116 #  else
117 #   define testutil_stringify_helper(s) #s
118 #   define testutil_stringify(s) testutil_stringify_helper(s)
119 #   define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__)
120 #  endif                        /* _MSC_VER */
121 # else
122 #  define TEST_CASE_NAME __func__
123 # endif                         /* __STDC_VERSION__ */
124
125 /*
126  * Internal helpers. Test programs shouldn't use these directly, but should
127  * rather link to one of the helper main() methods.
128  */
129
130 /* setup_test() should be called as the first thing in a test main(). */
131 void setup_test(void);
132 /*
133  * finish_test() should be called as the last thing in a test main().
134  * The result of run_tests() should be the input to finish_test().
135  */
136 __owur int finish_test(int ret);
137
138 void add_test(const char *test_case_name, int (*test_fn) ());
139 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num,
140                    int subtest);
141 __owur int run_tests(const char *test_prog_name);
142
143 /*
144  * Declarations for user defined functions
145  */
146 void register_tests(void);
147 int test_main(int argc, char *argv[]);
148
149
150 /*
151  *  Test assumption verification helpers.
152  */
153
154 #define PRINTF_FORMAT(a, b)
155 #if defined(__GNUC__) && defined(__STDC_VERSION__)
156   /*
157    * Because we support the 'z' modifier, which made its appearance in C99,
158    * we can't use __attribute__ with pre C99 dialects.
159    */
160 # if __STDC_VERSION__ >= 199901L
161 #  undef PRINTF_FORMAT
162 #  define PRINTF_FORMAT(a, b)   __attribute__ ((format(printf, a, b)))
163 # endif
164 #endif
165
166 #  define DECLARE_COMPARISON(type, name, opname)                        \
167     int test_ ## name ## _ ## opname(const char *, int,                 \
168                                      const char *, const char *,        \
169                                      const type, const type);
170
171 # define DECLARE_COMPARISONS(type, name)                                \
172     DECLARE_COMPARISON(type, name, eq)                                  \
173     DECLARE_COMPARISON(type, name, ne)                                  \
174     DECLARE_COMPARISON(type, name, lt)                                  \
175     DECLARE_COMPARISON(type, name, le)                                  \
176     DECLARE_COMPARISON(type, name, gt)                                  \
177     DECLARE_COMPARISON(type, name, ge)
178
179 DECLARE_COMPARISONS(int, int)
180 DECLARE_COMPARISONS(unsigned int, uint)
181 DECLARE_COMPARISONS(char, char)
182 DECLARE_COMPARISONS(unsigned char, uchar)
183 DECLARE_COMPARISONS(long, long)
184 DECLARE_COMPARISONS(unsigned long, ulong)
185 /*
186  * Because this comparison uses a printf format specifier that's not
187  * universally known (yet), we provide an option to not have it declared.
188  */
189 # ifndef TESTUTIL_NO_size_t_COMPARISON
190 DECLARE_COMPARISONS(size_t, size_t)
191 # endif
192
193 /*
194  * Pointer comparisons against other pointers and null.
195  * These functions return 1 if the test is true.
196  * Otherwise, they return 0 and pretty-print diagnostics.
197  * These should not be called directly, use the TEST_xxx macros below instead.
198  */
199 DECLARE_COMPARISON(void *, ptr, eq)
200 DECLARE_COMPARISON(void *, ptr, ne)
201 int test_ptr(const char *file, int line, const char *s, const void *p);
202 int test_ptr_null(const char *file, int line, const char *s, const void *p);
203
204 /*
205  * Equality tests for strings where NULL is a legitimate value.
206  * These calls return 1 if the two passed strings compare true.
207  * Otherwise, they return 0 and pretty-print diagnostics.
208  * These should not be called directly, use the TEST_xxx macros below instead.
209  */
210 DECLARE_COMPARISON(char *, str, eq)
211 DECLARE_COMPARISON(char *, str, ne)
212
213 /*
214  * Same as above, but for strncmp.
215  */
216 int test_strn_eq(const char *file, int line, const char *, const char *,
217                  const char *a, const char *b, size_t s);
218 int test_strn_ne(const char *file, int line, const char *, const char *,
219                  const char *a, const char *b, size_t s);
220
221 /*
222  * Equality test for memory blocks where NULL is a legitimate value.
223  * These calls return 1 if the two memory blocks compare true.
224  * Otherwise, they return 0 and pretty-print diagnostics.
225  * These should not be called directly, use the TEST_xxx macros below instead.
226  */
227 int test_mem_eq(const char *, int, const char *, const char *,
228                 const void *, size_t, const void *, size_t);
229 int test_mem_ne(const char *, int, const char *, const char *,
230                 const void *, size_t, const void *, size_t);
231
232 /*
233  * Check a boolean result for being true or false.
234  * They return 1 if the condition is true (i.e. the value is non-zro).
235  * Otherwise, they return 0 and pretty-prints diagnostics using |desc|.
236  * These should not be called directly, use the TEST_xxx macros below instead.
237  */
238 int test_true(const char *file, int line, const char *s, int b);
239 int test_false(const char *file, int line, const char *s, int b);
240
241 /*
242  * Pretty print a failure message.
243  * These should not be called directly, use the TEST_xxx macros below instead.
244  */
245 void test_error(const char *file, int line, const char *desc, ...)
246     PRINTF_FORMAT(3, 4);
247 void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
248 void test_info(const char *file, int line, const char *desc, ...)
249     PRINTF_FORMAT(3, 4);
250 void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
251
252 /*
253  * The following macros provide wrapper calls to the test functions with
254  * a default description that indicates the file and line number of the error.
255  *
256  * The following macros guarantee to evaluate each argument exactly once.
257  * This allows constructs such as: if(!TEST_ptr(ptr = OPENSSL_malloc(..)))
258  * to produce better contextual output than:
259  *      ptr = OPENSSL_malloc(..);
260  *      if (!TEST_ptr(ptr))
261  */
262 # define TEST_int_eq(a, b)    test_int_eq(__FILE__, __LINE__, #a, #b, a, b)
263 # define TEST_int_ne(a, b)    test_int_ne(__FILE__, __LINE__, #a, #b, a, b)
264 # define TEST_int_lt(a, b)    test_int_lt(__FILE__, __LINE__, #a, #b, a, b)
265 # define TEST_int_le(a, b)    test_int_le(__FILE__, __LINE__, #a, #b, a, b)
266 # define TEST_int_gt(a, b)    test_int_gt(__FILE__, __LINE__, #a, #b, a, b)
267 # define TEST_int_ge(a, b)    test_int_ge(__FILE__, __LINE__, #a, #b, a, b)
268
269 # define TEST_int_eq(a, b)    test_int_eq(__FILE__, __LINE__, #a, #b, a, b)
270 # define TEST_int_ne(a, b)    test_int_ne(__FILE__, __LINE__, #a, #b, a, b)
271 # define TEST_int_lt(a, b)    test_int_lt(__FILE__, __LINE__, #a, #b, a, b)
272 # define TEST_int_le(a, b)    test_int_le(__FILE__, __LINE__, #a, #b, a, b)
273 # define TEST_int_gt(a, b)    test_int_gt(__FILE__, __LINE__, #a, #b, a, b)
274 # define TEST_int_ge(a, b)    test_int_ge(__FILE__, __LINE__, #a, #b, a, b)
275
276 # define TEST_uint_eq(a, b)   test_uint_eq(__FILE__, __LINE__, #a, #b, a, b)
277 # define TEST_uint_ne(a, b)   test_uint_ne(__FILE__, __LINE__, #a, #b, a, b)
278 # define TEST_uint_lt(a, b)   test_uint_lt(__FILE__, __LINE__, #a, #b, a, b)
279 # define TEST_uint_le(a, b)   test_uint_le(__FILE__, __LINE__, #a, #b, a, b)
280 # define TEST_uint_gt(a, b)   test_uint_gt(__FILE__, __LINE__, #a, #b, a, b)
281 # define TEST_uint_ge(a, b)   test_uint_ge(__FILE__, __LINE__, #a, #b, a, b)
282
283 # define TEST_char_eq(a, b)   test_char_eq(__FILE__, __LINE__, #a, #b, a, b)
284 # define TEST_char_ne(a, b)   test_char_ne(__FILE__, __LINE__, #a, #b, a, b)
285 # define TEST_char_lt(a, b)   test_char_lt(__FILE__, __LINE__, #a, #b, a, b)
286 # define TEST_char_le(a, b)   test_char_le(__FILE__, __LINE__, #a, #b, a, b)
287 # define TEST_char_gt(a, b)   test_char_gt(__FILE__, __LINE__, #a, #b, a, b)
288 # define TEST_char_ge(a, b)   test_char_ge(__FILE__, __LINE__, #a, #b, a, b)
289
290 # define TEST_uchar_eq(a, b)  test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b)
291 # define TEST_uchar_ne(a, b)  test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b)
292 # define TEST_uchar_lt(a, b)  test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b)
293 # define TEST_uchar_le(a, b)  test_uchar_le(__FILE__, __LINE__, #a, #b, a, b)
294 # define TEST_uchar_gt(a, b)  test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b)
295 # define TEST_uchar_ge(a, b)  test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b)
296
297 # define TEST_long_eq(a, b)   test_long_eq(__FILE__, __LINE__, #a, #b, a, b)
298 # define TEST_long_ne(a, b)   test_long_ne(__FILE__, __LINE__, #a, #b, a, b)
299 # define TEST_long_lt(a, b)   test_long_lt(__FILE__, __LINE__, #a, #b, a, b)
300 # define TEST_long_le(a, b)   test_long_le(__FILE__, __LINE__, #a, #b, a, b)
301 # define TEST_long_gt(a, b)   test_long_gt(__FILE__, __LINE__, #a, #b, a, b)
302 # define TEST_long_ge(a, b)   test_long_ge(__FILE__, __LINE__, #a, #b, a, b)
303
304 # define TEST_ulong_eq(a, b)  test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b)
305 # define TEST_ulong_ne(a, b)  test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b)
306 # define TEST_ulong_lt(a, b)  test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b)
307 # define TEST_ulong_le(a, b)  test_ulong_le(__FILE__, __LINE__, #a, #b, a, b)
308 # define TEST_ulong_gt(a, b)  test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b)
309 # define TEST_ulong_ge(a, b)  test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b)
310
311 # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b)
312 # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b)
313 # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b)
314 # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b)
315 # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b)
316 # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b)
317
318 # define TEST_ptr_eq(a, b)    test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b)
319 # define TEST_ptr_ne(a, b)    test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b)
320 # define TEST_ptr(a)          test_ptr(__FILE__, __LINE__, #a, a)
321 # define TEST_ptr_null(a)     test_ptr_null(__FILE__, __LINE__, #a, a)
322
323 # define TEST_str_eq(a, b)    test_str_eq(__FILE__, __LINE__, #a, #b, a, b)
324 # define TEST_str_ne(a, b)    test_str_ne(__FILE__, __LINE__, #a, #b, a, b)
325 # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, b, n)
326 # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, b, n)
327
328 # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n)
329 # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n)
330
331 # define TEST_true(a)         test_true(__FILE__, __LINE__, #a, (a) != 0)
332 # define TEST_false(a)        test_false(__FILE__, __LINE__, #a, (a) != 0)
333
334 /*
335  * TEST_error(desc, ...) prints an informative error message in the standard
336  * format.  |desc| is a printf format string.
337  */
338 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
339 #  define TEST_error         test_error_c90
340 #  define TEST_info          test_info_c90
341 # else
342 #  define TEST_error(...)    test_error(__FILE__, __LINE__, __VA_ARGS__)
343 #  define TEST_info(...)     test_info(__FILE__, __LINE__, __VA_ARGS__)
344 # endif
345
346 /*
347  * For "impossible" conditions such as malloc failures or bugs in test code,
348  * where continuing the test would be meaningless. Note that OPENSSL_assert
349  * is fatal, and is never compiled out.
350  */
351 # define TEST_check(condition)                  \
352     do {                                        \
353         if (!(condition)) {                     \
354             ERR_print_errors_fp(stderr);        \
355             OPENSSL_assert(!#condition);        \
356         }                                       \
357     } while (0)
358 #endif                          /* HEADER_TESTUTIL_H */
359
360
361 /*
362  * The basic I/O functions used by the test framework.  These can be
363  * overriden when needed. Note that if one is, then all must be.
364  */
365 void test_open_streams(void);
366 void test_close_streams(void);
367 /* The following ALL return the number of characters written */
368 int test_puts_stdout(const char *str);
369 int test_puts_stderr(const char *str);
370 int test_vprintf_stdout(const char *fmt, va_list ap);
371 int test_vprintf_stderr(const char *fmt, va_list ap);
372 /* These return failure or success */
373 int test_flush_stdout(void);
374 int test_flush_stderr(void);
375
376 extern BIO *bio_out;
377 extern BIO *bio_err;
378
379 int subtest_level(void);