[v3,0/6] kunit: Add macros to help write more complex tests

Message

Michal Wajdeczko Aug. 29, 2024, 6:13 p.m. UTC

v1: https://groups.google.com/g/kunit-dev/c/f4LIMLyofj8
v2: make it more complex and attempt to be thread safe
    s/FIXED_STUB/GLOBAL_STUB (David, Lucas)
    make it little more thread safe (Rae, David)
    wait until stub call finishes before test end (David)
    wait until stub call finishes before changing stub (David)
    allow stub deactivation (Rae)
    prefer kunit log (David)
    add simple selftest (Michal)
    also introduce ONLY_IF_KUNIT macro (Michal)
v3: include example for DECLARE_IF_KUNIT (Lucas)
    rename s/ONLY_IF_KUNIT/VALUE_IF_KUNIT (Michal)
    and add simple usage example for it (Rae)
    fix s/fixed/global in comments (Lucas)
    improve stub sanitize flow (Lucas, Michal)
    reformat kernel-doc for better output (Michal)

Test outputs:

    $ tools/testing/kunit/kunit.py run *example*.*global* \
        --kunitconfig lib/kunit/.kunitconfig --raw_output

    KTAP version 1
    1..1
    # example: initializing suite
    KTAP version 1
    # Subtest: example
    # module: kunit_example_test
    1..1
    # example_global_stub_test: initializing
    # example_global_stub_test: add_two: redirecting to subtract_one
    # example_global_stub_test: add_two: redirecting to subtract_one
    # example_global_stub_test: cleaning up
    ok 1 example_global_stub_test
    # example: exiting suite
    ok 1 example

    $ tools/testing/kunit/kunit.py run *global*.*global* \
        --kunitconfig lib/kunit/.kunitconfig --raw_output

    KTAP version 1
    1..1
        KTAP version 1
        # Subtest: kunit_global_stub
        # module: kunit_test
        1..4
        # kunit_global_stub_test_activate: real_void_func: redirecting to replacement_void_func
        # kunit_global_stub_test_activate: real_func: redirecting to replacement_func
        # kunit_global_stub_test_activate: real_func: redirecting to replacement_func
        # kunit_global_stub_test_activate: real_func: redirecting to other_replacement_func
        # kunit_global_stub_test_activate: real_func: redirecting to other_replacement_func
        # kunit_global_stub_test_activate: real_func: redirecting to super_replacement_func
        # kunit_global_stub_test_activate: real_func: redirecting to super_replacement_func
        ok 1 kunit_global_stub_test_activate
        ok 2 kunit_global_stub_test_deactivate
        # kunit_global_stub_test_slow_deactivate: real_func: redirecting to slow_replacement_func
        # kunit_global_stub_test_slow_deactivate: real_func: redirecting to slow_replacement_func
        # kunit_global_stub_test_slow_deactivate: waiting for slow_replacement_func
        # kunit_global_stub_test_slow_deactivate.speed: slow
        ok 3 kunit_global_stub_test_slow_deactivate
        # kunit_global_stub_test_slow_replace: real_func: redirecting to slow_replacement_func
        # kunit_global_stub_test_slow_replace: real_func: redirecting to slow_replacement_func
        # kunit_global_stub_test_slow_replace: waiting for slow_replacement_func
        # kunit_global_stub_test_slow_replace: real_func: redirecting to other_replacement_func
        # kunit_global_stub_test_slow_replace.speed: slow
        ok 4 kunit_global_stub_test_slow_replace
    # kunit_global_stub: pass:4 fail:0 skip:0 total:4
    # Totals: pass:4 fail:0 skip:0 total:4
    ok 1 kunit_global_stub

Cc: Rae Moar <[e-mail]>
Cc: David Gow <[e-mail]>
Cc: Lucas De Marchi <[e-mail]>

Michal Wajdeczko (6):
  kunit: Introduce kunit_is_running()
  kunit: Add macro to conditionally expose declarations to tests
  kunit: Add macro to conditionally expose expressions to tests
  kunit: Allow function redirection outside of the KUnit thread
  kunit: Add example with alternate function redirection method
  kunit: Add some selftests for global stub redirection macros

 include/kunit/static_stub.h    | 158 ++++++++++++++++++++
 include/kunit/test-bug.h       |  12 +-
 include/kunit/visibility.h     |  40 ++++++
 lib/kunit/kunit-example-test.c |  67 +++++++++
 lib/kunit/kunit-test.c         | 254 ++++++++++++++++++++++++++++++++-
 lib/kunit/static_stub.c        |  50 +++++++
 6 files changed, 578 insertions(+), 3 deletions(-)