curl/tests/unit
Daniel Stenberg 4dee50b9c8 timeval: struct curltime is a struct timeval replacement
... to make all libcurl internals able to use the same data types for
the struct members. The timeval struct differs subtly on several
platforms so it makes it cumbersome to use everywhere.

Ref: #1652
Closes #1693
2017-07-28 15:51:25 +02:00
..
.gitignore tests/unit/.gitignore: hide unit1601 and above, too 2015-04-22 14:20:20 +02:00
CMakeLists.txt includes: remove curl/curlbuild.h and curl/curlrules.h 2017-06-14 11:07:33 +02:00
curlcheck.h tests: fix -Wcast-qual warnings 2017-05-05 21:29:50 +02:00
Makefile.am includes: remove curl/curlbuild.h and curl/curlrules.h 2017-06-14 11:07:33 +02:00
Makefile.inc progress: prevent resetting t_starttransfer 2017-06-30 09:05:53 +02:00
README
unit1300.c llist: no longer uses malloc 2017-04-22 11:25:27 +02:00
unit1301.c unit1301: keep testing curl_strequal 2016-10-31 09:53:34 +01:00
unit1302.c internals: rename the SessionHandle struct to Curl_easy 2016-06-22 10:28:41 +02:00
unit1303.c timeval: struct curltime is a struct timeval replacement 2017-07-28 15:51:25 +02:00
unit1304.c checksrc: white space edits to comply to stricter checksrc 2016-11-24 23:58:22 +01:00
unit1305.c unit1305: fix compiler warning 2017-05-05 11:44:22 +02:00
unit1307.c code: style updates 2016-04-03 22:38:36 +02:00
unit1308.c checksrc: code style: use 'char *name' style 2016-11-24 23:58:22 +01:00
unit1309.c timeval: struct curltime is a struct timeval replacement 2017-07-28 15:51:25 +02:00
unit1330.c URLs: change all http:// URLs to https:// 2016-02-03 00:19:02 +01:00
unit1394.c unit: make unit test source code checksrc compliant 2016-04-03 22:38:36 +02:00
unit1395.c dedotdot: fixed output for ".." and "." only input 2017-06-03 00:11:51 +02:00
unit1396.c tests: declare TU-local variables static 2017-05-01 12:55:09 +02:00
unit1397.c code: style updates 2016-04-03 22:38:36 +02:00
unit1398.c code: style updates 2016-04-03 22:38:36 +02:00
unit1399.c timeval: struct curltime is a struct timeval replacement 2017-07-28 15:51:25 +02:00
unit1600.c tests: declare TU-local variables static 2017-05-01 12:55:09 +02:00
unit1601.c unit: make unit test source code checksrc compliant 2016-04-03 22:38:36 +02:00
unit1602.c checksrc: white space edits to comply to stricter checksrc 2016-11-24 23:58:22 +01:00
unit1603.c code: style updates 2016-04-03 22:38:36 +02:00
unit1604.c unit1604: fixed indentation 2017-04-30 15:21:54 +02:00
unit1605.c tests: fixed OOM handling of unit tests to abort test 2017-04-30 10:55:20 +02:00
unit1606.c timeval: struct curltime is a struct timeval replacement 2017-07-28 15:51:25 +02:00

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 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
number that starts with 1300 and you can pick the next free number.

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 documentation.

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

----------------------- start -------------------------------
#include "curlcheck.h"

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

static void unit_setup( void )
{
  /* whatever you want done first */
}

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

----------------------- end -------------------------------