Name Date Size #Lines LOC

..Today-

certs/H23-Aug-2024-

data/H17-Nov-2024-

http/H04-Nov-2024-

libtest/H07-Nov-2024-

server/H22-Oct-2024-

unit/H17-Nov-2024-

.gitignoreH A D19-Sep-2024495 3230

CI.mdH A D16-Sep-20243.7 KiB10268

CMakeLists.txtH A D24-Oct-20244.1 KiB113105

FILEFORMAT.mdH A D08-Nov-202425.7 KiB721560

Makefile.amH A D22-Oct-20244.5 KiB198133

README.mdH A D24-Aug-202410.2 KiB270181

appveyor.pmH A D22-Apr-20234 KiB13196

azure.pmH A D22-Apr-20235.2 KiB166130

config.inH A D03-Jan-20231 KiB2524

configurehelp.pm.inH A D21-Sep-20241.2 KiB4638

devtest.plH A D01-Oct-20245.8 KiB203121

dictserver.pyH A D04-Oct-20246 KiB187110

directories.pmH A D12-Apr-20238 KiB308255

ech_combos.pyH A D16-Apr-20243.3 KiB9931

ech_tests.shH A D27-Sep-202453.4 KiB1,157998

ftpserver.plH A D13-Sep-202490 KiB3,3772,508

getpart.pmH A D04-Aug-20248.9 KiB360244

globalconfig.pmH A D08-Nov-20244.3 KiB12980

http-server.plH A D18-Apr-20235 KiB195152

http2-server.plH A D01-Oct-20243.4 KiB12287

http3-server.plH A D01-Oct-20243.4 KiB12286

memanalyze.plH A D30-Mar-202311.9 KiB435333

mk-bundle-hints.shH A D22-Sep-20242.9 KiB7533

mk-bundle.plH A D22-Sep-20243.9 KiB163110

negtelnetserver.pyH A D04-Oct-202411.5 KiB370233

nghttpx.confH A D03-Jan-20231.1 KiB270

pathhelp.pmH A D02-Oct-20245.9 KiB18688

processhelp.pmH A D19-Sep-202412.4 KiB438285

requirements.txtH A D26-Apr-20231 KiB2726

rtspserver.plH A D12-Apr-20233.5 KiB13798

runner.pmH A D13-Nov-202448.1 KiB1,5471,037

runtests.mdH A D08-Nov-202410.1 KiB314212

runtests.plH A D13-Nov-2024104.4 KiB3,2192,348

secureserver.plH A D26-Sep-202411.3 KiB384265

serverhelp.pmH A D27-Sep-20249.1 KiB284159

servers.pmH A D29-Oct-2024103.2 KiB3,1572,349

smbserver.pyH A D04-Oct-202416 KiB454305

sshhelp.pmH A D12-Apr-202311.7 KiB428283

sshserver.plH A D22-Sep-202442.9 KiB1,223708

stunnel.pemH A D27-Jun-20247.9 KiB163156

test1119.plH A D09-Jul-20246.5 KiB246157

test1132.plH A D08-Dec-20232.6 KiB9956

test1135.plH A D08-Dec-20232.5 KiB11573

test1139.plH A D08-Nov-20248.7 KiB324226

test1140.plH A D18-Jul-20243.3 KiB11576

test1165.plH A D01-Sep-20245.1 KiB205147

test1167.plH A D14-May-20244 KiB160103

test1173.plH A D18-Jul-202410.7 KiB384305

test1175.plH A D09-Jul-20242.2 KiB8346

test1177.plH A D08-Apr-20242.4 KiB9660

test1222.plH A D18-Jul-20249.3 KiB330229

test1275.plH A D17-Aug-20243.5 KiB12185

test1276.plH A D08-Dec-20232 KiB6734

test1477.plH A D18-Jul-20242.6 KiB10162

test1486.plH A D11-Jun-20242.5 KiB10362

test1488.plH A D18-Jul-20243.1 KiB12978

test1544.plH A D08-Dec-20233.9 KiB14892

test1707.plH A D16-Aug-20243.3 KiB13694

test971.plH A D23-Jan-20243.1 KiB12667

testcurl.mdH A D06-Aug-20244 KiB13994

testcurl.plH A D30-Oct-202420.7 KiB798602

testutil.pmH A D01-Oct-20247.5 KiB265151

tftpserver.plH A D12-Apr-20233.3 KiB13499

util.pyH A D04-Oct-20242.8 KiB9350

valgrind.pmH A D20-Sep-20241.3 KiB5220

valgrind.suppH A D03-Oct-20242.6 KiB140131

README.md

1<!--
2Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3
4SPDX-License-Identifier: curl
5-->
6
7# The curl Test Suite
8
9# Running
10
11  See the "Requires to run" section for prerequisites.
12
13  In the root of the curl repository:
14
15    ./configure && make && make test
16
17  To run a specific set of tests (e.g. 303 and 410):
18
19    make test TFLAGS="303 410"
20
21  To run the tests faster, pass the -j (parallelism) flag:
22
23    make test TFLAGS="-j10"
24
25  "make test" builds the test suite support code and invokes the 'runtests.pl'
26  perl script to run all the tests. The value of `TFLAGS` is passed
27  directly to 'runtests.pl'.
28
29  When you run tests via make, the flags `-a` and `-s` are passed, meaning
30  to continue running tests even after one fails, and to emit short output.
31
32  If you would like to not use those flags, you can run 'runtests.pl' directly.
33  You must `chdir` into the tests directory, then you can run it like so:
34
35    ./runtests.pl 303 410
36
37  You must have run `make test` at least once first to build the support code.
38
39  To see what flags are available for runtests.pl, and what output it emits, run:
40
41    man ./tests/runtests.1
42
43  After a test fails, examine the tests/log directory for stdout, stderr, and
44  output from the servers used in the test.
45
46## Requires to run
47
48  - perl (and a Unix-style shell)
49  - python (and a Unix-style shell, for SMB and TELNET tests)
50  - python-impacket (for SMB tests)
51  - diff (when a test fails, a diff is shown)
52  - stunnel (for HTTPS and FTPS tests)
53  - OpenSSH or SunSSH (for SCP and SFTP tests)
54  - nghttpx (for HTTP/2 and HTTP/3 tests)
55  - An available `en_US.UTF-8` locale
56
57### Installation of impacket
58
59  The Python-based test servers support Python 3.
60
61  Please install python-impacket in the correct Python environment.
62  You can use pip or your OS' package manager to install 'impacket'.
63
64  On Debian/Ubuntu the package name is 'python3-impacket'
65
66  On FreeBSD the package name is 'py311-impacket'
67
68  On any system where pip is available: 'python3 -m pip install impacket'
69
70  You may also need to manually install the Python package 'six'
71  as that may be a missing requirement for impacket.
72
73## Event-based
74
75  If curl is built with `Debug` enabled (see below), then the `runtests.pl`
76  script offers a `-e` option that makes it perform *event-based*. Such tests
77  invokes the curl tool with `--test-event`, a debug-only option made for this
78  purpose.
79
80  Performing event-based means that the curl tool uses the
81  `curl_multi_socket_action()` API call to drive the transfer(s), instead of
82  the otherwise "normal" functions it would use. This allows us to test drive
83  the socket_action API. Transfers done this way should work exactly the same
84  as with the non-event based API.
85
86  To be able to use `--test-event` together with `--parallel`, curl requires
87  *libuv* to be present and enabled in the build: `configure --enable-libuv`
88
89### Port numbers used by test servers
90
91  All test servers run on "random" port numbers. All tests should be written
92  to use suitable variables instead of fixed port numbers so that test cases
93  continue to work independent on what port numbers the test servers actually
94  use.
95
96  See [`FILEFORMAT`](FILEFORMAT.md) for the port number variables.
97
98### Test servers
99
100  The test suite runs stand-alone servers on random ports to which it makes
101  requests. For SSL tests, it runs stunnel to handle encryption to the regular
102  servers. For SSH, it runs a standard OpenSSH server.
103
104  The listen port numbers for the test servers are picked randomly to allow
105  users to run multiple test cases concurrently and to not collide with other
106  existing services that might listen to ports on the machine.
107
108  The HTTP server supports listening on a Unix domain socket, the default
109  location is 'http.sock'.
110
111  For HTTP/2 and HTTP/3 testing an installed `nghttpx` is used. HTTP/3
112  tests check if nghttpx supports the protocol. To override the nghttpx
113  used, set the environment variable `NGHTTPX`. The default can also be
114  changed by specifying `--with-test-nghttpx=<path>` as argument to `configure`.
115
116### Shell startup scripts
117
118  Tests which use the ssh test server, SCP/SFTP tests, might be badly
119  influenced by the output of system wide or user specific shell startup
120  scripts, .bashrc, .profile, /etc/csh.cshrc, .login, /etc/bashrc, etc. which
121  output text messages or escape sequences on user login. When these shell
122  startup messages or escape sequences are output they might corrupt the
123  expected stream of data which flows to the sftp-server or from the ssh
124  client which can result in bad test behavior or even prevent the test server
125  from running.
126
127  If the test suite ssh or sftp server fails to start up and logs the message
128  'Received message too long' then you are certainly suffering the unwanted
129  output of a shell startup script. Locate, cleanup or adjust the shell
130  script.
131
132### Memory test
133
134  The test script checks that all allocated memory is freed properly IF curl
135  has been built with the `CURLDEBUG` define set. The script automatically
136  detects if that is the case, and it uses the `memanalyze.pl` script to
137  analyze the memory debugging output.
138
139  Also, if you run tests on a machine where valgrind is found, the script uses
140  valgrind to run the test with (unless you use `-n`) to further verify
141  correctness.
142
143  The `runtests.pl` `-t` option enables torture testing mode. It runs each
144  test many times and makes each different memory allocation fail on each
145  successive run. This tests the out of memory error handling code to ensure
146  that memory leaks do not occur even in those situations. It can help to
147  compile curl with `CPPFLAGS=-DMEMDEBUG_LOG_SYNC` when using this option, to
148  ensure that the memory log file is properly written even if curl crashes.
149
150### Debug
151
152  If a test case fails, you can conveniently get the script to invoke the
153  debugger (gdb) for you with the server running and the same command line
154  parameters that failed. Just invoke `runtests.pl <test number> -g` and then
155  just type 'run' in the debugger to perform the command through the debugger.
156
157### Logs
158
159  All logs are generated in the log/ subdirectory (it is emptied first in the
160  runtests.pl script). They remain in there after a test run.
161
162### Log Verbosity
163
164  A curl build with `--enable-debug` offers more verbose output in the logs.
165  This applies not only for test cases, but also when running it standalone
166  with `curl -v`. While a curl debug built is
167  ***not suitable for production***, it is often helpful in tracking down
168  problems.
169
170  Sometimes, one needs detailed logging of operations, but does not want
171  to drown in output. The newly introduced *connection filters* allows one to
172  dynamically increase log verbosity for a particular *filter type*. Example:
173
174    CURL_DEBUG=ssl curl -v https://curl.se
175
176  makes the `ssl` connection filter log more details. One may do that for
177  every filter type and also use a combination of names, separated by `,` or
178  space.
179
180    CURL_DEBUG=ssl,http/2 curl -v https://curl.se
181
182   The order of filter type names is not relevant. Names used here are
183   case insensitive. Note that these names are implementation internals and
184   subject to change.
185
186   Some, likely stable names are `tcp`, `ssl`, `http/2`. For a current list,
187   one may search the sources for `struct Curl_cftype` definitions and find
188   the names there. Also, some filters are only available with certain build
189   options, of course.
190
191### Test input files
192
193  All test cases are put in the `data/` subdirectory. Each test is stored in
194  the file named according to the test number.
195
196  See [`FILEFORMAT`](FILEFORMAT.md) for a description of the test case file
197  format.
198
199### Code coverage
200
201  gcc provides a tool that can determine the code coverage figures for the
202  test suite. To use it, configure curl with `CFLAGS='-fprofile-arcs
203  -ftest-coverage -g -O0'`. Make sure you run the normal and torture tests to
204  get more full coverage, i.e. do:
205
206    make test
207    make test-torture
208
209  The graphical tool `ggcov` can be used to browse the source and create
210  coverage reports on \*nix hosts:
211
212    ggcov -r lib src
213
214  The text mode tool `gcov` may also be used, but it does not handle object
215  files in more than one directory correctly.
216
217### Remote testing
218
219  The runtests.pl script provides some hooks to allow curl to be tested on a
220  machine where perl can not be run. The test framework in this case runs on
221  a workstation where perl is available, while curl itself is run on a remote
222  system using ssh or some other remote execution method. See the comments at
223  the beginning of runtests.pl for details.
224
225## Test case numbering
226
227  Test cases used to be numbered by category ranges, but the ranges filled
228  up. Subsets of tests can now be selected by passing keywords to the
229  runtests.pl script via the make `TFLAGS` variable.
230
231  New tests are added by finding a free number in `tests/data/Makefile.am`.
232
233## Write tests
234
235  Here's a quick description on writing test cases. We basically have three
236  kinds of tests: the ones that test the curl tool, the ones that build small
237  applications and test libcurl directly and the unit tests that test
238  individual (possibly internal) functions.
239
240### test data
241
242  Each test has a master file that controls all the test data. What to read,
243  what the protocol exchange should look like, what exit code to expect and
244  what command line arguments to use etc.
245
246  These files are `tests/data/test[num]` where `[num]` is just a unique
247  identifier described above, and the XML-like file format of them is
248  described in the separate [`FILEFORMAT`](FILEFORMAT.md) document.
249
250### curl tests
251
252  A test case that runs the curl tool and verifies that it gets the correct
253  data, it sends the correct data, it uses the correct protocol primitives
254  etc.
255
256### libcurl tests
257
258  The libcurl tests are identical to the curl ones, except that they use a
259  specific and dedicated custom-built program to run instead of "curl". This
260  tool is built from source code placed in `tests/libtest` and if you want to
261  make a new libcurl test that is where you add your code.
262
263### unit tests
264
265  Unit tests are placed in `tests/unit`. There is a tests/unit/README
266  describing the specific set of checks and macros that may be used when
267  writing tests that verify behaviors of specific individual functions.
268
269  The unit tests depend on curl being built with debug enabled.
270