curl/tests/unit
Daniel Stenberg 82d334001f
copyright: update copyright year ranges to 2021
2021-05-26 08:18:11 +02:00
..
.gitignore tests/unit/.gitignore: hide unit1601 and above, too 2015-04-22 14:20:20 +02:00
CMakeLists.txt copyright: update copyright year ranges to 2021 2021-05-26 08:18:11 +02:00
Makefile.am curl.se: new home 2020-11-04 23:59:47 +01:00
Makefile.inc bufref: buffer reference support 2021-04-22 09:05:53 +02:00
README.md tests/unit/README: convert to markdown 2020-09-30 22:45:48 +02:00
curlcheck.h tests/unit: fix empty statements with no effect 2020-12-29 23:02:43 +01:00
unit1300.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1301.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1302.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1303.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1304.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1305.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1307.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1308.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1309.c tidy-up: make conditional checks more consistent 2021-04-22 09:10:17 +02:00
unit1323.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1330.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1394.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1395.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1396.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1397.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1398.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1399.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1600.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1601.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1602.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1603.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1604.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1605.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1606.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1607.c tidy-up: make conditional checks more consistent 2021-04-22 09:10:17 +02:00
unit1608.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1609.c copyright: update copyright year ranges to 2021 2021-03-27 23:00:14 +01:00
unit1610.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1611.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1612.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1620.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1621.c copyright: fix year ranges 2020-11-05 08:22:10 +01:00
unit1650.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1651.c lib: pass in 'struct Curl_easy *' to most functions 2021-01-17 23:56:09 +01:00
unit1652.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1653.c urlapi: don't accept blank port number field without scheme 2020-12-07 00:50:49 +01:00
unit1654.c lib/unit tests: add missing curl_global_cleanup() calls 2021-01-06 15:13:45 +01:00
unit1655.c curl.se: new home 2020-11-04 23:59:47 +01:00
unit1660.c hsts: enable by default 2021-04-19 08:22:16 +02:00
unit1661.c bufref: buffer reference support 2021-04-22 09:05:53 +02:00

README.md

Unit tests

The goal is to add tests for all functions in libcurl. If functions are too big and complicated, we should split them into smaller and testable ones.

Build Unit Tests

./configure --enable-debug is required for the unit tests to build. To enable unit tests, there will be a separate static libcurl built that will be used exclusively for linking unit test programs. Just build everything as normal, and then you can run the unit test cases as well.

Run Unit Tests

Unit tests are run as part of the regular test suite. If you have built everything to run unit tests, to can do 'make test' at the root level. Or you can cd tests and make and then invoke individual unit tests with ./runtests.pl NNNN where NNNN is the specific test number.

Debug Unit Tests

If a specific test fails you will get told. The test case then has output left in the log/ subdirectory, but most importantly you can re-run the test again using gdb by doing ./runtests.pl -g NNNN. That is, add a -g to make it start up gdb and run the same case using that.

Write Unit Tests

We put tests that focus on an area or a specific function into a single C source file. The source file should be named 'unitNNNN.c' where NNNN is a previously unused number.

Add your test to tests/unit/Makefile.inc (if it is a unit test). Add your test data file name to tests/data/Makefile.inc

You also need a separate file called tests/data/testNNNN (using the same number) that describes your test case. See the test1300 file for inspiration and the tests/FILEFORMAT.md documentation.

For the actual C file, here's a very simple example:

#include "curlcheck.h"

#include "a libcurl header.h" /* from the lib dir */

static CURLcode unit_setup( void )
{
  /* whatever you want done first */
  return CURLE_OK;
}

static void unit_stop( void )
{
  /* done before shutting down and exiting */
}

UNITTEST_START

  /* here you start doing things and checking that the results are good */

  fail_unless( size == 0 , "initial size should be zero" );
  fail_if( head == NULL , "head should not be initiated to NULL" );

  /* you end the test code like this: */

UNITTEST_STOP