kunit: Add "hooks" to call into KUnit when it's built as a module
authorDavid Gow <davidgow@google.com>
Sat, 28 Jan 2023 07:10:07 +0000 (15:10 +0800)
committerShuah Khan <skhan@linuxfoundation.org>
Wed, 8 Feb 2023 21:26:25 +0000 (14:26 -0700)
commit7170b7ed6acbde523c5d362c8978c60df4c30f30
tree73b521ca96b369ea15968b78b6f80e8d1bdf8f64
parent2dc9d6ca52a47fd00822e818c2a5e48fc5fbbd53
kunit: Add "hooks" to call into KUnit when it's built as a module

KUnit has several macros and functions intended for use from non-test
code. These hooks, currently the kunit_get_current_test() and
kunit_fail_current_test() macros, didn't work when CONFIG_KUNIT=m.

In order to support this case, the required functions and static data
need to be available unconditionally, even when KUnit itself is not
built-in. The new 'hooks.c' file is therefore always included, and has
both the static key required for kunit_get_current_test(), and a table
of function pointers in struct kunit_hooks_table. This is filled in with
the real implementations by kunit_install_hooks(), which is kept in
hooks-impl.h and called when the kunit module is loaded.

This can  be extended for future features which require similar
"hook" behaviour, such as static stubs, by simply adding new entries to
the struct, and the appropriate code to set them.

Fixed white-space errors during commit:
Shuah Khan <skhan@linuxfoundation.org>

Resolved merge conflicts with:
db105c37a4d6 ("kunit: Export kunit_running()")
This patch supersedes the above.
Shuah Khan <skhan@linuxfoundation.org>

Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Rae Moar <rmoar@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/kunit/usage.rst
include/kunit/test-bug.h
lib/Makefile
lib/kunit/Makefile
lib/kunit/hooks-impl.h [new file with mode: 0644]
lib/kunit/hooks.c [new file with mode: 0644]
lib/kunit/test.c