1 .. SPDX-License-Identifier: GPL-2.0
2
3 ============================
4 Run Tests without kunit_tool
5 ============================
6
7 If we do not want to use kunit_tool (For examp
8 with other systems, or run tests on real hardw
9 include KUnit in any kernel, read out results,
10
11 .. note:: KUnit is not designed for use in a p
12 possible that tests may reduce the s
13 the system.
14
15 Configure the Kernel
16 ====================
17
18 KUnit tests can run without kunit_tool. This c
19
20 - We have an existing kernel configuration to
21 - Need to run on real hardware (or using an em
22 does not support).
23 - Wish to integrate with some existing testing
24
25 KUnit is configured with the ``CONFIG_KUNIT``
26 tests can also be built by enabling their conf
27 ``.config``. KUnit tests usually (but don't al
28 ending in ``_KUNIT_TEST``. Most tests can eith
29 or be built into the kernel.
30
31 .. note ::
32
33 We can enable the ``KUNIT_ALL_TESTS``
34 automatically enable all tests with sa
35 a good way of quickly testing everythi
36 config.
37
38 Once we have built our kernel (and/or modules)
39 the tests. If the tests are built-in, they wil
40 kernel boot. The results will be written to th
41 in TAP format.
42
43 If the tests are built as modules, they will r
44 loaded.
45
46 .. code-block :: bash
47
48 # modprobe example-test
49
50 The results will appear in TAP format in ``dme
51
52 debugfs
53 =======
54
55 KUnit can be accessed from userspace via the d
56 information about debugfs at Documentation/fil
57
58 If ``CONFIG_KUNIT_DEBUGFS`` is enabled, the KU
59 mounted at /sys/kernel/debug/kunit. You can us
60 the following actions.
61
62 Retrieve Test Results
63 =====================
64
65 You can use debugfs to retrieve KUnit test res
66 accessible from the debugfs filesystem in the
67
68 .. code-block :: bash
69
70 /sys/kernel/debug/kunit/<test_suite>/r
71
72 The test results are printed in a KTAP documen
73 to the kernel log and thus, may have different
74
75 Run Tests After Kernel Has Booted
76 =================================
77
78 You can use the debugfs filesystem to trigger
79 boot. To run the test suite, you can use the f
80 the ``/sys/kernel/debug/kunit/<test_suite>/run
81
82 .. code-block :: bash
83
84 echo "any string" > /sys/kernel/debugf
85
86 As a result, the test suite runs and the resul
87 log.
88
89 However, this feature is not available with KU
90 because init data may have been discarded afte
91 suites that use init data should be defined us
92 kunit_test_init_section_suites() macro.
93
94 Also, you cannot use this feature to run tests
95 will wait to run until other tests have comple
96
97 .. note ::
98
99 For test authors, to use this feature,
100 and/or clean up any data, so the test
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.