Add test for CLIENT_EARLY_TRAFFIC_SECRET key logging
[openssl.git] / test / testutil / driver.c
index 660db7b3270c660da4a83113a1d5d45f5f55b2a3..9cdce7a4e035e6a0944978686dc85938da012b56 100644 (file)
 #include <string.h>
 #include <assert.h>
 
-#include "../../e_os.h"
+#include "internal/nelem.h"
 #include <openssl/bio.h>
 
+#ifdef _WIN32
+# define strdup _strdup
+#endif
+
 /*
  * Declares the structures needed to register each test case function.
  */
@@ -32,6 +36,7 @@ typedef struct test_info {
 
 static TEST_INFO all_tests[1024];
 static int num_tests = 0;
+static int seed = 0;
 /*
  * A parameterised tests runs a loop of test cases.
  * |num_test_cases| counts the total number of test cases
@@ -39,7 +44,7 @@ static int num_tests = 0;
  */
 static int num_test_cases = 0;
 
-void add_test(const char *test_case_name, int (*test_fn) ())
+void add_test(const char *test_case_name, int (*test_fn) (void))
 {
     assert(num_tests != OSSL_NELEM(all_tests));
     all_tests[num_tests].test_case_name = test_case_name;
@@ -84,14 +89,32 @@ static int should_report_leaks()
 }
 #endif
 
-void setup_test()
+static int gcd(int a, int b)
 {
-    char *TAP_levels = getenv("HARNESS_OSSL_LEVEL");
+    while (b != 0) {
+        int t = b;
+        b = a % b;
+        a = t;
+    }
+    return a;
+}
 
-    test_open_streams();
+void setup_test_framework()
+{
+    char *TAP_levels = getenv("HARNESS_OSSL_LEVEL");
+    char *test_seed = getenv("OPENSSL_TEST_RAND_ORDER");
 
     level = TAP_levels != NULL ? 4 * atoi(TAP_levels) : 0;
 
+    if (test_seed != NULL) {
+        seed = atoi(test_seed);
+        if (seed <= 0)
+            seed = (int)time(NULL);
+        test_printf_stdout("%*s# RAND SEED %d\n", subtest_level(), "", seed);
+        test_flush_stdout();
+        srand(seed);
+    }
+
 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
     if (should_report_leaks()) {
         CRYPTO_set_mem_debug(1);
@@ -100,16 +123,15 @@ void setup_test()
 #endif
 }
 
-int finish_test(int ret)
+int pulldown_test_framework(int ret)
 {
+    set_test_title(NULL);
 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
     if (should_report_leaks()
         && CRYPTO_mem_leaks_cb(openssl_error_cb, NULL) <= 0)
         return EXIT_FAILURE;
 #endif
 
-    test_close_streams();
-
     return ret;
 }
 
@@ -121,47 +143,73 @@ static void finalize(int success)
         ERR_print_errors_cb(openssl_error_cb, NULL);
 }
 
-static const char *test_title = NULL;
+static char *test_title = NULL;
 
 void set_test_title(const char *title)
 {
-    test_title = title;
+    free(test_title);
+    test_title = title == NULL ? NULL : strdup(title);
+}
+
+PRINTF_FORMAT(2, 3) static void test_verdict(int pass, const char *extra, ...)
+{
+    va_list ap;
+
+    test_flush_stdout();
+    test_flush_stderr();
+
+    test_printf_stdout("%*s%s", level, "", pass ? "ok" : "not ok");
+    if (extra != NULL) {
+        test_printf_stdout(" ");
+        va_start(ap, extra);
+        test_vprintf_stdout(extra, ap);
+        va_end(ap);
+    }
+    test_printf_stdout("\n");
+    test_flush_stdout();
 }
 
 int run_tests(const char *test_prog_name)
 {
     int num_failed = 0;
-    char *verdict = NULL;
-    int i, j;
+    int verdict = 1;
+    int ii, i, jj, j, jstep;
+    int permute[OSSL_NELEM(all_tests)];
 
-    if (num_tests < 1)
+    if (num_tests < 1) {
         test_printf_stdout("%*s1..0 # Skipped: %s\n", level, "",
                            test_prog_name);
-    else if (level > 0)
-        test_printf_stdout("%*s1..%d # Subtest: %s\n", level, "", num_tests,
-                           test_prog_name);
-    else
+    } else {
+        if (level > 0)
+            test_printf_stdout("%*s# Subtest: %s\n", level, "", test_prog_name);
         test_printf_stdout("%*s1..%d\n", level, "", num_tests);
+    }
     test_flush_stdout();
 
-    for (i = 0; i != num_tests; ++i) {
+    for (i = 0; i < num_tests; i++)
+        permute[i] = i;
+    if (seed != 0)
+        for (i = num_tests - 1; i >= 1; i--) {
+            j = rand() % (1 + i);
+            ii = permute[j];
+            permute[j] = permute[i];
+            permute[i] = ii;
+        }
+
+    for (ii = 0; ii != num_tests; ++ii) {
+        i = permute[ii];
         if (all_tests[i].num == -1) {
             int ret = 0;
 
             set_test_title(all_tests[i].test_case_name);
             ret = all_tests[i].test_fn();
 
-            test_flush_stdout();
-            test_flush_stderr();
-
-            verdict = "ok";
+            verdict = 1;
             if (!ret) {
-                verdict = "not ok";
+                verdict = 0;
                 ++num_failed;
             }
-            test_printf_stdout("%*s%s %d - %s\n", level, "", verdict, i + 1,
-                               test_title);
-            test_flush_stdout();
+            test_verdict(verdict, "%d - %s", ii + 1, test_title);
             finalize(ret);
         } else {
             int num_failed_inner = 0;
@@ -175,45 +223,48 @@ int run_tests(const char *test_prog_name)
                 test_flush_stdout();
             }
 
-            for (j = 0; j < all_tests[i].num; j++) {
-                int ret = 0;
+            j = -1;
+            if (seed == 0 || all_tests[i].num < 3)
+                jstep = 1;
+            else
+                do
+                    jstep = rand() % all_tests[i].num;
+                while (jstep == 0 || gcd(all_tests[i].num, jstep) != 1);
+
+            for (jj = 0; jj < all_tests[i].num; jj++) {
+                int ret;
 
+                j = (j + jstep) % all_tests[i].num;
                 set_test_title(NULL);
                 ret = all_tests[i].param_test_fn(j);
 
-                test_flush_stdout();
-                test_flush_stderr();
-
                 if (!ret)
                     ++num_failed_inner;
 
                 finalize(ret);
 
                 if (all_tests[i].subtest) {
-                    verdict = "ok";
+                    verdict = 1;
                     if (!ret) {
-                        verdict = "not ok";
+                        verdict = 0;
                         ++num_failed_inner;
                     }
                     if (test_title != NULL)
-                        test_printf_stdout("%*s%s %d - %s\n", level, "", verdict,
-                                           j + 1, test_title);
+                        test_verdict(verdict, "%d - %s", jj + 1, test_title);
                     else
-                        test_printf_stdout("%*s%s %d\n", level, "", verdict,
-                                           j + 1);
-                    test_flush_stdout();
+                        test_verdict(verdict, "%d - iteration %d",
+                                     jj + 1, j + 1);
                 }
             }
 
             level -= 4;
-            verdict = "ok";
+            verdict = 1;
             if (num_failed_inner) {
-                verdict = "not ok";
+                verdict = 0;
                 ++num_failed;
             }
-            test_printf_stdout("%*s%s %d - %s\n", level, "", verdict, i + 1,
-                               all_tests[i].test_case_name);
-            test_flush_stdout();
+            test_verdict(verdict, "%d - %s", ii + 1,
+                         all_tests[i].test_case_name);
         }
     }
     if (num_failed != 0)
@@ -221,3 +272,28 @@ int run_tests(const char *test_prog_name)
     return EXIT_SUCCESS;
 }
 
+/*
+ * Glue an array of strings together and return it as an allocated string.
+ * Optionally return the whole length of this string in |out_len|
+ */
+char *glue_strings(const char *list[], size_t *out_len)
+{
+    size_t len = 0;
+    char *p, *ret;
+    int i;
+
+    for (i = 0; list[i] != NULL; i++)
+        len += strlen(list[i]);
+
+    if (out_len != NULL)
+        *out_len = len;
+
+    if (!TEST_ptr(ret = p = OPENSSL_malloc(len + 1)))
+        return NULL;
+
+    for (i = 0; list[i] != NULL; i++)
+        p += strlen(strcpy(p, list[i]));
+
+    return ret;
+}
+