summaryrefslogtreecommitdiff
path: root/selftest/README
diff options
context:
space:
mode:
Diffstat (limited to 'selftest/README')
-rw-r--r--selftest/README55
1 files changed, 4 insertions, 51 deletions
diff --git a/selftest/README b/selftest/README
index 6a2c406cca..752b07bf64 100644
--- a/selftest/README
+++ b/selftest/README
@@ -10,7 +10,7 @@ There are two parts to this:
selftest.pl simply outputs subunit, which can then be formatted or analyzed
by tools that understand the subunit protocol. One of these tools is
-format-subunit.pl, which is used by default as part of "make test".
+format-subunit, which is used by default as part of "make test".
Available testsuites
====================
@@ -37,56 +37,9 @@ This protocol works by writing simple messages to standard output. Any
messages that can not be interpreted by this protocol are considered comments
for the last announced test.
-Accepted commands are:
+For a full description of the subunit protocol, see ../lib/subunit/README.
-test
-~~~~
-test: <NAME>
-
-Announce that a new test with the specified name is starting
-
-success
-~~~~~~~
-success: <NAME>
-
-Announce that the test with the specified name is done and ran successfully.
-
-failure
-~~~~~~~
-failure: <NAME>
-failure: <NAME> [ REASON ]
-
-Announce that the test with the specified name failed. Optionally, it is
-possible to specify a reason it failed.
-
-The alias "fail" will also work.
-
-xfail
-~~~~~
-xfail: <NAME>
-xfail: <NAME> [ REASON ]
-
-Announce that the test with the specified name failed but that the failure
-was expected, e.g. it's a test for a known bug that hasn't been fixed yet.
-Alternatively it is also possible to simply return "failure:" here but
-specify in the samba4-knownfailures file that it is failing.
-
-skip
-~~~~
-skip: <NAME>
-skip: <NAME> [ REASON ]
-
-Announce that the test with the specified name was skipped. Optionally a
-reason can be specified.
-
-time
-~~~~
-time: YYYY-MM-DD HH:mm:ssZ
-
-Announce the current time. This may be used to calculate the duration of
-various tests.
-
-The following are Samba extensions to Subunit:
+The following commands are Samba extensions to Subunit:
testsuite-count
~~~~~~~~~~~~~~~
@@ -95,7 +48,7 @@ testsuite-count: number
Announce the number of tests that is going to be run.
start-testsuite
-~~~~~~~~~
+~~~~~~~~~~~~~~~
start-testsuite: name
The testsuite name is used as prefix for all containing tests.