1 The test suite's file format is very simple and extensible, closely 2resembling XML. All data for a single test case resides in a single 3ASCII file. Labels mark the beginning and the end of all sections, and each 4label must be written in its own line. Comments are either XML-style 5(enclosed with <!-- and -->) or C-style (beginning with #) and must appear 6on their own lines and not alongside actual test data. Most test data files 7are syntactically valid XML, although a few files are not (lack of 8support for character entities and the preservation of CR/LF characters at 9the end of lines are the biggest differences). 10 11 The file begins with a 'testcase' tag, which encompasses the remainder of 12the file. 13 14<testcase> 15 16 Each file is split up in three main sections: reply, client and verify. The 17reply section is used for the server to know what to send as a reply for the 18requests curl sends, the client section defines how the client should behave 19while the verify section defines how to verify that the data stored after a 20command has been run ended up correctly. 21 22 Each main section has a number of available subsections that can be 23specified, that will be checked/used if specified. This document includes all 24the subsections currently supported. 25 26Main sections are 'info', 'reply', 'client' and 'verify'. 27 28<info> 29<keywords> 30A newline-separated list of keywords describing what this test case uses and 31tests. Try to use an already used keyword. These keywords will be used for 32statistical/informational purposes and for choosing or skipping classes 33of tests. "Keywords" must begin with an alphabetic character, "-", "[" 34or "{" and may actually consist of multiple words separated by spaces 35which are treated together as a single identifier. 36</keywords> 37</info> 38 39<reply> 40<data [nocheck="yes"] [sendzero="yes"] [base64="yes"]> 41data to be sent to the client on its request and later verified that it arrived 42safely. Set nocheck="yes" to prevent the test script from verifying the arrival 43of this data. 44 45If the data contains 'swsclose' anywhere within the start and end tag, and 46this is a HTTP test, then the connection will be closed by the server after 47this response is sent. If not, the connection will be kept persistent. 48 49If the data contains 'swsbounce' anywhere within the start and end tag, the 50HTTP server will detect if this is a second request using the same test and 51part number and will then increase the part number with one. This is useful 52for auth tests and similar. 53 54'sendzero' set to yes means that the (FTP) server will "send" the data even if 55the size is zero bytes. Used to verify curl's behaviour on zero bytes 56transfers. 57 58'base64' set to yes means that the data provided in the test-file is a chunk 59of data encoded with base64. It is the only way a test case can contain binary 60data. (This attribute can in fact be used on any section, but it doesn't make 61much sense for other sections than "data"). 62 63For FTP file listings, the <data> section will be used *only* if you make sure 64that there has been a CWD done first to a directory named 'test-[num]' where 65[num] is the test case number. Otherwise the ftp server can't know from which 66test file to load the list content. 67 68</data> 69<dataNUM> 70Send back this contents instead of the <data> one. The num is set by: 71A) The test number in the request line is >10000 and this is the remainder 72of [test case number]%10000. 73B) The request was HTTP and included digest details, which adds 1000 to NUM 74C) If a HTTP request is NTLM type-1, it adds 1001 to num 75D) If a HTTP request is NTLM type-3, it adds 1002 to num 76E) If a HTTP request is Basic and num is already >=1000, it adds 1 to num 77 78Dynamically changing num in this way allows the test harness to be used to 79test authentication negotiation where several different requests must be sent 80to complete a transfer. The response to each request is found in its own data 81section. Validating the entire negotiation sequence can be done by 82specifying a datacheck section. 83</dataNUM> 84<connect> 85The connect section is used instead of the 'data' for all CONNECT 86requests. The remainder of the rules for the data section then apply but with 87a connect prefix. 88</connect> 89<datacheck [nonewline="yes"]> 90if the data is sent but this is what should be checked afterwards. If 91'nonewline' is set, we will cut off the trailing newline of this given data 92before comparing with the one actually received by the client 93</datacheck> 94<size> 95number to return on a ftp SIZE command (set to -1 to make this command fail) 96</size> 97<mdtm> 98what to send back if the client sends a (FTP) MDTM command, set to -1 to 99have it return that the file doesn't exist 100</mdtm> 101<postcmd> 102special purpose server-command to control its behavior *after* the 103reply is sent 104For HTTP/HTTPS, these are supported: 105 106wait [secs] 107 - Pause for the given time 108</postcmd> 109<servercmd> 110Special-commands for the server. 111For FTP/SMTP/POP/IMAP, these are supported: 112 113REPLY [command] [return value] [response string] 114 - Changes how the server responds to the [command]. [response string] is 115 evaluated as a perl string, so it can contain embedded \r\n, for example. 116 There's a special [command] named "welcome" (without quotes) which is the 117 string sent immediately on connect as a welcome. 118COUNT [command] [num] 119 - Do the REPLY change for [command] only [num] times and then go back to the 120 built-in approach 121DELAY [command] [secs] 122 - Delay responding to this command for the given time 123RETRWEIRDO 124 - Enable the "weirdo" RETR case when multiple response lines appear at once 125 when a file is transfered 126RETRNOSIZE 127 - Make sure the RETR response doesn't contain the size of the file 128NOSAVE 129 - Don't actually save what is received 130SLOWDOWN 131 - Send FTP responses with 0.01 sec delay between each byte 132PASVBADIP 133 - makes PASV send back an illegal IP in its 227 response 134CAPA [capabilities] 135 - Enables support for and specifies a list of space separated capabilities to 136 return to the client for the IMAP CAPABILITY, POP3 CAPA and SMTP EHLO 137 commands 138AUTH [mechanisms] 139 - Enables support for SASL authentication and specifies a list of space 140 separated mechanisms for IMAP, POP3 and SMTP 141 142For HTTP/HTTPS: 143auth_required if this is set and a POST/PUT is made without auth, the 144 server will NOT wait for the full request body to get sent 145idle do nothing after receiving the request, just "sit idle" 146stream continuously send data to the client, never-ending 147writedelay: [secs] delay this amount between reply packets 148pipe: [num] tell the server to expect this many HTTP requests before 149 sending back anything, to allow pipelining tests 150skip: [num] instructs the server to ignore reading this many bytes from a PUT 151 or POST request 152 153rtp: part [num] channel [num] size [num] 154 stream a fake RTP packet for the given part on a chosen channel 155 with the given payload size 156 157connection-monitor When used, this will log [DISCONNECT] to the server.input 158 log when the connection is disconnected. 159 160 161For TFTP: 162writedelay: [secs] delay this amount between reply packets (each packet being 163 512 bytes payload) 164</servercmd> 165</reply> 166 167<client> 168 169<server> 170What server(s) this test case requires/uses: 171 172file 173ftp 174ftp-ipv6 175ftps 176http 177http-ipv6 178http-proxy 179https 180httptls+srp 181httptls+srp-ipv6 182imap 183none 184pop3 185rtsp 186rtsp-ipv6 187scp 188sftp 189smtp 190socks4 191socks5 192 193Give only one per line. This subsection is mandatory. 194</server> 195 196<features> 197A list of features that MUST be present in the client/library for this test to 198be able to run (if these features are not present, the test will be 199SKIPPED). Features testable here are: 200 201axTLS 202crypto 203debug 204getrlimit 205GnuTLS 206idn 207ipv6 208large_file 209libz 210Metalink 211NSS 212NTLM 213OpenSSL 214socks 215SSL 216TLS-SRP 217TrackMemory 218unittest 219 220as well as each protocol that curl supports. A protocol only needs to be 221specified if it is different from the server (useful when the server 222is 'none'). 223</features> 224 225<killserver> 226Using the same syntax as in <server> but when mentioned here these servers 227are explicitly KILLED when this test case is completed. Only use this if there 228is no other alternatives. Using this of course requires subsequent tests to 229restart servers. 230</killserver> 231 232<precheck> 233A command line that if set gets run by the test script before the test. If an 234output is displayed by the command or if the return code is non-zero, the test 235will be skipped and the (single-line) output will be displayed as reason for 236not running the test. Variables are substituted as in the <command> section. 237</precheck> 238 239<postcheck> 240A command line that if set gets run by the test script after the test. If 241the command exists with a non-zero status code, the test will be considered 242to have failed. Variables are substituted as in the <command> section. 243</postcheck> 244 245<tool> 246Name of tool to use instead of "curl". This tool must be built and exist 247either in the libtest/ directory (if the tool starts with 'lib') or in the 248unit/ directory (if the tool starts with 'unit'). 249</tool> 250 251<name> 252test case description 253</name> 254 255<setenv> 256variable1=contents1 257variable2=contents2 258 259Set the given environment variables to the specified value before the actual 260command is run. They are cleared again after the command has been run. 261Variables are first substituted as in the <command> section. 262</setenv> 263 264<command [option="no-output/no-include"] [timeout="secs"] [delay="secs"] 265 [type="perl"]> 266command line to run, there's a bunch of %variables that get replaced 267accordingly. 268 269Note that the URL that gets passed to the server actually controls what data 270that is returned. The last slash in the URL must be followed by a number. That 271number (N) will be used by the test-server to load test case N and return the 272data that is defined within the <reply><data></data></reply> section. 273 274If there's no test number found above, the HTTP test server will use the 275number following the last dot in the given hostname (made so that a CONNECT 276can still pass on test number) so that "foo.bar.123" gets treated as test case 277123. Alternatively, if an ipv6-address is provided to CONNECT, the last 278hexadecimal group in the address will be used as the test numer! For example 279the address "[1234::ff]" would be treated as test case 255. 280 281Set type="perl" to write the test case as a perl script. It implies that 282there's no memory debugging and valgrind gets shut off for this test. 283 284Set option="no-output" to prevent the test script to slap on the --output 285argument that directs the output to a file. The --output is also not added if 286the verify/stdout section is used. 287 288Set option="no-include" to prevent the test script to slap on the --include 289argument. 290 291Set timeout="secs" to override default server logs advisor read lock timeout. 292This timeout is used by the test harness, once that the command has completed 293execution, to wait for the test server to write out server side log files and 294remove the lock that advised not to read them. The "secs" parameter is the not 295negative integer number of seconds for the timeout. This 'timeout' attribute 296is documented for completeness sake, but is deep test harness stuff and only 297needed for very singular and specific test cases. Avoid using it. 298 299Set delay="secs" to introduce a time delay once that the command has completed 300execution and before the <postcheck> section runs. The "secs" parameter is the 301not negative integer number of seconds for the delay. This 'delay' attribute 302is intended for very specific test cases, and normally not needed. 303 304Available substitute variables include: 305%CLIENT6IP - IPv6 address of the client running curl 306%CLIENTIP - IPv4 address of the client running curl 307%CURL - Path to the curl executable 308%FTP2PORT - Port number of the FTP server 2 309%FTP6PORT - IPv6 port number of the FTP server 310%FTPPORT - Port number of the FTP server 311%FTPSPORT - Port number of the FTPS server 312%FTPTIME2 - Timeout in seconds that should be just sufficient to receive 313 a response from the test FTP server 314%FTPTIME3 - Even longer than %FTPTIME2 315%GOPHER6PORT - IPv6 port number of the Gopher server 316%GOPHERPORT - Port number of the Gopher server 317%HOST6IP - IPv6 address of the host running this test 318%HOSTIP - IPv4 address of the host running this test 319%HTTP6PORT - IPv6 port number of the HTTP server 320%HTTPPIPEPORT - Port number of the HTTP pipelining server 321%HTTPPORT - Port number of the HTTP server 322%HTTPSPORT - Port number of the HTTPS server 323%HTTPTLS6PORT - IPv6 port number of the HTTP TLS server 324%HTTPTLSPORT - Port number of the HTTP TLS server 325%IMAP6PORT - IPv6 port number of the IMAP server 326%IMAPPORT - Port number of the IMAP server 327%POP36PORT - IPv6 ort number of the POP3 server 328%POP3PORT - Port number of the POP3 server 329%PROXYPORT - Port number of the HTTP proxy 330%PWD - Current directory 331%RTSP6PORT - IPv6 port number of the RTSP server 332%RTSPPORT - Port number of the RTSP server 333%SMTP6PORT - IPv6 port number of the SMTP server 334%SMTPPORT - Port number of the SMTP server 335%SOCKSPORT - Port number of the SOCKS4/5 server 336%SRCDIR - Full path to the source dir 337%SSHPORT - Port number of the SCP/SFTP server 338%TFTP6PORT - IPv6 port number of the TFTP server 339%TFTPPORT - Port number of the TFTP server 340%USER - Login ID of the user running the test 341</command> 342 343<file name="log/filename"> 344This creates the named file with this content before the test case is run, 345which is useful if the test case needs a file to act on. 346Variables are substituted on the contents of the file as in the <command> 347section. 348</file> 349 350<stdin [nonewline="yes"]> 351Pass this given data on stdin to the tool. 352 353If 'nonewline' is set, we will cut off the trailing newline of this given data 354before comparing with the one actually received by the client 355</stdin> 356 357</client> 358 359<verify> 360<errorcode> 361numerical error code curl is supposed to return. Specify a list of accepted 362error codes by separating multiple numbers with comma. See test 237 for an 363example. 364</errorcode> 365<strip> 366One regex per line that is removed from the protocol dumps before the 367comparison is made. This is very useful to remove dependencies on dynamically 368changing protocol data such as port numbers or user-agent strings. 369</strip> 370<strippart> 371One perl op per line that operates on the protocol dump. This is pretty 372advanced. Example: "s/^EPRT .*/EPRT stripped/" 373</strippart> 374 375<protocol [nonewline="yes"]> 376 377the protocol dump curl should transmit, if 'nonewline' is set, we will cut off 378the trailing newline of this given data before comparing with the one actually 379sent by the client Variables are substituted as in the <command> section. The 380<strip> and <strippart> rules are applied before comparisons are made. 381 382</protocol> 383 384<proxy [nonewline="yes"]> 385 386The protocol dump curl should transmit to a HTTP proxy (when the http-proxy 387server is used), if 'nonewline' is set, we will cut off the trailing newline 388of this given data before comparing with the one actually sent by the client 389Variables are substituted as in the <command> section. The <strip> and 390<strippart> rules are applied before comparisons are made. 391 392</proxy> 393 394<stdout [mode="text"] [nonewline="yes"]> 395This verifies that this data was passed to stdout. Variables are 396substituted as in the <command> section. 397 398Use the mode="text" attribute if the output is in text mode on platforms that 399have a text/binary difference. 400 401If 'nonewline' is set, we will cut off the trailing newline of this given data 402before comparing with the one actually received by the client 403</stdout> 404<file name="log/filename" [mode="text"]> 405The file's contents must be identical to this after the test is complete. 406Use the mode="text" attribute if the output is in text mode on platforms that 407have a text/binary difference. 408Variables are substituted as in the <command> section. 409</file> 410<stripfile> 411One perl op per line that operates on the file before being compared. This is 412pretty advanced. Example: "s/^EPRT .*/EPRT stripped/" 413</stripfile> 414<upload> 415the contents of the upload data curl should have sent 416</upload> 417<valgrind> 418disable - disables the valgrind log check for this test 419</valgrind> 420</verify> 421 422</testcase> 423