According to KTAP specification[1], results should always start from a
header that provides a TAP protocol version, followed by a test plan with
a count of items to be executed. That pattern should be followed at each
nesting level. In the current implementation of the top-most, i.e., test
suite level, those rules apply only for test suites built into the kernel,
executed and reported on boot. Results submitted to dmesg from kunit test
modules loaded later are missing those top-level headers.
As a consequence, if a kunit test module provides more than one test suite
then, without the top level test plan, external tools that are parsing
dmesg for kunit test output are not able to tell how many test suites
should be expected and whether to continue parsing after complete output
from the first test suite is collected.
Submit the top-level headers also from the kunit test module notifier
initialization callback.
v2: Use kunit_exec_run_tests() (Mauro, Rae), but prevent it from
emitting the headers when called on load of non-test modules.
[1] https://docs.kernel.org/dev-tools/ktap.html#
Signed-off-by: Janusz Krzysztofik <[email protected]>
Cc: Mauro Carvalho Chehab <[email protected]>
Cc: Rae Moar <[email protected]>
---
include/kunit/test.h | 8 ++++++++
lib/kunit/executor.c | 42 +++++++++++++++++++++++-------------------
lib/kunit/test.c | 6 +++++-
3 files changed, 36 insertions(+), 20 deletions(-)
diff --git a/include/kunit/test.h b/include/kunit/test.h
index 011e0d6bb506c..3d002e6b252f2 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -256,6 +256,12 @@ struct kunit_suite {
int suite_init_err;
};
+/* Stores an array of suites, end points one past the end */
+struct kunit_suite_set {
+ struct kunit_suite * const *start;
+ struct kunit_suite * const *end;
+};
+
/**
* struct kunit - represents a running instance of a test.
*
@@ -317,6 +323,8 @@ int __kunit_test_suites_init(struct kunit_suite * const * const suites, int num_
void __kunit_test_suites_exit(struct kunit_suite **suites, int num_suites);
+void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin);
+
#if IS_BUILTIN(CONFIG_KUNIT)
int kunit_run_all_tests(void);
#else
diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c
index 5b5bed1efb931..bd6f3b5dc47f7 100644
--- a/lib/kunit/executor.c
+++ b/lib/kunit/executor.c
@@ -104,13 +104,7 @@ kunit_filter_glob_tests(const struct kunit_suite *const suite, const char *test_
static char *kunit_shutdown;
core_param(kunit_shutdown, kunit_shutdown, charp, 0644);
-/* Stores an array of suites, end points one past the end */
-struct suite_set {
- struct kunit_suite * const *start;
- struct kunit_suite * const *end;
-};
-
-static void kunit_free_suite_set(struct suite_set suite_set)
+static void kunit_free_suite_set(struct kunit_suite_set suite_set)
{
struct kunit_suite * const *suites;
@@ -119,16 +113,17 @@ static void kunit_free_suite_set(struct suite_set suite_set)
kfree(suite_set.start);
}
-static struct suite_set kunit_filter_suites(const struct suite_set *suite_set,
- const char *filter_glob,
- char *filters,
- char *filter_action,
- int *err)
+static struct kunit_suite_set
+kunit_filter_suites(const struct kunit_suite_set *suite_set,
+ const char *filter_glob,
+ char *filters,
+ char *filter_action,
+ int *err)
{
int i, j, k;
int filter_count = 0;
struct kunit_suite **copy, *filtered_suite, *new_filtered_suite;
- struct suite_set filtered;
+ struct kunit_suite_set filtered;
struct kunit_glob_filter parsed_glob;
struct kunit_attr_filter *parsed_filters;
@@ -219,17 +214,24 @@ static void kunit_handle_shutdown(void)
}
-static void kunit_exec_run_tests(struct suite_set *suite_set)
+#endif
+
+void kunit_exec_run_tests(struct kunit_suite_set *suite_set, bool builtin)
{
size_t num_suites = suite_set->end - suite_set->start;
- pr_info("KTAP version 1\n");
- pr_info("1..%zu\n", num_suites);
+ if (builtin || num_suites) {
+ pr_info("KTAP version 1\n");
+ pr_info("1..%zu\n", num_suites);
+ }
__kunit_test_suites_init(suite_set->start, num_suites);
}
-static void kunit_exec_list_tests(struct suite_set *suite_set, bool include_attr)
+#if IS_BUILTIN(CONFIG_KUNIT)
+
+static void kunit_exec_list_tests(struct kunit_suite_set *suite_set,
+ bool include_attr)
{
struct kunit_suite * const *suites;
struct kunit_case *test_case;
@@ -254,7 +256,9 @@ static void kunit_exec_list_tests(struct suite_set *suite_set, bool include_attr
int kunit_run_all_tests(void)
{
- struct suite_set suite_set = {__kunit_suites_start, __kunit_suites_end};
+ struct kunit_suite_set suite_set = {
+ __kunit_suites_start, __kunit_suites_end,
+ };
int err = 0;
if (!kunit_enabled()) {
pr_info("kunit: disabled\n");
@@ -271,7 +275,7 @@ int kunit_run_all_tests(void)
}
if (!action_param)
- kunit_exec_run_tests(&suite_set);
+ kunit_exec_run_tests(&suite_set, true);
else if (strcmp(action_param, "list") == 0)
kunit_exec_list_tests(&suite_set, false);
else if (strcmp(action_param, "list_attr") == 0)
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index cb9797fa6303f..8b2808068497f 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -736,7 +736,11 @@ EXPORT_SYMBOL_GPL(__kunit_test_suites_exit);
#ifdef CONFIG_MODULES
static void kunit_module_init(struct module *mod)
{
- __kunit_test_suites_init(mod->kunit_suites, mod->num_kunit_suites);
+ struct kunit_suite_set suite_set = {
+ mod->kunit_suites, mod->kunit_suites + mod->num_kunit_suites,
+ };
+
+ kunit_exec_run_tests(&suite_set, false);
}
static void kunit_module_exit(struct module *mod)
--
2.41.0
Hi Janusz,
kernel test robot noticed the following build errors:
[auto build test ERROR on 5a175d369c702ce08c9feb630125c9fc7a9e1370]
url: https://github.com/intel-lab-lkp/linux/commits/Janusz-Krzysztofik/kunit-Report-the-count-of-test-suites-in-a-module/20230805-065602
base: 5a175d369c702ce08c9feb630125c9fc7a9e1370
patch link: https://lore.kernel.org/r/20230804225220.8005-6-janusz.krzysztofik%40linux.intel.com
patch subject: [PATCH v4 1/3] kunit: Report the count of test suites in a module
config: loongarch-allyesconfig (https://download.01.org/0day-ci/archive/20230805/[email protected]/config)
compiler: loongarch64-linux-gcc (GCC) 12.3.0
reproduce: (https://download.01.org/0day-ci/archive/20230805/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>):
In file included from lib/kunit/executor.c:296:
lib/kunit/executor_test.c: In function 'filter_suites_test':
>> lib/kunit/executor_test.c:46:16: error: variable 'suite_set' has initializer but incomplete type
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
>> lib/kunit/executor_test.c:46:40: error: 'struct suite_set' has no member named 'start'
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~
lib/kunit/executor_test.c:46:48: warning: excess elements in struct initializer
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~
lib/kunit/executor_test.c:46:48: note: (near initialization for 'suite_set')
>> lib/kunit/executor_test.c:46:59: error: 'struct suite_set' has no member named 'end'
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~
lib/kunit/executor_test.c:46:65: warning: excess elements in struct initializer
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^
lib/kunit/executor_test.c:46:65: note: (near initialization for 'suite_set')
>> lib/kunit/executor_test.c:46:26: error: storage size of 'suite_set' isn't known
46 | struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
| ^~~~~~~~~
>> lib/kunit/executor_test.c:47:26: error: storage size of 'got' isn't known
47 | struct suite_set got;
| ^~~
In file included from lib/kunit/executor.c:4:
include/kunit/test.h:797:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
797 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:55:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
55 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
In file included from include/linux/rwsem.h:17,
from include/linux/notifier.h:15,
from include/linux/reboot.h:6,
from lib/kunit/executor.c:3:
include/linux/err.h:70:68: note: expected 'const void *' but argument is of type 'int'
70 | static inline bool __must_check IS_ERR_OR_NULL(__force const void *ptr)
| ~~~~~~~~~~~~^~~
include/kunit/test.h:804:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED'
570 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:804:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:55:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
55 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:804:64: note: (near initialization for '__assertion.value')
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED'
570 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:804:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:55:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
55 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:797:29: warning: passing argument 1 of 'IS_ERR_OR_NULL' makes pointer from integer without a cast [-Wint-conversion]
797 | if (!IS_ERR_OR_NULL(__ptr)) \
| ^~~~~
| |
| int
include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:60:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
60 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/linux/err.h:70:68: note: expected 'const void *' but argument is of type 'int'
70 | static inline bool __must_check IS_ERR_OR_NULL(__force const void *ptr)
| ~~~~~~~~~~~~^~~
include/kunit/test.h:804:64: warning: initialization of 'const void *' from 'int' makes pointer from integer without a cast [-Wint-conversion]
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED'
570 | const struct assert_class __assertion = INITIALIZER; \
| ^~~~~~~~~~~
include/kunit/test.h:804:23: note: in expansion of macro 'KUNIT_INIT_ASSERT'
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~~~~~~~~~~~~~
include/kunit/test.h:1478:9: note: in expansion of macro 'KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION'
1478 | KUNIT_PTR_NOT_ERR_OR_NULL_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1475:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG'
1475 | KUNIT_ASSERT_NOT_ERR_OR_NULL_MSG(test, ptr, NULL)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/executor_test.c:60:9: note: in expansion of macro 'KUNIT_ASSERT_NOT_ERR_OR_NULL'
60 | KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:804:64: note: (near initialization for '__assertion.value')
804 | KUNIT_INIT_ASSERT(.text = #ptr, .value = __ptr), \
| ^~~~~
include/kunit/test.h:570:49: note: in definition of macro '_KUNIT_FAILED'
570 | const struct assert_class __assertion = INITIALIZER; \
vim +/suite_set +46 lib/kunit/executor_test.c
1d71307a6f94df Daniel Latypov 2021-04-20 42
e5857d396f35e5 Daniel Latypov 2022-07-09 43 static void filter_suites_test(struct kunit *test)
1d71307a6f94df Daniel Latypov 2021-04-20 44 {
e5857d396f35e5 Daniel Latypov 2022-07-09 45 struct kunit_suite *subsuite[3] = {NULL, NULL};
e5857d396f35e5 Daniel Latypov 2022-07-09 @46 struct suite_set suite_set = {.start = subsuite, .end = &subsuite[2]};
e5857d396f35e5 Daniel Latypov 2022-07-09 @47 struct suite_set got;
e5857d396f35e5 Daniel Latypov 2022-07-09 48 int err = 0;
1d71307a6f94df Daniel Latypov 2021-04-20 49
a127b154a8f231 Daniel Latypov 2021-09-14 50 subsuite[0] = alloc_fake_suite(test, "suite1", dummy_test_cases);
a127b154a8f231 Daniel Latypov 2021-09-14 51 subsuite[1] = alloc_fake_suite(test, "suite2", dummy_test_cases);
1d71307a6f94df Daniel Latypov 2021-04-20 52
1d71307a6f94df Daniel Latypov 2021-04-20 53 /* Want: suite1, suite2, NULL -> suite2, NULL */
529534e8cba3e6 Rae Moar 2023-07-25 54 got = kunit_filter_suites(&suite_set, "suite2", NULL, NULL, &err);
e5857d396f35e5 Daniel Latypov 2022-07-09 55 KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
e5857d396f35e5 Daniel Latypov 2022-07-09 56 KUNIT_ASSERT_EQ(test, err, 0);
e5857d396f35e5 Daniel Latypov 2022-07-09 57 kfree_at_end(test, got.start);
1d71307a6f94df Daniel Latypov 2021-04-20 58
a127b154a8f231 Daniel Latypov 2021-09-14 59 /* Validate we just have suite2 */
e5857d396f35e5 Daniel Latypov 2022-07-09 60 KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start[0]);
e5857d396f35e5 Daniel Latypov 2022-07-09 61 KUNIT_EXPECT_STREQ(test, (const char *)got.start[0]->name, "suite2");
e5857d396f35e5 Daniel Latypov 2022-07-09 62
e5857d396f35e5 Daniel Latypov 2022-07-09 63 /* Contains one element (end is 1 past end) */
e5857d396f35e5 Daniel Latypov 2022-07-09 64 KUNIT_ASSERT_EQ(test, got.end - got.start, 1);
a127b154a8f231 Daniel Latypov 2021-09-14 65 }
a127b154a8f231 Daniel Latypov 2021-09-14 66
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki