![]() |
![]() |
![]() |
Cutter Reference Manual | ![]() |
---|---|---|---|---|
Assertion writing helperAssertion writing helper — Symbols in this section help you writing your own assertions. |
#define cut_test_pass () #define cut_test_fail (system_message, ...) #define cut_test_fail_va_list (system_message, user_message_format) #define cut_trace (expression) #define cut_trace_with_info_expression (expression, info_expression)
You will need to write your own assertions for writing easy to read test. Symbols in this section help you writing your own assertions.
e.g.:
my-assertions.h:
#ifndef __MY_ASSERTIONS_H__ #define __MY_ASSERTIONS_H__ #include <cutter.h> #ifdef __cplusplus extern "C" { #endif #define my_assert_equal_int(expected, actual, ...) \ cut_trace_with_info_expression( \ my_assert_equal_int_helper((expected), (actual), \ # expected, # actual, \ ## __VA_ARGS__, NULL), \ my_assert_equal_int(expected, actual, ## __VA_ARGS__)) void my_assert_equal_int (long expected, long actual, const char *expression_expected, const char *expression_actual, const char *user_message_format, ...); #ifdef __cplusplus } #endif #endif
my-assertions.c:
#include "my-assertions.h" void my_assert_equal_int(glong expected, glong actual, const gchar *expression_expected, const gchar *expression_actual, const gchar *user_message_format, ...) { if (expected == actual) { cut_test_pass(); } else { cut_test_fail_va_list( cut_take_printf("<%s == %s>\n" "expected: <%ld>\n" " actual: <%ld>", expression_expected, expression_actual, expected, actual), user_message_format); } }
Makefile.am:
AM_CFLAGS = $(GCUTTER_CFLAGS) LIBS = $(GCUTTER_LIBS) noinst_LTLIBRARIES = libmy-assertions.la libmy_assertions_la_SOURCES = my-assertions.c my-assertions.h AM_LDFLAGS = -module -rpath $(libdir) -avoid-version -no-undefined
#define cut_test_pass()
Call cut_test_pass()
if an assertion is
passed. cut_test_pass()
counts up n-assertions.
Since 1.0.5
#define cut_test_fail(system_message, ...)
Call cut_test_fail()
if an assertion is failed.
cut_test_fail()
counts up n-failures and terminate the
current test.
|
a failure message from testing system. (const char *) |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0.5
#define cut_test_fail_va_list(system_message, user_message_format)
See cut_test_fail()
for cut_test_fail_va_list()
's
behavior. user_message_format
is the prior variable of
variable length arguments.
e.g.:
void my_assert(cut_boolean result, const gchar *user_message_format, ...) { if (result) { cut_test_pass(); } else { cut_test_fail_va_list("Fail!", user_message_format); } }
|
a failure message from testing system. (const char *) |
|
a failure message from user. (const char *) |
Since 1.0.5
#define cut_trace(expression)
Mark the current file, line, function and expression
and
show it when assertion is failed in
expression
. Most of expression
will be function call.
Note that you can't get return value of expression
.
Here is an example of cut_trace()
. If
cut_assert_not_null(object) is failed, you will get a
backtrace that contains two line;
cut_assert_not_null(object) and create_my_object("my-name").
e.g.:
static MyObject *object; static void create_my_object(const char *name) { object = my_object_new(name); cut_assert_not_null(object); } void test_my_object_name(void) { cut_trace(create_my_object("my-name")); cut_assert_equal_string("my-name", my_object_get_name(object)); }
You will use cut_trace()
with macro for test readability:
static MyObject *object; static void create_my_object_helper(const char *name) { object = my_object_new(name); cut_assert_not_null(object); } #define create_my_object(...) \ cut_trace(create_my_object_helper(__VA_ARGS__)) void test_my_object_name(void) { create_my_object("my-name"); cut_assert_equal_string("my-name", my_object_get_name(object)); }
|
an expression to be traced. |
Since 1.0.5
#define cut_trace_with_info_expression(expression, info_expression)
It's difference between cut_trace()
and
cut_trace_with_info_expression()
that traced expression
is the same expression as expression
or
not. cut_trace_with_info_expression()
is useful when you
want to hide some information in expression
for
backtrace readability.
Here is an example of
cut_trace_with_info_expression()
. If
cut_assert_not_null(object) is failed, you will get a
backtrace that contains two line:
cut_assert_not_null(object)
create_my_object("my-name") not create_my_object_helper("my-name")
If you use cut_trace()
instead of
cut_trace_with_info_expression()
, you will get
create_my_object_helper("my-name"). You may be confused
about 'Where is create_my_object_helper("my-name") from?
test_my_object_name()
uses create_my_object("my-name")
but does not use create_my_object_helper("my-name").'.
e.g.:
static MyObject *object; static void create_my_object_helper(const char *name) { object = my_object_new(name); cut_assert_not_null(object); } #define create_my_object(...) \ cut_trace_with_info_expression( \ create_my_object_helper(__VA_ARGS__), \ create_my_object(__VA_ARGS__)) void test_my_object_name(void) { create_my_object("my-name"); cut_assert_equal_string("my-name", my_object_get_name(object)); }
|
an expression to be traced. |
|
a traced expression. |
Since 1.0.5