Skip to content

Commit 4a04a8a

Browse files
committed
[v1.2.1] Merge branch 'bleeding'
Changelog: * Added a cr_ prefix to all assertion macros. Old macros are deprecated and will be removed in a future version.
2 parents 6b71e1c + 0f25296 commit 4a04a8a

18 files changed

+274
-185
lines changed

.bumpversion.cfg

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[bumpversion]
2+
current_version = 1.2.1
3+
commit = True
4+
5+
[bumpversion:file:configure.ac]
6+
7+
[bumpversion:file:doc/conf.py]
8+
9+
[bumpversion:file:appveyor.yml]
10+

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
!*/
33

44
!.gitignore
5+
!.bumpversion.cfg
56

67
!*.c
78
!*.h

ChangeLog

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
2015-04-26 Franklin "Snaipe" Mathieu <franklinmathieu@gmail.com>
2+
3+
* criterion: version 1.2.1
4+
* Added a cr_ prefix to all assertion macros. Old macros are deprecated
5+
and will be removed in a future version.
6+
17
2015-04-15 Franklin "Snaipe" Mathieu <franklinmathieu@gmail.com>
28

39
* criterion: version 1.2.0

appveyor.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 1.0.0_b{build}-{branch}
1+
version: 1.2.1_b{build}-{branch}
22

33
os: Windows Server 2012
44

configure.ac

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
AC_PREREQ([2.60])
22

3-
AC_INIT([criterion], [1.2.0], [], [criterion], [franklinmathieu@gmail.com])
3+
AC_INIT([criterion], [1.2.1], [], [criterion], [franklinmathieu@gmail.com])
44
AC_CONFIG_SRCDIR([src/runner.c])
55

66
LT_PREREQ([2.2.4])

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
# built documents.
4040
#
4141
# The short X.Y version.
42-
version = '1.2.0'
42+
version = '1.2.1'
4343
# The full version, including alpha/beta/rc tags.
4444
release = version
4545

doc/starter.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Asserting things
2626

2727
Assertions come in two kinds:
2828

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;
3030
in other words, if the condition evaluates to ``false``, the test is
3131
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
3333
test. Execution will continue even if the condition evaluates to
3434
``false``, but the test will be marked as a failure.
3535

36-
``assert()`` and ``expect()`` are the most simple kinds of assertions
36+
``cr_assert()`` and ``cr_expect()`` are the most simple kinds of assertions
3737
criterion has to offer. They both take a mandatory condition as a first
3838
parameter, and an optional failure message:
3939

@@ -43,45 +43,45 @@ parameter, and an optional failure message:
4343
#include <criterion/criterion.h>
4444
4545
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);
4949
}
5050
5151
On top of those, more assertions are available for common operations:
5252

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])``:
6060
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])``:
6262
passes if all elements of Actual (from 0 to Size - 1) are equals to those
6363
of Expected.
64-
* ``assert_arrays_eq_cmp(Actual, Expected, Size, Cmp, [Message])``:
64+
* ``cr_assert_arrays_eq_cmp(Actual, Expected, Size, Cmp, [Message])``:
6565
Same as ``arrays_eq`` but equality is defined by the result of the binary
6666
Cmp function.
6767

6868
Equality and lexical comparison assertions are also available for strings:
6969

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])``
7575

7676
And some assertions have a logical negative counterpart:
7777

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])``
8585

8686
Of course, every ``assert`` has an ``expect`` counterpart.
8787

0 commit comments

Comments
 (0)