X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=test%2Ftestutil.h;h=39b6d0e6f1c1e0b6adcb7160a99ed9d085434e91;hb=6e290a25c2cbdc26119c0866c20d9292f9e64dd8;hp=ba54ac15037d05bcceab838d238e16aaa30230c4;hpb=453dfd8d5ee0893146e0fb61a5978ab59ba95c01;p=oweals%2Fopenssl.git diff --git a/test/testutil.h b/test/testutil.h index ba54ac1503..39b6d0e6f1 100644 --- a/test/testutil.h +++ b/test/testutil.h @@ -1,64 +1,64 @@ -/*- - * Utilities for writing OpenSSL unit tests. - * - * More information: - * http://wiki.openssl.org/index.php/How_To_Write_Unit_Tests_For_OpenSSL - * - * Author: Mike Bland (mbland@acm.org) - * Date: 2014-06-07 - * ==================================================================== - * Copyright (c) 2014 The OpenSSL Project. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * - * 3. All advertising materials mentioning features or use of this - * software must display the following acknowledgment: - * "This product includes software developed by the OpenSSL Project - * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" - * - * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to - * endorse or promote products derived from this software without - * prior written permission. For written permission, please contact - * licensing@OpenSSL.org. - * - * 5. Products derived from this software may not be called "OpenSSL" - * nor may "OpenSSL" appear in their names without prior written - * permission of the OpenSSL Project. - * - * 6. Redistributions of any form whatsoever must retain the following - * acknowledgment: - * "This product includes software developed by the OpenSSL Project - * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" - * - * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY - * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR - * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, - * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED - * OF THE POSSIBILITY OF SUCH DAMAGE. - * ==================================================================== +/* + * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved. + * + * 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 */ #ifndef HEADER_TESTUTIL_H # define HEADER_TESTUTIL_H +#include +#include + +/*- + * Simple unit tests should implement register_tests() from test_main.h + * and link against test_main.c. + * To register tests, call ADD_TEST or ADD_ALL_TESTS: + * + * #include "test_main.h" + * + * void register_tests(void) + * { + * ADD_TEST(test_foo); + * ADD_ALL_TESTS(test_bar, num_test_bar); + * } + * + * Tests that need to perform custom setup or read command-line arguments should + * implement test_main() from test_main_custom.h and link against + * test_main_custom.c: + * + * int test_main(int argc, char *argv[]) + * { + * int ret; + * + * // Custom setup ... + * + * ADD_TEST(test_foo); + * ADD_ALL_TESTS(test_bar, num_test_bar); + * // Add more tests ... + * + * ret = run_tests(argv[0]); + * + * // Custom teardown ... + * + * return ret; + * } + */ + +/* Adds a simple test case. */ +# define ADD_TEST(test_function) add_test(#test_function, test_function) + +/* + * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num. + */ +# define ADD_ALL_TESTS(test_function, num) \ + add_all_tests(#test_function, test_function, num) + /*- + * Test cases that share common setup should use the helper * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions. * * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE @@ -68,7 +68,7 @@ * * EXECUTE_TEST will pass fixture to execute_func() by value, call * tear_down(), and return the result of execute_func(). execute_func() should - * take a TEST_FIXTURE_TYPE by value and return zero on success or one on + * take a TEST_FIXTURE_TYPE by value and return 1 on success and 0 on * failure. * * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST @@ -94,10 +94,15 @@ int result = 0 # define EXECUTE_TEST(execute_func, tear_down)\ - if (execute_func(fixture) != 0) result = 1;\ + 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 * possible; otherwise we get by with the file name and line number. @@ -115,21 +120,42 @@ # endif /* __STDC_VERSION__ */ /* - * In main(), call ADD_TEST to register each test case function, then call - * run_tests() to execute all tests and report the results. The result - * returned from run_tests() should be used as the return value for main(). + * Internal helpers. Test programs shouldn't use these directly, but should + * rather link to one of the helper main() methods. */ -# define ADD_TEST(test_function) add_test(#test_function, test_function) +/* setup_test() should be called as the first thing in a test main(). */ +void setup_test(void); /* - * Simple parameterized tests. Adds a test_function(idx) test for each - * 0 <= idx < num. + * 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(). */ -# define ADD_ALL_TESTS(test_function, num) \ - add_all_tests(#test_function, test_function, num) +__owur int finish_test(int ret); void add_test(const char *test_case_name, int (*test_fn) ()); void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num); -int run_tests(const char *test_prog_name); +__owur int run_tests(const char *test_prog_name); +/* + * Test assumption verification helpers. + */ + +/* + * Returns 1 if |s1| and |s2| are both NULL or equal. + * Otherwise, returns 0 and pretty-prints diagnostics using |desc|. + */ +int strings_equal(const char *desc, const char *s1, const char *s2); + +/* + * 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. + */ +#define TEST_check(condition) \ + do { \ + if (!(condition)) { \ + ERR_print_errors_fp(stderr); \ + OPENSSL_assert(!#condition); \ + } \ + } while (0) #endif /* HEADER_TESTUTIL_H */