test: Add an overall test runner

Add a new test runner that will eventually be able to run any test. For
now, have it run the 'command' unit tests, so that the functionality in
cmd_ut_category() moves into it.

Signed-off-by: Simon Glass <sjg@chromium.org>

diff --git a/include/test/ut.h b/include/test/ut.h
index 17400c73ea9f8a861c9b52557e8a3efc887b2b15..88e75ab791cc18e81e6745ae30d65b560bd4d0f6 100644 (file)
--- a/include/test/ut.h
+++ b/include/test/ut.h
@@ -356,4 +356,46 @@ void ut_silence_console(struct unit_test_state *uts);
  */
 void ut_unsilence_console(struct unit_test_state *uts);
 
+/**
+ * ut_run_tests() - Run a set of tests
+ *
+ * This runs the tests, handling any preparation and clean-up needed. It prints
+ * the name of each test before running it.
+ *
+ * @uts: Test state to update. The caller should ensure that this is zeroed for
+ *     the first call to this function. On exit, @uts->fail_count is
+ *     incremented by the number of failures (0, one hopes)
+ * @prefix: String prefix for the tests. Any tests that have this prefix will be
+ *     printed without the prefix, so that it is easier to see the unique part
+ *     of the test name. If NULL, no prefix processing is done
+ * @tests: List of tests to run
+ * @count: Number of tests to run
+ * @select_name: Name of a single test to run (from the list provided). If NULL
+ *     then all tests are run
+ * @return 0 if all tests passed, -ENOENT if test @select_name was not found,
+ *     -EBADF if any failed
+ */
+int ut_run_tests(struct unit_test_state *uts, const char *prefix,
+                struct unit_test *tests, int count, const char *select_name);
+
+/**
+ * ut_run_tests() - Run a set of tests
+ *
+ * This runs the test, handling any preparation and clean-up needed. It prints
+ * the name of each test before running it.
+ *
+ * @category: Category of these tests. This is a string printed at the start to
+ *     announce the the number of tests
+ * @prefix: String prefix for the tests. Any tests that have this prefix will be
+ *     printed without the prefix, so that it is easier to see the unique part
+ *     of the test name. If NULL, no prefix processing is done
+ * @tests: List of tests to run
+ * @count: Number of tests to run
+ * @select_name: Name of a single test to run (from the list provided). If NULL
+ *     then all tests are run
+ * @return 0 if all tests passed, -1 if any failed
+ */
+int ut_run_list(const char *name, const char *prefix, struct unit_test *tests,
+               int count, const char *select_name);
+
 #endif

diff --git a/test/Makefile b/test/Makefile
index 932e51738312e67f10aa3d9167dd005566d776d1..5cd284e322e099af8a9a7d2a5364e7289d1a9e58 100644 (file)
--- a/test/Makefile
+++ b/test/Makefile
@@ -2,6 +2,8 @@
 #
 # (C) Copyright 2012 The Chromium Authors
 
+obj-y += test-main.o
+
 ifneq ($(CONFIG_$(SPL_)BLOBLIST),)
 obj-$(CONFIG_$(SPL_)CMDLINE) += bloblist.o
 obj-$(CONFIG_$(SPL_)CMDLINE) += bootm.o

diff --git a/test/cmd_ut.c b/test/cmd_ut.c
index 8f3089890ea7462698f048d64462f6e43144cb4b..157f6aa976769dcb0454662aae3eb9f2f39108c8 100644 (file)
--- a/test/cmd_ut.c
+++ b/test/cmd_ut.c
@@ -9,6 +9,7 @@
 #include <console.h>
 #include <test/suites.h>
 #include <test/test.h>
+#include <test/ut.h>
 
 static int do_ut_all(struct cmd_tbl *cmdtp, int flag, int argc,
                     char *const argv[]);
@@ -17,41 +18,12 @@ int cmd_ut_category(const char *name, const char *prefix,
                    struct unit_test *tests, int n_ents,
                    int argc, char *const argv[])
 {
-       struct unit_test_state uts = { .fail_count = 0 };
-       struct unit_test *test;
-       int prefix_len = prefix ? strlen(prefix) : 0;
+       int ret;
 
-       if (argc == 1)
-               printf("Running %d %s tests\n", n_ents, name);
+       ret = ut_run_list(name, prefix, tests, n_ents,
+                         argc > 1 ? argv[1] : NULL);
 
-       for (test = tests; test < tests + n_ents; test++) {
-               const char *test_name = test->name;
-
-               /* Remove the prefix */
-               if (prefix && !strncmp(test_name, prefix, prefix_len))
-                       test_name += prefix_len;
-
-               if (argc > 1 && strcmp(argv[1], test_name))
-                       continue;
-               printf("Test: %s\n", test->name);
-
-               if (test->flags & UT_TESTF_CONSOLE_REC) {
-                       int ret = console_record_reset_enable();
-
-                       if (ret) {
-                               printf("Skipping: Console recording disabled\n");
-                               continue;
-                       }
-               }
-
-               uts.start = mallinfo();
-
-               test->func(&uts);
-       }
-
-       printf("Failures: %d\n", uts.fail_count);
-
-       return uts.fail_count ? CMD_RET_FAILURE : 0;
+       return ret ? CMD_RET_FAILURE : 0;
 }
 
 static struct cmd_tbl cmd_ut_sub[] = {

diff --git a/test/test-main.c b/test/test-main.c
new file mode 100644 (file)
index 0000000..376e7eb
--- /dev/null
+++ b/test/test-main.c
@@ -0,0 +1,66 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright 2021 Google LLC
+ * Written by Simon Glass <sjg@chromium.org>
+ */
+
+#include <common.h>
+#include <console.h>
+#include <test/test.h>
+
+int ut_run_tests(struct unit_test_state *uts, const char *prefix,
+                struct unit_test *tests, int count, const char *select_name)
+{
+       struct unit_test *test;
+       int prefix_len = prefix ? strlen(prefix) : 0;
+       int found = 0;
+
+       for (test = tests; test < tests + count; test++) {
+               const char *test_name = test->name;
+
+               /* Remove the prefix */
+               if (prefix && !strncmp(test_name, prefix, prefix_len))
+                       test_name += prefix_len;
+
+               if (select_name && strcmp(select_name, test_name))
+                       continue;
+               printf("Test: %s\n", test_name);
+               found++;
+
+               if (test->flags & UT_TESTF_CONSOLE_REC) {
+                       int ret = console_record_reset_enable();
+
+                       if (ret) {
+                               printf("Skipping: Console recording disabled\n");
+                               continue;
+                       }
+               }
+
+               uts->start = mallinfo();
+
+               test->func(uts);
+       }
+       if (select_name && !found)
+               return -ENOENT;
+
+       return uts->fail_count ? -EBADF : 0;
+}
+
+int ut_run_list(const char *category, const char *prefix,
+               struct unit_test *tests, int count, const char *select_name)
+{
+       struct unit_test_state uts = { .fail_count = 0 };
+       int ret;
+
+       if (!select_name)
+               printf("Running %d %s tests\n", count, category);
+
+       ret = ut_run_tests(&uts, prefix, tests, count, select_name);
+
+       if (ret == -ENOENT)
+               printf("Test '%s' not found\n", select_name);
+       else
+               printf("Failures: %d\n", uts.fail_count);
+
+       return ret;
+}