2 * Utilities for writing OpenSSL unit tests.
5 * http://wiki.openssl.org/index.php/How_To_Write_Unit_Tests_For_OpenSSL
7 * Author: Mike Bland (mbland@acm.org)
9 * ====================================================================
10 * Copyright (c) 2014 The OpenSSL Project. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in
21 * the documentation and/or other materials provided with the
24 * 3. All advertising materials mentioning features or use of this
25 * software must display the following acknowledgment:
26 * "This product includes software developed by the OpenSSL Project
27 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
29 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
30 * endorse or promote products derived from this software without
31 * prior written permission. For written permission, please contact
32 * licensing@OpenSSL.org.
34 * 5. Products derived from this software may not be called "OpenSSL"
35 * nor may "OpenSSL" appear in their names without prior written
36 * permission of the OpenSSL Project.
38 * 6. Redistributions of any form whatsoever must retain the following
40 * "This product includes software developed by the OpenSSL Project
41 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
43 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
44 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
46 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
47 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
49 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
50 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
52 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
54 * OF THE POSSIBILITY OF SUCH DAMAGE.
55 * ====================================================================
58 #ifndef HEADER_TESTUTIL_H
59 # define HEADER_TESTUTIL_H
62 * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
64 * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE
65 * object called "fixture". It will also allocate the "result" variable used
66 * by EXECUTE_TEST. set_up() should take a const char* specifying the test
67 * case name and return a TEST_FIXTURE_TYPE by value.
69 * EXECUTE_TEST will pass fixture to execute_func() by value, call
70 * tear_down(), and return the result of execute_func(). execute_func() should
71 * take a TEST_FIXTURE_TYPE by value and return zero on success or one on
74 * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST
77 * #define SETUP_FOOBAR_TEST_FIXTURE()\
78 * SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar)
80 * #define EXECUTE_FOOBAR_TEST()\
81 * EXECUTE_TEST(execute_foobar, tear_down_foobar)
83 * Then test case functions can take the form:
85 * static int test_foobar_feature()
87 * SETUP_FOOBAR_TEST_FIXTURE();
88 * [...set individual members of fixture...]
89 * EXECUTE_FOOBAR_TEST();
92 # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
93 TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME); \
96 # define EXECUTE_TEST(execute_func, tear_down)\
97 if (execute_func(fixture) != 0) result = 1;\
102 * TEST_CASE_NAME is defined as the name of the test case function where
103 * possible; otherwise we get by with the file name and line number.
105 # if __STDC_VERSION__ < 199901L
106 # if defined(_MSC_VER)
107 # define TEST_CASE_NAME __FUNCTION__
109 # define testutil_stringify_helper(s) #s
110 # define testutil_stringify(s) testutil_stringify_helper(s)
111 # define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__)
112 # endif /* _MSC_VER */
114 # define TEST_CASE_NAME __func__
115 # endif /* __STDC_VERSION__ */
118 * In main(), call ADD_TEST to register each test case function, then call
119 * run_tests() to execute all tests and report the results. The result
120 * returned from run_tests() should be used as the return value for main().
122 # define ADD_TEST(test_function) add_test(#test_function, test_function)
125 * Simple parameterized tests. Adds a test_function(idx) test for each
128 # define ADD_ALL_TESTS(test_function, num) \
129 add_all_tests(#test_function, test_function, num)
131 void add_test(const char *test_case_name, int (*test_fn) ());
132 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num);
133 int run_tests(const char *test_prog_name);
135 #endif /* HEADER_TESTUTIL_H */