neo/curl/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
  22 If the data contains 'swsclose' *anywhere* within the start and end tag, and
  23 this is a HTTP test, then the connection will be closed by the server after
  24 this response is sent. If not, the connection will be kept persistant.
  25 </data>
  26 <dataNUM>
  27 Send back this contents instead of the <data> one. The num is set by:
  28 A) The test number in the request line is >10000 and this is the remainder
  29 of [test case number]%10000.
  30 B) The request was HTTP and included digest details, which adds 1000 to NUM
  31 C) If a HTTP request is NTLM type-1, it adds 1001 to num
  32 D) If a HTTP request is NTLM type-3, it adds 1002 to num
  33 </dateNUM>
  34 <datacheck [nonewline=yes]>
  35 if the data is sent but this is what should be checked afterwards. If
  36 'nonewline' is set, we will cut off the trailing newline of this given data
  37 before comparing with the one actually received by the client
  38 </datacheck>
  39 <size>
  40 number to return on a ftp SIZE command (set to -1 to make this command fail)
  41 </size>
  42 <mdtm>
  43 what to send back if the client sends a (FTP) MDTM command, set to -1 to
  44 have it return that the file doesn't exist
  45 </mdtm>
  46 <cmd>
  47 special purpose server-command to control its behavior *before* the
  48 reply is sent
  49 </cmd>
  50 <postcmd>
  51 special purpose server-command to control its behavior *after* the
  52 reply is sent
  53 </postcmd>
  54 </reply>
  55
  56 <client>
  57
  58 <server>
  59 protocols as in 'http' 'ftp' etc. Give only one per line. Used for test cases
  60 500+ (at this point) to specify which servers the test case requires. In the
  61 future all test cases should use this. Makes us independent of the test
  62 case number.
  63 </server>
  64
  65 <features>
  66 A list of features that must be present in the client/library for this test
  67 to be able to run. Features testable here are:
  68 SSL
  69 netrc_debug
  70 large_file
  71 </features>
  72
  73 <killserver>
  74 Using the same syntax as in <server> but when mentioned here these servers
  75 are explicitly KILLED when this test case is completed. Only use this if there
  76 is no other alternatives. Using this of course requires subsequent tests to
  77 restart servers.
  78 </killserver>
  79
  80 <tool>
  81 Name of tool to use instead of "curl". This tool must be built and exist
  82 in the libtest/ directory.
  83 </tool>
  84
  85 <name>
  86 test case description
  87 </name>
  88
  89 <setenv>
  90 variable1=contents1
  91 variable2=contents2
  92
  93 Set the given environment variables to the specified value before the actual
  94 command is run, they are clear again after the command has been run.
  95 </setenv>
  96
  97 <command [option=no-output]>
  98 command line to run, there's a bunch of %variables that get replaced
  99 accordingly.
 100
 101 Note that the URL that gets passed to the server actually controls what data
 102 that is returned. The last slash in the URL must be followed by a number. That
 103 number (N) will be used by the test-server to load test case N and return the
 104 data that is defined within the <reply><data></data></reply> section.
 105
 106 If a CONNECT is used to the server (to emulate HTTPS etc over proxy), the port
 107 number given in the CONNECT request will be used to identify which test that
 108 is being run, if the proxy host name is said to start with 'test'.
 109
 110 Set 'option=no-output' to prevent the test script to slap on the --output
 111 argument that directs the output to a file. The --output is also not added if
 112 the client/stdout section is used.
 113
 114 Available substitute variables include:
 115 %HOSTIP    - IP address of the host running this test
 116 %HOSTPORT  - Port number of the HTTP server
 117 %HTTPSPORT - Port number of the HTTPS server
 118 %FTPPORT   - Port number of the FTP server
 119 %FTPSPORT  - Port number of the FTPS server
 120 %SRCDIR    - Full path to the source dir
 121 %PWD       - Current directory
 122 </command>
 123
 124 <file name="log/filename">
 125 this creates the named file with this content before the test case is run
 126 which is useful if the test case needs a file to act on.
 127 </file>
 128
 129 <stdin>
 130 Pass this given data on stdin to the tool.
 131 </stdin>
 132
 133 </client>
 134
 135 <verify>
 136 <errorcode>
 137 numerical error code curl is supposed to return
 138 </errorcode>
 139 <strip>
 140 One regex per line that is removed from the protocol dumps before the
 141 comparison is made. This is very useful to remove dependencies on dynamicly
 142 changing protocol data such as port numbers or user-agent strings.
 143 </strip>
 144 <protocol [nonewline=yes]>
 145 the protocol dump curl should transmit, if 'nonewline' is set, we will cut
 146 off the trailing newline of this given data before comparing with the one
 147 actually sent by the client
 148 </protocol>
 149 <stdout>
 150 This verfies that this data was passed to stdout.
 151 </stdout>
 152 <file name="log/filename">
 153 the file's contents must be identical to this
 154 </file>
 155 <upload>
 156 the contents of the upload data curl should have sent
 157 </upload>
 158 </verify>