README.md
1# Unit tests
2
3The goal is to add tests for *all* functions in libcurl. If functions are too
4big and complicated, we should split them into smaller and testable ones.
5
6## Build Unit Tests
7
8`./configure --enable-debug` is required for the unit tests to build. To
9enable unit tests, there will be a separate static libcurl built that will be
10used exclusively for linking unit test programs. Just build everything as
11normal, and then you can run the unit test cases as well.
12
13## Run Unit Tests
14
15Unit tests are run as part of the regular test suite. If you have built
16everything to run unit tests, to can do 'make test' at the root level. Or you
17can `cd tests` and `make` and then invoke individual unit tests with
18`./runtests.pl NNNN` where `NNNN` is the specific test number.
19
20## Debug Unit Tests
21
22If a specific test fails you will get told. The test case then has output left
23in the log/ subdirectory, but most importantly you can re-run the test again
24using gdb by doing `./runtests.pl -g NNNN`. That is, add a `-g` to make it
25start up gdb and run the same case using that.
26
27## Write Unit Tests
28
29We put tests that focus on an area or a specific function into a single C
30source file. The source file should be named 'unitNNNN.c' where NNNN is a
31previously unused number.
32
33Add your test to `tests/unit/Makefile.inc` (if it is a unit test). Add your
34test data file name to `tests/data/Makefile.inc`
35
36You also need a separate file called `tests/data/testNNNN` (using the same
37number) that describes your test case. See the test1300 file for inspiration
38and the `tests/FILEFORMAT.md` documentation.
39
40For the actual C file, here's a very simple example:
41~~~c
42#include "curlcheck.h"
43
44#include "a libcurl header.h" /* from the lib dir */
45
46static CURLcode unit_setup( void )
47{
48 /* whatever you want done first */
49 return CURLE_OK;
50}
51
52static void unit_stop( void )
53{
54 /* done before shutting down and exiting */
55}
56
57UNITTEST_START
58
59 /* here you start doing things and checking that the results are good */
60
61 fail_unless( size == 0 , "initial size should be zero" );
62 fail_if( head == NULL , "head should not be initiated to NULL" );
63
64 /* you end the test code like this: */
65
66UNITTEST_STOP
67