← Back to branch summary

~james-page/ubuntu/oneiric/curl/minimal-udeb

« back to all changes in this revision

Viewing changes to tests/unit/README

  • Committer: Bazaar Package Importer
  • Author(s): Lorenzo De Liso
  • Date: 2011-05-02 19:12:31 UTC
  • mfrom: (3.4.17 sid)
  • Revision ID: james.westby@ubuntu.com-20110502191231-1hiklg06nzo62ws8
Tags: 7.21.6-1ubuntu1
https://launchpad.net/bugs/775794
* Merge from debian unstable (LP: #775794), remaining changes:
  - debian/control:
    + Build-Depends: Replace libssh2-1-dev with openssh-server.
      Drop stunnel since it's in universe, as well.
    + Drop libssh2-1-dev from libcurl4-openssl-dev's Depends.

Show diffs side-by-side

added added

removed removed

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