a Unit Testing Framework for C and C++ - Cutter

setup ()

void
setup (void);

If you define setup() in your test program, cutter will call your setup() before each your test is run. If you define cut_setup(), setup() is ignored.

cut_setup ()

void
cut_setup (void);

If you define cut_setup() in your test program, cutter will call your cut_setup() before each your test is run. cut_setup() has priority over setup().

Since: 1.0.6

teardown ()

void
teardown (void);

If you define teardown() in your test program, cutter will call your teardown() after each your test is run even if a test is failed. If you define cut_teardown(), teardown() is ignored.

cut_teardown ()

void
cut_teardown (void);

If you define cut_teardown() in your test program, cutter will call your cut_teardown() after each your test is run even if a test is failed. cut_teardown() has priority over teardown().

Since: 1.0.6

cut_startup ()

void
cut_startup (void);

If you define cut_startup() in your test program, cutter will call your cut_startup() before each your test case is run. cut_startup() has priority over startup().

Since: 1.0.6

cut_shutdown ()

void
cut_shutdown (void);

If you define shutdown() in your test program, cutter will call your shutdown() after each your test case is run. cut_shutdown() has priority over shutdown().

Since: 1.0.6

cut_add_data()

#define             cut_add_data(first_data_name, ...)

Adds data to use data driven test.

e.g.:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

#include <cutter.h>

void data_translate (void);
void test_translate (const void *data);

static const char*
translate (int input)
{
   switch(input) {
   case 1:
       return "first";
   case 111:
       return "a hundred eleven";
   default:
       return "unsupported";
   }
}

typedef struct _TranslateTestData
{
    char *translated;
    int input;
} TranslateTestData;

static TranslateTestData *
translate_test_data_new (char *translated, int input)
{
    TranslateTestData *data;

    data = malloc(sizeof(TranslateTestData));
    data->translated = strdup(translated);
    data->input = input;

    return data;
}

static void
translate_test_data_free (TranslateTestData *data)
{
    free(data->translated);
    free(data);
}

void
data_translate(void)
{
    cut_add_data("simple data",
                 translate_test_data_new("first", 1),
                 translate_test_data_free,
                 "complex data",
                 translate_test_data_new("a hundred eleven", 111),
                 translate_test_data_free,
                 NULL);
}

void
test_translate(const void *data)
{
     const TranslateTestData *test_data = data;

     cut_assert_equal_string(test_data->translated,
                             translate(test_data->input));
}

Since: 1.0.3

cut_add_data_backward_compatibility()

#define             cut_add_data_backward_compatibility(context, ...)

cut_set_attributes()

#define             cut_set_attributes(first_attribute_name, ...)

Sets attributes of the test.

e.g.:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

#include <cutter.h>

void attributes_repeat (void);
void test_repeat (void);

void
attributes_repeat(void)
{
    cut_set_attributes("description", "a test for repeat function",
                       "bug", "111",
                       "priority", "high",
                       NULL);
}

void
test_repeat(void)
{
     cut_assert_equal_string_with_free("XXX", repeat("X", 3));
}

Since: 1.0.4

cut_get_current_test_context

#define             cut_get_current_test_context()

Returns the current test context. The current test context is a thread local object. It means that you don't need to care this if you don't create a new thread in your test. This is only needed to care if you create a new thread. You need to pass the current test context in your test thread to the current test context in a created thread.

e.g.:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

int
your_thread_function(void *data)
{
    CutTestContext *test_context = data;
    cut_set_current_test_context(test_context);
    ...
}

void
run_your_thread(void)
{
    int result;
    pthread_t your_thread;

    result = pthread_create(&your_thread, NULL,
                            your_thread_function,
                            cut_get_current_test_context());
    ...
}

Since: 1.0.4

cut_set_current_test_context()

#define             cut_set_current_test_context(test_context)

Set test_context as the current test context. See cut_get_current_test_context() for more details.

Since: 1.0.4

cut_set_message ()

void
cut_set_message (const char *format,
                 ...);

Sets a message to be used by the next assertion.

Since: 1.0.6

cut_set_message_va_list ()

void
cut_set_message_va_list (const char *format,
                         va_list args);

Sets a message to be used by the next assertion.

Since: 1.0.6

cut_keep_message ()

void
cut_keep_message (void);

Keeps the current message set by cut_set_message() or cut_set_message_va_list() after the next assertion.

Since: 1.0.6

cut_message ()

void
cut_message (const char *format,
             ...);

Specifies optional assertion message.

e.g.:

1
2

cut_assert_equal_string("abc", "def",
                        cut_message("should fail!"));

Since: 1.1.0

CUT_EXPORT

#  define CUT_EXPORT __declspec(dllexport)

Marks a function as a exported function. This is needed for just Windows environment. If you want to run your tests on Windows, you need to use this. Otherwise, you don't need to use this.

e.g.:

1
2
3
4
5

CUT_EXPORT void
test_add (void)
{
  ...
}

Since: 1.1.2