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