![]() |
![]() |
![]() |
Cutter Reference Manual | ![]() |
---|---|---|---|---|
#define cut_assert (expression, ...) #define cut_assert_true (expression, ...) #define cut_assert_false (expression, ...) #define cut_assert_null (expression, ...) #define cut_assert_null_string (expression, ...) #define cut_assert_not_null (expression, ...) #define cut_assert_equal_int (expected, actual, ...) #define cut_assert_equal_uint (expected, actual, ...) #define cut_assert_equal_double (expected, error, actual, ...) #define cut_assert_equal_string (expected, actual, ...) #define cut_assert_equal_string_with_free (expected, actual, ...) #define cut_assert_equal_string_or_null (expected, actual, ...) #define cut_assert_equal_memory (expected, expected_size, actual, actual_size, ...) #define cut_assert_equal_string_array (expected, actual, ...) #define cut_assert_equal_string_array_with_free(expected, actual, ...) #define cut_assert_operator (lhs, operator, rhs, ...) #define cut_assert_operator_int (lhs, operator, rhs, ...) #define cut_assert_equal (function, expected, actual, ...) #define cut_assert_errno (...) #define cut_assert_file_exist (path, ...) #define cut_assert_path_exist (path, ...) #define cut_assert_path_not_exist (path, ...) #define cut_assert_match (pattern, actual, ...) #define cut_assert_match_with_free (pattern, actual, ...) #define cut_assert_equal_pointer (expected, actual, ...) #define cut_assert_equal_fixture_data_string(expected, path, ...) #define cut_error (format, ...) #define cut_error_errno (...) #define cut_fail (format, ...) #define cut_pend (format, ...) #define cut_pending (format, ...) #define cut_notify (format, ...) #define cut_omit (format, ...)
To check that your program works as you expect, you use
cut_assert_XXX()
where you want to check expected value
is got.
e.g.:
cut_assert_equal_int(3, 1 + 2);
#define cut_assert(expression, ...)
Passes if expression
is not 0 or NULL.
|
the expression to check. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_true(expression, ...)
Passes if expression
is TRUE value (not 0 or NULL).
|
the expression to check. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.9
#define cut_assert_false(expression, ...)
Passes if expression
is 0 or NULL.
|
the expression to check. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.9
#define cut_assert_null(expression, ...)
Passes if expression
is NULL.
|
the expression to check. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_null_string(expression, ...)
Passes if expression
is NULL.
|
the expression that returns string. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.3
#define cut_assert_not_null(expression, ...)
Passes if expression
is not NULL.
|
the expression to check. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_int(expected, actual, ...)
Passes if expected
== actual
.
|
an expected integer value. |
|
an actual integer value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_uint(expected, actual, ...)
Passes if expected
== actual
.
|
an expected unsigned integer value. |
|
an actual unsigned integer value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_double(expected, error, actual, ...)
Passes if (expected
- error
) <= actual
<= (expected
+ error
).
|
an expected float value. |
|
an float value that specifies error range. |
|
an actual float value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_string(expected, actual, ...)
Passes if both expected
and actual
are NULL or
strcmp(expected
, actual
) == 0.
|
an expected string value. |
|
an actual string value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_string_with_free(expected, actual, ...)
Passes if both expected
and actual
are NULL or
strcmp(expected
, actual
) == 0.
|
an expected string value. |
|
an actual string value that is freed. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.3
#define cut_assert_equal_string_or_null(expected, actual, ...)
cut_assert_equal_string_or_null
has been deprecated since version 0.3 and should not be used in newly-written code. Use cut_assert_equal_string()
instead.
Passes if both expected
and actual
are NULL or
strcmp(expected
, actual
) == 0.
|
an expected string value. |
|
an actual string value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_memory(expected, expected_size, \ actual, actual_size, ...)
Passes if expected_size
== actual_size
and
memcmp(expected
, actual
, expected_size
) == 0.
|
an expected data. |
|
a size of expected .
|
|
an actual data. |
|
a size of actual .
|
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_string_array(expected, actual, ...)
Passes if both expected
and actual
are not NULL and
have same content (strcmp()
== 0) strings.
|
an expected NULL-terminated array of strings. |
|
an actual NULL-terminated array of strings that are freed. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal_string_array_with_free(expected, actual, ...)
Passes if both expected
and actual
are not NULL and
have same content (strcmp()
== 0) strings.
|
an expected NULL-terminated array of strings. |
|
an actual NULL-terminated array of strings. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.9
#define cut_assert_operator(lhs, operator, rhs, ...)
Passes if (lhs
operator
rhs
) is TRUE.
e.g.:
cut_assert_operator(1, <, 2) -> (1 < 2);
|
a left hand side value. |
|
a binary operator. |
|
a right hand side value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_operator_int(lhs, operator, rhs, ...)
Passes if (lhs
operator
rhs
) is TRUE.
e.g.:
cut_assert_operator_int(1, <, 2) -> (1 < 2);
|
a left hand side integer value. |
|
a binary operator. |
|
a right hand side integer value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_equal(function, expected, actual, ...)
Passes if function
(expected
, actual
) returns TRUE.
e.g.:
cut_assert_equal(!strcmp, "abc", "abc"); -> Pass
|
a function that compares actual with expected .
|
|
an expected value. |
|
an actual value. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
#define cut_assert_errno(...)
Passes if errno is 0.
e.g.:
count = write(stdout, buffer, strlen(buffer)); cut_assert_errno("Failed to write"); -> Pass when count != -1
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.8
#define cut_assert_file_exist(path, ...)
cut_assert_file_exist
has been deprecated since version 1.0.2 and should not be used in newly-written code. Use cut_assert_path_exist()
instead.
Passes if path
exists. It may or may not be a regular file.
e.g.:
cut_assert_file_exist("/tmp"); -> Pass on many environment cut_assert_file_exist("/non-existent"); -> Fail
|
the path to test. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 0.9
#define cut_assert_path_exist(path, ...)
Passes if path
exists. It may or may not be a regular file.
e.g.:
cut_assert_path_exist("/tmp"); -> Pass on many environment cut_assert_path_exist("/non-existent"); -> Fail
|
the path to test. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0.2
#define cut_assert_path_not_exist(path, ...)
Passes if path
doesn't exist.
e.g.:
cut_assert_path_not_exist("/non-existent"); -> Pass on many environment cut_assert_path_not_exist("/tmp"); -> Fail
|
the path to test. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0.2
#define cut_assert_match(pattern, actual, ...)
Passes if pattern
matches string
.
e.g.:
cut_assert_match("^abc", "abc"); -> Pass cut_assert_match("^abc", " abc"); -> Fail
|
the regular expression as string. |
|
the string to be matched. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0
#define cut_assert_match_with_free(pattern, actual, ...)
Passes if pattern
matches string
. See cut_assert_match()
for detail.
|
the regular expression as string. |
|
the string to be matched that is freed. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0
#define cut_assert_equal_pointer(expected, actual, ...)
Passes if expected
== actual
.
|
an expected pointer. |
|
an actual pointer. |
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0
#define cut_assert_equal_fixture_data_string(expected, path, ...)
Passes if expected
== cut_get_fixture_data_string(path
, ...).
|
an expected string. |
|
a first element of the path to the fixture data. |
|
remaining elements in path. |
Since 1.0.2
#define cut_error(format, ...)
Raises an error with message.
|
the message format. See the printf() documentation.
|
|
the parameters to insert into the format string. |
#define cut_error_errno(...)
e.g.:
void setup (void) { mkdir("tmp", 0700); cut_error_errno("Failed to make tmp directory"); -> Error when tmp directory isn't made successfully. }
|
optional format string, followed by parameters to insert
into the format string (as with printf() )
|
Since 1.0.2
#define cut_fail(format, ...)
Raises a failure with message.
|
the message format. See the printf() documentation.
|
|
the parameters to insert into the format string. |
#define cut_pend(format, ...)
Marks the test is pending with message. The test is stopped.
|
the message format. See the printf() documentation.
|
|
the parameters to insert into the format string. |
#define cut_pending(format, ...) cut_pend(format, ## __VA_ARGS__)
cut_pending
has been deprecated since version 0.4 and should not be used in newly-written code. Use cut_pend()
instead.
Marks the test is pending with message. The test is stopped.
|
the message format. See the printf() documentation.
|
|
the parameters to insert into the format string. |
#define cut_notify(format, ...)
Leaves a notification message. The test is continued.
|
the message format. See the printf() documentation.
|
|
the parameters to insert into the format string. |