tests/FILEFORMAT

   1  The file format of the test suite is a very simple and extendable format. All
   2 data for a single test case resides in a single ASCII file. Labels mark the
   3 beginning and the end of all sections. Each label must be written in its own
   4 line and is resembling XML/HTML.
   5
   6  Each file is split up in three main sections: reply, client and verify. The
   7 reply section is used for the server to know what to send as a reply for the
   8 requests curl sends, the client section defines how the client should behave
   9 while the verify section defines how to verify that the data stored after a
  10 command has been run ended up correctly.
  11
  12  Each main section has a number of available subsections that can be
  13 specified, that will be checked/used if specified. This document includes all
  14 the subsections currently supported.
  15
  16 <reply>
  17 <data [nocheck=1]>
  18 data to sent to the client on its request and later verified that it arrived
  19 safely. Set the nocheck=1 to prevent the test script to verify the arrival
  20 of this data.
  21 </data>
  22 <dataNUM>
  23 Send back this contents instead of the <data> one. The num is set by:
  24 A) The test number in the request line is >10000 and this is the remainder
  25 of [test case number]%10000.
  26 B) The request was HTTP and included digest details, which sets NUM to 1000.
  27 C) If a HTTP request is NTLM type-1, it sets num to 1001
  28 D) If a HTTP request is NTLM type-3, it sets num to 1002
  29 </dateNUM>
  30 <datacheck [nonewline=yes]>
  31 if the data is sent but this is what should be checked afterwards. If
  32 'nonewline' is set, we will cut off the trailing newline of this given data
  33 before comparing with the one actually received by the client
  34 </datacheck>
  35 <size>
  36 number to return on a ftp SIZE command (set to -1 to make this command fail)
  37 </size>
  38 <mdtm>
  39 what to send back if the client sends a (FTP) MDTM command, set to -1 to
  40 have it return that the file doesn't exist
  41 </mdtm>
  42 <cmd>
  43 special purpose server-command to control its behavior *before* the
  44 reply is sent
  45 </cmd>
  46 <postcmd>
  47 special purpose server-command to control its behavior *after* the
  48 reply is sent
  49 </postcmd>
  50 </reply>
  51
  52 <client>
  53
  54 <server>
  55 protocols as in 'http' 'ftp' etc. Give only one per line. Used for test cases
  56 500+ (at this point) to specify which servers the test case requires. In the
  57 future all test cases should use this. Makes us independent of the test
  58 case number.
  59 </server>
  60
  61 <features>
  62 A list of features that must be present in the client/library for this test
  63 to be able to run. Features testable here are:
  64 SSL
  65 netrc_debug
  66 </features>
  67
  68 <killserver>
  69 Using the same syntax as in <server> but when mentioned here these servers
  70 are explicitly KILLED when this test case is completed. Only use this if there
  71 is no other alternatives. Using this of course requires subsequent tests to
  72 restart servers.
  73 </killserver>
  74
  75 <tool>
  76 Name of tool to use instead of "curl". This tool must be built and exist
  77 in the libtest/ directory.
  78 </tool>
  79
  80 <name>
  81 test case description
  82 </name>
  83
  84 <setenv>
  85 variable1=contents1
  86 variable2=contents2
  87
  88 Set the given environment variables to the specified value before the actual
  89 command is run, they are clear again after the command has been run.
  90 </setenv>
  91
  92 <command [option=no-output]>
  93 command line to run, there's a bunch of %variables that get replaced
  94 accordingly. more about them elsewhere
  95
  96 Set 'option=no-output' to prevent the test script to slap on the --output
  97 argument that directs the output to a file. The --output is also not added if
  98 the client/stdout section is used.
  99
 100 Available substitute variables include:
 101 %HOSTIP    - IP address of the host running this test
 102 %HOSTPORT  - Port number of the HTTP server
 103 %HTTPSPORT - Port number of the HTTPS server
 104 %FTPPORT   - Port number of the FTP server
 105 %FTPSPORT  - Port number of the FTPS server
 106 %SRCDIR    - Full path to the source dir
 107 %PWD       - Current directory
 108 </command>
 109
 110 <file name="log/filename">
 111 this creates the named file with this content before the test case is run
 112 which is useful if the test case needs a file to act on.
 113 </file>
 114
 115 </client>
 116
 117 <verify>
 118 <errorcode>
 119 numerical error code curl is supposed to return
 120 </errorcode>
 121 <strip>
 122 One regex per line that is removed from the protocol dumps before the
 123 comparison is made. This is very useful to remove dependencies on dynamicly
 124 changing protocol data such as port numbers or user-agent strings.
 125 </strip>
 126 <protocol [nonewline=yes]>
 127 the protocol dump curl should transmit, if 'nonewline' is set, we will cut
 128 off the trailing newline of this given data before comparing with the one
 129 actually sent by the client
 130 </protocol>
 131 <stdout>
 132 This verfies that this data was passed to stdout.
 133 </stdout>
 134 <file name="log/filename">
 135 the file's contents must be identical to this
 136 </file>
 137 <upload>
 138 the contents of the upload data curl should have sent
 139 </upload>
 140 </verify>