| 
									
										
										
										
											2016-05-18 02:20:24 +08:00
										 |  |  | /*
 | 
					
						
							| 
									
										
										
										
											2017-06-19 09:21:22 +08:00
										 |  |  |  * Copyright 2014-2017 The OpenSSL Project Authors. All Rights Reserved. | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2016-05-18 02:20:24 +08:00
										 |  |  |  * Licensed under the OpenSSL license (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
 | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  */ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #ifndef HEADER_TESTUTIL_H
 | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  | # define HEADER_TESTUTIL_H
 | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | #include <stdarg.h>
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-08-09 23:03:23 +08:00
										 |  |  | #include <openssl/err.h>
 | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  | #include <openssl/e_os2.h>
 | 
					
						
							| 
									
										
										
										
											2017-05-08 10:09:41 +08:00
										 |  |  | #include <openssl/bn.h>
 | 
					
						
							| 
									
										
										
										
											2016-08-09 23:03:23 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  | /*-
 | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * Simple unit tests should implement setup_tests(). | 
					
						
							|  |  |  |  * This function should return zero if the registration process fails. | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * To register tests, call ADD_TEST or ADD_ALL_TESTS: | 
					
						
							|  |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * int setup_tests(void) | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * { | 
					
						
							|  |  |  |  *     ADD_TEST(test_foo); | 
					
						
							|  |  |  |  *     ADD_ALL_TESTS(test_bar, num_test_bar); | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  *     return 1; | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * } | 
					
						
							|  |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * Tests that require clean up after execution should implement: | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * void cleanup_tests(void); | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * The cleanup_tests function will be called even if setup_tests() | 
					
						
							|  |  |  |  * returns failure. | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * In some cases, early initialization before the framework is set up | 
					
						
							|  |  |  |  * may be needed.  In such a case, this should be implemented: | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * int global_init(void); | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * This function should return zero if there is an unrecoverable error and | 
					
						
							| 
									
										
										
										
											2017-08-13 02:02:24 +08:00
										 |  |  |  * non-zero if the initialization was successful. | 
					
						
							| 
									
										
										
										
											2016-11-04 00:15:41 +08:00
										 |  |  |  */ | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | /* Adds a simple test case. */ | 
					
						
							| 
									
										
										
										
											2016-11-04 00:15:41 +08:00
										 |  |  | # define ADD_TEST(test_function) add_test(#test_function, test_function)
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | # define ADD_ALL_TESTS(test_function, num) \
 | 
					
						
							| 
									
										
										
										
											2017-04-19 16:34:54 +08:00
										 |  |  |     add_all_tests(#test_function, test_function, num, 1) | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * A variant of the same without TAP output. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | # define ADD_ALL_TESTS_NOSUBTEST(test_function, num) \
 | 
					
						
							|  |  |  |     add_all_tests(#test_function, test_function, num, 0) | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-12-28 10:48:40 +08:00
										 |  |  | /*-
 | 
					
						
							| 
									
										
										
										
											2016-11-04 00:15:41 +08:00
										 |  |  |  * Test cases that share common setup should use the helper | 
					
						
							| 
									
										
										
										
											2014-12-28 10:48:40 +08:00
										 |  |  |  * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions. | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  * | 
					
						
							|  |  |  |  * 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 | 
					
						
							| 
									
										
										
										
											2017-08-04 08:49:38 +08:00
										 |  |  |  * case name and return a TEST_FIXTURE_TYPE by reference. | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-08-04 08:49:38 +08:00
										 |  |  |  * EXECUTE_TEST will pass fixture to execute_func() by reference, call | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  * tear_down(), and return the result of execute_func(). execute_func() should | 
					
						
							| 
									
										
										
										
											2017-08-04 08:49:38 +08:00
										 |  |  |  * 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. | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  * | 
					
						
							|  |  |  |  * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST | 
					
						
							|  |  |  |  * variations like so: | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * #define SETUP_FOOBAR_TEST_FIXTURE()\ | 
					
						
							|  |  |  |  *   SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar) | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * #define EXECUTE_FOOBAR_TEST()\ | 
					
						
							|  |  |  |  *   EXECUTE_TEST(execute_foobar, tear_down_foobar) | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * Then test case functions can take the form: | 
					
						
							|  |  |  |  * | 
					
						
							|  |  |  |  * static int test_foobar_feature() | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  |  *      { | 
					
						
							|  |  |  |  *      SETUP_FOOBAR_TEST_FIXTURE(); | 
					
						
							|  |  |  |  *      [...set individual members of fixture...] | 
					
						
							|  |  |  |  *      EXECUTE_FOOBAR_TEST(); | 
					
						
							|  |  |  |  *      } | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  */ | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  | # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
 | 
					
						
							| 
									
										
										
										
											2017-08-04 08:49:38 +08:00
										 |  |  |     TEST_FIXTURE_TYPE *fixture = set_up(TEST_CASE_NAME); \ | 
					
						
							| 
									
										
										
										
											2016-03-17 22:14:30 +08:00
										 |  |  |     int result = 0 | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  | # define EXECUTE_TEST(execute_func, tear_down)\
 | 
					
						
							| 
									
										
										
										
											2017-08-04 08:49:38 +08:00
										 |  |  |     if (fixture != NULL) {\ | 
					
						
							| 
									
										
										
										
											2016-04-05 20:29:06 +08:00
										 |  |  |         result = execute_func(fixture);\ | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  |         tear_down(fixture);\ | 
					
						
							| 
									
										
										
										
											2017-08-04 08:49:38 +08:00
										 |  |  |     } | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * TEST_CASE_NAME is defined as the name of the test case function where | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  |  * possible; otherwise we get by with the file name and line number. | 
					
						
							|  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2017-02-23 21:52:23 +08:00
										 |  |  | # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
 | 
					
						
							| 
									
										
										
										
											2015-01-22 11:40:55 +08:00
										 |  |  | #  if defined(_MSC_VER)
 | 
					
						
							|  |  |  | #   define TEST_CASE_NAME __FUNCTION__
 | 
					
						
							|  |  |  | #  else
 | 
					
						
							|  |  |  | #   define testutil_stringify_helper(s) #s
 | 
					
						
							|  |  |  | #   define testutil_stringify(s) testutil_stringify_helper(s)
 | 
					
						
							|  |  |  | #   define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__)
 | 
					
						
							|  |  |  | #  endif                        /* _MSC_VER */
 | 
					
						
							|  |  |  | # else
 | 
					
						
							|  |  |  | #  define TEST_CASE_NAME __func__
 | 
					
						
							|  |  |  | # endif                         /* __STDC_VERSION__ */
 | 
					
						
							| 
									
										
										
										
											2014-06-08 01:05:50 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-03-17 22:14:30 +08:00
										 |  |  | /*
 | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * 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. | 
					
						
							| 
									
										
										
										
											2016-03-17 22:14:30 +08:00
										 |  |  |  */ | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  | 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); | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * Internal helpers. Test programs shouldn't use these directly, but should | 
					
						
							|  |  |  |  * rather link to one of the helper main() methods. | 
					
						
							| 
									
										
										
										
											2016-11-07 23:53:15 +08:00
										 |  |  |  */ | 
					
						
							| 
									
										
										
										
											2016-03-17 22:14:30 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-07-28 07:26:40 +08:00
										 |  |  | void add_test(const char *test_case_name, int (*test_fn) (void)); | 
					
						
							| 
									
										
										
										
											2017-04-19 16:34:54 +08:00
										 |  |  | void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num, | 
					
						
							|  |  |  |                    int subtest); | 
					
						
							| 
									
										
										
										
											2014-06-20 00:27:54 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-04-18 22:27:27 +08:00
										 |  |  | /*
 | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  |  * Declarations for user defined functions. | 
					
						
							|  |  |  |  * The first two return a boolean indicating that the test should not proceed. | 
					
						
							| 
									
										
										
										
											2017-04-18 22:27:27 +08:00
										 |  |  |  */ | 
					
						
							| 
									
										
										
										
											2017-07-18 09:48:27 +08:00
										 |  |  | int global_init(void); | 
					
						
							|  |  |  | int setup_tests(void); | 
					
						
							|  |  |  | void cleanup_tests(void); | 
					
						
							| 
									
										
										
										
											2017-04-18 22:27:27 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-07-05 02:16:14 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  *  Test assumption verification helpers. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | #define PRINTF_FORMAT(a, b)
 | 
					
						
							| 
									
										
										
										
											2017-04-18 22:27:27 +08:00
										 |  |  | #if defined(__GNUC__) && defined(__STDC_VERSION__)
 | 
					
						
							|  |  |  |   /*
 | 
					
						
							|  |  |  |    * Because we support the 'z' modifier, which made its appearance in C99, | 
					
						
							|  |  |  |    * we can't use __attribute__ with pre C99 dialects. | 
					
						
							|  |  |  |    */ | 
					
						
							|  |  |  | # if __STDC_VERSION__ >= 199901L
 | 
					
						
							|  |  |  | #  undef PRINTF_FORMAT
 | 
					
						
							|  |  |  | #  define PRINTF_FORMAT(a, b)   __attribute__ ((format(printf, a, b)))
 | 
					
						
							|  |  |  | # endif
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | #endif
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-07-28 07:26:40 +08:00
										 |  |  | # define DECLARE_COMPARISON(type, name, opname)                         \
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  |     int test_ ## name ## _ ## opname(const char *, int,                 \ | 
					
						
							|  |  |  |                                      const char *, const char *,        \ | 
					
						
							|  |  |  |                                      const type, const type); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define DECLARE_COMPARISONS(type, name)                                \
 | 
					
						
							|  |  |  |     DECLARE_COMPARISON(type, name, eq)                                  \ | 
					
						
							|  |  |  |     DECLARE_COMPARISON(type, name, ne)                                  \ | 
					
						
							|  |  |  |     DECLARE_COMPARISON(type, name, lt)                                  \ | 
					
						
							|  |  |  |     DECLARE_COMPARISON(type, name, le)                                  \ | 
					
						
							|  |  |  |     DECLARE_COMPARISON(type, name, gt)                                  \ | 
					
						
							|  |  |  |     DECLARE_COMPARISON(type, name, ge) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | DECLARE_COMPARISONS(int, int) | 
					
						
							|  |  |  | DECLARE_COMPARISONS(unsigned int, uint) | 
					
						
							|  |  |  | DECLARE_COMPARISONS(char, char) | 
					
						
							|  |  |  | DECLARE_COMPARISONS(unsigned char, uchar) | 
					
						
							|  |  |  | DECLARE_COMPARISONS(long, long) | 
					
						
							|  |  |  | DECLARE_COMPARISONS(unsigned long, ulong) | 
					
						
							| 
									
										
										
										
											2017-11-27 11:27:35 +08:00
										 |  |  | DECLARE_COMPARISONS(time_t, time_t) | 
					
						
							| 
									
										
										
										
											2017-04-19 19:06:08 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Because this comparison uses a printf format specifier that's not | 
					
						
							|  |  |  |  * universally known (yet), we provide an option to not have it declared. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | # ifndef TESTUTIL_NO_size_t_COMPARISON
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | DECLARE_COMPARISONS(size_t, size_t) | 
					
						
							| 
									
										
										
										
											2017-04-19 19:06:08 +08:00
										 |  |  | # endif
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * Pointer comparisons against other pointers and null. | 
					
						
							|  |  |  |  * These functions return 1 if the test is true. | 
					
						
							|  |  |  |  * Otherwise, they return 0 and pretty-print diagnostics. | 
					
						
							|  |  |  |  * These should not be called directly, use the TEST_xxx macros below instead. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | DECLARE_COMPARISON(void *, ptr, eq) | 
					
						
							|  |  |  | DECLARE_COMPARISON(void *, ptr, ne) | 
					
						
							|  |  |  | int test_ptr(const char *file, int line, const char *s, const void *p); | 
					
						
							|  |  |  | int test_ptr_null(const char *file, int line, const char *s, const void *p); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-07-05 02:16:14 +08:00
										 |  |  | /*
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  |  * Equality tests for strings where NULL is a legitimate value. | 
					
						
							|  |  |  |  * These calls return 1 if the two passed strings compare true. | 
					
						
							|  |  |  |  * Otherwise, they return 0 and pretty-print diagnostics. | 
					
						
							|  |  |  |  * These should not be called directly, use the TEST_xxx macros below instead. | 
					
						
							| 
									
										
										
										
											2016-07-05 02:16:14 +08:00
										 |  |  |  */ | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | DECLARE_COMPARISON(char *, str, eq) | 
					
						
							|  |  |  | DECLARE_COMPARISON(char *, str, ne) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-04-19 04:33:15 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Same as above, but for strncmp. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | int test_strn_eq(const char *file, int line, const char *, const char *, | 
					
						
							|  |  |  |                  const char *a, const char *b, size_t s); | 
					
						
							|  |  |  | int test_strn_ne(const char *file, int line, const char *, const char *, | 
					
						
							|  |  |  |                  const char *a, const char *b, size_t s); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Equality test for memory blocks where NULL is a legitimate value. | 
					
						
							| 
									
										
										
										
											2017-04-13 06:51:28 +08:00
										 |  |  |  * These calls return 1 if the two memory blocks compare true. | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  |  * Otherwise, they return 0 and pretty-print diagnostics. | 
					
						
							|  |  |  |  * These should not be called directly, use the TEST_xxx macros below instead. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | int test_mem_eq(const char *, int, const char *, const char *, | 
					
						
							|  |  |  |                 const void *, size_t, const void *, size_t); | 
					
						
							|  |  |  | int test_mem_ne(const char *, int, const char *, const char *, | 
					
						
							|  |  |  |                 const void *, size_t, const void *, size_t); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * Check a boolean result for being true or false. | 
					
						
							| 
									
										
										
										
											2017-08-13 02:02:24 +08:00
										 |  |  |  * 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|. | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  |  * 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); | 
					
						
							|  |  |  | int test_false(const char *file, int line, const char *s, int b); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-05-08 10:09:41 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Comparisons between BIGNUMs. | 
					
						
							|  |  |  |  * BIGNUMS can be compared against other BIGNUMs or zero. | 
					
						
							|  |  |  |  * Some additional equality tests against 1 & specific values are provided. | 
					
						
							|  |  |  |  * Tests for parity are included as well. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | DECLARE_COMPARISONS(BIGNUM *, BN) | 
					
						
							|  |  |  | int test_BN_eq_zero(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_ne_zero(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_lt_zero(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_le_zero(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_gt_zero(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_ge_zero(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a); | 
					
						
							|  |  |  | int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws, | 
					
						
							|  |  |  |                     const BIGNUM *a, BN_ULONG w); | 
					
						
							|  |  |  | int test_BN_abs_eq_word(const char *file, int line, const char *bns, | 
					
						
							|  |  |  |                         const char *ws, const BIGNUM *a, BN_ULONG w); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Pretty print a failure message. | 
					
						
							|  |  |  |  * These should not be called directly, use the TEST_xxx macros below instead. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | void test_error(const char *file, int line, const char *desc, ...) | 
					
						
							|  |  |  |     PRINTF_FORMAT(3, 4); | 
					
						
							|  |  |  | 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); | 
					
						
							| 
									
										
										
										
											2017-06-12 08:01:17 +08:00
										 |  |  | void test_note(const char *desc, ...) PRINTF_FORMAT(1, 2); | 
					
						
							| 
									
										
										
										
											2017-04-28 20:48:13 +08:00
										 |  |  | void test_openssl_errors(void); | 
					
						
							| 
									
										
										
										
											2017-06-19 09:21:22 +08:00
										 |  |  | void test_perror(const char *s); | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * The following macros provide wrapper calls to the test functions with | 
					
						
							|  |  |  |  * a default description that indicates the file and line number of the error. | 
					
						
							| 
									
										
										
										
											2017-04-13 06:51:28 +08:00
										 |  |  |  * | 
					
						
							|  |  |  |  * The following macros guarantee to evaluate each argument exactly once. | 
					
						
							| 
									
										
										
										
											2017-08-26 23:56:44 +08:00
										 |  |  |  * This allows constructs such as: if (!TEST_ptr(ptr = OPENSSL_malloc(..))) | 
					
						
							| 
									
										
										
										
											2017-04-13 06:51:28 +08:00
										 |  |  |  * to produce better contextual output than: | 
					
						
							|  |  |  |  *      ptr = OPENSSL_malloc(..); | 
					
						
							|  |  |  |  *      if (!TEST_ptr(ptr)) | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  |  */ | 
					
						
							|  |  |  | # 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)
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-04-13 06:51:28 +08:00
										 |  |  | # 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)
 | 
					
						
							|  |  |  | # define TEST_uint_le(a, b)   test_uint_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uint_gt(a, b)   test_uint_gt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uint_ge(a, b)   test_uint_ge(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define TEST_char_eq(a, b)   test_char_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_char_ne(a, b)   test_char_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_char_lt(a, b)   test_char_lt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_char_le(a, b)   test_char_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_char_gt(a, b)   test_char_gt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_char_ge(a, b)   test_char_ge(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define TEST_uchar_eq(a, b)  test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uchar_ne(a, b)  test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uchar_lt(a, b)  test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uchar_le(a, b)  test_uchar_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uchar_gt(a, b)  test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_uchar_ge(a, b)  test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define TEST_long_eq(a, b)   test_long_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_long_ne(a, b)   test_long_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_long_lt(a, b)   test_long_lt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_long_le(a, b)   test_long_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_long_gt(a, b)   test_long_gt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_long_ge(a, b)   test_long_ge(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define TEST_ulong_eq(a, b)  test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_ulong_ne(a, b)  test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_ulong_lt(a, b)  test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_ulong_le(a, b)  test_ulong_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_ulong_gt(a, b)  test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_ulong_ge(a, b)  test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # 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)
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-11-27 11:27:35 +08:00
										 |  |  | # 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)
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | # 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)
 | 
					
						
							|  |  |  | # define TEST_ptr_null(a)     test_ptr_null(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # define TEST_str_eq(a, b)    test_str_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_str_ne(a, b)    test_str_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							| 
									
										
										
										
											2017-04-19 04:33:15 +08:00
										 |  |  | # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, b, n)
 | 
					
						
							|  |  |  | # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, b, n)
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | 
 | 
					
						
							|  |  |  | # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n)
 | 
					
						
							|  |  |  | # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n)
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-04-10 05:13:59 +08:00
										 |  |  | # define TEST_true(a)         test_true(__FILE__, __LINE__, #a, (a) != 0)
 | 
					
						
							|  |  |  | # define TEST_false(a)        test_false(__FILE__, __LINE__, #a, (a) != 0)
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-05-08 10:09:41 +08:00
										 |  |  | # define TEST_BN_eq(a, b)     test_BN_eq(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_BN_ne(a, b)     test_BN_ne(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							| 
									
										
										
										
											2017-05-09 05:58:55 +08:00
										 |  |  | # define TEST_BN_lt(a, b)     test_BN_lt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_BN_gt(a, b)     test_BN_gt(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_BN_le(a, b)     test_BN_le(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							|  |  |  | # define TEST_BN_ge(a, b)     test_BN_ge(__FILE__, __LINE__, #a, #b, a, b)
 | 
					
						
							| 
									
										
										
										
											2017-05-08 10:09:41 +08:00
										 |  |  | # define TEST_BN_eq_zero(a)   test_BN_eq_zero(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_ne_zero(a)   test_BN_ne_zero(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_lt_zero(a)   test_BN_lt_zero(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_gt_zero(a)   test_BN_gt_zero(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_le_zero(a)   test_BN_le_zero(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_ge_zero(a)   test_BN_ge_zero(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_eq_one(a)    test_BN_eq_one(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_eq_word(a, w) test_BN_eq_word(__FILE__, __LINE__, #a, #w, a, w)
 | 
					
						
							|  |  |  | # define TEST_BN_abs_eq_word(a, w) test_BN_abs_eq_word(__FILE__, __LINE__, #a, #w, a, w)
 | 
					
						
							|  |  |  | # define TEST_BN_odd(a)       test_BN_odd(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | # define TEST_BN_even(a)      test_BN_even(__FILE__, __LINE__, #a, a)
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-22 12:27:55 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * TEST_error(desc, ...) prints an informative error message in the standard | 
					
						
							|  |  |  |  * format.  |desc| is a printf format string. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
 | 
					
						
							|  |  |  | #  define TEST_error         test_error_c90
 | 
					
						
							|  |  |  | #  define TEST_info          test_info_c90
 | 
					
						
							|  |  |  | # else
 | 
					
						
							|  |  |  | #  define TEST_error(...)    test_error(__FILE__, __LINE__, __VA_ARGS__)
 | 
					
						
							|  |  |  | #  define TEST_info(...)     test_info(__FILE__, __LINE__, __VA_ARGS__)
 | 
					
						
							|  |  |  | # endif
 | 
					
						
							| 
									
										
										
										
											2017-06-12 08:01:17 +08:00
										 |  |  | # define TEST_note           test_note
 | 
					
						
							| 
									
										
										
										
											2017-04-28 20:48:13 +08:00
										 |  |  | # define TEST_openssl_errors test_openssl_errors
 | 
					
						
							| 
									
										
										
										
											2017-06-19 09:21:22 +08:00
										 |  |  | # define TEST_perror         test_perror
 | 
					
						
							| 
									
										
										
										
											2016-08-09 23:03:23 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-04-18 22:27:27 +08:00
										 |  |  | extern BIO *bio_out; | 
					
						
							|  |  |  | extern BIO *bio_err; | 
					
						
							| 
									
										
										
										
											2017-04-19 16:34:54 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-06-12 08:01:17 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Formatted output for strings, memory and bignums. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | 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); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-06-06 01:32:05 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * Utilities to parse a test file. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | #define TESTMAXPAIRS        20
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | typedef struct pair_st { | 
					
						
							|  |  |  |     char *key; | 
					
						
							|  |  |  |     char *value; | 
					
						
							|  |  |  | } PAIR; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | typedef struct stanza_st { | 
					
						
							|  |  |  |     const char *test_file;      /* Input file name */ | 
					
						
							|  |  |  |     BIO *fp;                    /* Input file */ | 
					
						
							|  |  |  |     int curr;                   /* Current line in file */ | 
					
						
							|  |  |  |     int start;                  /* Line where test starts */ | 
					
						
							|  |  |  |     int errors;                 /* Error count */ | 
					
						
							|  |  |  |     int numtests;               /* Number of tests */ | 
					
						
							|  |  |  |     int numskip;                /* Number of skipped tests */ | 
					
						
							|  |  |  |     int numpairs; | 
					
						
							|  |  |  |     PAIR pairs[TESTMAXPAIRS]; | 
					
						
							|  |  |  |     BIO *key;                   /* temp memory BIO for reading in keys */ | 
					
						
							|  |  |  |     char buff[4096];            /* Input buffer for a single key/value */ | 
					
						
							|  |  |  | } STANZA; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * Prepare to start reading the file |testfile| as input. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | int test_start_file(STANZA *s, const char *testfile); | 
					
						
							|  |  |  | int test_end_file(STANZA *s); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * Read a stanza from the test file.  A stanza consists of a block | 
					
						
							| 
									
										
										
										
											2017-06-06 23:35:43 +08:00
										 |  |  |  * of lines of the form | 
					
						
							| 
									
										
										
										
											2017-06-06 01:32:05 +08:00
										 |  |  |  *      key = value | 
					
						
							|  |  |  |  * The block is terminated by EOF or a blank line. | 
					
						
							|  |  |  |  * Return 1 if found, 0 on EOF or error. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | int test_readstanza(STANZA *s); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | /*
 | 
					
						
							|  |  |  |  * Clear a stanza, release all allocated memory. | 
					
						
							|  |  |  |  */ | 
					
						
							|  |  |  | void test_clearstanza(STANZA *s); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-11-07 18:50:30 +08:00
										 |  |  | /*
 | 
					
						
							|  |  |  |  * 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); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-04-28 20:37:19 +08:00
										 |  |  | #endif                          /* HEADER_TESTUTIL_H */
 |