aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2019-02-27 07:25:33 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2019-03-02 09:07:54 +0100
commit91f847d308b57adec89245308b60ae063026b456 (patch)
treec81abbf9cc46c75322f5838cea7ed1492733c8ad /docs/markdown
parentf2e513791e56886a145a8e72854841b9f9122ca6 (diff)
downloadmeson-91f847d308b57adec89245308b60ae063026b456.zip
meson-91f847d308b57adec89245308b60ae063026b456.tar.gz
meson-91f847d308b57adec89245308b60ae063026b456.tar.bz2
mtest: implement TAP parsing
This provides an initial support for parsing TAP output. It detects failures and skipped tests without relying on exit code, as well as early termination of the test due to an error or a crash. For now, subtests are not recorded in the TestRun object. However, because the TAP output goes on stdout, it is printed by --print-errorlogs when a test does not behave as expected. Handling subtests as TestRuns, and serializing them to JSON, can be added later. The parser was written specifically for Meson, and comes with its own test suite. Fixes #2923.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md10
-rw-r--r--docs/markdown/Unit-tests.md6
2 files changed, 10 insertions, 6 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 412135f..f2b0416 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1443,11 +1443,11 @@ Keyword arguments are the following:
before test is executed even if they have `build_by_default : false`.
Since 0.46.0
-- `protocol` specifies how the test results are parsed. For now
- it must be `exitcode`, that is the executable's exit code is used
- by the test harness to record the outcome of the test. For example
- an exit code of zero indicates success. For more on the Meson test harness
- protocol read [Unit Tests](Unit-tests.md). Since 0.50.0
+- `protocol` specifies how the test results are parsed and can be one
+ of `exitcode` (the executable's exit code is used by the test harness
+ to record the outcome of the test) or `tap` ([Test Anything
+ Protocol](https://www.testanything.org/)). For more on the Meson test
+ harness protocol read [Unit Tests](Unit-tests.md). Since 0.50.0
Defined tests can be run in a backend-agnostic way by calling
`meson test` inside the build dir, or by using backend-specific
diff --git a/docs/markdown/Unit-tests.md b/docs/markdown/Unit-tests.md
index 9148bd5..9e61739 100644
--- a/docs/markdown/Unit-tests.md
+++ b/docs/markdown/Unit-tests.md
@@ -53,7 +53,11 @@ $ MESON_TESTTHREADS=5 ninja test
## Skipped tests and hard errors
-Sometimes a test can only determine at runtime that it can not be run. The GNU standard approach in this case is to exit the program with error code 77. Meson will detect this and report these tests as skipped rather than failed. This behavior was added in version 0.37.0.
+Sometimes a test can only determine at runtime that it can not be run.
+
+For the default `exitcode` testing protocol, the GNU standard approach in this case is to exit the program with error code 77. Meson will detect this and report these tests as skipped rather than failed. This behavior was added in version 0.37.0.
+
+For TAP-based tests, skipped tests should print a single line starting with `1..0 # SKIP`.
In addition, sometimes a test fails set up so that it should fail even if it is marked as an expected failure. The GNU standard approach in this case is to exit the program with error code 99. Again, Meson will detect this and report these tests as `ERROR`, ignoring the setting of `should_fail`. This behavior was added in version 0.50.0.