dev-tools/kunit/architecture.rst

1 .. SPDX-License-Identifier: GPL-2.0
9 - `In-Kernel Testing Framework`_
10 - `kunit_tool (Command-line Test Harness)`_
12 In-Kernel Testing Framework
19 - Organizes tests
20 - Reports test results
21 - Provides test utilities
23 Test Cases
24 ----------
26 The test case is the fundamental unit in KUnit. KUnit test cases are organised
32 	``generate_params`` is optional for non-parameterized tests.
35 running test. The KUnit assertion macros and other KUnit utilities use the
38 - ``->priv``: The setup functions can use it to store arbitrary test
41 - ``->param_value``: It contains the parameter value which can be
45 -----------
47 A KUnit suite includes a collection of test cases. The KUnit suites
50 .. code-block:: c
68 test cases ``example_test_foo``, ``example_test_bar``, and
75 --------
77 The KUnit executor can list and run built-in KUnit tests on boot.
81 `include/asm-generic/vmlinux.lds.h <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.…
87 .. kernel-figure:: kunit_suitememorydiagram.svg
103 `lib/kunit/try-catch.c <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/lib…
106 ----------------
112 - ``{EXPECT|ASSERT}`` determines whether the check is an assertion or an
116 	- For expectations, the test is marked as failed and the failure is logged.
118 	- Failing assertions, on the other hand, result in the test case being
121 		- Assertions call the function:
124 		- ``__kunit_abort`` calls the function:
127 		- ``kunit_try_catch_throw`` calls the function:
131 - ``<op>`` denotes a check with options: ``TRUE`` (supplied property
136 - ``[_MSG]`` prints a custom message on failure.
139 ---------------------
141 Documentation/dev-tools/ktap.rst.
146 -------------------
154 array-based common-case generators.
156 kunit_tool (Command-line Test Harness)
164 Documentation/dev-tools/kunit/run_manual.rst) or use ``kunit_tool``
165 (see Documentation/dev-tools/kunit/run_wrapper.rst).
167 - ``configure`` command generates the kernel ``.config`` from a
168   ``.kunitconfig`` file (and any architecture-specific options).
182 - ``build`` runs ``make`` on the kernel tree with required options
185   To build a KUnit kernel from the current ``.config``, you can use the
187 - ``exec`` command executes kernel results either directly (using
188   User-mode Linux configuration), or through an emulator such
191   If you already have built a kernel with built-in KUnit tests,
194 - ``parse`` extracts the KTAP output from a kernel log, parses