curl/tests
Dan Fandrich e9a460411f Fixed an infinite loop when given an invalid SFTP quote command. 2008-03-18 22:59:04 +00:00
..
data Fixed an infinite loop when given an invalid SFTP quote command. 2008-03-18 22:59:04 +00:00
libtest Spell the commands right 2008-03-15 01:03:23 +00:00
server fix log message used when unable to connect to destination port 2008-03-05 18:27:31 +00:00
.cvsignore To verify that the sftp server is actually running, responsive and that 2008-02-08 13:54:02 +00:00
FILEFORMAT Fixed the test harness so it will write out zero-length data files. 2008-03-06 01:11:43 +00:00
Makefile.am Modify test harness so that the minimum SSH version required to run 2008-01-03 20:48:22 +00:00
README fixed typo 2008-03-10 14:32:19 +00:00
ftp.pm Clear out FTP server options before each new client. 2007-04-24 21:30:39 +00:00
ftpserver.pl Revert last change since it breaks running the test suite 2007-11-23 09:50:44 +00:00
getpart.pm Make the test script tag parser a bit more robust. 2007-01-18 20:32:46 +00:00
httpserver.pl Revert last change since it breaks running the test suite 2007-11-23 09:50:44 +00:00
httpsserver.pl Use getcwd() to get the directory, which works even if one of the directory 2007-12-22 18:25:43 +00:00
keywords.pl sum up 2005-05-20 11:14:44 +00:00
memanalyze.pl Using fdopen() is a more correct way to implement the CURLOPT_NEW_FILE_PREMS 2007-06-28 11:11:29 +00:00
runtests.1 Fixed the -l option of runtests.pl 2007-10-11 21:15:09 +00:00
runtests.pl Fixed the test harness so it will write out zero-length data files. 2008-03-06 01:11:43 +00:00
sshhelp.pm To verify that the sftp server is actually running, responsive and that 2008-02-08 13:54:02 +00:00
sshserver.pl Additional SunSSH 1.1 ssh server options 2008-02-11 14:28:48 +00:00
stunnel.pem jayjwa added the "DH PARAMETERS" to make this work with recent stunnels 2007-04-14 20:29:09 +00:00
testcurl.1 added -nobuildconf 2005-05-20 11:24:55 +00:00
testcurl.pl Use getcwd() to get the directory, which works even if one of the 2007-12-20 21:21:43 +00:00
valgrind.pm Detect curl source when valgrind provides an absolute source file name 2007-10-31 18:32:06 +00:00

README

                                  _   _ ____  _     
                              ___| | | |  _ \| |    
                             / __| | | | |_) | |    
                            | (__| |_| |  _ <| |___ 
                             \___|\___/|_| \_\_____|

The cURL Test Suite

Requires:
  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)

TCP ports used by default:

  - 8990 on localhost for HTTP tests
  - 8991 on localhost for HTTPS tests
  - 8994 on localhost for HTTP IPv6 tests
  - 8992 on localhost for FTP tests
  - 8995 on localhost for FTP (2) tests
  - 8993 on localhost for FTPS tests
  - 8996 on localhost for FTP IPv6 tests
  - 8997 on localhost for TFTP tests
  - 8999 on localhost for SCP/SFTP tests
  - 9000 on localhost for SOCKS tests

  The test suite runs simple FTP, HTTP and TFTP 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.

  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.

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
  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.

  Use -s for shorter output, or pass test numbers to run specific tests only
  (like "./runtests.pl 3 4" to test 3 and 4 only). It also supports test case
  ranges with 'to', as in "./runtests 3 to 9" which runs the seven tests from
  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:
  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 output text
  messages or escape sequences on user login.  When these shell startup messages
  or escape sequences are output they might corrupt the expected stream of data
  which flows to the sftp-server or from the ssh client which can result in bad
  test behaviour or even prevent the test server from running.

  If the test suite ssh or sftp server fails to start up and logs the message
  'Received message too long' then you are certainly suffering the unwanted
  output of a shell startup script.  Locate, cleanup or adjust the shell script.

Memory:
  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.

  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.

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

  ... and get a stack trace with the gdb command:

          (gdb) where

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:
  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
  and torture tests to get more full coverage, i.e. do:

    make test
    cd tests
    make torture-test

  The graphical tool ggcov can be used to browse the source and create
  coverage reports on *NIX hosts:

    ggcov -r lib src

  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:
  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, I'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)
 1000 - 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