Bring the memory output inline with the suggestions in #3465.
[openssl.git] / test / testutil / driver.c
index e70fd216156efaaea347c7d42539dd5ed726c252..3b62e59554a5d8902d4ddabc864bfaf3ddc9b1ea 100644 (file)
@@ -8,6 +8,8 @@
  */
 
 #include "../testutil.h"
+#include "output.h"
+#include "tu_local.h"
 
 #include <string.h>
 #include <assert.h>
@@ -23,10 +25,14 @@ typedef struct test_info {
     int (*test_fn) ();
     int (*param_test_fn)(int idx);
     int num;
+
+    /* flags */
+    int subtest:1;
 } 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
@@ -45,16 +51,24 @@ 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 num, int subtest)
 {
     assert(num_tests != OSSL_NELEM(all_tests));
     all_tests[num_tests].test_case_name = test_case_name;
     all_tests[num_tests].param_test_fn = test_fn;
     all_tests[num_tests].num = num;
+    all_tests[num_tests].subtest = subtest;
     ++num_tests;
     num_test_cases += num;
 }
 
+static int level = 0;
+
+int subtest_level(void)
+{
+    return level;
+}
+
 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 static int should_report_leaks()
 {
@@ -71,16 +85,34 @@ static int should_report_leaks()
 }
 #endif
 
-
-static int err_cb(const char *str, size_t len, void *u)
+static int gcd(int a, int b)
 {
-    return test_puts_stderr(str);
+    while (b != 0) {
+        int t = b;
+        b = a % b;
+        a = t;
+    }
+    return a;
 }
 
 void setup_test()
 {
+    char *TAP_levels = getenv("HARNESS_OSSL_LEVEL");
+    char *test_seed = getenv("OPENSSL_TEST_RAND_ORDER");
+
     test_open_streams();
 
+    level = TAP_levels != NULL ? 4 * atoi(TAP_levels) : 0;
+
+    if (test_seed != NULL) {
+        seed = atoi(test_seed);
+        if (seed <= 0)
+            seed = 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);
@@ -92,7 +124,8 @@ void setup_test()
 int finish_test(int ret)
 {
 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
-    if (should_report_leaks() && CRYPTO_mem_leaks_cb(err_cb, NULL) <= 0)
+    if (should_report_leaks()
+        && CRYPTO_mem_leaks_cb(openssl_error_cb, NULL) <= 0)
         return EXIT_FAILURE;
 #endif
 
@@ -106,62 +139,128 @@ static void finalize(int success)
     if (success)
         ERR_clear_error();
     else
-        ERR_print_errors_cb(err_cb, NULL);
+        ERR_print_errors_cb(openssl_error_cb, NULL);
 }
 
-static void helper_printf_stdout(const char *fmt, ...)
-{
-    va_list ap;
+static char *test_title = NULL;
 
-    va_start(ap, fmt);
-    test_vprintf_stdout(fmt, ap);
-    va_end(ap);
+void set_test_title(const char *title)
+{
+    free(test_title);
+    test_title = title == NULL ? NULL : strdup(title);
 }
 
 int run_tests(const char *test_prog_name)
 {
     int num_failed = 0;
-    int i, j;
+    char *verdict = NULL;
+    int ii, i, jj, j, jstep;
+    int permute[OSSL_NELEM(all_tests)];
 
-    helper_printf_stdout("%s: %d test case%s\n", test_prog_name, num_test_cases,
-                         num_test_cases == 1 ? "" : "s");
+    if (num_tests < 1) {
+        test_printf_stdout("%*s1..0 # Skipped: %s\n", level, "",
+                           test_prog_name);
+    } 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 = all_tests[i].test_fn();
+            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";
             if (!ret) {
-                helper_printf_stdout("** %s failed **\n--------\n",
-                                     all_tests[i].test_case_name);
-                test_flush_stdout();
+                verdict = "not ok";
                 ++num_failed;
             }
+            test_printf_stdout("%*s%s %d - %s\n", level, "", verdict, ii + 1,
+                               test_title);
+            test_flush_stdout();
             finalize(ret);
         } else {
-            for (j = 0; j < all_tests[i].num; j++) {
-                int ret = all_tests[i].param_test_fn(j);
+            int num_failed_inner = 0;
 
-                if (!ret) {
-                    helper_printf_stdout("** %s failed test %d\n--------\n",
-                                         all_tests[i].test_case_name, j);
+            level += 4;
+            if (all_tests[i].subtest) {
+                test_printf_stdout("%*s# Subtest: %s\n", level, "",
+                                   all_tests[i].test_case_name);
+                test_printf_stdout("%*s%d..%d\n", level, "", 1,
+                                   all_tests[i].num);
+                test_flush_stdout();
+            }
+
+            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";
+                    if (!ret) {
+                        verdict = "not ok";
+                        ++num_failed_inner;
+                    }
+                    if (test_title != NULL)
+                        test_printf_stdout("%*s%s %d - %s\n", level, "",
+                                           verdict, jj + 1, test_title);
+                    else
+                        test_printf_stdout("%*s%s %d - iteration %d\n", level,
+                                           "", verdict, jj + 1, j + 1);
                     test_flush_stdout();
-                    ++num_failed;
                 }
-                finalize(ret);
             }
+
+            level -= 4;
+            verdict = "ok";
+            if (num_failed_inner) {
+                verdict = "not ok";
+                ++num_failed;
+            }
+            test_printf_stdout("%*s%s %d - %s\n", level, "", verdict, ii + 1,
+                               all_tests[i].test_case_name);
+            test_flush_stdout();
         }
     }
-
-    if (num_failed != 0) {
-        helper_printf_stdout("%s: %d test%s failed (out of %d)\n",
-                             test_prog_name, num_failed,
-                             num_failed != 1 ? "s" : "", num_test_cases);
-        test_flush_stdout();
+    if (num_failed != 0)
         return EXIT_FAILURE;
-    }
-    helper_printf_stdout("  All tests passed.\n");
-    test_flush_stdout();
     return EXIT_SUCCESS;
 }