test/testutil.h

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