X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=test%2Ftestutil.h;h=639190564777f60576c57fd1040959a94fc68fb1;hp=7be9fb902e691bc84af3754170df37152f315d4a;hb=b7af3f1433cc0d8d5f88c0b8dcd55c0c2261281a;hpb=ff281ee8369350d88e8b57af139614f5683e1e8c diff --git a/test/testutil.h b/test/testutil.h index 7be9fb902e..6391905647 100644 --- a/test/testutil.h +++ b/test/testutil.h @@ -17,34 +17,31 @@ #include /*- - * 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 +65,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 +92,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 @@ -124,30 +118,38 @@ # endif /* __STDC_VERSION__ */ /* - * Internal helpers. Test programs shouldn't use these directly, but should - * rather link to one of the helper main() methods. + * Tests that need access to command line arguments should use the functions: + * test_get_argument(int n) to get the nth argument, the first argument is + * argument 0. This function returns NULL on error. + * test_get_argument_count() to get the count of the arguments. + * test_has_option(const char *) to check if the specified option was passed. + * test_get_option_argument(const char *) to get an option which includes an + * argument. NULL is returns if the option is not found. + * const char *test_get_program_name(void) returns the name of the test program + * being executed. */ +const char *test_get_program_name(void); +char *test_get_argument(size_t n); +size_t test_get_argument_count(void); +int test_has_option(const char *option); +const char *test_get_option_argument(const char *option); -/* 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(). + * Internal helpers. Test programs shouldn't use these directly, but should + * rather link to one of the helper main() methods. */ -__owur int finish_test(int ret); -void add_test(const char *test_case_name, int (*test_fn) ()); +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); /* * Test assumption verification helpers. @@ -165,7 +167,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 +186,7 @@ DECLARE_COMPARISONS(char, char) DECLARE_COMPARISONS(unsigned char, uchar) DECLARE_COMPARISONS(long, long) DECLARE_COMPARISONS(unsigned long, ulong) +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 +236,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); @@ -280,7 +283,7 @@ void test_perror(const char *s); * 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)) @@ -292,13 +295,6 @@ void test_perror(const char *s); # 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) @@ -341,6 +337,13 @@ void test_perror(const char *s); # 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_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) @@ -445,4 +448,10 @@ int test_readstanza(STANZA *s); */ void test_clearstanza(STANZA *s); +/* + * 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); + #endif /* HEADER_TESTUTIL_H */