test: log functions with CONFIG_LOG=n

If CONFIG_LOG=n, we still expect output for log_err(), log_warning(),
log_notice(), log_info() and in case of DEBUG=1 also for log_debug().

Provide unit tests verifying this.

The tests depend on:

	CONFIG_CONSOLE_RECORD=y
	CONFIG_LOG=n
	CONFIG_UT_LOG=y

It may be necessary to increase the value of CONFIG_SYS_MALLOC_F_LEN to
accommodate CONFIG_CONSOLE_RECORD=y.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Simon Glass <sjg@chromium.org>

diff --git a/MAINTAINERS b/MAINTAINERS
index 0bafe5cabca8aee398479e47228c971a9a585a95..7ac7e21ba17a648f676b0d56dd97adb47928a58a 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -656,7 +656,7 @@ S:  Maintained
 T:     git https://gitlab.denx.de/u-boot/u-boot.git
 F:     common/log*
 F:     cmd/log.c
-F:     test/log/log_test.c
+F:     test/log/
 F:     test/py/tests/test_log.py
 
 MALI DISPLAY PROCESSORS

diff --git a/include/test/log.h b/include/test/log.h
new file mode 100644 (file)
index 0000000..c661cde
--- /dev/null
+++ b/include/test/log.h
@@ -0,0 +1,16 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Copyright (c) 2020, Heinrich Schuchardt <xypron.glpk@gmx.de>
+ *
+ * Tests for logging functions
+ */
+
+#ifndef __TEST_LOG_H__
+#define __TEST_LOG_H__
+
+#include <test/test.h>
+
+/* Declare a new logging test */
+#define LOG_TEST(_name) UNIT_TEST(_name, 0, log_test)
+
+#endif /* __TEST_LOG_H__ */

diff --git a/include/test/suites.h b/include/test/suites.h
index 0748185eaf75b05011ccc52b8474383e8ed298fe..39ad81a90f9dd6ef4b6a5e2daacc71adc6f0c12a 100644 (file)
--- a/include/test/suites.h
+++ b/include/test/suites.h
@@ -30,6 +30,7 @@ int do_ut_compression(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[]);
 int do_ut_dm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 int do_ut_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 int do_ut_lib(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
+int do_ut_log(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 int do_ut_optee(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 int do_ut_overlay(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 int do_ut_time(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);

diff --git a/test/Kconfig b/test/Kconfig
index 0157e0b060adcb71baffbf0a6af3ca3969e7a5bd..28704a25b613368264b1ee4e45b61bb0b22e1b19 100644 (file)
--- a/test/Kconfig
+++ b/test/Kconfig
@@ -40,6 +40,15 @@ config UT_LIB_RSA
 
 endif
 
+config UT_LOG
+       bool "Unit tests for logging functions"
+       depends on UNIT_TEST
+       default y
+       help
+         Enables the 'ut log' command which tests logging functions like
+         log_err().
+         See also CONFIG_LOG_TEST which provides the 'log test' command.
+
 config UT_TIME
        bool "Unit tests for time functions"
        depends on UNIT_TEST

diff --git a/test/Makefile b/test/Makefile
index 2fe41f489c3b7814710b26b303c12231769981a1..2971d0d87fb28c7eec4b2e64d70123742469c144 100644 (file)
--- a/test/Makefile
+++ b/test/Makefile
@@ -10,5 +10,5 @@ obj-$(CONFIG_SANDBOX) += compression.o
 obj-$(CONFIG_SANDBOX) += print_ut.o
 obj-$(CONFIG_UT_TIME) += time_ut.o
 obj-$(CONFIG_UT_UNICODE) += unicode_ut.o
-obj-$(CONFIG_$(SPL_)LOG) += log/
+obj-y += log/
 obj-$(CONFIG_UNIT_TEST) += lib/

diff --git a/test/cmd_ut.c b/test/cmd_ut.c
index a3a9d49f7ec8a71bf34550ec8e16c2534ef69940..7fdcdbb1a63760beada556b87abee4a85c4ea7a1 100644 (file)
--- a/test/cmd_ut.c
+++ b/test/cmd_ut.c
@@ -60,6 +60,9 @@ static cmd_tbl_t cmd_ut_sub[] = {
 #ifdef CONFIG_UT_LIB
        U_BOOT_CMD_MKENT(lib, CONFIG_SYS_MAXARGS, 1, do_ut_lib, "", ""),
 #endif
+#ifdef CONFIG_UT_LOG
+       U_BOOT_CMD_MKENT(log, CONFIG_SYS_MAXARGS, 1, do_ut_log, "", ""),
+#endif
 #ifdef CONFIG_UT_TIME
        U_BOOT_CMD_MKENT(time, CONFIG_SYS_MAXARGS, 1, do_ut_time, "", ""),
 #endif
@@ -125,6 +128,9 @@ static char ut_help_text[] =
 #ifdef CONFIG_UT_LIB
        "ut lib [test-name] - test library functions\n"
 #endif
+#ifdef CONFIG_UT_LOG
+       "ut log [test-name] - test logging functions\n"
+#endif
 #ifdef CONFIG_UT_OPTEE
        "ut optee [test-name]\n"
 #endif

diff --git a/test/log/Makefile b/test/log/Makefile
index e0d0a4745f12b65e7e3a153ba749b957ad92d7a6..98178f5e2b32e1935550822c3e44dbe9d0b38d0c 100644 (file)
--- a/test/log/Makefile
+++ b/test/log/Makefile
@@ -3,3 +3,13 @@
 # Copyright (c) 2017 Google, Inc
 
 obj-$(CONFIG_LOG_TEST) += log_test.o
+
+ifdef CONFIG_UT_LOG
+
+obj-y += test-main.o
+
+ifndef CONFIG_LOG
+obj-$(CONFIG_CONSOLE_RECORD) += nolog_test.o
+endif
+
+endif # CONFIG_UT_LOG

diff --git a/test/log/nolog_test.c b/test/log/nolog_test.c
new file mode 100644 (file)
index 0000000..8461952
--- /dev/null
+++ b/test/log/nolog_test.c
@@ -0,0 +1,135 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (c) 2020, Heinrich Schuchardt <xypron.glpk@gmx.de>
+ *
+ * Logging function tests for CONFIG_LOG=n.
+ */
+
+/* Needed for testing log_debug() */
+#define DEBUG 1
+
+#include <common.h>
+#include <console.h>
+#include <test/log.h>
+#include <test/test.h>
+#include <test/suites.h>
+#include <test/ut.h>
+
+DECLARE_GLOBAL_DATA_PTR;
+
+#define BUFFSIZE 32
+
+static int nolog_test_log_err(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       log_err("testing %s\n", "log_err");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_line(uts, "testing log_err"));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_log_err);
+
+static int nolog_test_log_warning(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       log_warning("testing %s\n", "log_warning");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_line(uts, "testing log_warning"));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_log_warning);
+
+static int nolog_test_log_notice(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       log_notice("testing %s\n", "log_notice");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_line(uts, "testing log_notice"));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_log_notice);
+
+static int nolog_test_log_info(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       log_err("testing %s\n", "log_info");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_line(uts, "testing log_info"));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_log_info);
+
+#undef _DEBUG
+#define _DEBUG 0
+static int nolog_test_nodebug(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       debug("testing %s\n", "debug");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_nodebug);
+
+static int nolog_test_log_nodebug(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       log_debug("testing %s\n", "log_debug");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assert(!strcmp(buf, ""));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_log_nodebug);
+
+#undef _DEBUG
+#define _DEBUG 1
+static int nolog_test_debug(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       debug("testing %s\n", "debug");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_line(uts, "testing debug"));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_debug);
+
+static int nolog_test_log_debug(struct unit_test_state *uts)
+{
+       char buf[BUFFSIZE];
+
+       memset(buf, 0, BUFFSIZE);
+       console_record_reset_enable();
+       log_debug("testing %s\n", "log_debug");
+       gd->flags &= ~GD_FLG_RECORD;
+       ut_assertok(ut_check_console_line(uts, "testing log_debug"));
+       ut_assertok(ut_check_console_end(uts));
+       return 0;
+}
+LOG_TEST(nolog_test_log_debug);

diff --git a/test/log/test-main.c b/test/log/test-main.c
new file mode 100644 (file)
index 0000000..855de47
--- /dev/null
+++ b/test/log/test-main.c
@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (c) 2020, Heinrich Schuchardt <xypron.glpk@gmx.de>
+ *
+ * Logging function tests.
+ */
+
+#include <common.h>
+#include <console.h>
+#include <test/log.h>
+#include <test/suites.h>
+
+int do_ut_log(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+{
+       struct unit_test *tests = ll_entry_start(struct unit_test, log_test);
+       const int n_ents = ll_entry_count(struct unit_test, log_test);
+
+       return cmd_ut_category("log", "log_test_",
+                              tests, n_ents, argc, argv);
+}