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 <internal/nelem.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 static int seed = 0;
  36 /*
  37  * A parameterised tests runs a loop of test cases.
  38  * |num_test_cases| counts the total number of test cases
  39  * across all tests.
  40  */
  41 static int num_test_cases = 0;
  42
  43 void add_test(const char *test_case_name, int (*test_fn) (void))
  44 {
  45     assert(num_tests != OSSL_NELEM(all_tests));
  46     all_tests[num_tests].test_case_name = test_case_name;
  47     all_tests[num_tests].test_fn = test_fn;
  48     all_tests[num_tests].num = -1;
  49     ++num_tests;
  50     ++num_test_cases;
  51 }
  52
  53 void add_all_tests(const char *test_case_name, int(*test_fn)(int idx),
  54                    int num, int subtest)
  55 {
  56     assert(num_tests != OSSL_NELEM(all_tests));
  57     all_tests[num_tests].test_case_name = test_case_name;
  58     all_tests[num_tests].param_test_fn = test_fn;
  59     all_tests[num_tests].num = num;
  60     all_tests[num_tests].subtest = subtest;
  61     ++num_tests;
  62     num_test_cases += num;
  63 }
  64
  65 static int level = 0;
  66
  67 int subtest_level(void)
  68 {
  69     return level;
  70 }
  71
  72 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
  73 static int should_report_leaks()
  74 {
  75     /*
  76      * When compiled with enable-crypto-mdebug, OPENSSL_DEBUG_MEMORY=0
  77      * can be used to disable leak checking at runtime.
  78      * Note this only works when running the test binary manually;
  79      * the test harness always enables OPENSSL_DEBUG_MEMORY.
  80      */
  81     char *mem_debug_env = getenv("OPENSSL_DEBUG_MEMORY");
  82
  83     return mem_debug_env == NULL
  84         || (strcmp(mem_debug_env, "0") && strcmp(mem_debug_env, ""));
  85 }
  86 #endif
  87
  88 static int gcd(int a, int b)
  89 {
  90     while (b != 0) {
  91         int t = b;
  92         b = a % b;
  93         a = t;
  94     }
  95     return a;
  96 }
  97
  98 void setup_test_framework()
  99 {
 100     char *TAP_levels = getenv("HARNESS_OSSL_LEVEL");
 101     char *test_seed = getenv("OPENSSL_TEST_RAND_ORDER");
 102
 103     level = TAP_levels != NULL ? 4 * atoi(TAP_levels) : 0;
 104
 105     if (test_seed != NULL) {
 106         seed = atoi(test_seed);
 107         if (seed <= 0)
 108             seed = (int)time(NULL);
 109         test_printf_stdout("%*s# RAND SEED %d\n", subtest_level(), "", seed);
 110         test_flush_stdout();
 111         srand(seed);
 112     }
 113
 114 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 115     if (should_report_leaks()) {
 116         CRYPTO_set_mem_debug(1);
 117         CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
 118     }
 119 #endif
 120 }
 121
 122 int pulldown_test_framework(int ret)
 123 {
 124     set_test_title(NULL);
 125 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 126     if (should_report_leaks()
 127         && CRYPTO_mem_leaks_cb(openssl_error_cb, NULL) <= 0)
 128         return EXIT_FAILURE;
 129 #endif
 130
 131     return ret;
 132 }
 133
 134 static void finalize(int success)
 135 {
 136     if (success)
 137         ERR_clear_error();
 138     else
 139         ERR_print_errors_cb(openssl_error_cb, NULL);
 140 }
 141
 142 static char *test_title = NULL;
 143
 144 void set_test_title(const char *title)
 145 {
 146     free(test_title);
 147     test_title = title == NULL ? NULL : strdup(title);
 148 }
 149
 150 PRINTF_FORMAT(2, 3) static void test_verdict(int pass, const char *extra, ...)
 151 {
 152     va_list ap;
 153
 154     test_flush_stdout();
 155     test_flush_stderr();
 156
 157     test_printf_stdout("%*s%s", level, "", pass ? "ok" : "not ok");
 158     if (extra != NULL) {
 159         test_printf_stdout(" ");
 160         va_start(ap, extra);
 161         test_vprintf_stdout(extra, ap);
 162         va_end(ap);
 163     }
 164     test_printf_stdout("\n");
 165     test_flush_stdout();
 166 }
 167
 168 int run_tests(const char *test_prog_name)
 169 {
 170     int num_failed = 0;
 171     int verdict = 1;
 172     int ii, i, jj, j, jstep;
 173     int permute[OSSL_NELEM(all_tests)];
 174
 175     if (num_tests < 1) {
 176         test_printf_stdout("%*s1..0 # Skipped: %s\n", level, "",
 177                            test_prog_name);
 178     } else {
 179         if (level > 0)
 180             test_printf_stdout("%*s# Subtest: %s\n", level, "", test_prog_name);
 181         test_printf_stdout("%*s1..%d\n", level, "", num_tests);
 182     }
 183     test_flush_stdout();
 184
 185     for (i = 0; i < num_tests; i++)
 186         permute[i] = i;
 187     if (seed != 0)
 188         for (i = num_tests - 1; i >= 1; i--) {
 189             j = rand() % (1 + i);
 190             ii = permute[j];
 191             permute[j] = permute[i];
 192             permute[i] = ii;
 193         }
 194
 195     for (ii = 0; ii != num_tests; ++ii) {
 196         i = permute[ii];
 197         if (all_tests[i].num == -1) {
 198             int ret = 0;
 199
 200             set_test_title(all_tests[i].test_case_name);
 201             ret = all_tests[i].test_fn();
 202
 203             verdict = 1;
 204             if (!ret) {
 205                 verdict = 0;
 206                 ++num_failed;
 207             }
 208             test_verdict(verdict, "%d - %s", ii + 1, test_title);
 209             finalize(ret);
 210         } else {
 211             int num_failed_inner = 0;
 212
 213             level += 4;
 214             if (all_tests[i].subtest) {
 215                 test_printf_stdout("%*s# Subtest: %s\n", level, "",
 216                                    all_tests[i].test_case_name);
 217                 test_printf_stdout("%*s%d..%d\n", level, "", 1,
 218                                    all_tests[i].num);
 219                 test_flush_stdout();
 220             }
 221
 222             j = -1;
 223             if (seed == 0 || all_tests[i].num < 3)
 224                 jstep = 1;
 225             else
 226                 do
 227                     jstep = rand() % all_tests[i].num;
 228                 while (jstep == 0 || gcd(all_tests[i].num, jstep) != 1);
 229
 230             for (jj = 0; jj < all_tests[i].num; jj++) {
 231                 int ret;
 232
 233                 j = (j + jstep) % all_tests[i].num;
 234                 set_test_title(NULL);
 235                 ret = all_tests[i].param_test_fn(j);
 236
 237                 if (!ret)
 238                     ++num_failed_inner;
 239
 240                 finalize(ret);
 241
 242                 if (all_tests[i].subtest) {
 243                     verdict = 1;
 244                     if (!ret) {
 245                         verdict = 0;
 246                         ++num_failed_inner;
 247                     }
 248                     if (test_title != NULL)
 249                         test_verdict(verdict, "%d - %s", jj + 1, test_title);
 250                     else
 251                         test_verdict(verdict, "%d - iteration %d",
 252                                      jj + 1, j + 1);
 253                 }
 254             }
 255
 256             level -= 4;
 257             verdict = 1;
 258             if (num_failed_inner) {
 259                 verdict = 0;
 260                 ++num_failed;
 261             }
 262             test_verdict(verdict, "%d - %s", ii + 1,
 263                          all_tests[i].test_case_name);
 264         }
 265     }
 266     if (num_failed != 0)
 267         return EXIT_FAILURE;
 268     return EXIT_SUCCESS;
 269 }
 270