test/testutil/driver.c

   1 /*
   2  * Copyright 2016-2017 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 #include "../testutil.h"
  11 #include "output.h"
  12 #include "tu_local.h"
  13
  14 #include <string.h>
  15 #include <assert.h>
  16
  17 #include "../../e_os.h"
  18 #include <openssl/bio.h>
  19
  20 /*
  21  * Declares the structures needed to register each test case function.
  22  */
  23 typedef struct test_info {
  24     const char *test_case_name;
  25     int (*test_fn) ();
  26     int (*param_test_fn)(int idx);
  27     int num;
  28
  29     /* flags */
  30     int subtest:1;
  31 } TEST_INFO;
  32
  33 static TEST_INFO all_tests[1024];
  34 static int num_tests = 0;
  35 /*
  36  * A parameterised tests runs a loop of test cases.
  37  * |num_test_cases| counts the total number of test cases
  38  * across all tests.
  39  */
  40 static int num_test_cases = 0;
  41
  42 void add_test(const char *test_case_name, int (*test_fn) ())
  43 {
  44     assert(num_tests != OSSL_NELEM(all_tests));
  45     all_tests[num_tests].test_case_name = test_case_name;
  46     all_tests[num_tests].test_fn = test_fn;
  47     all_tests[num_tests].num = -1;
  48     ++num_tests;
  49     ++num_test_cases;
  50 }
  51
  52 void add_all_tests(const char *test_case_name, int(*test_fn)(int idx),
  53                    int num, int subtest)
  54 {
  55     assert(num_tests != OSSL_NELEM(all_tests));
  56     all_tests[num_tests].test_case_name = test_case_name;
  57     all_tests[num_tests].param_test_fn = test_fn;
  58     all_tests[num_tests].num = num;
  59     all_tests[num_tests].subtest = subtest;
  60     ++num_tests;
  61     num_test_cases += num;
  62 }
  63
  64 static int level = 0;
  65
  66 int subtest_level(void)
  67 {
  68     return level;
  69 }
  70
  71 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
  72 static int should_report_leaks()
  73 {
  74     /*
  75      * When compiled with enable-crypto-mdebug, OPENSSL_DEBUG_MEMORY=0
  76      * can be used to disable leak checking at runtime.
  77      * Note this only works when running the test binary manually;
  78      * the test harness always enables OPENSSL_DEBUG_MEMORY.
  79      */
  80     char *mem_debug_env = getenv("OPENSSL_DEBUG_MEMORY");
  81
  82     return mem_debug_env == NULL
  83         || (strcmp(mem_debug_env, "0") && strcmp(mem_debug_env, ""));
  84 }
  85 #endif
  86
  87 static int err_cb(const char *str, size_t len, void *u)
  88 {
  89     return test_puts_stderr(str);
  90 }
  91
  92 void setup_test()
  93 {
  94     char *TAP_levels = getenv("HARNESS_OSSL_LEVEL");
  95
  96     test_open_streams();
  97
  98     level = TAP_levels != NULL ? 4 * atoi(TAP_levels) : 0;
  99
 100 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 101     if (should_report_leaks()) {
 102         CRYPTO_set_mem_debug(1);
 103         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
 104     }
 105 #endif
 106 }
 107
 108 int finish_test(int ret)
 109 {
 110 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 111     if (should_report_leaks() && CRYPTO_mem_leaks_cb(err_cb, NULL) <= 0)
 112         return EXIT_FAILURE;
 113 #endif
 114
 115     test_close_streams();
 116
 117     return ret;
 118 }
 119
 120 static void finalize(int success)
 121 {
 122     if (success)
 123         ERR_clear_error();
 124     else
 125         ERR_print_errors_cb(err_cb, NULL);
 126 }
 127
 128 int run_tests(const char *test_prog_name)
 129 {
 130     int num_failed = 0;
 131     char *verdict = NULL;
 132     int i, j;
 133
 134     if (num_tests < 1)
 135         test_printf_stdout("%*s1..0 # Skipped: %s\n", level, "",
 136                            test_prog_name);
 137     else if (level > 0)
 138         test_printf_stdout("%*s1..%d # Subtest: %s\n", level, "", num_tests,
 139                            test_prog_name);
 140     else
 141         test_printf_stdout("%*s1..%d\n", level, "", num_tests);
 142     test_flush_stdout();
 143
 144     for (i = 0; i != num_tests; ++i) {
 145         if (all_tests[i].num == -1) {
 146             int ret = all_tests[i].test_fn();
 147
 148             test_flush_stdout();
 149             test_flush_stderr();
 150
 151             verdict = "ok";
 152             if (!ret) {
 153                 verdict = "not ok";
 154                 ++num_failed;
 155             }
 156             test_printf_stdout("%*s%s %d - %s\n", level, "", verdict, i + 1,
 157                                all_tests[i].test_case_name);
 158             test_flush_stdout();
 159             finalize(ret);
 160         } else {
 161             int num_failed_inner = 0;
 162
 163             level += 4;
 164             if (all_tests[i].subtest) {
 165                 test_printf_stdout("%*s# Subtest: %s\n", level, "",
 166                                    all_tests[i].test_case_name);
 167                 test_printf_stdout("%*s%d..%d\n", level, "", 1,
 168                                    all_tests[i].num);
 169                 test_flush_stdout();
 170             }
 171
 172             for (j = 0; j < all_tests[i].num; j++) {
 173                 int ret = all_tests[i].param_test_fn(j);
 174
 175                 test_flush_stdout();
 176                 test_flush_stderr();
 177
 178                 if (!ret)
 179                     ++num_failed_inner;
 180
 181                 finalize(ret);
 182
 183                 if (all_tests[i].subtest) {
 184                     verdict = "ok";
 185                     if (!ret) {
 186                         verdict = "not ok";
 187                         ++num_failed_inner;
 188                     }
 189                     test_printf_stdout("%*s%s %d\n", level, "", verdict, j + 1);
 190                     test_flush_stdout();
 191                 }
 192             }
 193
 194             level -= 4;
 195             verdict = "ok";
 196             if (num_failed_inner) {
 197                 verdict = "not ok";
 198                 ++num_failed;
 199             }
 200             test_printf_stdout("%*s%s %d - %s\n", level, "", verdict, i + 1,
 201                                all_tests[i].test_case_name);
 202             test_flush_stdout();
 203         }
 204     }
 205     if (num_failed != 0)
 206         return EXIT_FAILURE;
 207     return EXIT_SUCCESS;
 208 }
 209