Add missing mem leak test activation and checks

[openssl.git] / test / testutil.h

diff --git a/test/testutil.h b/test/testutil.h
index 3e9cb8401562057d2899b5f7762efca9071fffc5..2ae3d7d16c39183664eef58ac882d13dc3b0fe29 100644 (file)
--- a/test/testutil.h
+++ b/test/testutil.h
@@ -1,5 +1,4 @@
-/* test/testutil.h */
-/*
+/*-
  * Utilities for writing OpenSSL unit tests.
  *
  * More information:
@@ -57,9 +56,10 @@
  */
 
 #ifndef HEADER_TESTUTIL_H
-#define HEADER_TESTUTIL_H
+# define HEADER_TESTUTIL_H
 
-/* SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions.
+/*-
+ * 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
  * object called "fixture". It will also allocate the "result" variable used
@@ -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
@@ -83,34 +83,53 @@
  * Then test case functions can take the form:
  *
  * static int test_foobar_feature()
- *     {
- *     SETUP_FOOBAR_TEST_FIXTURE();
- *     [...set individual members of fixture...]
- *     EXECUTE_FOOBAR_TEST();
- *     }
+ *      {
+ *      SETUP_FOOBAR_TEST_FIXTURE();
+ *      [...set individual members of fixture...]
+ *      EXECUTE_FOOBAR_TEST();
+ *      }
  */
-#define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
-       TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME);\
-       int result = 0
+# define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\
+    TEST_FIXTURE_TYPE fixture = set_up(TEST_CASE_NAME); \
+    int result = 0
 
-#define EXECUTE_TEST(execute_func, tear_down)\
-       if (execute_func(fixture) != 0) result = 1;\
-       tear_down(fixture);\
-       return result
+# define EXECUTE_TEST(execute_func, tear_down)\
+        result = execute_func(fixture);\
+        tear_down(fixture);\
+        return result
 
-/* TEST_CASE_NAME is defined as the name of the test case function where
+/*
+ * 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.
  */
-#if __STDC_VERSION__ < 199901L
-#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__ */
+# if __STDC_VERSION__ < 199901L
+#  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__ */
+
+/*
+ * 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().
+ */
+# define ADD_TEST(test_function) add_test(#test_function, test_function)
+
+/*
+ * Simple parameterized tests. Adds a test_function(idx) test for each
+ * 0 <= idx < num.
+ */
+# define ADD_ALL_TESTS(test_function, num) \
+  add_all_tests(#test_function, test_function, num)
+
+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);
 
-#endif /* HEADER_TESTUTIL_H */
+#endif                          /* HEADER_TESTUTIL_H */