@@ -26,14 +26,14 @@ Asserting things
26
26
27
27
Assertions come in two kinds:
28
28
29
- * ``assert * `` are assertions that are fatal to the current test if failed;
29
+ * ``cr_assert * `` are assertions that are fatal to the current test if failed;
30
30
in other words, if the condition evaluates to ``false ``, the test is
31
31
marked as a failure and the execution of the function is aborted.
32
- * ``expect * `` are, in the other hand, assertions that are not fatal to the
32
+ * ``cr_expect * `` are, in the other hand, assertions that are not fatal to the
33
33
test. Execution will continue even if the condition evaluates to
34
34
``false ``, but the test will be marked as a failure.
35
35
36
- ``assert () `` and ``expect () `` are the most simple kinds of assertions
36
+ ``cr_assert () `` and ``cr_expect () `` are the most simple kinds of assertions
37
37
criterion has to offer. They both take a mandatory condition as a first
38
38
parameter, and an optional failure message:
39
39
@@ -43,45 +43,45 @@ parameter, and an optional failure message:
43
43
#include <criterion/criterion.h>
44
44
45
45
Test(sample, test) {
46
- expect (strlen("Test") == 4, "Expected \"Test\" to have a length of 4.");
47
- expect (strlen("Hello") == 4, "This will always fail, why did I add this?");
48
- assert (strlen("") == 0);
46
+ cr_expect (strlen("Test") == 4, "Expected \"Test\" to have a length of 4.");
47
+ cr_expect (strlen("Hello") == 4, "This will always fail, why did I add this?");
48
+ cr_assert (strlen("") == 0);
49
49
}
50
50
51
51
On top of those, more assertions are available for common operations:
52
52
53
- * ``assert_null (Ptr, [Message]) ``: passes if Ptr is NULL.
54
- * ``assert_eq (Actual, Expected, [Message]) ``: passes if Actual == Expected.
55
- * ``assert_lt (Actual, Expected, [Message]) ``: passes if Actual < Expected.
56
- * ``assert_leq (Actual, Expected, [Message]) ``: passes if Actual <= Expected.
57
- * ``assert_gt (Actual, Expected, [Message]) ``: passes if Actual > Expected.
58
- * ``assert_geq (Actual, Expected, [Message]) ``: passes if Actual >= Expected.
59
- * ``assert_float_eq (Actual, Expected, Epsilon, [Message]) ``:
53
+ * ``cr_assert_null (Ptr, [Message]) ``: passes if Ptr is NULL.
54
+ * ``cr_assert_eq (Actual, Expected, [Message]) ``: passes if Actual == Expected.
55
+ * ``cr_assert_lt (Actual, Expected, [Message]) ``: passes if Actual < Expected.
56
+ * ``cr_assert_leq (Actual, Expected, [Message]) ``: passes if Actual <= Expected.
57
+ * ``cr_assert_gt (Actual, Expected, [Message]) ``: passes if Actual > Expected.
58
+ * ``cr_assert_geq (Actual, Expected, [Message]) ``: passes if Actual >= Expected.
59
+ * ``cr_assert_float_eq (Actual, Expected, Epsilon, [Message]) ``:
60
60
passes if Actual == Expected with an error of Epsilon.
61
- * ``assert_arrays_eq (Actual, Expected, Size, [Message]) ``:
61
+ * ``cr_assert_arrays_eq (Actual, Expected, Size, [Message]) ``:
62
62
passes if all elements of Actual (from 0 to Size - 1) are equals to those
63
63
of Expected.
64
- * ``assert_arrays_eq_cmp (Actual, Expected, Size, Cmp, [Message]) ``:
64
+ * ``cr_assert_arrays_eq_cmp (Actual, Expected, Size, Cmp, [Message]) ``:
65
65
Same as ``arrays_eq `` but equality is defined by the result of the binary
66
66
Cmp function.
67
67
68
68
Equality and lexical comparison assertions are also available for strings:
69
69
70
- * ``assert_strings_eq (Actual, Expected, [Message]) ``
71
- * ``assert_strings_lt (Actual, Expected, [Message]) ``
72
- * ``assert_strings_leq (Actual, Expected, [Message]) ``
73
- * ``assert_strings_gt (Actual, Expected, [Message]) ``
74
- * ``assert_strings_geq (Actual, Expected, [Message]) ``
70
+ * ``cr_assert_strings_eq (Actual, Expected, [Message]) ``
71
+ * ``cr_assert_strings_lt (Actual, Expected, [Message]) ``
72
+ * ``cr_assert_strings_leq (Actual, Expected, [Message]) ``
73
+ * ``cr_assert_strings_gt (Actual, Expected, [Message]) ``
74
+ * ``cr_assert_strings_geq (Actual, Expected, [Message]) ``
75
75
76
76
And some assertions have a logical negative counterpart:
77
77
78
- * ``assert_not (Condition, [Message]) ``
79
- * ``assert_not_null (Ptr, [Message]) ``
80
- * ``assert_neq (Actual, Unexpected, [Message]) ``
81
- * ``assert_float_neq (Actual, Unexpected, Epsilon, [Message]) ``
82
- * ``assert_strings_neq (Actual, Unexpected, [Message]) ``
83
- * ``assert_arrays_neq (Actual, Unexpected, Size, [Message]) ``
84
- * ``assert_arrays_neq_cmp (Actual, Unexpected, Size, Cmp, [Message]) ``
78
+ * ``cr_assert_not (Condition, [Message]) ``
79
+ * ``cr_assert_not_null (Ptr, [Message]) ``
80
+ * ``cr_assert_neq (Actual, Unexpected, [Message]) ``
81
+ * ``cr_assert_float_neq (Actual, Unexpected, Epsilon, [Message]) ``
82
+ * ``cr_assert_strings_neq (Actual, Unexpected, [Message]) ``
83
+ * ``cr_assert_arrays_neq (Actual, Unexpected, Size, [Message]) ``
84
+ * ``cr_assert_arrays_neq_cmp (Actual, Unexpected, Size, Cmp, [Message]) ``
85
85
86
86
Of course, every ``assert `` has an ``expect `` counterpart.
87
87
0 commit comments