X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=test%2Ftestutil.h;h=bacb6bb939e5adbd80cba5afaf49ee0e3e8b9598;hb=f0049b86cc5d745af97c087e54abaeb00de40b6b;hp=48c4eb3677354cd82170e4e6d2925dd331a9e476;hpb=ae269dd8b72dbed1f2c5f92dbe0fbf5b7b905e7b;p=oweals%2Fopenssl.git diff --git a/test/testutil.h b/test/testutil.h index 48c4eb3677..bacb6bb939 100644 --- a/test/testutil.h +++ b/test/testutil.h @@ -1,50 +1,48 @@ /* - * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved. + * Copyright 2014-2020 The OpenSSL Project Authors. All Rights Reserved. * - * Licensed under the OpenSSL license (the "License"). You may not use + * Licensed under the Apache License 2.0 (the "License"). You may not use * this file except in compliance with the License. You can obtain a copy * in the file LICENSE in the source distribution or at * https://www.openssl.org/source/license.html */ -#ifndef HEADER_TESTUTIL_H -# define HEADER_TESTUTIL_H +#ifndef OSSL_TESTUTIL_H +# define OSSL_TESTUTIL_H #include #include #include #include +#include "opt.h" /*- - * Simple unit tests should implement register_tests(). + * Simple unit tests should implement setup_tests(). + * This function should return zero if the registration process fails. * To register tests, call ADD_TEST or ADD_ALL_TESTS: * - * void register_tests(void) + * int setup_tests(void) * { * ADD_TEST(test_foo); * ADD_ALL_TESTS(test_bar, num_test_bar); + * return 1; * } * - * Tests that need to perform custom setup or read command-line arguments should - * implement test_main(): + * Tests that require clean up after execution should implement: * - * int test_main(int argc, char *argv[]) - * { - * int ret; - * - * // Custom setup ... + * void cleanup_tests(void); * - * ADD_TEST(test_foo); - * ADD_ALL_TESTS(test_bar, num_test_bar); - * // Add more tests ... + * The cleanup_tests function will be called even if setup_tests() + * returns failure. * - * ret = run_tests(argv[0]); + * In some cases, early initialization before the framework is set up + * may be needed. In such a case, this should be implemented: * - * // Custom teardown ... + * int global_init(void); * - * return ret; - * } + * This function should return zero if there is an unrecoverable error and + * non-zero if the initialization was successful. */ /* Adds a simple test case. */ @@ -68,12 +66,13 @@ * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE * object called "fixture". It will also allocate the "result" variable used * by EXECUTE_TEST. set_up() should take a const char* specifying the test - * case name and return a TEST_FIXTURE_TYPE by value. + * case name and return a TEST_FIXTURE_TYPE by reference. * - * EXECUTE_TEST will pass fixture to execute_func() by value, call + * EXECUTE_TEST will pass fixture to execute_func() by reference, call * tear_down(), and return the result of execute_func(). execute_func() should - * take a TEST_FIXTURE_TYPE by value and return 1 on success and 0 on - * failure. + * take a TEST_FIXTURE_TYPE by reference and return 1 on success and 0 on + * failure. The tear_down function is responsible for deallocation of the + * result variable, if required. * * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST * variations like so: @@ -94,18 +93,14 @@ * } */ # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\ - TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME); \ + TEST_FIXTURE_TYPE *fixture = set_up(TEST_CASE_NAME); \ int result = 0 # define EXECUTE_TEST(execute_func, tear_down)\ + if (fixture != NULL) {\ result = execute_func(fixture);\ tear_down(fixture);\ - return result - -/* Shorthand if tear_down does nothing. */ -# define EXECUTE_TEST_NO_TEARDOWN(execute_func)\ - result = execute_func(fixture);\ - return result + } /* * TEST_CASE_NAME is defined as the name of the test case function where @@ -123,31 +118,113 @@ # define TEST_CASE_NAME __func__ # endif /* __STDC_VERSION__ */ + +/* The default test enum which should be common to all tests */ +#define OPT_TEST_ENUM \ + OPT_TEST_HELP = 500, \ + OPT_TEST_LIST, \ + OPT_TEST_SINGLE, \ + OPT_TEST_ITERATION, \ + OPT_TEST_INDENT, \ + OPT_TEST_SEED + +/* The Default test OPTIONS common to all tests (without a usage string) */ +#define OPT_TEST_OPTIONS \ + { OPT_HELP_STR, 1, '-', "Valid options are:\n" }, \ + { "help", OPT_TEST_HELP, '-', "Display this summary" }, \ + { "list", OPT_TEST_LIST, '-', "Display the list of tests available" }, \ + { "test", OPT_TEST_SINGLE, 's', "Run a single test by id or name" }, \ + { "iter", OPT_TEST_ITERATION, 'n', "Run a single iteration of a test" }, \ + { "indent", OPT_TEST_INDENT,'p', "Number of tabs added to output" }, \ + { "seed", OPT_TEST_SEED, 'n', "Seed value to randomize tests with" } + +/* The Default test OPTIONS common to all tests starting with an additional usage string */ +#define OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(usage) \ + { OPT_HELP_STR, 1, '-', "Usage: %s [options] " usage }, \ + OPT_TEST_OPTIONS + +/* The Default test OPTIONS common to all tests with an default usage string */ +#define OPT_TEST_OPTIONS_DEFAULT_USAGE \ + { OPT_HELP_STR, 1, '-', "Usage: %s [options]\n" }, \ + OPT_TEST_OPTIONS + /* - * Internal helpers. Test programs shouldn't use these directly, but should - * rather link to one of the helper main() methods. + * Optional Cases that need to be ignored by the test app when using opt_next(), + * (that are handled internally). */ +#define OPT_TEST_CASES \ + OPT_TEST_HELP: \ + case OPT_TEST_LIST: \ + case OPT_TEST_SINGLE: \ + case OPT_TEST_ITERATION: \ + case OPT_TEST_INDENT: \ + case OPT_TEST_SEED -/* setup_test() should be called as the first thing in a test main(). */ -void setup_test(void); /* - * finish_test() should be called as the last thing in a test main(). - * The result of run_tests() should be the input to finish_test(). + * Tests that use test_get_argument() that dont have any additional options + * (i.e- dont use opt_next()) can use this to set the usage string. + * It embeds test_get_options() which gives default command line options for + * the test system. + * + * Tests that need to use opt_next() need to specify + * (1) test_get_options() containing an options[] (Which should include either + * OPT_TEST_OPTIONS_DEFAULT_USAGE OR + * OPT_TEST_OPTIONS_WITH_EXTRA_USAGE). + * (2) An enum outside the test_get_options() which contains OPT_TEST_ENUM, as + * well as the additional options that need to be handled. + * (3) case OPT_TEST_CASES: break; inside the opt_next() handling code. */ -__owur int finish_test(int ret); +#define OPT_TEST_DECLARE_USAGE(usage_str) \ +const OPTIONS *test_get_options(void) \ +{ \ + enum { OPT_TEST_ENUM }; \ + static const OPTIONS options[] = { \ + OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(usage_str), \ + { NULL } \ + }; \ + return options; \ +} -void add_test(const char *test_case_name, int (*test_fn) ()); +/* + * Used to read non optional command line values that follow after the options. + * Returns NULL if there is no argument. + */ +char *test_get_argument(size_t n); +/* Return the number of additional non optional command line arguments */ +size_t test_get_argument_count(void); + +/* + * Skip over common test options. Should be called before calling + * test_get_argument() + */ +int test_skip_common_options(void); + +/* + * Internal helpers. Test programs shouldn't use these directly, but should + * rather link to one of the helper main() methods. + */ + +void add_test(const char *test_case_name, int (*test_fn) (void)); void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num, int subtest); -__owur int run_tests(const char *test_prog_name); -void set_test_title(const char *title); /* - * Declarations for user defined functions + * Declarations for user defined functions. + * The first two return a boolean indicating that the test should not proceed. */ -void register_tests(void); -int test_main(int argc, char *argv[]); - +int global_init(void); +int setup_tests(void); +void cleanup_tests(void); +/* + * Used to supply test specific command line options, + * If non optional parameters are used, then the first entry in the OPTIONS[] + * should contain: + * { OPT_HELP_STR, 1, '-', "list of non optional commandline params\n"}, + * The last entry should always be { NULL }. + * + * Run the test locally using './test/test_name -help' to check the usage. + */ +const OPTIONS *test_get_options(void); /* * Test assumption verification helpers. @@ -165,7 +242,7 @@ int test_main(int argc, char *argv[]); # endif #endif -# define DECLARE_COMPARISON(type, name, opname) \ +# define DECLARE_COMPARISON(type, name, opname) \ int test_ ## name ## _ ## opname(const char *, int, \ const char *, const char *, \ const type, const type); @@ -184,6 +261,9 @@ DECLARE_COMPARISONS(char, char) DECLARE_COMPARISONS(unsigned char, uchar) DECLARE_COMPARISONS(long, long) DECLARE_COMPARISONS(unsigned long, ulong) +DECLARE_COMPARISONS(double, double) +DECLARE_COMPARISONS(time_t, time_t) + /* * Because this comparison uses a printf format specifier that's not * universally known (yet), we provide an option to not have it declared. @@ -233,8 +313,8 @@ int test_mem_ne(const char *, int, const char *, const char *, /* * Check a boolean result for being true or false. - * They return 1 if the condition is true (i.e. the value is non-zro). - * Otherwise, they return 0 and pretty-prints diagnostics using |desc|. + * They return 1 if the condition is true (i.e. the value is non-zero). + * Otherwise, they return 0 and pretty-prints diagnostics using |s|. * These should not be called directly, use the TEST_xxx macros below instead. */ int test_true(const char *file, int line, const char *s, int b); @@ -271,14 +351,19 @@ void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); void test_info(const char *file, int line, const char *desc, ...) PRINTF_FORMAT(3, 4); void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); +void test_note(const char *desc, ...) PRINTF_FORMAT(1, 2); +int test_skip(const char *file, int line, const char *desc, ...) + PRINTF_FORMAT(3, 4); +int test_skip_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); void test_openssl_errors(void); +void test_perror(const char *s); /* * The following macros provide wrapper calls to the test functions with * a default description that indicates the file and line number of the error. * * The following macros guarantee to evaluate each argument exactly once. - * This allows constructs such as: if(!TEST_ptr(ptr = OPENSSL_malloc(..))) + * This allows constructs such as: if (!TEST_ptr(ptr = OPENSSL_malloc(..))) * to produce better contextual output than: * ptr = OPENSSL_malloc(..); * if (!TEST_ptr(ptr)) @@ -290,13 +375,6 @@ void test_openssl_errors(void); # define TEST_int_gt(a, b) test_int_gt(__FILE__, __LINE__, #a, #b, a, b) # define TEST_int_ge(a, b) test_int_ge(__FILE__, __LINE__, #a, #b, a, b) -# define TEST_int_eq(a, b) test_int_eq(__FILE__, __LINE__, #a, #b, a, b) -# define TEST_int_ne(a, b) test_int_ne(__FILE__, __LINE__, #a, #b, a, b) -# define TEST_int_lt(a, b) test_int_lt(__FILE__, __LINE__, #a, #b, a, b) -# define TEST_int_le(a, b) test_int_le(__FILE__, __LINE__, #a, #b, a, b) -# define TEST_int_gt(a, b) test_int_gt(__FILE__, __LINE__, #a, #b, a, b) -# define TEST_int_ge(a, b) test_int_ge(__FILE__, __LINE__, #a, #b, a, b) - # define TEST_uint_eq(a, b) test_uint_eq(__FILE__, __LINE__, #a, #b, a, b) # define TEST_uint_ne(a, b) test_uint_ne(__FILE__, __LINE__, #a, #b, a, b) # define TEST_uint_lt(a, b) test_uint_lt(__FILE__, __LINE__, #a, #b, a, b) @@ -339,6 +417,20 @@ void test_openssl_errors(void); # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b) # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_double_eq(a, b) test_double_eq(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_double_ne(a, b) test_double_ne(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_double_lt(a, b) test_double_lt(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_double_le(a, b) test_double_le(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_double_gt(a, b) test_double_gt(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_double_ge(a, b) test_double_ge(__FILE__, __LINE__, #a, #b, a, b) + +# define TEST_time_t_eq(a, b) test_time_t_eq(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_time_t_ne(a, b) test_time_t_ne(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_time_t_lt(a, b) test_time_t_lt(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_time_t_le(a, b) test_time_t_le(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_time_t_gt(a, b) test_time_t_gt(__FILE__, __LINE__, #a, #b, a, b) +# define TEST_time_t_ge(a, b) test_time_t_ge(__FILE__, __LINE__, #a, #b, a, b) + # define TEST_ptr_eq(a, b) test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b) # define TEST_ptr_ne(a, b) test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b) # define TEST_ptr(a) test_ptr(__FILE__, __LINE__, #a, a) @@ -380,27 +472,26 @@ void test_openssl_errors(void); # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L # define TEST_error test_error_c90 # define TEST_info test_info_c90 +# define TEST_skip test_skip_c90 # else # define TEST_error(...) test_error(__FILE__, __LINE__, __VA_ARGS__) # define TEST_info(...) test_info(__FILE__, __LINE__, __VA_ARGS__) +# define TEST_skip(...) test_skip(__FILE__, __LINE__, __VA_ARGS__) # endif +# define TEST_note test_note # define TEST_openssl_errors test_openssl_errors +# define TEST_perror test_perror + +extern BIO *bio_out; +extern BIO *bio_err; /* - * For "impossible" conditions such as malloc failures or bugs in test code, - * where continuing the test would be meaningless. Note that OPENSSL_assert - * is fatal, and is never compiled out. + * Formatted output for strings, memory and bignums. */ -# define TEST_check(condition) \ - do { \ - if (!(condition)) { \ - TEST_openssl_errors(); \ - OPENSSL_assert(!#condition); \ - } \ - } while (0) +void test_output_string(const char *name, const char *m, size_t l); +void test_output_bignum(const char *name, const BIGNUM *bn); +void test_output_memory(const char *name, const unsigned char *m, size_t l); -extern BIO *bio_out; -extern BIO *bio_err; /* * Utilities to parse a test file. @@ -434,7 +525,7 @@ int test_end_file(STANZA *s); /* * Read a stanza from the test file. A stanza consists of a block - * of lines of the form + * of lines of the form * key = value * The block is terminated by EOF or a blank line. * Return 1 if found, 0 on EOF or error. @@ -446,4 +537,21 @@ int test_readstanza(STANZA *s); */ void test_clearstanza(STANZA *s); -#endif /* HEADER_TESTUTIL_H */ +/* + * Glue an array of strings together and return it as an allocated string. + * Optionally return the whole length of this string in |out_len| + */ +char *glue_strings(const char *list[], size_t *out_len); + +/* + * Pseudo random number generator of low quality but having repeatability + * across platforms. The two calls are replacements for random(3) and + * srandom(3). + */ +uint32_t test_random(void); +void test_random_seed(uint32_t sd); + +/* Create a file path from a directory and a filename */ +char *test_mk_file_path(const char *dir, const char *file); + +#endif /* OSSL_TESTUTIL_H */