selftest: Show filename or script we had trouble reading

[samba.git] / selftest / README

diff --git a/selftest/README b/selftest/README
index f8be20a569c787a97ea7d049649093aea345d89e..d9ad0202683d1424c1ac54ae04a15fd4918fec15 100644 (file)
--- a/selftest/README
+++ b/selftest/README
@@ -3,15 +3,24 @@
 This directory contains test scripts that are useful for running a
 bunch of tests all at once. 
 
+There are two parts to this: 
+
+ * The test runner (selftest/selftest.pl)
+ * The test formatter
+
+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, which is used by default as part of "make test".
+
 Available testsuites
 ====================
 The available testsuites are obtained from a script, usually 
-selftest/samba{3,4}_tests.sh. This script should for each testsuite output 
+source{3,4}/selftest/tests.py. This script should for each testsuite output
 the name of the test, the command to run and the environment that should be 
 provided. Use the included "plantest" function to generate the required output.
 
 Testsuite behaviour
-================================
+===================
 
 Exit code
 ------------
@@ -28,44 +37,39 @@ 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>
+The following commands are Samba extensions to Subunit:
 
-Announce that a new test with the specified name is starting
-
-success
+testsuite-count
 ~~~~~~~~~~~~~~~
-success: <NAME> 
+testsuite-count: number
 
-Announce that the test with the specified name is done and ran successfully.
+Announce the number of tests that is going to be run.
 
-failure
+start-testsuite
 ~~~~~~~~~~~~~~~
-failure: <NAME> 
-failure: <NAME> [ REASON ]
+start-testsuite: name
+
+The testsuite name is used as prefix for all containing tests.
+
+skip-testsuite
+~~~~~~~~~~~~~~
+skip-testsuite: name
 
-Announce that the test with the specified name failed. Optionally, it is 
-possible to specify a reason it failed.
+Mark the testsuite with the specified name as skipped.
 
-skip
-~~~~~~~~~~~~
-skip: <NAME>
-skip: <NAME> [ REASON ]
+testsuite-success
+~~~~~~~~~~~~~~~~~
+testsuite-success: name
 
-Announce that the test with the specified name was skipped. Optionally a 
-reason can be specified.
+Indicate that the testsuite has succeeded successfully.
 
-knownfail
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-knownfail: <NAME>
-knownfail: <NAME> [ REASON ]
+testsuite-fail
+~~~~~~~~~~~~~~
+testsuite-fail: name
 
-Announce that the test with the specified name was run and failed as expected.
-Alternatively it is also possible to simply return "failure:" here but 
-specify in the samba4-knownfailures file that it is failing.
+Indicate that a testsuite has failed.
 
 Environments
 ============
@@ -73,30 +77,32 @@ Tests often need to run against a server with particular things set up,
 a "environment". This environment is provided by the test "target": Samba 3, 
 Samba 4 or Windows.
 
-The following environments are currently available:
+The environments are currently available include
 
  - none: No server set up, no variables set.
- - dc: Domain controller set up. The following environment variables will 
+ - dc,s3dc: Domain controller set up. The following environment variables will
    be set:
 
      * USERNAME: Administrator user name
-        * PASSWORD: Administrator password
-        * DOMAIN: Domain name
-        * REALM: Realm name
-        * SERVER: DC host name 
-        * SERVER_IP: DC IPv4 address
-        * NETBIOSNAME: DC NetBIOS name
-        * NETIOSALIAS: DC NetBIOS alias
-
- - member: Domain controller and member server that is joined to it set up. The
+     * PASSWORD: Administrator password
+     * DOMAIN: Domain name
+     * REALM: Realm name
+     * SERVER: DC host name 
+     * SERVER_IP: DC IPv4 address
+     * SERVER_IPV6: DC IPv6 address
+     * NETBIOSNAME: DC NetBIOS name
+     * NETIOSALIAS: DC NetBIOS alias
+
+ - member,s4member,s3member: Domain controller and member server that is joined to it set up. The
    following environment variables will be set:
 
      * USERNAME: Domain administrator user name
-        * PASSWORD: Domain administrator password
-        * DOMAIN: Domain name
-        * REALM: Realm name
-        * SERVER: Name of the member server
+     * PASSWORD: Domain administrator password
+     * DOMAIN: Domain name
+     * REALM: Realm name
+     * SERVER: Name of the member server
 
+See Samba.pm, Samba3.pm and Samba4.pm for the full list.
 
 Running tests
 =============
@@ -105,7 +111,7 @@ To run all the tests use::
 
    make test
 
-To run a quick subset (aiming for about 1 minute of testing) run::
+To run a quicker subset run::
 
    make quicktest