1
0
mirror of https://github.com/moparisthebest/curl synced 2024-12-25 01:28:51 -05:00
curl/tests/unit
Daniel Stenberg ed35d6590e
dynbuf: introduce internal generic dynamic buffer functions
A common set of functions instead of many separate implementations for
creating buffers that can grow when appending data to them. Existing
functionality has been ported over.

In my early basic testing, the total number of allocations seem at
roughly the same amount as before, possibly a few less.

See docs/DYNBUF.md for a description of the API.

Closes #5300
2020-05-04 10:40:39 +02:00
..
.gitignore tests/unit/.gitignore: hide unit1601 and above, too 2015-04-22 14:20:20 +02:00
CMakeLists.txt copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
curlcheck.h copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
Makefile.am tests: make sure checksrc runs on header files too 2019-12-16 22:46:48 +01:00
Makefile.inc unit1612: fixed the inclusion and compilation of the HMAC unit test 2020-03-06 13:08:03 +00:00
README doh: fix (harmless) buffer overrun 2019-09-15 23:25:24 +02:00
unit1300.c cleanup: fix some text/comment typos 2020-03-12 14:28:17 +01:00
unit1301.c unit1301: fix error message on first test 2017-08-31 11:37:13 +02:00
unit1302.c copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
unit1303.c copyrights: update all copyright notices to 2019 on files changed this year 2019-11-02 23:15:56 +01:00
unit1304.c cleanup: remove FIXME and TODO comments 2019-05-16 09:16:56 +02:00
unit1305.c code style: use spaces around pluses 2017-09-11 09:29:50 +02:00
unit1307.c copyrights: update all copyright notices to 2019 on files changed this year 2019-11-02 23:15:56 +01:00
unit1308.c mime: tests and examples. 2017-09-02 19:08:45 +01:00
unit1309.c tests: Fix format specifiers 2018-05-14 09:42:27 +02:00
unit1323.c timediff: return timediff_t from the time diff functions 2017-10-25 09:54:37 +02:00
unit1330.c copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
unit1394.c cleanup: insert newline after if() conditions 2020-03-30 16:05:30 +02:00
unit1395.c copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
unit1396.c code style: use spaces around equals signs 2017-09-11 09:29:50 +02:00
unit1397.c axtls: removed 2018-11-01 10:29:53 +01:00
unit1398.c cleanup: remove FIXME and TODO comments 2019-05-16 09:16:56 +02:00
unit1399.c copyrights: update all copyright notices to 2019 on files changed this year 2019-11-02 23:15:56 +01:00
unit1600.c copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
unit1601.c md5/sha256: Updated the functions to allow non-string data to be hashed 2020-02-23 07:50:33 +00: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 snprintf: renamed and we now only use msnprintf() 2018-11-23 08:26:51 +01:00
unit1605.c copyright: fix out-of-date copyright ranges and missing headers 2020-03-24 15:05:59 +01:00
unit1606.c unit1606: Fixed shadowed variable warning 2017-08-28 23:55:55 +02:00
unit1607.c unit1607: fix mem-leak in OOM 2019-12-13 08:16:29 +01:00
unit1608.c tests: Run global cleanup at end of tests 2019-04-15 15:23:58 +02:00
unit1609.c unit1609: fix mem-leak in OOM 2019-12-13 08:16:32 +01:00
unit1610.c md5/sha256: Updated the functions to allow non-string data to be hashed 2020-02-23 07:50:33 +00:00
unit1611.c tests: Added a unit test for MD4 digest generation 2020-02-23 18:47:32 +00:00
unit1612.c unit1612: fixed the inclusion and compilation of the HMAC unit test 2020-03-06 13:08:03 +00:00
unit1620.c conncache: various concept cleanups 2020-04-30 14:27:54 +02:00
unit1621.c xattr: skip unittest on unsupported platforms 2019-04-11 09:22:22 +02:00
unit1650.c dynbuf: introduce internal generic dynamic buffer functions 2020-05-04 10:40:39 +02:00
unit1651.c unit1651: Fixed conversion compilation warning 2020-03-01 15:10:28 +00:00
unit1652.c snprintf: renamed and we now only use msnprintf() 2018-11-23 08:26:51 +01:00
unit1653.c urlapi: strip off scope id from numerical IPv6 addresses 2019-05-03 12:17:22 +02:00
unit1654.c altsvc: make saving the cache an atomic operation 2020-02-18 07:49:21 +01:00
unit1655.c src: Remove C99 constructs to ensure C89 compliance 2020-04-19 21:56:52 +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 '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
number that starts with 1300 and you can pick the next free number.

Add your test to tests/unit/Makefile.inc (if it is a unit test).
Add your test data 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 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 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

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