ec2f532c4c2b2f012fd70fdfb621572102044407
[openssl.git] / test / testutil.h
1 /*
2  * Copyright 2014-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 #include <openssl/bn.h>
18 #include "opt.h"
19
20 /*-
21  * Simple unit tests should implement setup_tests().
22  * This function should return zero if the registration process fails.
23  * To register tests, call ADD_TEST or ADD_ALL_TESTS:
24  *
25  * int setup_tests(void)
26  * {
27  *     ADD_TEST(test_foo);
28  *     ADD_ALL_TESTS(test_bar, num_test_bar);
29  *     return 1;
30  * }
31  *
32  * Tests that require clean up after execution should implement:
33  *
34  * void cleanup_tests(void);
35  *
36  * The cleanup_tests function will be called even if setup_tests()
37  * returns failure.
38  *
39  * In some cases, early initialization before the framework is set up
40  * may be needed.  In such a case, this should be implemented:
41  *
42  * int global_init(void);
43  *
44  * This function should return zero if there is an unrecoverable error and
45  * non-zero if the initialization was successful.
46  */
47
48 /* Adds a simple test case. */
49 # define ADD_TEST(test_function) add_test(#test_function, test_function)
50
51 /*
52  * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num.
53  */
54 # define ADD_ALL_TESTS(test_function, num) \
55     add_all_tests(#test_function, test_function, num, 1)
56 /*
57  * A variant of the same without TAP output.
58  */
59 # define ADD_ALL_TESTS_NOSUBTEST(test_function, num) \
60     add_all_tests(#test_function, test_function, num, 0)
61
62 /*-
63  * Test cases that share common setup should use the helper
64  * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
65  *
66  * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE
67  * object called "fixture". It will also allocate the "result" variable used
68  * by EXECUTE_TEST. set_up() should take a const char* specifying the test
69  * case name and return a TEST_FIXTURE_TYPE by reference.
70  *
71  * EXECUTE_TEST will pass fixture to execute_func() by reference, call
72  * tear_down(), and return the result of execute_func(). execute_func() should
73  * take a TEST_FIXTURE_TYPE by reference and return 1 on success and 0 on
74  * failure.  The tear_down function is responsible for deallocation of the
75  * result variable, if required.
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     if (fixture != NULL) {\
101         result = execute_func(fixture);\
102         tear_down(fixture);\
103     }
104
105 /*
106  * TEST_CASE_NAME is defined as the name of the test case function where
107  * possible; otherwise we get by with the file name and line number.
108  */
109 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
110 #  if defined(_MSC_VER)
111 #   define TEST_CASE_NAME __FUNCTION__
112 #  else
113 #   define testutil_stringify_helper(s) #s
114 #   define testutil_stringify(s) testutil_stringify_helper(s)
115 #   define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__)
116 #  endif                        /* _MSC_VER */
117 # else
118 #  define TEST_CASE_NAME __func__
119 # endif                         /* __STDC_VERSION__ */
120
121
122 /* The default test enum which should be common to all tests */
123 #define OPT_TEST_ENUM \
124     OPT_TEST_HELP = 500, \
125     OPT_TEST_LIST, \
126     OPT_TEST_SINGLE, \
127     OPT_TEST_ITERATION, \
128     OPT_TEST_INDENT, \
129     OPT_TEST_SEED
130
131 /* The Default test OPTIONS common to all tests (without a usage string) */
132 #define OPT_TEST_OPTIONS \
133     { OPT_HELP_STR, 1,  '-', "Valid options are:\n" }, \
134     { "help", OPT_TEST_HELP, '-', "Display this summary" }, \
135     { "list", OPT_TEST_LIST, '-', "Display the list of tests available" }, \
136     { "test", OPT_TEST_SINGLE, 's', "Run a single test by id or name" }, \
137     { "iter", OPT_TEST_ITERATION, 'n', "Run a single iteration of a test" }, \
138     { "indent", OPT_TEST_INDENT,'p', "Number of tabs added to output" }, \
139     { "seed", OPT_TEST_SEED, 'n', "Seed value to randomize tests with" }
140
141 /* The Default test OPTIONS common to all tests starting with an additional usage string */
142 #define OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(usage) \
143     { OPT_HELP_STR, 1, '-', "Usage: %s [options] " usage }, \
144     OPT_TEST_OPTIONS
145
146 /* The Default test OPTIONS common to all tests with an default usage string */
147 #define OPT_TEST_OPTIONS_DEFAULT_USAGE \
148     { OPT_HELP_STR, 1, '-', "Usage: %s [options]\n" }, \
149     OPT_TEST_OPTIONS
150
151 /*
152  * Optional Cases that need to be ignored by the test app when using opt_next(),
153  * (that are handled internally).
154  */
155 #define OPT_TEST_CASES \
156          OPT_TEST_HELP: \
157     case OPT_TEST_LIST: \
158     case OPT_TEST_SINGLE: \
159     case OPT_TEST_ITERATION: \
160     case OPT_TEST_INDENT: \
161     case OPT_TEST_SEED
162
163 /*
164  * Tests that use test_get_argument() that dont have any additional options
165  * (i.e- dont use opt_next()) can use this to set the usage string.
166  * It embeds test_get_options() which gives default command line options for
167  * the test system.
168  *
169  * Tests that need to use opt_next() need to specify
170  *  (1) test_get_options() containing an options[] (Which should include either
171  *    OPT_TEST_OPTIONS_DEFAULT_USAGE OR
172  *    OPT_TEST_OPTIONS_WITH_EXTRA_USAGE).
173  *  (2) An enum outside the test_get_options() which contains OPT_TEST_ENUM, as
174  *      well as the additional options that need to be handled.
175  *  (3) case OPT_TEST_CASES: break; inside the opt_next() handling code.
176  */
177 #define OPT_TEST_DECLARE_USAGE(usage_str) \
178 const OPTIONS *test_get_options(void) \
179 { \
180     enum { OPT_TEST_ENUM }; \
181     static const OPTIONS options[] = { \
182         OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(usage_str), \
183         { NULL } \
184     }; \
185     return options; \
186 }
187
188 /*
189  * Used to read non optional command line values that follow after the options.
190  * Returns NULL if there is no argument.
191  */
192 char *test_get_argument(size_t n);
193 /* Return the number of additional non optional command line arguments */
194 size_t test_get_argument_count(void);
195
196 /*
197  * Internal helpers. Test programs shouldn't use these directly, but should
198  * rather link to one of the helper main() methods.
199  */
200
201 void add_test(const char *test_case_name, int (*test_fn) (void));
202 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num,
203                    int subtest);
204
205 /*
206  * Declarations for user defined functions.
207  * The first two return a boolean indicating that the test should not proceed.
208  */
209 int global_init(void);
210 int setup_tests(void);
211 void cleanup_tests(void);
212 /*
213  * Used to supply test specific command line options,
214  * If non optional parameters are used, then the first entry in the OPTIONS[]
215  * should contain:
216  * { OPT_HELP_STR, 1, '-', "list of non optional commandline params\n"},
217  * The last entry should always be { NULL }.
218  *
219  * Run the test locally using './test/test_name -help' to check the usage.
220  */
221 const OPTIONS *test_get_options(void);
222
223 /*
224  *  Test assumption verification helpers.
225  */
226
227 #define PRINTF_FORMAT(a, b)
228 #if defined(__GNUC__) && defined(__STDC_VERSION__)
229   /*
230    * Because we support the 'z' modifier, which made its appearance in C99,
231    * we can't use __attribute__ with pre C99 dialects.
232    */
233 # if __STDC_VERSION__ >= 199901L
234 #  undef PRINTF_FORMAT
235 #  define PRINTF_FORMAT(a, b)   __attribute__ ((format(printf, a, b)))
236 # endif
237 #endif
238
239 # define DECLARE_COMPARISON(type, name, opname)                         \
240     int test_ ## name ## _ ## opname(const char *, int,                 \
241                                      const char *, const char *,        \
242                                      const type, const type);
243
244 # define DECLARE_COMPARISONS(type, name)                                \
245     DECLARE_COMPARISON(type, name, eq)                                  \
246     DECLARE_COMPARISON(type, name, ne)                                  \
247     DECLARE_COMPARISON(type, name, lt)                                  \
248     DECLARE_COMPARISON(type, name, le)                                  \
249     DECLARE_COMPARISON(type, name, gt)                                  \
250     DECLARE_COMPARISON(type, name, ge)
251
252 DECLARE_COMPARISONS(int, int)
253 DECLARE_COMPARISONS(unsigned int, uint)
254 DECLARE_COMPARISONS(char, char)
255 DECLARE_COMPARISONS(unsigned char, uchar)
256 DECLARE_COMPARISONS(long, long)
257 DECLARE_COMPARISONS(unsigned long, ulong)
258 DECLARE_COMPARISONS(time_t, time_t)
259 /*
260  * Because this comparison uses a printf format specifier that's not
261  * universally known (yet), we provide an option to not have it declared.
262  */
263 # ifndef TESTUTIL_NO_size_t_COMPARISON
264 DECLARE_COMPARISONS(size_t, size_t)
265 # endif
266
267 /*
268  * Pointer comparisons against other pointers and null.
269  * These functions return 1 if the test is true.
270  * Otherwise, they return 0 and pretty-print diagnostics.
271  * These should not be called directly, use the TEST_xxx macros below instead.
272  */
273 DECLARE_COMPARISON(void *, ptr, eq)
274 DECLARE_COMPARISON(void *, ptr, ne)
275 int test_ptr(const char *file, int line, const char *s, const void *p);
276 int test_ptr_null(const char *file, int line, const char *s, const void *p);
277
278 /*
279  * Equality tests for strings where NULL is a legitimate value.
280  * These calls return 1 if the two passed strings compare true.
281  * Otherwise, they return 0 and pretty-print diagnostics.
282  * These should not be called directly, use the TEST_xxx macros below instead.
283  */
284 DECLARE_COMPARISON(char *, str, eq)
285 DECLARE_COMPARISON(char *, str, ne)
286
287 /*
288  * Same as above, but for strncmp.
289  */
290 int test_strn_eq(const char *file, int line, const char *, const char *,
291                  const char *a, const char *b, size_t s);
292 int test_strn_ne(const char *file, int line, const char *, const char *,
293                  const char *a, const char *b, size_t s);
294
295 /*
296  * Equality test for memory blocks where NULL is a legitimate value.
297  * These calls return 1 if the two memory blocks compare true.
298  * Otherwise, they return 0 and pretty-print diagnostics.
299  * These should not be called directly, use the TEST_xxx macros below instead.
300  */
301 int test_mem_eq(const char *, int, const char *, const char *,
302                 const void *, size_t, const void *, size_t);
303 int test_mem_ne(const char *, int, const char *, const char *,
304                 const void *, size_t, const void *, size_t);
305
306 /*
307  * Check a boolean result for being true or false.
308  * They return 1 if the condition is true (i.e. the value is non-zero).
309  * Otherwise, they return 0 and pretty-prints diagnostics using |s|.
310  * These should not be called directly, use the TEST_xxx macros below instead.
311  */
312 int test_true(const char *file, int line, const char *s, int b);
313 int test_false(const char *file, int line, const char *s, int b);
314
315 /*
316  * Comparisons between BIGNUMs.
317  * BIGNUMS can be compared against other BIGNUMs or zero.
318  * Some additional equality tests against 1 & specific values are provided.
319  * Tests for parity are included as well.
320  */
321 DECLARE_COMPARISONS(BIGNUM *, BN)
322 int test_BN_eq_zero(const char *file, int line, const char *s, const BIGNUM *a);
323 int test_BN_ne_zero(const char *file, int line, const char *s, const BIGNUM *a);
324 int test_BN_lt_zero(const char *file, int line, const char *s, const BIGNUM *a);
325 int test_BN_le_zero(const char *file, int line, const char *s, const BIGNUM *a);
326 int test_BN_gt_zero(const char *file, int line, const char *s, const BIGNUM *a);
327 int test_BN_ge_zero(const char *file, int line, const char *s, const BIGNUM *a);
328 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a);
329 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a);
330 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a);
331 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws,
332                     const BIGNUM *a, BN_ULONG w);
333 int test_BN_abs_eq_word(const char *file, int line, const char *bns,
334                         const char *ws, const BIGNUM *a, BN_ULONG w);
335
336 /*
337  * Pretty print a failure message.
338  * These should not be called directly, use the TEST_xxx macros below instead.
339  */
340 void test_error(const char *file, int line, const char *desc, ...)
341     PRINTF_FORMAT(3, 4);
342 void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
343 void test_info(const char *file, int line, const char *desc, ...)
344     PRINTF_FORMAT(3, 4);
345 void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
346 void test_note(const char *desc, ...) PRINTF_FORMAT(1, 2);
347 void test_openssl_errors(void);
348 void test_perror(const char *s);
349
350 /*
351  * The following macros provide wrapper calls to the test functions with
352  * a default description that indicates the file and line number of the error.
353  *
354  * The following macros guarantee to evaluate each argument exactly once.
355  * This allows constructs such as: if (!TEST_ptr(ptr = OPENSSL_malloc(..)))
356  * to produce better contextual output than:
357  *      ptr = OPENSSL_malloc(..);
358  *      if (!TEST_ptr(ptr))
359  */
360 # define TEST_int_eq(a, b)    test_int_eq(__FILE__, __LINE__, #a, #b, a, b)
361 # define TEST_int_ne(a, b)    test_int_ne(__FILE__, __LINE__, #a, #b, a, b)
362 # define TEST_int_lt(a, b)    test_int_lt(__FILE__, __LINE__, #a, #b, a, b)
363 # define TEST_int_le(a, b)    test_int_le(__FILE__, __LINE__, #a, #b, a, b)
364 # define TEST_int_gt(a, b)    test_int_gt(__FILE__, __LINE__, #a, #b, a, b)
365 # define TEST_int_ge(a, b)    test_int_ge(__FILE__, __LINE__, #a, #b, a, b)
366
367 # define TEST_uint_eq(a, b)   test_uint_eq(__FILE__, __LINE__, #a, #b, a, b)
368 # define TEST_uint_ne(a, b)   test_uint_ne(__FILE__, __LINE__, #a, #b, a, b)
369 # define TEST_uint_lt(a, b)   test_uint_lt(__FILE__, __LINE__, #a, #b, a, b)
370 # define TEST_uint_le(a, b)   test_uint_le(__FILE__, __LINE__, #a, #b, a, b)
371 # define TEST_uint_gt(a, b)   test_uint_gt(__FILE__, __LINE__, #a, #b, a, b)
372 # define TEST_uint_ge(a, b)   test_uint_ge(__FILE__, __LINE__, #a, #b, a, b)
373
374 # define TEST_char_eq(a, b)   test_char_eq(__FILE__, __LINE__, #a, #b, a, b)
375 # define TEST_char_ne(a, b)   test_char_ne(__FILE__, __LINE__, #a, #b, a, b)
376 # define TEST_char_lt(a, b)   test_char_lt(__FILE__, __LINE__, #a, #b, a, b)
377 # define TEST_char_le(a, b)   test_char_le(__FILE__, __LINE__, #a, #b, a, b)
378 # define TEST_char_gt(a, b)   test_char_gt(__FILE__, __LINE__, #a, #b, a, b)
379 # define TEST_char_ge(a, b)   test_char_ge(__FILE__, __LINE__, #a, #b, a, b)
380
381 # define TEST_uchar_eq(a, b)  test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b)
382 # define TEST_uchar_ne(a, b)  test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b)
383 # define TEST_uchar_lt(a, b)  test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b)
384 # define TEST_uchar_le(a, b)  test_uchar_le(__FILE__, __LINE__, #a, #b, a, b)
385 # define TEST_uchar_gt(a, b)  test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b)
386 # define TEST_uchar_ge(a, b)  test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b)
387
388 # define TEST_long_eq(a, b)   test_long_eq(__FILE__, __LINE__, #a, #b, a, b)
389 # define TEST_long_ne(a, b)   test_long_ne(__FILE__, __LINE__, #a, #b, a, b)
390 # define TEST_long_lt(a, b)   test_long_lt(__FILE__, __LINE__, #a, #b, a, b)
391 # define TEST_long_le(a, b)   test_long_le(__FILE__, __LINE__, #a, #b, a, b)
392 # define TEST_long_gt(a, b)   test_long_gt(__FILE__, __LINE__, #a, #b, a, b)
393 # define TEST_long_ge(a, b)   test_long_ge(__FILE__, __LINE__, #a, #b, a, b)
394
395 # define TEST_ulong_eq(a, b)  test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b)
396 # define TEST_ulong_ne(a, b)  test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b)
397 # define TEST_ulong_lt(a, b)  test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b)
398 # define TEST_ulong_le(a, b)  test_ulong_le(__FILE__, __LINE__, #a, #b, a, b)
399 # define TEST_ulong_gt(a, b)  test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b)
400 # define TEST_ulong_ge(a, b)  test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b)
401
402 # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b)
403 # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b)
404 # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b)
405 # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b)
406 # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b)
407 # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b)
408
409 # define TEST_time_t_eq(a, b) test_time_t_eq(__FILE__, __LINE__, #a, #b, a, b)
410 # define TEST_time_t_ne(a, b) test_time_t_ne(__FILE__, __LINE__, #a, #b, a, b)
411 # define TEST_time_t_lt(a, b) test_time_t_lt(__FILE__, __LINE__, #a, #b, a, b)
412 # define TEST_time_t_le(a, b) test_time_t_le(__FILE__, __LINE__, #a, #b, a, b)
413 # define TEST_time_t_gt(a, b) test_time_t_gt(__FILE__, __LINE__, #a, #b, a, b)
414 # define TEST_time_t_ge(a, b) test_time_t_ge(__FILE__, __LINE__, #a, #b, a, b)
415
416 # define TEST_ptr_eq(a, b)    test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b)
417 # define TEST_ptr_ne(a, b)    test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b)
418 # define TEST_ptr(a)          test_ptr(__FILE__, __LINE__, #a, a)
419 # define TEST_ptr_null(a)     test_ptr_null(__FILE__, __LINE__, #a, a)
420
421 # define TEST_str_eq(a, b)    test_str_eq(__FILE__, __LINE__, #a, #b, a, b)
422 # define TEST_str_ne(a, b)    test_str_ne(__FILE__, __LINE__, #a, #b, a, b)
423 # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, b, n)
424 # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, b, n)
425
426 # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n)
427 # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n)
428
429 # define TEST_true(a)         test_true(__FILE__, __LINE__, #a, (a) != 0)
430 # define TEST_false(a)        test_false(__FILE__, __LINE__, #a, (a) != 0)
431
432 # define TEST_BN_eq(a, b)     test_BN_eq(__FILE__, __LINE__, #a, #b, a, b)
433 # define TEST_BN_ne(a, b)     test_BN_ne(__FILE__, __LINE__, #a, #b, a, b)
434 # define TEST_BN_lt(a, b)     test_BN_lt(__FILE__, __LINE__, #a, #b, a, b)
435 # define TEST_BN_gt(a, b)     test_BN_gt(__FILE__, __LINE__, #a, #b, a, b)
436 # define TEST_BN_le(a, b)     test_BN_le(__FILE__, __LINE__, #a, #b, a, b)
437 # define TEST_BN_ge(a, b)     test_BN_ge(__FILE__, __LINE__, #a, #b, a, b)
438 # define TEST_BN_eq_zero(a)   test_BN_eq_zero(__FILE__, __LINE__, #a, a)
439 # define TEST_BN_ne_zero(a)   test_BN_ne_zero(__FILE__, __LINE__, #a, a)
440 # define TEST_BN_lt_zero(a)   test_BN_lt_zero(__FILE__, __LINE__, #a, a)
441 # define TEST_BN_gt_zero(a)   test_BN_gt_zero(__FILE__, __LINE__, #a, a)
442 # define TEST_BN_le_zero(a)   test_BN_le_zero(__FILE__, __LINE__, #a, a)
443 # define TEST_BN_ge_zero(a)   test_BN_ge_zero(__FILE__, __LINE__, #a, a)
444 # define TEST_BN_eq_one(a)    test_BN_eq_one(__FILE__, __LINE__, #a, a)
445 # define TEST_BN_eq_word(a, w) test_BN_eq_word(__FILE__, __LINE__, #a, #w, a, w)
446 # define TEST_BN_abs_eq_word(a, w) test_BN_abs_eq_word(__FILE__, __LINE__, #a, #w, a, w)
447 # define TEST_BN_odd(a)       test_BN_odd(__FILE__, __LINE__, #a, a)
448 # define TEST_BN_even(a)      test_BN_even(__FILE__, __LINE__, #a, a)
449
450 /*
451  * TEST_error(desc, ...) prints an informative error message in the standard
452  * format.  |desc| is a printf format string.
453  */
454 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
455 #  define TEST_error         test_error_c90
456 #  define TEST_info          test_info_c90
457 # else
458 #  define TEST_error(...)    test_error(__FILE__, __LINE__, __VA_ARGS__)
459 #  define TEST_info(...)     test_info(__FILE__, __LINE__, __VA_ARGS__)
460 # endif
461 # define TEST_note           test_note
462 # define TEST_openssl_errors test_openssl_errors
463 # define TEST_perror         test_perror
464
465 extern BIO *bio_out;
466 extern BIO *bio_err;
467
468 /*
469  * Formatted output for strings, memory and bignums.
470  */
471 void test_output_string(const char *name, const char *m, size_t l);
472 void test_output_bignum(const char *name, const BIGNUM *bn);
473 void test_output_memory(const char *name, const unsigned char *m, size_t l);
474
475
476 /*
477  * Utilities to parse a test file.
478  */
479 #define TESTMAXPAIRS        20
480
481 typedef struct pair_st {
482     char *key;
483     char *value;
484 } PAIR;
485
486 typedef struct stanza_st {
487     const char *test_file;      /* Input file name */
488     BIO *fp;                    /* Input file */
489     int curr;                   /* Current line in file */
490     int start;                  /* Line where test starts */
491     int errors;                 /* Error count */
492     int numtests;               /* Number of tests */
493     int numskip;                /* Number of skipped tests */
494     int numpairs;
495     PAIR pairs[TESTMAXPAIRS];
496     BIO *key;                   /* temp memory BIO for reading in keys */
497     char buff[4096];            /* Input buffer for a single key/value */
498 } STANZA;
499
500 /*
501  * Prepare to start reading the file |testfile| as input.
502  */
503 int test_start_file(STANZA *s, const char *testfile);
504 int test_end_file(STANZA *s);
505
506 /*
507  * Read a stanza from the test file.  A stanza consists of a block
508  * of lines of the form
509  *      key = value
510  * The block is terminated by EOF or a blank line.
511  * Return 1 if found, 0 on EOF or error.
512  */
513 int test_readstanza(STANZA *s);
514
515 /*
516  * Clear a stanza, release all allocated memory.
517  */
518 void test_clearstanza(STANZA *s);
519
520 /*
521  * Glue an array of strings together and return it as an allocated string.
522  * Optionally return the whole length of this string in |out_len|
523  */
524 char *glue_strings(const char *list[], size_t *out_len);
525
526 #endif                          /* HEADER_TESTUTIL_H */