On Tue, Aug 27, 2024 at 12:20:14AM GMT, Michal Wajdeczko wrote:
Add example how to use KUNIT_FIXED_STUB_REDIRECT and compare its
s/FIXED/GLOBAL/
usage with the KUNIT_STATIC_STUB_REDIRECT. Also show how the DECLARE_IF_KUNIT macro could be helpful in declaring test data in the non-test data structures.
Signed-off-by: Michal Wajdeczko michal.wajdeczko@intel.com Reviewed-by: Rae Moar rmoar@google.com #v1 Reviewed-by: David Gow davidgow@google.com #v1
Cc: Daniel Latypov dlatypov@google.com Cc: Lucas De Marchi lucas.demarchi@intel.com
v2: add missing testcase description (Rae) and rebase
lib/kunit/kunit-example-test.c | 67 ++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+)
diff --git a/lib/kunit/kunit-example-test.c b/lib/kunit/kunit-example-test.c index 3056d6bc705d..146935a16883 100644 --- a/lib/kunit/kunit-example-test.c +++ b/lib/kunit/kunit-example-test.c @@ -6,8 +6,10 @@
- Author: Brendan Higgins brendanhiggins@google.com
*/
+#include <linux/workqueue.h> #include <kunit/test.h> #include <kunit/static_stub.h> +#include <kunit/visibility.h>
/*
- This is the most fundamental element of KUnit, the test case. A test case
@@ -221,6 +223,70 @@ static void example_static_stub_using_fn_ptr_test(struct kunit *test) KUNIT_EXPECT_EQ(test, add_one(1), 2); }
+/* This could be a location of various global stub functions. */ +static struct {
- KUNIT_DECLARE_GLOBAL_STUB(add_two, int (*)(int i));
+} stubs;
+/* This is a function we'll replace with stubs. */ +static int add_two(int i) +{
- /* This will trigger the stub if active. */
- KUNIT_STATIC_STUB_REDIRECT(add_two, i);
- KUNIT_GLOBAL_STUB_REDIRECT(stubs.add_two, i);
Nice use of an outer storage so we can give it the same name. IMO this should be encouraged.
- return i + 2;
+}
+struct add_two_async_work {
- struct work_struct work;
- int param;
- int result;
+};
+static void add_two_async_func(struct work_struct *work) +{
- struct add_two_async_work *w = container_of(work, typeof(*w), work);
- w->result = add_two(w->param);
+}
+static int add_two_async(int i) +{
- struct add_two_async_work w = { .param = i };
- INIT_WORK_ONSTACK(&w.work, add_two_async_func);
- schedule_work(&w.work);
- flush_work(&w.work);
- destroy_work_on_stack(&w.work);
- return w.result;
+}
+/*
- This test shows how to use KUNIT_GLOBAL_STUB_REDIRECT and compares its
- usage with the KUNIT_STATIC_STUB_REDIRECT.
- */
+static void example_global_stub_test(struct kunit *test) +{
- /* static stub redirection works only for KUnit thread */
- kunit_activate_static_stub(test, add_two, subtract_one);
- KUNIT_EXPECT_EQ(test, add_two(1), subtract_one(1));
- KUNIT_EXPECT_NE_MSG(test, add_two_async(1), subtract_one(1),
"stub shouldn't be active outside KUnit thread!");- kunit_deactivate_static_stub(test, add_two);
- KUNIT_EXPECT_EQ(test, add_two(1), add_two(1));
- /* fixed stub redirection works for KUnit and other threads */
s/fixed/global/
with those fixes,
Reviewed-by: Lucas De Marchi lucas.demarchi@intel.com
thanks Lucas De Marchi
- kunit_activate_global_stub(test, stubs.add_two, subtract_one);
- KUNIT_EXPECT_EQ(test, add_two(1), subtract_one(1));
- KUNIT_EXPECT_EQ(test, add_two_async(1), subtract_one(1));
- kunit_deactivate_global_stub(test, stubs.add_two);
- KUNIT_EXPECT_EQ(test, add_two(1), add_two(1));
+}
static const struct example_param { int value; } example_params_array[] = { @@ -294,6 +360,7 @@ static struct kunit_case example_test_cases[] = { KUNIT_CASE(example_all_expect_macros_test), KUNIT_CASE(example_static_stub_test), KUNIT_CASE(example_static_stub_using_fn_ptr_test),
- KUNIT_CASE(example_global_stub_test), KUNIT_CASE(example_priv_test), KUNIT_CASE_PARAM(example_params_test, example_gen_params), KUNIT_CASE_SLOW(example_slow_test),
-- 2.43.0