xref: /linux/lib/kunit/Kconfig (revision e2219db280e3fe52e5cc242e4225dd2685af3c56)
1914cc63eSBrendan Higgins#
2914cc63eSBrendan Higgins# KUnit base configuration
3914cc63eSBrendan Higgins#
4914cc63eSBrendan Higgins
5914cc63eSBrendan Higginsmenuconfig KUNIT
69fe124bfSAlan Maguire	tristate "KUnit - Enable support for unit tests"
7914cc63eSBrendan Higgins	help
8914cc63eSBrendan Higgins	  Enables support for kernel unit tests (KUnit), a lightweight unit
9914cc63eSBrendan Higgins	  testing and mocking framework for the Linux kernel. These tests are
10914cc63eSBrendan Higgins	  able to be run locally on a developer's workstation without a VM or
11914cc63eSBrendan Higgins	  special hardware when using UML. Can also be used on most other
12914cc63eSBrendan Higgins	  architectures. For more information, please see
13914cc63eSBrendan Higgins	  Documentation/dev-tools/kunit/.
14d8e2a76bSBrendan Higgins
15d8e2a76bSBrendan Higginsif KUNIT
16d8e2a76bSBrendan Higgins
17*e2219db2SAlan Maguireconfig KUNIT_DEBUGFS
18*e2219db2SAlan Maguire	bool "KUnit - Enable /sys/kernel/debug/kunit debugfs representation"
19*e2219db2SAlan Maguire	help
20*e2219db2SAlan Maguire	  Enable debugfs representation for kunit.  Currently this consists
21*e2219db2SAlan Maguire	  of /sys/kernel/debug/kunit/<test_suite>/results files for each
22*e2219db2SAlan Maguire	  test suite, which allow users to see results of the last test suite
23*e2219db2SAlan Maguire	  run that occurred.
24*e2219db2SAlan Maguire
25d8e2a76bSBrendan Higginsconfig KUNIT_TEST
26c475c77dSAlan Maguire	tristate "KUnit test for KUnit"
27d8e2a76bSBrendan Higgins	help
28d8e2a76bSBrendan Higgins	  Enables the unit tests for the KUnit test framework. These tests test
29d8e2a76bSBrendan Higgins	  the KUnit test framework itself; the tests are both written using
30d8e2a76bSBrendan Higgins	  KUnit and test KUnit. This option should only be enabled for testing
31d8e2a76bSBrendan Higgins	  purposes by developers interested in testing that KUnit works as
32d8e2a76bSBrendan Higgins	  expected.
33d8e2a76bSBrendan Higgins
34d8e2a76bSBrendan Higginsconfig KUNIT_EXAMPLE_TEST
35c475c77dSAlan Maguire	tristate "Example test for KUnit"
36d8e2a76bSBrendan Higgins	help
37d8e2a76bSBrendan Higgins	  Enables an example unit test that illustrates some of the basic
38d8e2a76bSBrendan Higgins	  features of KUnit. This test only exists to help new users understand
39d8e2a76bSBrendan Higgins	  what KUnit is and how it is used. Please refer to the example test
40d8e2a76bSBrendan Higgins	  itself, lib/kunit/example-test.c, for more information. This option
41d8e2a76bSBrendan Higgins	  is intended for curious hackers who would like to understand how to
42d8e2a76bSBrendan Higgins	  use KUnit for kernel development.
43d8e2a76bSBrendan Higgins
44d8e2a76bSBrendan Higginsendif # KUNIT
45