1#
2# KUnit base configuration
3#
4
5menuconfig KUNIT
6	tristate "KUnit - Enable support for unit tests"
7	select GLOB
8	help
9	  Enables support for kernel unit tests (KUnit), a lightweight unit
10	  testing and mocking framework for the Linux kernel. These tests are
11	  able to be run locally on a developer's workstation without a VM or
12	  special hardware when using UML. Can also be used on most other
13	  architectures. For more information, please see
14	  Documentation/dev-tools/kunit/.
15
16if KUNIT
17
18config KUNIT_DEBUGFS
19	bool "KUnit - Enable /sys/kernel/debug/kunit debugfs representation" if !KUNIT_ALL_TESTS
20	default KUNIT_ALL_TESTS
21	help
22	  Enable debugfs representation for kunit.  Currently this consists
23	  of /sys/kernel/debug/kunit/<test_suite>/results files for each
24	  test suite, which allow users to see results of the last test suite
25	  run that occurred.
26
27config KUNIT_TEST
28	tristate "KUnit test for KUnit" if !KUNIT_ALL_TESTS
29	default KUNIT_ALL_TESTS
30	help
31	  Enables the unit tests for the KUnit test framework. These tests test
32	  the KUnit test framework itself; the tests are both written using
33	  KUnit and test KUnit. This option should only be enabled for testing
34	  purposes by developers interested in testing that KUnit works as
35	  expected.
36
37config KUNIT_EXAMPLE_TEST
38	tristate "Example test for KUnit" if !KUNIT_ALL_TESTS
39	default KUNIT_ALL_TESTS
40	help
41	  Enables an example unit test that illustrates some of the basic
42	  features of KUnit. This test only exists to help new users understand
43	  what KUnit is and how it is used. Please refer to the example test
44	  itself, lib/kunit/example-test.c, for more information. This option
45	  is intended for curious hackers who would like to understand how to
46	  use KUnit for kernel development.
47
48config KUNIT_ALL_TESTS
49	tristate "All KUnit tests with satisfied dependencies"
50	help
51	  Enables all KUnit tests, if they can be enabled.
52	  KUnit tests run during boot and output the results to the debug log
53	  in TAP format (http://testanything.org/). Only useful for kernel devs
54	  running the KUnit test harness, and not intended for inclusion into a
55	  production build.
56
57	  For more information on KUnit and unit tests in general please refer
58	  to the KUnit documentation in Documentation/dev-tools/kunit/.
59
60	  If unsure, say N.
61
62config KUNIT_DEFAULT_ENABLED
63	bool "Default value of kunit.enable"
64	default y
65	help
66	  Sets the default value of kunit.enable. If set to N then KUnit
67	  tests will not execute unless kunit.enable=1 is passed to the
68	  kernel command line.
69
70	  In most cases this should be left as Y. Only if additional opt-in
71	  behavior is needed should this be set to N.
72
73endif # KUNIT
74