Documentation/dev-tools/ktap.rst

11 which don't align with the original TAP specification. Thus, a "Kernel TAP"
16 KTAP test results describe a series of tests (which may be nested: i.e., test
17 can have subtests), each of which can contain both diagnostic data -- e.g., log
32 a couple of places (notably the "Subtest" header), which are described where
38 All KTAP-formatted results begin with a "version line" which specifies which
47 Note that, in KTAP, subtests also begin with a version line, which denotes the
48 start of the nested test results. This differs from TAP14, which uses a
64 which case the test plan may be omitted -- it is strongly recommended one is
77 The result can be either "ok", which indicates the test case passed,
78 or "not ok", which indicates that the test case failed.
99 - "SKIP", which indicates a test was skipped (note the result of the test case
101 - "TODO", which indicates that a test is not expected to pass at the moment,
104 - "XFAIL", which indicates that a test is expected to fail. This is similar
106 - “TIMEOUT”, which indicates a test has timed out (note the result of the test
108 - “ERROR”, which indicates that the execution of a test has failed due to a
112 The diagnostic data is a plain-text field which contains any additional details
116 The diagnostic data field is optional, and results which have neither a
167 kernel output which may help debug the test. It is nevertheless recommended
280 A single test called "main_test", which fails, and has three subtests:
282 - "example_test_1", which passes, and has one subtest:
284    - "test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1"
286 - "example_test_2", which passes, and has two subtests:
288    - "test_1", which is skipped, with the explanation "test_1 skipped"
289    - "test_2", which passes
291 - "example_test_3", which fails, and has three subtests
293    - "test_1", which passes
294    - "test_2", which outputs the diagnostic line "test_2: FAIL", and fails.
295    - "test_3", which is skipped with the explanation "test_3 skipped"