sphinx.addnodesdocument)}( rawsource children]( translations
LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba
attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget"/translations/zh_CN/dev-tools/ktapmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/zh_TW/dev-tools/ktapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/it_IT/dev-tools/ktapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/ja_JP/dev-tools/ktapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/ko_KR/dev-tools/ktapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/pt_BR/dev-tools/ktapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah }(h ]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/sp_SP/dev-tools/ktapmodnameN classnameN refexplicituh1hhh ubeh }(h ]h ]h"]h$]h&]current_languageEnglishuh1h
hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah }(h ]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhh`_. The Linux Kernel largely uses TAP output for test
results. However, Kernel testing frameworks have special needs for test results
which don't align with the original TAP specification. Thus, a "Kernel TAP"
(KTAP) format is specified to extend and alter TAP to support these use-cases.
This specification describes the generally accepted format of KTAP as it is
currently used in the kernel.h](hTAP, or the Test Anything Protocol is a format for specifying test results used
by a number of projects. Its website and specification are found at this }(hhhhhNhNubh reference)}(h#`link
`_h]hlink}(hhhhhNhNubah }(h ]h ]h"]h$]h&]namelinkrefurihttps://testanything.org/uh1hhhubhtarget)}(h
h]h }(h ]linkah ]h"]linkah$]h&]refurihuh1h
referencedKhhubhX . The Linux Kernel largely uses TAP output for test
results. However, Kernel testing frameworks have special needs for test results
which don’t align with the original TAP specification. Thus, a “Kernel TAP”
(KTAP) format is specified to extend and alter TAP to support these use-cases.
This specification describes the generally accepted format of KTAP as it is
currently used in the kernel.}(hhhhhNhNubeh }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hX@ KTAP test results describe a series of tests (which may be nested: i.e., test
can have subtests), each of which can contain both diagnostic data -- e.g., log
lines -- and a final result. The test structure and results are
machine-readable, whereas the diagnostic data is unstructured and is there to
aid human debugging.h]hX@ KTAP test results describe a series of tests (which may be nested: i.e., test
can have subtests), each of which can contain both diagnostic data -- e.g., log
lines -- and a final result. The test structure and results are
machine-readable, whereas the diagnostic data is unstructured and is there to
aid human debugging.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(h8KTAP output is built from four different types of lines:h]h8KTAP output is built from four different types of lines:}(hj# hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhhhhubh bullet_list)}(hhh](h list_item)}(h
Version linesh]h)}(hj: h]h
Version lines}(hj< hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj8 ubah }(h ]h ]h"]h$]h&]uh1j6 hj3 hhhhhNubj7 )}(h
Plan linesh]h)}(hjQ h]h
Plan lines}(hjS hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjO ubah }(h ]h ]h"]h$]h&]uh1j6 hj3 hhhhhNubj7 )}(hTest case result linesh]h)}(hjh h]hTest case result lines}(hjj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjf ubah }(h ]h ]h"]h$]h&]uh1j6 hj3 hhhhhNubj7 )}(hDiagnostic lines
h]h)}(hDiagnostic linesh]hDiagnostic lines}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj} ubah }(h ]h ]h"]h$]h&]uh1j6 hj3 hhhhhNubeh }(h ]h ]h"]h$]h&]bullet-uh1j1 hhhKhhhhubh)}(hXQ In general, valid KTAP output should also form valid TAP output, but some
information, in particular nested test results, may be lost. Also note that
there is a stagnant draft specification for TAP14, KTAP diverges from this in
a couple of places (notably the "Subtest" header), which are described where
relevant later in this document.h]hXU In general, valid KTAP output should also form valid TAP output, but some
information, in particular nested test results, may be lost. Also note that
there is a stagnant draft specification for TAP14, KTAP diverges from this in
a couple of places (notably the “Subtest” header), which are described where
relevant later in this document.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hhh](h)}(h
Version linesh]h
Version lines}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhK$ubh)}(hAll KTAP-formatted results begin with a "version line" which specifies which
version of the (K)TAP standard the result is compliant with.h]hAll KTAP-formatted results begin with a “version line” which specifies which
version of the (K)TAP standard the result is compliant with.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK&hj hhubh)}(h For example:h]h For example:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK)hj hhubj2 )}(hhh](j7 )}(h"KTAP version 1"h]h)}(hj h]h“KTAP version 1”}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK+hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h"TAP version 13"h]h)}(hj h]h“TAP version 13”}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK,hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h"TAP version 14"
h]h)}(h"TAP version 14"h]h“TAP version 14”}(hj
hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK-hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubeh }(h ]h ]h"]h$]h&]j j uh1j1 hhhK+hj hhubh)}(hNote that, in KTAP, subtests also begin with a version line, which denotes the
start of the nested test results. This differs from TAP14, which uses a
separate "Subtest" line.h]hNote that, in KTAP, subtests also begin with a version line, which denotes the
start of the nested test results. This differs from TAP14, which uses a
separate “Subtest” line.}(hj' hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK/hj hhubh)}(hWhile, going forward, "KTAP version 1" should be used by compliant tests, it
is expected that most parsers and other tooling will accept the other versions
listed here for compatibility with existing tests and frameworks.h]hWhile, going forward, “KTAP version 1” should be used by compliant tests, it
is expected that most parsers and other tooling will accept the other versions
listed here for compatibility with existing tests and frameworks.}(hj5 hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK3hj hhubeh }(h ]
version-linesah ]h"]
version linesah$]h&]uh1hhhhhhhhK$ubh)}(hhh](h)}(h
Plan linesh]h
Plan lines}(hjN hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhjK hhhhhK8ubh)}(hJA test plan provides the number of tests (or subtests) in the KTAP output.h]hJA test plan provides the number of tests (or subtests) in the KTAP output.}(hj\ hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK:hjK hhubh)}(hPlan lines must follow the format of "1..N" where N is the number of tests or subtests.
Plan lines follow version lines to indicate the number of nested tests.h]hPlan lines must follow the format of “1..N” where N is the number of tests or subtests.
Plan lines follow version lines to indicate the number of nested tests.}(hjj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK [][ # [] []]h]hG [][ # [] []]}hj sbah }(h ]h ]h"]h$]h&]hhƌforcelanguagenonehighlight_args}uh1j hhhKIhj hhubh)}(h|The result can be either "ok", which indicates the test case passed,
or "not ok", which indicates that the test case failed.h]hThe result can be either “ok”, which indicates the test case passed,
or “not ok”, which indicates that the test case failed.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKMhj hhubh)}(h represents the number of the test being performed. The first test must
have the number 1 and the number then must increase by 1 for each additional
subtest within the same test at the same nesting level.h]h represents the number of the test being performed. The first test must
have the number 1 and the number then must increase by 1 for each additional
subtest within the same test at the same nesting level.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKPhj hhubh)}(hThe description is a description of the test, generally the name of
the test, and can be any string of characters other than # or a
newline. The description is optional, but recommended.h]hThe description is a description of the test, generally the name of
the test, and can be any string of characters other than # or a
newline. The description is optional, but recommended.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKThj hhubh)}(hlThe directive and any diagnostic data is optional. If either are present, they
must follow a hash sign, "#".h]hpThe directive and any diagnostic data is optional. If either are present, they
must follow a hash sign, “#”.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKXhj hhubh)}(hX8 A directive is a keyword that indicates a different outcome for a test other
than passed and failed. The directive is optional, and consists of a single
keyword preceding the diagnostic data. In the event that a parser encounters
a directive it doesn't support, it should fall back to the "ok" / "not ok"
result.h]hXB A directive is a keyword that indicates a different outcome for a test other
than passed and failed. The directive is optional, and consists of a single
keyword preceding the diagnostic data. In the event that a parser encounters
a directive it doesn’t support, it should fall back to the “ok” / “not ok”
result.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK[hj hhubh)}(h"Currently accepted directives are:h]h"Currently accepted directives are:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKahj hhubj2 )}(hhh](j7 )}(h"SKIP", which indicates a test was skipped (note the result of the test case
result line can be either "ok" or "not ok" if the SKIP directive is used)h]h)}(h"SKIP", which indicates a test was skipped (note the result of the test case
result line can be either "ok" or "not ok" if the SKIP directive is used)h]h“SKIP”, which indicates a test was skipped (note the result of the test case
result line can be either “ok” or “not ok” if the SKIP directive is used)}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKchj ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h"TODO", which indicates that a test is not expected to pass at the moment,
e.g. because the feature it is testing is known to be broken. While this
directive is inherited from TAP, its use in the kernel is discouraged.h]h)}(h"TODO", which indicates that a test is not expected to pass at the moment,
e.g. because the feature it is testing is known to be broken. While this
directive is inherited from TAP, its use in the kernel is discouraged.h]h“TODO”, which indicates that a test is not expected to pass at the moment,
e.g. because the feature it is testing is known to be broken. While this
directive is inherited from TAP, its use in the kernel is discouraged.}(hj5 hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKehj1 ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h"XFAIL", which indicates that a test is expected to fail. This is similar
to "TODO", above, and is used by some kselftest tests.h]h)}(h"XFAIL", which indicates that a test is expected to fail. This is similar
to "TODO", above, and is used by some kselftest tests.h]h“XFAIL”, which indicates that a test is expected to fail. This is similar
to “TODO”, above, and is used by some kselftest tests.}(hjM hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhhjI ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h“TIMEOUT”, which indicates a test has timed out (note the result of the test
case result line should be “not ok” if the TIMEOUT directive is used)h]h)}(h“TIMEOUT”, which indicates a test has timed out (note the result of the test
case result line should be “not ok” if the TIMEOUT directive is used)h]h“TIMEOUT”, which indicates a test has timed out (note the result of the test
case result line should be “not ok” if the TIMEOUT directive is used)}(hje hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKjhja ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h“ERROR”, which indicates that the execution of a test has failed due to a
specific error that is included in the diagnostic data. (note the result of
the test case result line should be “not ok” if the ERROR directive is used)
h]h)}(h“ERROR”, which indicates that the execution of a test has failed due to a
specific error that is included in the diagnostic data. (note the result of
the test case result line should be “not ok” if the ERROR directive is used)h]h“ERROR”, which indicates that the execution of a test has failed due to a
specific error that is included in the diagnostic data. (note the result of
the test case result line should be “not ok” if the ERROR directive is used)}(hj} hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKlhjy ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubeh }(h ]h ]h"]h$]h&]j j uh1j1 hhhKchj hhubh)}(hThe diagnostic data is a plain-text field which contains any additional details
about why this result was produced. This is typically an error message for ERROR
or failed tests, or a description of missing dependencies for a SKIP result.h]hThe diagnostic data is a plain-text field which contains any additional details
about why this result was produced. This is typically an error message for ERROR
or failed tests, or a description of missing dependencies for a SKIP result.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKphj hhubh)}(hThe diagnostic data field is optional, and results which have neither a
directive nor any diagnostic data do not need to include the "#" field
separator.h]hThe diagnostic data field is optional, and results which have neither a
directive nor any diagnostic data do not need to include the “#” field
separator.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKthj hhubh)}(h Example result lines include::h]h Example result lines include:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKxhj hhubj )}(hok 1 test_case_nameh]hok 1 test_case_name}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKzhj hhubh)}(h!The test "test_case_name" passed.h]h%The test “test_case_name” passed.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhK|hj hhubj )}(hnot ok 1 test_case_nameh]hnot ok 1 test_case_name}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(h!The test "test_case_name" failed.h]h%The test “test_case_name” failed.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h1ok 1 test # SKIP necessary dependency unavailableh]h1ok 1 test # SKIP necessary dependency unavailable}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(h[The test "test" was SKIPPED with the diagnostic message "necessary dependency
unavailable".h]hcThe test “test” was SKIPPED with the diagnostic message “necessary dependency
unavailable”.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h"not ok 1 test # TIMEOUT 30 secondsh]h"not ok 1 test # TIMEOUT 30 seconds}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(h=The test "test" timed out, with diagnostic data "30 seconds".h]hEThe test “test” timed out, with diagnostic data “30 seconds”.}(hj# hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(h ok 5 check return code # rcode=0h]h ok 5 check return code # rcode=0}hj1 sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(hRThe test "check return code" passed, with additional diagnostic data “rcode=0”h]hVThe test “check return code” passed, with additional diagnostic data “rcode=0”}(hj? hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubeh }(h ]test-case-result-linesah ]h"]test case result linesah$]h&]uh1hhhhhhhhKDubh)}(hhh](h)}(hDiagnostic linesh]hDiagnostic lines}(hjX hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhjU hhhhhKubh)}(hX# If tests wish to output any further information, they should do so using
"diagnostic lines". Diagnostic lines are optional, freeform text, and are
often used to describe what is being tested and any intermediate results in
more detail than the final result and diagnostic data line provides.h]hX' If tests wish to output any further information, they should do so using
“diagnostic lines”. Diagnostic lines are optional, freeform text, and are
often used to describe what is being tested and any intermediate results in
more detail than the final result and diagnostic data line provides.}(hjf hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjU hhubh)}(hX Diagnostic lines are formatted as "# ", where the
description can be any string. Diagnostic lines can be anywhere in the test
output. As a rule, diagnostic lines regarding a test are directly before the
test result line for that test.h]hX Diagnostic lines are formatted as “# ”, where the
description can be any string. Diagnostic lines can be anywhere in the test
output. As a rule, diagnostic lines regarding a test are directly before the
test result line for that test.}(hjt hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjU hhubh)}(hX3 Note that most tools will treat unknown lines (see below) as diagnostic lines,
even if they do not start with a "#": this is to capture any other useful
kernel output which may help debug the test. It is nevertheless recommended
that tests always prefix any diagnostic output they have with a "#" character.h]hX; Note that most tools will treat unknown lines (see below) as diagnostic lines,
even if they do not start with a “#”: this is to capture any other useful
kernel output which may help debug the test. It is nevertheless recommended
that tests always prefix any diagnostic output they have with a “#” character.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjU hhubeh }(h ]diagnostic-linesah ]h"]diagnostic linesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h
Unknown linesh]h
Unknown lines}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(hThere may be lines within KTAP output that do not follow the format of one of
the four formats for lines described above. This is allowed, however, they will
not influence the status of the tests.h]hThere may be lines within KTAP output that do not follow the format of one of
the four formats for lines described above. This is allowed, however, they will
not influence the status of the tests.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hX This is an important difference from TAP. Kernel tests may print messages
to the system console or a log file. Both of these destinations may contain
messages either from unrelated kernel or userspace activity, or kernel
messages from non-test code that is invoked by the test. The kernel code
invoked by the test likely is not aware that a test is in progress and
thus can not print the message as a diagnostic message.h]hX This is an important difference from TAP. Kernel tests may print messages
to the system console or a log file. Both of these destinations may contain
messages either from unrelated kernel or userspace activity, or kernel
messages from non-test code that is invoked by the test. The kernel code
invoked by the test likely is not aware that a test is in progress and
thus can not print the message as a diagnostic message.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubeh }(h ]
unknown-linesah ]h"]
unknown linesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Nested testsh]h Nested tests}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubh)}(hIn KTAP, tests can be nested. This is done by having a test include within its
output an entire set of KTAP-formatted results. This can be used to categorize
and group related tests, or to split out different results from the same test.h]hIn KTAP, tests can be nested. This is done by having a test include within its
output an entire set of KTAP-formatted results. This can be used to categorize
and group related tests, or to split out different results from the same test.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hThe "parent" test's result should consist of all of its subtests' results,
starting with another KTAP version line and test plan, and end with the overall
result. If one of the subtests fail, for example, the parent test should also
fail.h]hThe “parent” test’s result should consist of all of its subtests’ results,
starting with another KTAP version line and test plan, and end with the overall
result. If one of the subtests fail, for example, the parent test should also
fail.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hAdditionally, all lines in a subtest should be indented. One level of
indentation is two spaces: " ". The indentation should begin at the version
line and should end before the parent test's result line.h]hAdditionally, all lines in a subtest should be indented. One level of
indentation is two spaces: “ “. The indentation should begin at the version
line and should end before the parent test’s result line.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(hw"Unknown lines" are not considered to be lines in a subtest and thus are
allowed to be either indented or not indented.h]h{“Unknown lines” are not considered to be lines in a subtest and thus are
allowed to be either indented or not indented.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubh)}(h.An example of a test with two nested subtests:h]h.An example of a test with two nested subtests:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(hmKTAP version 1
1..1
KTAP version 1
1..2
ok 1 test_1
not ok 2 test_2
# example failed
not ok 1 exampleh]hmKTAP version 1
1..1
KTAP version 1
1..2
ok 1 test_1
not ok 2 test_2
# example failed
not ok 1 example}hj$ sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(h9An example format with multiple levels of nested testing:h]h9An example format with multiple levels of nested testing:}(hj2 hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj hhubj )}(hKTAP version 1
1..2
KTAP version 1
1..2
KTAP version 1
1..2
not ok 1 test_1
ok 2 test_2
not ok 1 test_3
ok 2 test_4 # SKIP
not ok 1 example_test_1
ok 2 example_test_2h]hKTAP version 1
1..2
KTAP version 1
1..2
KTAP version 1
1..2
not ok 1 test_1
ok 2 test_2
not ok 1 test_3
ok 2 test_4 # SKIP
not ok 1 example_test_1
ok 2 example_test_2}hj@ sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubeh }(h ] nested-testsah ]h"] nested testsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h&Major differences between TAP and KTAPh]h&Major differences between TAP and KTAP}(hjY hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhjV hhhhhKubhtable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h }(h ]h ]h"]h$]h&]colwidthK2uh1jq hjn ubjr )}(hhh]h }(h ]h ]h"]h$]h&]colwidthK uh1jq hjn ubjr )}(hhh]h }(h ]h ]h"]h$]h&]colwidthKuh1jq hjn ubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(hFeatureh]hFeature}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hTAPh]hTAP}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hKTAPh]hKTAP}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubeh }(h ]h ]h"]h$]h&]uh1j hj ubah }(h ]h ]h"]h$]h&]uh1j hjn ubhtbody)}(hhh](j )}(hhh](j )}(hhh]h)}(h"yaml and json in diagnosic messageh]h"yaml and json in diagnosic message}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hokh]hok}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj
ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hnot recommendedh]hnot recommended}(hj' hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj$ ubah }(h ]h ]h"]h$]h&]uh1j hj ubeh }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hTODO directiveh]hTODO directive}(hjG hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjD ubah }(h ]h ]h"]h$]h&]uh1j hjA ubj )}(hhh]h)}(hokh]hok}(hj^ hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj[ ubah }(h ]h ]h"]h$]h&]uh1j hjA ubj )}(hhh]h)}(hnot recognizedh]hnot recognized}(hju hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjr ubah }(h ]h ]h"]h$]h&]uh1j hjA ubeh }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h0allows an arbitrary number of tests to be nestedh]h0allows an arbitrary number of tests to be nested}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hnoh]hno}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hyesh]hyes}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubeh }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h2"Unknown lines" are in category of "Anything else"h]h:“Unknown lines” are in category of “Anything else”}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hyesh]hyes}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hnoh]hno}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj ubah }(h ]h ]h"]h$]h&]uh1j hj ubeh }(h ]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h"Unknown lines" areh]h“Unknown lines” are}(hj1 hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj. ubah }(h ]h ]h"]h$]h&]uh1j hj+ ubj )}(hhh]h)}(h incorrecth]h incorrect}(hjH hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjE ubah }(h ]h ]h"]h$]h&]uh1j hj+ ubj )}(hhh]h)}(hallowedh]hallowed}(hj_ hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhj\ ubah }(h ]h ]h"]h$]h&]uh1j hj+ ubeh }(h ]h ]h"]h$]h&]uh1j hj ubeh }(h ]h ]h"]h$]h&]uh1j hjn ubeh }(h ]h ]h"]h$]h&]colsKuh1jl hji ubah }(h ]h ]h"]h$]h&]uh1jg hjV hhhhhNubh)}(hThe TAP14 specification does permit nested tests, but instead of using another
nested version line, uses a line of the form
"Subtest: " where is the name of the parent test.h]hThe TAP14 specification does permit nested tests, but instead of using another
nested version line, uses a line of the form
“Subtest: ” where is the name of the parent test.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhKhjV hhubeh }(h ]&major-differences-between-tap-and-ktapah ]h"]&major differences between tap and ktapah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hExample KTAP outputh]hExample KTAP output}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhKubj )}(hX KTAP version 1
1..1
KTAP version 1
1..3
KTAP version 1
1..1
# test_1: initializing test_1
ok 1 test_1
ok 1 example_test_1
KTAP version 1
1..2
ok 1 test_1 # SKIP test_1 skipped
ok 2 test_2
ok 2 example_test_2
KTAP version 1
1..3
ok 1 test_1
# test_2: FAIL
not ok 2 test_2
ok 3 test_3 # SKIP test_3 skipped
not ok 3 example_test_3
not ok 1 main_testh]hX KTAP version 1
1..1
KTAP version 1
1..3
KTAP version 1
1..1
# test_1: initializing test_1
ok 1 test_1
ok 1 example_test_1
KTAP version 1
1..2
ok 1 test_1 # SKIP test_1 skipped
ok 2 test_2
ok 2 example_test_2
KTAP version 1
1..3
ok 1 test_1
# test_2: FAIL
not ok 2 test_2
ok 3 test_3 # SKIP test_3 skipped
not ok 3 example_test_3
not ok 1 main_test}hj sbah }(h ]h ]h"]h$]h&]hhuh1j hhhKhj hhubh)}(h,This output defines the following hierarchy:h]h,This output defines the following hierarchy:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hFA single test called "main_test", which fails, and has three subtests:h]hJA single test called “main_test”, which fails, and has three subtests:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMhj hhubj2 )}(hhh](j7 )}(h"example_test_1", which passes, and has one subtest:
- "test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1"
h](h)}(h4"example_test_1", which passes, and has one subtest:h]h8“example_test_1”, which passes, and has one subtest:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhMhj ubh block_quote)}(h[- "test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1"
h]j2 )}(hhh]j7 )}(hY"test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1"
h]h)}(hX"test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1"h]h`“test_1”, which passes, and outputs the diagnostic message “test_1: initializing test_1”}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj ubah }(h ]h ]h"]h$]h&]j j uh1j1 hhhM hj ubah }(h ]h ]h"]h$]h&]uh1j hhhM hj ubeh }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h"example_test_2", which passes, and has two subtests:
- "test_1", which is skipped, with the explanation "test_1 skipped"
- "test_2", which passes
h](h)}(h5"example_test_2", which passes, and has two subtests:h]h9“example_test_2”, which passes, and has two subtests:}(hj) hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM hj% ubj )}(h]- "test_1", which is skipped, with the explanation "test_1 skipped"
- "test_2", which passes
h]j2 )}(hhh](j7 )}(hA"test_1", which is skipped, with the explanation "test_1 skipped"h]h)}(hj@ h]hI“test_1”, which is skipped, with the explanation “test_1 skipped”}(hjB hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM hj> ubah }(h ]h ]h"]h$]h&]uh1j6 hj; ubj7 )}(h"test_2", which passes
h]h)}(h"test_2", which passesh]h“test_2”, which passes}(hjY hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM!hjU ubah }(h ]h ]h"]h$]h&]uh1j6 hj; ubeh }(h ]h ]h"]h$]h&]j j uh1j1 hhhM hj7 ubah }(h ]h ]h"]h$]h&]uh1j hhhM hj% ubeh }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h"example_test_3", which fails, and has three subtests
- "test_1", which passes
- "test_2", which outputs the diagnostic line "test_2: FAIL", and fails.
- "test_3", which is skipped with the explanation "test_3 skipped"
h](h)}(h5"example_test_3", which fails, and has three subtestsh]h9“example_test_3”, which fails, and has three subtests}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM#hj ubj )}(h- "test_1", which passes
- "test_2", which outputs the diagnostic line "test_2: FAIL", and fails.
- "test_3", which is skipped with the explanation "test_3 skipped"
h]j2 )}(hhh](j7 )}(h"test_1", which passesh]h)}(hj h]h“test_1”, which passes}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM%hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj ubj7 )}(hF"test_2", which outputs the diagnostic line "test_2: FAIL", and fails.h]h)}(hj h]hN“test_2”, which outputs the diagnostic line “test_2: FAIL”, and fails.}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM&hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj ubj7 )}(hA"test_3", which is skipped with the explanation "test_3 skipped"
h]h)}(h@"test_3", which is skipped with the explanation "test_3 skipped"h]hH“test_3”, which is skipped with the explanation “test_3 skipped”}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM'hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj ubeh }(h ]h ]h"]h$]h&]j j uh1j1 hhhM%hj ubah }(h ]h ]h"]h$]h&]uh1j hhhM%hj ubeh }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubeh }(h ]h ]h"]h$]h&]j j uh1j1 hhhMhj hhubh)}(hX Note that the individual subtests with the same names do not conflict, as they
are found in different parent tests. This output also exhibits some sensible
rules for "bubbling up" test results: a test fails if any of its subtests fail.
Skipped tests do not affect the result of the parent test (though it often
makes sense for a test to be marked skipped if _all_ of its subtests have been
skipped).h]hX Note that the individual subtests with the same names do not conflict, as they
are found in different parent tests. This output also exhibits some sensible
rules for “bubbling up” test results: a test fails if any of its subtests fail.
Skipped tests do not affect the result of the parent test (though it often
makes sense for a test to be marked skipped if _all_ of its subtests have been
skipped).}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM)hj hhubeh }(h ]example-ktap-outputah ]h"]example ktap outputah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h See also:h]h See also:}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhj hhhhhM1ubj2 )}(hhh](j7 )}(hQThe TAP specification:
https://testanything.org/tap-version-13-specification.htmlh]h)}(hQThe TAP specification:
https://testanything.org/tap-version-13-specification.htmlh](hThe TAP specification:
}(hj$ hhhNhNubh)}(h:https://testanything.org/tap-version-13-specification.htmlh]h:https://testanything.org/tap-version-13-specification.html}(hj, hhhNhNubah }(h ]h ]h"]h$]h&]refurij. uh1hhj$ ubeh }(h ]h ]h"]h$]h&]uh1hhhhM3hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(hThe (stagnant) TAP version 14 specification:
https://github.com/TestAnything/Specification/blob/tap-14-specification/specification.mdh]h)}(hThe (stagnant) TAP version 14 specification:
https://github.com/TestAnything/Specification/blob/tap-14-specification/specification.mdh](h-The (stagnant) TAP version 14 specification:
}(hjK hhhNhNubh)}(hXhttps://github.com/TestAnything/Specification/blob/tap-14-specification/specification.mdh]hXhttps://github.com/TestAnything/Specification/blob/tap-14-specification/specification.md}(hjS hhhNhNubah }(h ]h ]h"]h$]h&]refurijU uh1hhjK ubeh }(h ]h ]h"]h$]h&]uh1hhhhM5hjG ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(hBThe kselftest documentation:
Documentation/dev-tools/kselftest.rsth]h)}(hBThe kselftest documentation:
Documentation/dev-tools/kselftest.rsth]hBThe kselftest documentation:
Documentation/dev-tools/kselftest.rst}(hjr hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM7hjn ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubj7 )}(h@The KUnit documentation:
Documentation/dev-tools/kunit/index.rsth]h)}(h@The KUnit documentation:
Documentation/dev-tools/kunit/index.rsth]h@The KUnit documentation:
Documentation/dev-tools/kunit/index.rst}(hj hhhNhNubah }(h ]h ]h"]h$]h&]uh1hhhhM9hj ubah }(h ]h ]h"]h$]h&]uh1j6 hj hhhhhNubeh }(h ]h ]h"]h$]h&]j j uh1j1 hhhM3hj hhubeh }(h ]see-alsoah ]h"] see also:ah$]h&]uh1hhhhhhhhM1ubeh }(h ]0the-kernel-test-anything-protocol-ktap-version-1ah ]h"]3the kernel test anything protocol (ktap), version 1ah$]h&]uh1hhhhhhhhKubeh }(h ]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN
source_urlN
toc_backlinksj footnote_backlinksK
sectnum_xformKstrip_commentsNstrip_elements_with_classesN
strip_classesN report_levelK
halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-sig input_encoding_error_handlerstrictoutput_encodingutf-8 output_encoding_error_handlerj error_encodingutf-8 error_encoding_error_handlerbackslashreplace
language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid
dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN
_config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthK trim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales] character_level_inline_markupdoctitle_xform
docinfo_xformKsectsubtitle_xform
image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j j j j jH jE j j jR jO j j j j jS jP j j j j j j u nametypes}(j j jH j jR j j jS j j j uh }(j hj hjE j j jK jO j j jU j j jP j j jV j j j j u
footnote_refs}
citation_refs}
autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK
id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log]
decorationNhhub.