test: Add some tests for kconfig.h
authorSimon Glass <sjg@chromium.org>
Mon, 1 Aug 2022 13:57:59 +0000 (07:57 -0600)
committerTom Rini <trini@konsulko.com>
Wed, 10 Aug 2022 17:38:30 +0000 (13:38 -0400)
The macros in this file are a little confusing and we currently have no
tests to check that they work as expected.

Add some tests which check the macros in C code. Add a few tests which
check that the build errors are generated correctly too, using buildman's
-a option.

Signed-off-by: Simon Glass <sjg@chromium.org>
test/Kconfig
test/Makefile
test/lib/Kconfig [new file with mode: 0644]
test/lib/Makefile
test/lib/kconfig.c [new file with mode: 0644]
test/lib/kconfig_spl.c [new file with mode: 0644]
test/py/tests/test_kconfig.py [new file with mode: 0644]

index 9b283a5..a6b463e 100644 (file)
@@ -20,7 +20,7 @@ config SPL_UNIT_TEST
 config UT_LIB
        bool "Unit tests for library functions"
        depends on UNIT_TEST
-       default y
+       default y if !SANDBOX_VPL
        help
          Enables the 'ut lib' command which tests library functions like
          memcat(), memcyp(), memmove() and ASN1 compiler/decoder.
@@ -99,5 +99,6 @@ config UT_UNICODE
 
 source "test/dm/Kconfig"
 source "test/env/Kconfig"
+source "test/lib/Kconfig"
 source "test/optee/Kconfig"
 source "test/overlay/Kconfig"
index 1dfd567..1787736 100644 (file)
@@ -17,6 +17,9 @@ obj-$(CONFIG_$(SPL_)CMDLINE) += command_ut.o
 obj-$(CONFIG_$(SPL_)UT_COMPRESSION) += compression.o
 obj-y += dm/
 obj-$(CONFIG_FUZZ) += fuzz/
+ifndef CONFIG_SANDBOX_VPL
+obj-$(CONFIG_UNIT_TEST) += lib/
+endif
 obj-$(CONFIG_$(SPL_)CMDLINE) += print_ut.o
 obj-$(CONFIG_$(SPL_)CMDLINE) += str_ut.o
 obj-$(CONFIG_UT_TIME) += time_ut.o
@@ -25,7 +28,6 @@ obj-y += ut.o
 ifeq ($(CONFIG_SPL_BUILD),)
 obj-$(CONFIG_UNIT_TEST) += boot/
 obj-$(CONFIG_UNIT_TEST) += common/
-obj-$(CONFIG_UNIT_TEST) += lib/
 obj-y += log/
 obj-$(CONFIG_$(SPL_)UT_UNICODE) += unicode_ut.o
 endif
diff --git a/test/lib/Kconfig b/test/lib/Kconfig
new file mode 100644 (file)
index 0000000..dbb03e4
--- /dev/null
@@ -0,0 +1,23 @@
+# SPDX-License-Identifier: GPL-2.0+
+# Copyright 2022 Google LLC
+
+if SANDBOX
+
+config TEST_KCONFIG
+       bool "Enable detection of Kconfig macro errors"
+       help
+         This is used to test that the IF_ENABLED_INT() macro causes a build error
+         if the value is used when the CONFIG Is not enabled.
+
+config TEST_KCONFIG_ENABLE
+       bool "Option to enable"
+       help
+         This is the option that controls whether the value is present.
+
+config TEST_KCONFIG_VALUE
+       int "Value associated with the option"
+       depends on TEST_KCONFIG_ENABLE
+       help
+         This is the value whgch is present if TEST_KCONFIG_ENABLE is enabled.
+
+endif # SANDBOX
index d244bb4..7e7922f 100644 (file)
@@ -2,11 +2,13 @@
 #
 # (C) Copyright 2018
 # Mario Six, Guntermann & Drunck GmbH, mario.six@gdsys.cc
+ifeq ($(CONFIG_SPL_BUILD),)
 obj-y += cmd_ut_lib.o
 obj-y += abuf.o
 obj-$(CONFIG_EFI_LOADER) += efi_device_path.o
 obj-$(CONFIG_EFI_SECURE_BOOT) += efi_image_region.o
 obj-y += hexdump.o
+obj-$(CONFIG_SANDBOX) += kconfig.o
 obj-y += lmb.o
 obj-y += longjmp.o
 obj-$(CONFIG_CONSOLE_RECORD) += test_print.o
@@ -19,3 +21,6 @@ obj-$(CONFIG_UT_LIB_RSA) += rsa.o
 obj-$(CONFIG_AES) += test_aes.o
 obj-$(CONFIG_GETOPT) += getopt.o
 obj-$(CONFIG_UT_LIB_CRYPT) += test_crypt.o
+else
+obj-$(CONFIG_SANDBOX) += kconfig_spl.o
+endif
diff --git a/test/lib/kconfig.c b/test/lib/kconfig.c
new file mode 100644 (file)
index 0000000..472d2c5
--- /dev/null
@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Test of linux/kconfig.h macros
+ *
+ * Copyright 2022 Google LLC
+ * Written by Simon Glass <sjg@chromium.org>
+ */
+
+#include <common.h>
+#include <test/lib.h>
+#include <test/test.h>
+#include <test/ut.h>
+
+static int lib_test_is_enabled(struct unit_test_state *uts)
+{
+       ulong val;
+
+       ut_asserteq(1, IS_ENABLED(CONFIG_CMDLINE))
+       ut_asserteq(0, IS_ENABLED(CONFIG__UNDEFINED))
+
+       ut_asserteq(1, CONFIG_IS_ENABLED(CMDLINE))
+       ut_asserteq(0, CONFIG_IS_ENABLED(OF_PLATDATA))
+       ut_asserteq(0, CONFIG_IS_ENABLED(_UNDEFINED))
+
+       ut_asserteq(0xc000,
+                   IF_ENABLED_INT(CONFIG_BLOBLIST_FIXED, CONFIG_BLOBLIST_ADDR));
+       ut_asserteq(0xc000,
+                   CONFIG_IF_ENABLED_INT(BLOBLIST_FIXED, BLOBLIST_ADDR));
+
+       /*
+        * This fails if CONFIG_TEST_KCONFIG_ENABLE is not enabled, since the
+        * value is used. Disable for SPL so that the errors in kconfig_spl.c
+        * are detected, since otherwise a build error when building U-Boot may
+        * cause SPL to not be built.
+        */
+       if (!IS_ENABLED(CONFIG_SANDBOX_SPL) &&
+           IS_ENABLED(CONFIG_TEST_KCONFIG)) {
+               val = IF_ENABLED_INT(CONFIG_TEST_KCONFIG_ENABLE,
+                                    CONFIG_TEST_KCONFIG_VALUE);
+               printf("value %ld\n", val);
+       }
+
+       /*
+        * This fails if CONFIG_TEST_KCONFIG_ENABLE is not enabled, since the
+        * value is used. Disable for SPL so that the errors in kconfig_spl.c
+        * are detected, since otherwise a build error when building U-Boot may
+        * cause SPL to not be built.
+        */
+       if (!IS_ENABLED(CONFIG_SANDBOX_SPL) &&
+           CONFIG_IS_ENABLED(TEST_KCONFIG)) {
+               val = CONFIG_IF_ENABLED_INT(TEST_KCONFIG_ENABLE,
+                                           TEST_KCONFIG_VALUE);
+               printf("value2 %ld\n", val);
+       }
+
+       return 0;
+}
+LIB_TEST(lib_test_is_enabled, 0);
diff --git a/test/lib/kconfig_spl.c b/test/lib/kconfig_spl.c
new file mode 100644 (file)
index 0000000..c89ceae
--- /dev/null
@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Test of linux/kconfig.h macros for SPL
+ *
+ * Copyright 2022 Google LLC
+ * Written by Simon Glass <sjg@chromium.org>
+ */
+
+#include <common.h>
+#include <test/lib.h>
+#include <test/test.h>
+#include <test/ut.h>
+
+static int lib_test_spl_is_enabled(struct unit_test_state *uts)
+{
+       ulong val;
+
+       ut_asserteq(0, CONFIG_IS_ENABLED(CMDLINE))
+       ut_asserteq(1, CONFIG_IS_ENABLED(OF_PLATDATA))
+       ut_asserteq(0, CONFIG_IS_ENABLED(_UNDEFINED))
+
+       /*
+        * This fails if CONFIG_TEST_KCONFIG_ENABLE is not enabled, since the
+        * value is used.
+        */
+       if (IS_ENABLED(CONFIG_TEST_KCONFIG)) {
+               val = IF_ENABLED_INT(CONFIG_TEST_KCONFIG_ENABLE,
+                                    CONFIG_TEST_KCONFIG_VALUE);
+               printf("value %ld\n", val);
+       }
+
+       /*
+        * This fails if CONFIG_TEST_KCONFIG_ENABLE is not enabled, since the
+        * value is used.
+        */
+       if (CONFIG_IS_ENABLED(TEST_KCONFIG)) {
+               val = CONFIG_IF_ENABLED_INT(TEST_KCONFIG_ENABLE,
+                                           TEST_KCONFIG_VALUE);
+               printf("value2 %ld\n", val);
+       }
+
+       return 0;
+}
+LIB_TEST(lib_test_spl_is_enabled, 0);
diff --git a/test/py/tests/test_kconfig.py b/test/py/tests/test_kconfig.py
new file mode 100644 (file)
index 0000000..0b9e6bc
--- /dev/null
@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2022 Google LLC
+# Written by Simon Glass <sjg@chromium.org>
+
+import pytest
+
+import u_boot_utils as util
+
+# This is needed for Azure, since the default '..' directory is not writeable
+TMPDIR = '/tmp/test_kconfig'
+
+@pytest.mark.slow
+@pytest.mark.boardspec('sandbox')
+def test_kconfig(u_boot_console):
+    """Test build failures when IF_ENABLED_INT() option is not enabled"""
+    cons = u_boot_console
+
+    # This detects build errors in test/lib/kconfig.c
+    out = util.run_and_log(
+        cons, ['./tools/buildman/buildman', '-m', '--board', 'sandbox',
+               '-a', 'TEST_KCONFIG', '-o', TMPDIR], ignore_errors=True)
+    assert 'invalid_use_of_IF_ENABLED_INT' in out
+    assert 'invalid_use_of_CONFIG_IF_ENABLED_INT' in out
+
+@pytest.mark.slow
+@pytest.mark.boardspec('sandbox_spl')
+def test_kconfig_spl(u_boot_console):
+    """Test build failures when IF_ENABLED_INT() option is not enabled"""
+    cons = u_boot_console
+
+    # This detects build errors in test/lib/kconfig_spl.c
+    out = util.run_and_log(
+        cons, ['./tools/buildman/buildman', '-m', '--board', 'sandbox_spl',
+               '-a', 'TEST_KCONFIG', '-o', TMPDIR], ignore_errors=True)
+    assert 'invalid_use_of_IF_ENABLED_INT' in out
+
+    # There is no CONFIG_SPL_TEST_KCONFIG, so the CONFIG_IF_ENABLED_INT()
+    # line should not generate an error
+    assert 'invalid_use_of_CONFIG_IF_ENABLED_INT' not in out