dev-tools/kunit/index.rst

1 .. SPDX-License-Identifier: GPL-2.0
4 KUnit - Unit Testing for the Linux Kernel
12 	kunit-tool
28 writing unit tests. Tests written against KUnit will run on kernel boot if
29 built-in, or when loaded if built as a module. These tests write out results to
33 :doc:`kunit_tool <kunit-tool>`, which builds a `User Mode Linux
34 <http://user-mode-linux.sourceforge.net>`_ kernel, runs it, and parses the test
51 KUnit tests can be run on most architectures, and most tests are architecture
52 independent. All built-in KUnit tests run on kernel startup.  Alternatively,
53 KUnit and KUnit tests can be built as modules and tests will run when the test
58         KUnit can also run tests without needing a virtual machine or actual
62         architecture), or by using :doc:`kunit_tool <kunit-tool>`.
64 KUnit is fast. Excluding build time, from invocation to completion KUnit can run
66 deal to some people, but having such fast and easy to run tests fundamentally
69 <https://gist.github.com/lorn/1272686/revisions#diff-53c65572127855f1b003db4064a94573R874>`_:
78 difficult to write, and require a special setup or special hardware to run,
79 then you wait a lot longer to write tests, and you wait a lot longer to run
82 fast, you run them all the time, every time you make a change, and every time
84 correctly on every change when you can just run them yourself in less time than
90 *   :doc:`start` - for new users of KUnit
91 *   :doc:`usage` - for a more detailed explanation of KUnit features
92 *   :doc:`api/index` - for the list of KUnit APIs used for testing
93 *   :doc:`kunit-tool` - for more information on the kunit_tool helper script
94 *   :doc:`faq` - for answers to some common questions about KUnit