tests/FILEFORMAT

   1  The test suite's file format is very simple and extensible, closely
   2 resembling XML. All data for a single test case resides in a single
   3 ASCII file. Labels mark the beginning and the end of all sections, and each
   4 label must be written in its own line.  Comments are either XML-style
   5 (enclosed with <!-- and -->) or C-style (beginning with #) and must appear
   6 on their own lines and not alongside actual test data.  Most test data files
   7 are syntactically valid XML, although a few files are not (lack of
   8 support for character entities and the preservation of CR/LF characters at
   9 the end of lines are the biggest differences).
  10
  11  The file begins with a 'testcase' tag, which encompasses the remainder of
  12 the file.
  13
  14 <testcase>
  15
  16  Each file is split up in three main sections: reply, client and verify. The
  17 reply section is used for the server to know what to send as a reply for the
  18 requests curl sends, the client section defines how the client should behave
  19 while the verify section defines how to verify that the data stored after a
  20 command has been run ended up correctly.
  21
  22  Each main section has a number of available subsections that can be
  23 specified, that will be checked/used if specified. This document includes all
  24 the subsections currently supported.
  25
  26 Main sections are 'info', 'reply', 'client' and 'verify'.
  27
  28 <info>
  29 <keywords>
  30 A newline-separated list of keywords describing what this test case uses and
  31 tests. Try to use an already used keyword. These keywords will be used for
  32 statistical/informational purposes.
  33 </keywords>
  34 </info>
  35
  36 <reply>
  37 <data [nocheck="1"] [sendzero="yes"] [base64="yes"]>
  38 data to be sent to the client on its request and later verified that it arrived
  39 safely. Set the nocheck=1 to prevent the test script to verify the arrival
  40 of this data.
  41
  42 If the data contains 'swsclose' anywhere within the start and end tag, and
  43 this is a HTTP test, then the connection will be closed by the server after
  44 this response is sent. If not, the connection will be kept persistent.
  45
  46 If the data contains 'swsbounce' anywhere within the start and end tag, the
  47 HTTP server will detect if this is a second request using the same test and
  48 part number and will then increase the part number with one. This is useful
  49 for auth tests and similar.
  50
  51 'sendzero' set to yes means that the (FTP) server will "send" the data even if
  52 the size is zero bytes. Used to verify curl's behaviour on zero bytes
  53 transfers.
  54
  55 'base64' set to yes means that the data provided in the test-file is a chunk
  56 of data encoded with base64. It is the only way a test case can contain binary
  57 data. (This attribute can in fact be used on any section, but it doesn't make
  58 much sense for other sections than "data").
  59 </data>
  60 <dataNUM>
  61 Send back this contents instead of the <data> one. The num is set by:
  62 A) The test number in the request line is >10000 and this is the remainder
  63 of [test case number]%10000.
  64 B) The request was HTTP and included digest details, which adds 1000 to NUM
  65 C) If a HTTP request is NTLM type-1, it adds 1001 to num
  66 D) If a HTTP request is NTLM type-3, it adds 1002 to num
  67 </dataNUM>
  68 <datacheck [nonewline="yes"]>
  69 if the data is sent but this is what should be checked afterwards. If
  70 'nonewline' is set, we will cut off the trailing newline of this given data
  71 before comparing with the one actually received by the client
  72 </datacheck>
  73 <size>
  74 number to return on a ftp SIZE command (set to -1 to make this command fail)
  75 </size>
  76 <mdtm>
  77 what to send back if the client sends a (FTP) MDTM command, set to -1 to
  78 have it return that the file doesn't exist
  79 </mdtm>
  80 <postcmd>
  81 special purpose server-command to control its behavior *after* the
  82 reply is sent
  83 For HTTP/HTTPS, these are supported:
  84
  85 wait [secs]
  86  - Pause for the given time
  87 </postcmd>
  88 <servercmd>
  89 Special-commands for the server.
  90 For FTP, these are supported:
  91
  92 REPLY [command] [return value] [response string]
  93  - Changes how the server responds to the [command]. [response string] is
  94    evaluated as a perl string, so it can contain embedded \r\n, for example.
  95 COUNT [command] [num]
  96  - Do the REPLY change for [command] only [num] times and then go back to the
  97    built-in approach
  98 DELAY [command] [secs]
  99  - Delay responding to this command for the given time
 100 RETRWEIRDO
 101  - Enable the "weirdo" RETR case when multiple response lines appear at once
 102    when a file is transfered
 103 RETRNOSIZE
 104  - Make sure the RETR response doesn't contain the size of the file
 105 NOSAVE
 106  - Don't actually save what is received
 107 SLOWDOWN
 108  - Send FTP responses with 0.1 sec delay between each byte
 109 PASVBADIP
 110  - makes PASV send back an illegal IP in its 227 response
 111
 112 For HTTP/HTTPS:
 113 auth_required - if this is set and a POST/PUT is made without auth, the
 114                 server will NOT wait for the full request body to get sent
 115 idle -          do nothing after receiving the request, just "sit idle"
 116 stream -        continuously send data to the client, never-ending
 117 pipe: [num] -   tell the server to expect this many HTTP requests before
 118                 sending back anything, to allow pipelining tests
 119 </servercmd>
 120 </reply>
 121
 122 <client>
 123
 124 <server>
 125 What server(s) this test case requires/uses:
 126
 127 file
 128 ftp
 129 ftp-ipv6
 130 ftps
 131 http
 132 http-ipv6
 133 https
 134 none
 135 scp
 136 sftp
 137 socks4
 138 socks5
 139
 140 Give only one per line.  This subsection is mandatory.
 141 </server>
 142
 143 <features>
 144 A list of features that MUST be present in the client/library for this test to
 145 be able to run (if these features are not present, the test will be
 146 SKIPPED). Features testable here are:
 147
 148 crypto
 149 getrlimit
 150 GnuTLS
 151 idn
 152 ipv6
 153 large_file
 154 libz
 155 netrc_debug
 156 NSS
 157 OpenSSL
 158 SSL
 159
 160 as well as each protocol that curl supports.  A protocol only needs to be
 161 specified if it is different from the server (useful when the server
 162 is 'none').
 163 </features>
 164
 165 <killserver>
 166 Using the same syntax as in <server> but when mentioned here these servers
 167 are explicitly KILLED when this test case is completed. Only use this if there
 168 is no other alternatives. Using this of course requires subsequent tests to
 169 restart servers.
 170 </killserver>
 171
 172 <precheck>
 173 A command line that if set gets run by the test script before the test. If an
 174 output is displayed by the command, the test will be skipped and the
 175 (single-line) output will be displayed as reason for not running the test.
 176 Variables are substituted as in the <command> section.
 177 </precheck>
 178
 179 <postcheck>
 180 A command line that if set gets run by the test script after the test. If
 181 the command exists with a non-zero status code, the test will be considered
 182 to have failed. Variables are substituted as in the <command> section.
 183 </postcheck>
 184
 185 <tool>
 186 Name of tool to use instead of "curl". This tool must be built and exist
 187 in the libtest/ directory.
 188 </tool>
 189
 190 <name>
 191 test case description
 192 </name>
 193
 194 <setenv>
 195 variable1=contents1
 196 variable2=contents2
 197
 198 Set the given environment variables to the specified value before the actual
 199 command is run. They are cleared again after the command has been run.
 200 Variables are first substituted as in the <command> section.
 201 </setenv>
 202
 203 <command [option="no-output"]>
 204 command line to run, there's a bunch of %variables that get replaced
 205 accordingly.
 206
 207 Note that the URL that gets passed to the server actually controls what data
 208 that is returned. The last slash in the URL must be followed by a number. That
 209 number (N) will be used by the test-server to load test case N and return the
 210 data that is defined within the <reply><data></data></reply> section.
 211
 212 If a CONNECT is used to the server (to emulate HTTPS etc over proxy), the port
 213 number given in the CONNECT request will be used to identify which test that
 214 is being run, if the proxy host name is said to start with 'test'.
 215
 216 Set option="no-output" to prevent the test script to slap on the --output
 217 argument that directs the output to a file. The --output is also not added if
 218 the verify/stdout section is used.
 219
 220 Available substitute variables include:
 221 %CLIENTIP   - IPv4 address of the client running curl
 222 %CLIENT6IP  - IPv6 address of the client running curl
 223 %HOSTIP    - IPv4 address of the host running this test
 224 %HOSTPORT  - Port number of the HTTP server
 225 %HOST6IP   - IPv6 address of the host running this test
 226 %HOST6PORT - IPv6 port number of the HTTP server
 227 %HTTPSPORT - Port number of the HTTPS server
 228 %FTPPORT   - Port number of the FTP server
 229 %FTP6PORT  - IPv6 port number of the FTP server
 230 %FTPSPORT  - Port number of the FTPS server
 231 %FTP2PORT  - Port number of the FTP server 2
 232 %FTPTIME2  - Timeout in seconds that should be just sufficient to receive
 233              a response from the test FTP server
 234 %TFTPPORT  - Port number of the TFTP server
 235 %TFTP6PORT - IPv6 port number of the TFTP server
 236 %SSHPORT   - Port number of the SCP/SFTP server
 237 %SOCKSPORT - Port number of the SOCKS4/5 server
 238 %SRCDIR    - Full path to the source dir
 239 %PWD       - Current directory
 240 %CURL      - Path to the curl executable
 241 %USER      - Login ID of the user running the test
 242 </command>
 243
 244 <file name="log/filename">
 245 This creates the named file with this content before the test case is run,
 246 which is useful if the test case needs a file to act on.
 247 Variables are substituted on the contents of the file as in the <command>
 248 section.
 249 </file>
 250
 251 <stdin>
 252 Pass this given data on stdin to the tool.
 253 </stdin>
 254
 255 </client>
 256
 257 <verify>
 258 <errorcode>
 259 numerical error code curl is supposed to return. Specify a list of accepted
 260 error codes by separating multiple numbers with comma. See test 237 for an
 261 example.
 262 </errorcode>
 263 <strip>
 264 One regex per line that is removed from the protocol dumps before the
 265 comparison is made. This is very useful to remove dependencies on dynamically
 266 changing protocol data such as port numbers or user-agent strings.
 267 </strip>
 268 <strippart>
 269 One perl op per line that operates on the protocol dump. This is pretty
 270 advanced. Example: "s/^EPRT .*/EPRT stripped/"
 271 </strippart>
 272 <protocol [nonewline="yes"]>
 273 the protocol dump curl should transmit, if 'nonewline' is set, we will cut
 274 off the trailing newline of this given data before comparing with the one
 275 actually sent by the client
 276 Variables are substituted as in the <command> section.
 277 </protocol>
 278 <stdout [mode="text"] [nonewline=yes]>
 279 This verifies that this data was passed to stdout.
 280
 281 Use the mode="text" attribute if the output is in text mode on platforms that
 282 have a text/binary difference.
 283
 284 If 'nonewline' is set, we will cut off the trailing newline of this given data
 285 before comparing with the one actually received by the client
 286 </stdout>
 287 <file name="log/filename" [mode="text"]>
 288 The file's contents must be identical to this after the test is complete.
 289 Use the mode="text" attribute if the output is in text mode on platforms that
 290 have a text/binary difference.
 291 Variables are substituted as in the <command> section.
 292 </file>
 293 <stripfile>
 294 One perl op per line that operates on the file before being compared. This is
 295 pretty advanced. Example: "s/^EPRT .*/EPRT stripped/"
 296 </stripfile>
 297 <upload>
 298 the contents of the upload data curl should have sent
 299 </upload>
 300 <valgrind>
 301 disable - disables the valgrind log check for this test
 302 </valgrind>
 303 </verify>
 304
 305 </testcase>