tests/README

   1                                   _   _ ____  _
   2                               ___| | | |  _ \| |
   3                              / __| | | | |_) | |
   4                             | (__| |_| |  _ <| |___
   5                              \___|\___/|_| \_\_____|
   6
   7 The cURL Test Suite
   8
   9  1. Running
  10   1.1 Requires to run
  11   1.2 Port numbers used by test servers
  12   1.3 Test servers
  13   1.4 Run
  14   1.5 Shell startup scripts
  15   1.6 Memory test
  16   1.7 Debug
  17   1.8 Logs
  18   1.9 Test input files
  19   1.10 Code coverage
  20   1.11 Remote testing
  21
  22  2. Numbering
  23   2.1 Test case numbering
  24
  25  3. Write tests
  26   3.1 test data
  27   3.2 curl tests
  28   3.3 libcurl tests
  29   3.4 unit tests
  30
  31  4. TODO
  32   4.1 More protocols
  33   4.2 SOCKS auth
  34
  35 ==============================================================================
  36
  37 1. Running
  38
  39  1.1 Requires to run
  40
  41   perl (and a unix-style shell)
  42   python (and a unix-style shell)
  43   diff (when a test fails, a diff is shown)
  44   stunnel (for HTTPS and FTPS tests)
  45   OpenSSH or SunSSH (for SCP, SFTP and SOCKS4/5 tests)
  46
  47  1.2 Port numbers used by test servers
  48
  49   - TCP/8990 for HTTP
  50   - TCP/8991 for HTTPS
  51   - TCP/8992 for FTP
  52   - TCP/8993 for FTPS
  53   - TCP/8994 for HTTP IPv6
  54   - TCP/8995 for FTP (2)
  55   - TCP/8996 for FTP IPv6
  56   - UDP/8997 for TFTP
  57   - UDP/8998 for TFTP IPv6
  58   - TCP/8999 for SCP/SFTP
  59   - TCP/9000 for SOCKS
  60   - TCP/9001 for POP3
  61   - TCP/9002 for IMAP
  62   - TCP/9003 for SMTP
  63   - TCP/9004 for SMTP IPv6
  64   - TCP/9005 for RTSP
  65   - TCP/9006 for RTSP IPv6
  66   - TCP/9007 for GOPHER
  67   - TCP/9008 for GOPHER IPv6
  68   - TCP/9008 for HTTPS server with TLS-SRP support
  69
  70  1.3 Test servers
  71
  72   The test suite runs simple FTP, POP3, IMAP, SMTP, HTTP and TFTP stand-alone
  73   servers on the ports listed above to which it makes requests. For SSL tests,
  74   it runs stunnel to handle encryption to the regular servers. For SSH, it
  75   runs a standard OpenSSH server. For SOCKS4/5 tests SSH is used to perform
  76   the SOCKS functionality and requires a SSH client and server.
  77
  78   The base port number (8990), which all the individual port numbers are
  79   indexed from, can be set explicitly using runtests.pl' -b option to allow
  80   running more than one instance of the test suite simultaneously on one
  81   machine, or just move the servers in case you have local services on any of
  82   those ports.
  83
  84   The HTTP server supports listening on a Unix domain socket, the default
  85   location is 'http.sock'.
  86
  87  1.4 Run
  88
  89   'make test'. This builds the test suite support code and invokes the
  90   'runtests.pl' perl script to run all the tests. Edit the top variables
  91   of that script in case you have some specific needs, or run the script
  92   manually (after the support code has been built).
  93
  94   The script breaks on the first test that doesn't do OK. Use -a to prevent
  95   the script from aborting on the first error. Run the script with -v for more
  96   verbose output. Use -d to run the test servers with debug output enabled as
  97   well. Specifying -k keeps all the log files generated by the test intact.
  98
  99   Use -s for shorter output, or pass test numbers to run specific tests only
 100   (like "./runtests.pl 3 4" to test 3 and 4 only). It also supports test case
 101   ranges with 'to', as in "./runtests 3 to 9" which runs the seven tests from
 102   3 to 9. Any test numbers starting with ! are disabled, as are any test
 103   numbers found in the file data/DISABLED (one per line).
 104
 105   When -s is not present, each successful test will display on one line the
 106   test number and description and on the next line a set of flags, the test
 107   result, current test sequence, total number of tests to be run and an
 108   estimated amount of time to complete the test run. The flags consist of
 109   these letters describing what is checked in this test:
 110
 111     s stdout
 112     d data
 113     u upload
 114     p protocol
 115     o output
 116     e exit code
 117     m memory
 118     v valgrind
 119
 120  1.5 Shell startup scripts
 121
 122   Tests which use the ssh test server, SCP/SFTP/SOCKS tests, might be badly
 123   influenced by the output of system wide or user specific shell startup
 124   scripts, .bashrc, .profile, /etc/csh.cshrc, .login, /etc/bashrc, etc. which
 125   output text messages or escape sequences on user login.  When these shell
 126   startup messages or escape sequences are output they might corrupt the
 127   expected stream of data which flows to the sftp-server or from the ssh
 128   client which can result in bad test behaviour or even prevent the test
 129   server from running.
 130
 131   If the test suite ssh or sftp server fails to start up and logs the message
 132   'Received message too long' then you are certainly suffering the unwanted
 133   output of a shell startup script.  Locate, cleanup or adjust the shell
 134   script.
 135
 136  1.6 Memory test
 137
 138   The test script will check that all allocated memory is freed properly IF
 139   curl has been built with the CURLDEBUG define set. The script will
 140   automatically detect if that is the case, and it will use the
 141   'memanalyze.pl' script to analyze the memory debugging output.
 142
 143   Also, if you run tests on a machine where valgrind is found, the script will
 144   use valgrind to run the test with (unless you use -n) to further verify
 145   correctness.
 146
 147   runtests.pl's -t option will enable torture testing mode, which runs each
 148   test many times and makes each different memory allocation fail on each
 149   successive run.  This tests the out of memory error handling code to ensure
 150   that memory leaks do not occur even in those situations. It can help to
 151   compile curl with CPPFLAGS=-DMEMDEBUG_LOG_SYNC when using this option, to
 152   ensure that the memory log file is properly written even if curl crashes.
 153
 154  1.7 Debug
 155
 156   If a test case fails, you can conveniently get the script to invoke the
 157   debugger (gdb) for you with the server running and the exact same command
 158   line parameters that failed. Just invoke 'runtests.pl <test number> -g' and
 159   then just type 'run' in the debugger to perform the command through the
 160   debugger.
 161
 162  1.8 Logs
 163
 164   All logs are generated in the logs/ subdirectory (it is emptied first in the
 165   runtests.pl script). Use runtests.pl -k to force it to keep the temporary
 166   files after the test run since successful runs will clean it up otherwise.
 167
 168  1.9 Test input files
 169
 170   All test cases are put in the data/ subdirectory. Each test is stored in the
 171   file named according to the test number.
 172
 173   See FILEFORMAT for the description of the test case files.
 174
 175  1.10 Code coverage
 176
 177   gcc provides a tool that can determine the code coverage figures for
 178   the test suite.  To use it, configure curl with
 179   CFLAGS='-fprofile-arcs -ftest-coverage -g -O0'.  Make sure you run the normal
 180   and torture tests to get more full coverage, i.e. do:
 181
 182     make test
 183     make test-torture
 184
 185   The graphical tool ggcov can be used to browse the source and create
 186   coverage reports on *NIX hosts:
 187
 188     ggcov -r lib src
 189
 190   The text mode tool gcov may also be used, but it doesn't handle object files
 191   in more than one directory very well.
 192
 193  1.11 Remote testing
 194
 195   The runtests.pl script provides some hooks to allow curl to be tested on a
 196   machine where perl can not be run.  The test framework in this case runs on
 197   a workstation where perl is available, while curl itself is run on a remote
 198   system using ssh or some other remote execution method.  See the comments at
 199   the beginning of runtests.pl for details.
 200
 201 2. Numbering
 202
 203  2.1 Test case numbering
 204
 205      1   -  99   HTTP
 206      100 - 199   FTP*
 207      200 - 299   FILE*
 208      300 - 399   HTTPS
 209      400 - 499   FTPS
 210      500 - 599   libcurl source code tests, not using the curl command tool
 211      600 - 699   SCP/SFTP
 212      700 - 799   SOCKS4 (even numbers) and SOCK5 (odd numbers)
 213      800 - 899   POP3, IMAP, SMTP
 214      1000 - 1299 miscellaneous*
 215      1300 - 1399 unit tests*
 216      1400 - 1499 miscellaneous*
 217      1500 - 1599 libcurl source code tests, not using the curl command tool
 218                  (same as 5xx)
 219      2000 - x    multiple sequential protocols per test case*
 220
 221   Since 30-apr-2003, there's nothing in the system that requires us to keep
 222   within these number series, and those sections marked with * actually
 223   contain tests for a variety of protocols. Each test case now specifies its
 224   own server requirements, independent of test number.
 225
 226 3. Write tests
 227
 228   Here's a quick description on writing test cases. We basically have three
 229   kinds of tests: the ones that test the curl tool, the ones that build small
 230   applications and test libcurl directly and the unit tests that test
 231   individual (possibly internal) functions.
 232
 233  3.1 test data
 234
 235   Each test has a master file that controls all the test data. What to read,
 236   what the protocol exchange should look like, what exit code to expect and
 237   what command line arguments to use etc.
 238
 239   These files are tests/data/test[num] where [num] is described in section 2
 240   of this document, and the XML-like file format of them is described in the
 241   separate tests/FILEFORMAT document.
 242
 243  3.2 curl tests
 244
 245   A test case that runs the curl tool and verifies that it gets the correct
 246   data, it sends the correct data, it uses the correct protocol primitives
 247   etc.
 248
 249  3.3 libcurl tests
 250
 251   The libcurl tests are identical to the curl ones, except that they use a
 252   specific and dedicated custom-built program to run instead of "curl". This
 253   tool is built from source code placed in tests/libtest and if you want to
 254   make a new libcurl test that is where you add your code.
 255
 256  3.4 unit tests
 257
 258   Unit tests are tests in the 13xx sequence and they are placed in tests/unit.
 259   There's a tests/unit/README describing the specific set of checks and macros
 260   that may be used when writing tests that verify behaviors of specific
 261   individual functions.
 262
 263   The unit tests depend on curl being built with debug enabled.
 264
 265 4. TODO
 266
 267  4.1 More protocols
 268
 269   Add tests for TELNET, LDAP, DICT...
 270
 271  4.2 SOCKS auth
 272
 273   SOCKS4/5 test deficiencies - no proxy authentication tests as SSH (the
 274   test mechanism) doesn't support them