test/testutil.h

   1 /*
   2  * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_TESTUTIL_H
  11 # define HEADER_TESTUTIL_H
  12
  13 #include <openssl/err.h>
  14
  15 /*
  16  * In main(), call ADD_TEST to register each test case function, then call
  17  * run_tests() to execute all tests and report the results. The result
  18  * returned from run_tests() should be used as the return value for main().
  19  */
  20 # define ADD_TEST(test_function) add_test(#test_function, test_function)
  21
  22 /*-
  23  * Test cases that share common setup should use the helper
  24  * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
  25  *
  26  * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE
  27  * object called "fixture". It will also allocate the "result" variable used
  28  * by EXECUTE_TEST. set_up() should take a const char* specifying the test
  29  * case name and return a TEST_FIXTURE_TYPE by value.
  30  *
  31  * EXECUTE_TEST will pass fixture to execute_func() by value, call
  32  * tear_down(), and return the result of execute_func(). execute_func() should
  33  * take a TEST_FIXTURE_TYPE by value and return 1 on success and 0 on
  34  * failure.
  35  *
  36  * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST
  37  * variations like so:
  38  *
  39  * #define SETUP_FOOBAR_TEST_FIXTURE()\
  40  *   SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar)
  41  *
  42  * #define EXECUTE_FOOBAR_TEST()\
  43  *   EXECUTE_TEST(execute_foobar, tear_down_foobar)
  44  *
  45  * Then test case functions can take the form:
  46  *
  47  * static int test_foobar_feature()
  48  *      {
  49  *      SETUP_FOOBAR_TEST_FIXTURE();
  50  *      [...set individual members of fixture...]
  51  *      EXECUTE_FOOBAR_TEST();
  52  *      }
  53  */
  54 # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
  55     TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME); \
  56     int result = 0
  57
  58 # define EXECUTE_TEST(execute_func, tear_down)\
  59         result = execute_func(fixture);\
  60         tear_down(fixture);\
  61         return result
  62
  63 /* Shorthand if tear_down does nothing. */
  64 # define EXECUTE_TEST_NO_TEARDOWN(execute_func)\
  65         result = execute_func(fixture);\
  66         return result
  67
  68 /*
  69  * TEST_CASE_NAME is defined as the name of the test case function where
  70  * possible; otherwise we get by with the file name and line number.
  71  */
  72 # if __STDC_VERSION__ < 199901L
  73 #  if defined(_MSC_VER)
  74 #   define TEST_CASE_NAME __FUNCTION__
  75 #  else
  76 #   define testutil_stringify_helper(s) #s
  77 #   define testutil_stringify(s) testutil_stringify_helper(s)
  78 #   define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__)
  79 #  endif                        /* _MSC_VER */
  80 # else
  81 #  define TEST_CASE_NAME __func__
  82 # endif                         /* __STDC_VERSION__ */
  83
  84 /*
  85  * Simple parameterized tests. Adds a test_function(idx) test for each
  86  * 0 <= idx < num.
  87  */
  88 # define ADD_ALL_TESTS(test_function, num) \
  89   add_all_tests(#test_function, test_function, num)
  90
  91 void add_test(const char *test_case_name, int (*test_fn) ());
  92 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num);
  93 int run_tests(const char *test_prog_name);
  94
  95 /*
  96  *  Test assumption verification helpers.
  97  */
  98
  99 /*
 100  * Returns 1 if |s1| and |s2| are both NULL or equal.
 101  * Otherwise, returns 0 and pretty-prints diagnostics using |desc|.
 102  */
 103 int strings_equal(const char *desc, const char *s1, const char *s2);
 104 #endif                          /* HEADER_TESTUTIL_H */
 105
 106 /*
 107  * For "impossible" conditions such as malloc failures or bugs in test code,
 108  * where continuing the test would be meaningless. Note that OPENSSL_assert
 109  * is fatal, and is never compiled out.
 110  */
 111 #define TEST_check(condition)                   \
 112     do {                                        \
 113         if (!(condition)) {                     \
 114             ERR_print_errors_fp(stderr);        \
 115             OPENSSL_assert(!#condition);        \
 116         }                                       \
 117     } while (0)