1 .. SPDX-License-Identifier: GPL-2.0
3 ============================
4 Run Tests without kunit_tool
5 ============================
7 If we do not want to use kunit_tool (For example: we want to integrate
8 with other systems, or run tests on real hardware), we can
9 include KUnit in any kernel, read out results, and parse manually.
11 .. note:: KUnit is not designed for use in a production system. It is
12 possible that tests may reduce the stability or security of
18 KUnit tests can run without kunit_tool. This can be useful, if:
20 - We have an existing kernel configuration to test.
21 - Need to run on real hardware (or using an emulator/VM kunit_tool
23 - Wish to integrate with some existing testing systems.
25 KUnit is configured with the ``CONFIG_KUNIT`` option, and individual
26 tests can also be built by enabling their config options in our
27 ``.config``. KUnit tests usually (but don't always) have config options
28 ending in ``_KUNIT_TEST``. Most tests can either be built as a module,
29 or be built into the kernel.
33 We can enable the ``KUNIT_ALL_TESTS`` config option to
34 automatically enable all tests with satisfied dependencies. This is
35 a good way of quickly testing everything applicable to the current
38 Once we have built our kernel (and/or modules), it is simple to run
39 the tests. If the tests are built-in, they will run automatically on the
40 kernel boot. The results will be written to the kernel log (``dmesg``)
43 If the tests are built as modules, they will run when the module is
48 # modprobe example-test
50 The results will appear in TAP format in ``dmesg``.
54 If ``CONFIG_KUNIT_DEBUGFS`` is enabled, KUnit test results will
55 be accessible from the ``debugfs`` filesystem (if mounted).
56 They will be in ``/sys/kernel/debug/kunit/<test_suite>/results``, in