tests/README: extended and reformatted

1 files changed, 150 insertions, 61 deletions

diff --git a/tests/README b/tests/README
index 4d8e70c78..f0248e632 100644
--- a/tests/README
+++ b/tests/README
@@ -6,13 +6,44 @@
 
 The cURL Test Suite
 
-Requires:
+ 1. Running
+  1.1 Requires to run
+  1.2 Port numbers used by test servers
+  1.3 Test servers
+  1.4 Run
+  1.5 Shell startup scripts
+  1.6 Memory test
+  1.7 Debug
+  1.8 Logs
+  1.9 Test input files
+  1.10 Code coverage
+  1.11 Remote testing
+
+ 2. Numbering
+  2.1 Test case numbering
+
+ 3. Write tests
+  3.1 test data
+  3.2 curl tests
+  3.3 libcurl tests
+  3.4 unit tests
+
+ 4. TODO
+  4.1 More protocols
+  4.2 SOCKS auth
+
+==============================================================================
+
+1. Running
+
+ 1.1 Requires to run
+
   perl (and a unix-style shell)
   diff (when a test fails, a diff is shown)
   stunnel (for HTTPS and FTPS tests)
   OpenSSH or SunSSH (for SCP, SFTP and SOCKS4/5 tests)
 
-Ports used by default:
+ 1.2 Port numbers used by test servers
 
   - TCP/8990 for HTTP
   - TCP/8991 for HTTPS
@@ -28,25 +59,36 @@ Ports used by default:
   - TCP/9001 for POP3
   - TCP/9002 for IMAP
   - TCP/9003 for SMTP
+  - TCP/9004 for SMTP IPv6
+  - TCP/9005 for RTSP
+  - TCP/9006 for RTSP IPv6
+  - TCP/9007 for GOPHER
+  - TCP/9008 for GOPHER IPv6
+  - TCP/9008 for HTTPS server with TLS-SRP support
+
+ 1.3 Test servers
 
   The test suite runs simple FTP, POP3, IMAP, SMTP, HTTP and TFTP stand-alone
-  servers on these ports to which it makes requests.  For SSL tests, it runs
-  stunnel to handle encryption to the regular servers. For SSH, it runs a
-  standard OpenSSH server. For SOCKS4/5 tests SSH is used to perform the SOCKS
-  functionality and requires a SSH client and server.
+  servers on the ports listed above to which it makes requests. For SSL tests,
+  it runs stunnel to handle encryption to the regular servers. For SSH, it
+  runs a standard OpenSSH server. For SOCKS4/5 tests SSH is used to perform
+  the SOCKS functionality and requires a SSH client and server.
 
-  The base port number shown above can be changed using runtests' -b option
-  to allow running more than one instance of the test suite simultaneously
-  on one machine.
+  The base port number (8990), which all the individual port numbers are
+  indexed from, can be set explicitly using runtests.pl' -b option to allow
+  running more than one instance of the test suite simultaneously on one
+  machine, or just move the servers in case you have local services on any of
+  those ports.
+
+ 1.4 Run
 
-Run:
   'make test'. This builds the test suite support code and invokes the
   'runtests.pl' perl script to run all the tests. Edit the top variables
   of that script in case you have some specific needs, or run the script
   manually (after the support code has been built).
 
   The script breaks on the first test that doesn't do OK. Use -a to prevent
-  the script from abort on the first error. Run the script with -v for more
+  the script from aborting on the first error. Run the script with -v for more
   verbose output. Use -d to run the test servers with debug output enabled as
   well. Specifying -k keeps all the log files generated by the test intact.
 
@@ -56,7 +98,8 @@ Run:
   3 to 9. Any test numbers starting with ! are disabled, as are any test
   numbers found in the file data/DISABLED (one per line).
 
-Shell startup scripts:
+ 1.5 Shell startup scripts
+
   Tests which use the ssh test server, SCP/SFTP/SOCKS tests, might be badly
   influenced by the output of system wide or user specific shell startup
   scripts, .bashrc, .profile, /etc/csh.cshrc, .login, /etc/bashrc, etc. which
@@ -71,44 +114,45 @@ Shell startup scripts:
   output of a shell startup script.  Locate, cleanup or adjust the shell
   script.
 
-Memory:
+ 1.6 Memory test
+
   The test script will check that all allocated memory is freed properly IF
   curl has been built with the CURLDEBUG define set. The script will
-  automatically detect if that is the case, and it will use the ../memanalyze
-  script to analyze the memory debugging output.
+  automatically detect if that is the case, and it will use the
+  'memanalyze.pl' script to analyze the memory debugging output.
+
+  Also, if you run tests on a machine where valgrind is found, the script will
+  use valgrind to run the test with (unless you use -n) to further verify
+  correctness.
 
-  The -t option will enable torture testing mode, which runs each test
-  many times but causes a different memory allocation to fail on each
-  successive run.  This tests the out of memory error handling code to
-  ensure that memory leaks do not occur even in those situations.
+  runtests.pl's -t option will enable torture testing mode, which runs each
+  test many times and makes each different memory allocation fail on each
+  successive run.  This tests the out of memory error handling code to ensure
+  that memory leaks do not occur even in those situations.
+
+ 1.7 Debug
 
-Debug:
   If a test case fails, you can conveniently get the script to invoke the
   debugger (gdb) for you with the server running and the exact same command
   line parameters that failed. Just invoke 'runtests.pl <test number> -g' and
   then just type 'run' in the debugger to perform the command through the
   debugger.
 
-  If a test case causes a core dump, analyze it by running gdb like:
-
-          # gdb ../curl/src core
+ 1.8 Logs
 
-  ... and get a stack trace with the gdb command:
+  All logs are generated in the logs/ subdirectory (it is emptied first in the
+  runtests.pl script). Use runtests.pl -k to force it to keep the temporary
+  files after the test run since successful runs will clean it up otherwise.
 
-          (gdb) where
+ 1.9 Test input files
 
-Logs:
-  All logs are generated in the logs/ subdirectory (it is emptied first
-  in the runtests.pl script). Use runtests.pl -k to keep the temporary files
-  after the test run.
-
-Data:
   All test cases are put in the data/ subdirectory. Each test is stored in the
   file named according to the test number.
 
   See FILEFORMAT for the description of the test case files.
 
-Code coverage:
+ 1.10 Code coverage
+
   gcc provides a tool that can determine the code coverage figures for
   the test suite.  To use it, configure curl with
   CFLAGS='-fprofile-arcs -ftest-coverage -g -O0'.  Make sure you run the normal
@@ -125,38 +169,83 @@ Code coverage:
   The text mode tool gcov may also be used, but it doesn't handle object files
   in more than one directory very well.
 
-Remote testing:
+ 1.11 Remote testing
+
   The runtests.pl script provides some hooks to allow curl to be tested on a
   machine where perl can not be run.  The test framework in this case runs on
   a workstation where perl is available, while curl itself is run on a remote
   system using ssh or some other remote execution method.  See the comments at
   the beginning of runtests.pl for details.
 
-TEST CASE NUMBERS
-
- So far, we've used this system:
-
- 1   -  99   HTTP
- 100 - 199   FTP*
- 200 - 299   FILE*
- 300 - 399   HTTPS
- 400 - 499   FTPS
- 500 - 599   libcurl source code tests, not using the curl command tool
- 600 - 699   SCP/SFTP
- 700 - 799   SOCKS4 (even numbers) and SOCK5 (odd numbers)
- 800 - 899   POP3, IMAP, SMTP
- 1000 - 1299 miscellaneous*
- 1300 - 1399 unit tests*
- 1400 - 1999 miscellaneous*
- 2000 - x    multiple sequential protocols per test case*
-
- Since 30-apr-2003, there's nothing in the system that requires us to keep
- within these number series, and those sections marked with * actually
- contain tests for a variety of protocols. Each test case now specifies
- its own server requirements, independent of test number.
-
-TODO:
-
-  * Add tests for TELNET, LDAP, DICT...
-  * SOCKS4/5 test deficiencies - no proxy authentication tests as SSH (the
-    test mechanism) doesn't support them
+2. Numbering
+
+ 2.1 Test case numbering
+
+     1   -  99   HTTP
+     100 - 199   FTP*
+     200 - 299   FILE*
+     300 - 399   HTTPS
+     400 - 499   FTPS
+     500 - 599   libcurl source code tests, not using the curl command tool
+     600 - 699   SCP/SFTP
+     700 - 799   SOCKS4 (even numbers) and SOCK5 (odd numbers)
+     800 - 899   POP3, IMAP, SMTP
+     1000 - 1299 miscellaneous*
+     1300 - 1399 unit tests*
+     1400 - 1999 miscellaneous*
+     2000 - x    multiple sequential protocols per test case*
+
+  Since 30-apr-2003, there's nothing in the system that requires us to keep
+  within these number series, and those sections marked with * actually
+  contain tests for a variety of protocols. Each test case now specifies its
+  own server requirements, independent of test number.
+
+3. Write tests
+
+  Here's a quick description on writing test cases. We basically have three
+  kinds of tests: the ones that test the curl tool, the ones that build small
+  applications and test libcurl directly and the unit tests that test
+  individual (possibly internal) functions.
+
+ 3.1 test data
+
+  Each test has a master file that controls all the test data. What to read,
+  what the protocol exchange should look like, what exit code to expect and
+  what command line arguments to use etc.
+
+  These files are tests/data/test[num] where [num] is described in section 2
+  of this document, and the XML-like file format of them is described in the
+  separate tests/FILEFORMAT document.
+
+ 3.2 curl tests
+
+  A test case that runs the curl tool and verifies that it gets the correct
+  data, it sends the correct data, it uses the correct protocol primitives
+  etc.
+
+ 3.3 libcurl tests
+
+  The libcurl tests are identical to the curl ones, except that they use a
+  specific and dedicated custom-built program to run instead of "curl". This
+  tool is built from source code placed in tests/libtest and if you want to
+  make a new libcurl test that is where you add your code.
+
+ 3.4 unit tests
+
+  Unit tests are tests in the 13xx sequence and they are placed in tests/unit.
+  There's a tests/unit/README describing the specific set of checks and macros
+  that may be used when writing tests that verify behaviors of specific
+  individual functions.
+
+  The unit tests depend on curl being built with debug enabled.
+
+4. TODO
+
+ 4.1 More protocols
+
+  Add tests for TELNET, LDAP, DICT...
+
+ 4.2 SOCKS auth
+
+  SOCKS4/5 test deficiencies - no proxy authentication tests as SSH (the
+  test mechanism) doesn't support them