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]
  94 COUNT [command] [num]
  95  - Do the REPLY change for [command] only [num] times and then go back to the
  96    built-in approach
  97 DELAY [command] [secs]
  98  - Delay responding to this command for the given time
  99 RETRWEIRDO
 100  - Enable the "weirdo" RETR case when multiple response lines appear at once
 101    when a file is transfered
 102 RETRNOSIZE
 103  - Make sure the RETR response doesn't contain the size of the file
 104 NOSAVE
 105  - Don't actually save what is received
 106 SLOWDOWN
 107  - Send FTP responses with 0.1 sec delay between each byte
 108 PASVBADIP
 109  - makes PASV send back an illegal IP in its 227 response
 110
 111 For HTTP/HTTPS:
 112 auth_required - if this is set and a POST/PUT is made without auth, the
 113                 server will NOT wait for the full request body to get sent
 114 idle -          do nothing after receiving the request, just "sit idle"
 115 stream -        continuously send data to the client, never-ending
 116 pipe: [num] -   tell the server to expect this many HTTP requests before
 117                 sending back anything, to allow pipelining tests
 118 </servercmd>
 119 </reply>
 120
 121 <client>
 122
 123 <server>
 124 What server(s) this test case requires/uses:
 125
 126 file
 127 ftp
 128 ftp-ipv6
 129 ftps
 130 http
 131 http-ipv6
 132 https
 133 none
 134 scp
 135 sftp
 136
 137 Give only one per line.  This subsection is mandatory.
 138 </server>
 139
 140 <features>
 141 A list of features that MUST be present in the client/library for this test to
 142 be able to run (if these features are not present, the test will be
 143 SKIPPED). Features testable here are:
 144
 145 crypto
 146 getrlimit
 147 GnuTLS
 148 idn
 149 ipv6
 150 large_file
 151 libz
 152 netrc_debug
 153 NSS
 154 OpenSSL
 155 SSL
 156
 157 as well as each protocol that curl supports.  A protocol only needs to be
 158 specified if it is different from the server (useful when the server
 159 is 'none').
 160 </features>
 161
 162 <killserver>
 163 Using the same syntax as in <server> but when mentioned here these servers
 164 are explicitly KILLED when this test case is completed. Only use this if there
 165 is no other alternatives. Using this of course requires subsequent tests to
 166 restart servers.
 167 </killserver>
 168
 169 <precheck>
 170 A command line that if set gets run by the test script before the test. If an
 171 output is displayed by the command, the test will be skipped and the
 172 (single-line) output will be displayed as reason for not running the test.
 173 Variables are substituted as in the <command> section.
 174 </precheck>
 175
 176 <postcheck>
 177 A command line that if set gets run by the test script after the test. If
 178 the command exists with a non-zero status code, the test will be considered
 179 to have failed. Variables are substituted as in the <command> section.
 180 </postcheck>
 181
 182 <tool>
 183 Name of tool to use instead of "curl". This tool must be built and exist
 184 in the libtest/ directory.
 185 </tool>
 186
 187 <name>
 188 test case description
 189 </name>
 190
 191 <setenv>
 192 variable1=contents1
 193 variable2=contents2
 194
 195 Set the given environment variables to the specified value before the actual
 196 command is run. They are cleared again after the command has been run.
 197 Variables are first substituted as in the <command> section.
 198 </setenv>
 199
 200 <command [option="no-output"]>
 201 command line to run, there's a bunch of %variables that get replaced
 202 accordingly.
 203
 204 Note that the URL that gets passed to the server actually controls what data
 205 that is returned. The last slash in the URL must be followed by a number. That
 206 number (N) will be used by the test-server to load test case N and return the
 207 data that is defined within the <reply><data></data></reply> section.
 208
 209 If a CONNECT is used to the server (to emulate HTTPS etc over proxy), the port
 210 number given in the CONNECT request will be used to identify which test that
 211 is being run, if the proxy host name is said to start with 'test'.
 212
 213 Set 'option=no-output' to prevent the test script to slap on the --output
 214 argument that directs the output to a file. The --output is also not added if
 215 the client/stdout section is used.
 216
 217 Available substitute variables include:
 218 %HOSTIP    - IPv6 address of the host running this test
 219 %HOSTPORT  - Port number of the HTTP server
 220 %HOST6IP   - IPv6 address of the host running this test
 221 %HOST6PORT - IPv6 port number of the HTTP server
 222 %HTTPSPORT - Port number of the HTTPS server
 223 %FTPPORT   - Port number of the FTP server
 224 %FTP6PORT  - IPv6 port number of the FTP server
 225 %FTPSPORT  - Port number of the FTPS server
 226 %FTP2PORT  - Port number of the FTP server 2
 227 %TFTPPORT  - Port number of the TFTP server
 228 %TFTP6PORT - IPv6 port number of the TFTP server
 229 %SSHPORT   - Port number of the SCP/SFTP server
 230 %SRCDIR    - Full path to the source dir
 231 %PWD       - Current directory
 232 %CURL      - Path to the curl executable
 233 %USER      - Login ID of the user running the test
 234 </command>
 235
 236 <file name="log/filename">
 237 This creates the named file with this content before the test case is run,
 238 which is useful if the test case needs a file to act on.
 239 Variables are substituted on the contents of the file as in the <command>
 240 section.
 241 </file>
 242
 243 <stdin>
 244 Pass this given data on stdin to the tool.
 245 </stdin>
 246
 247 </client>
 248
 249 <verify>
 250 <errorcode>
 251 numerical error code curl is supposed to return. Specify a list of accepted
 252 error codes by separating multiple numbers with comma. See test 237 for an
 253 example.
 254 </errorcode>
 255 <strip>
 256 One regex per line that is removed from the protocol dumps before the
 257 comparison is made. This is very useful to remove dependencies on dynamically
 258 changing protocol data such as port numbers or user-agent strings.
 259 </strip>
 260 <strippart>
 261 One perl op per line that operates on the protocol dump. This is pretty
 262 advanced. Example: "s/^EPRT .*/EPRT stripped/"
 263 </strippart>
 264 <protocol [nonewline="yes"]>
 265 the protocol dump curl should transmit, if 'nonewline' is set, we will cut
 266 off the trailing newline of this given data before comparing with the one
 267 actually sent by the client
 268 Variables are substituted as in the <command> section.
 269 </protocol>
 270 <stdout [mode="text"]>
 271 This verifies that this data was passed to stdout.
 272
 273 Use the mode="text" attribute if the output is in text mode on platforms that
 274 have a text/binary difference.
 275 </stdout>
 276 <file name="log/filename" [mode="text"]>
 277 The file's contents must be identical to this after the test is complete.
 278
 279 Use the mode="text" attribute if the output is in text mode on platforms that
 280 have a text/binary difference.
 281 </file>
 282 <stripfile>
 283 One perl op per line that operates on the file before being compared. This is
 284 pretty advanced. Example: "s/^EPRT .*/EPRT stripped/"
 285 </stripfile>
 286 <upload>
 287 the contents of the upload data curl should have sent
 288 </upload>
 289 <valgrind>
 290 disable - disables the valgrind log check for this test
 291 </valgrind>
 292 </verify>
 293
 294 </testcase>