2 * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved.
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
18 #include <openssl/opensslconf.h>
19 #include <openssl/crypto.h>
20 #include <openssl/err.h>
23 * Declares the structures needed to register each test case function.
25 typedef struct test_info {
26 const char *test_case_name;
28 int (*param_test_fn)(int idx);
32 static TEST_INFO all_tests[1024];
33 static int num_tests = 0;
35 * A parameterised tests runs a loop of test cases.
36 * |num_test_cases| counts the total number of test cases
39 static int num_test_cases = 0;
41 void add_test(const char *test_case_name, int (*test_fn) ())
43 assert(num_tests != OSSL_NELEM(all_tests));
44 all_tests[num_tests].test_case_name = test_case_name;
45 all_tests[num_tests].test_fn = test_fn;
46 all_tests[num_tests].num = -1;
51 void add_all_tests(const char *test_case_name, int(*test_fn)(int idx),
54 assert(num_tests != OSSL_NELEM(all_tests));
55 all_tests[num_tests].test_case_name = test_case_name;
56 all_tests[num_tests].param_test_fn = test_fn;
57 all_tests[num_tests].num = num;
59 num_test_cases += num;
62 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
63 static int should_report_leaks()
66 * When compiled with enable-crypto-mdebug, OPENSSL_DEBUG_MEMORY=0
67 * can be used to disable leak checking at runtime.
68 * Note this only works when running the test binary manually;
69 * the test harness always enables OPENSSL_DEBUG_MEMORY.
71 char *mem_debug_env = getenv("OPENSSL_DEBUG_MEMORY");
73 return mem_debug_env == NULL
74 || (strcmp(mem_debug_env, "0") && strcmp(mem_debug_env, ""));
81 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
82 if (should_report_leaks()) {
83 CRYPTO_set_mem_debug(1);
84 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
89 int finish_test(int ret)
91 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
92 if (should_report_leaks() && CRYPTO_mem_leaks_fp(stderr) <= 0)
98 static void finalize(int success)
103 ERR_print_errors_fp(stderr);
106 int run_tests(const char *test_prog_name)
112 printf("%s: %d test case%s\n", test_prog_name, num_test_cases,
113 num_test_cases == 1 ? "" : "s");
115 for (i = 0; i != num_tests; ++i) {
116 if (all_tests[i].num == -1) {
117 int ret = all_tests[i].test_fn();
120 printf("** %s failed **\n--------\n",
121 all_tests[i].test_case_name);
126 for (j = 0; j < all_tests[i].num; j++) {
127 int ret = all_tests[i].param_test_fn(j);
130 printf("** %s failed test %d\n--------\n",
131 all_tests[i].test_case_name, j);
139 if (num_failed != 0) {
140 printf("%s: %d test%s failed (out of %d)\n", test_prog_name,
141 num_failed, num_failed != 1 ? "s" : "", num_test_cases);
144 printf(" All tests passed.\n");
148 static const char *print_string_maybe_null(const char *s)
150 return s == NULL ? "(NULL)" : s;
153 int strings_equal(const char *desc, const char *s1, const char *s2)
155 if (s1 == NULL && s2 == NULL)
157 if (s1 == NULL || s2 == NULL || strcmp(s1, s2) != 0) {
158 fprintf(stderr, "%s mismatch: %s vs %s\n", desc, print_string_maybe_null(s1),
159 print_string_maybe_null(s2));