diff mbox series

[v2] kunit: fix assert_type for comparison macros

Message ID 20220821150147.277753-1-sander@svanheule.net (mailing list archive)
State Accepted
Commit aded3cad909581c60335037112c4f86bbfe90f17
Delegated to: Brendan Higgins
Headers show
Series [v2] kunit: fix assert_type for comparison macros | expand

Commit Message

Sander Vanheule Aug. 21, 2022, 3:01 p.m. UTC
When replacing KUNIT_BINARY_*_MSG_ASSERTION() macros with
KUNIT_BINARY_INT_ASSERTION(), the assert_type parameter was not always
correctly transferred.  Specifically, the following errors were
introduced:
  - KUNIT_EXPECT_LE_MSG() uses KUNIT_ASSERTION
  - KUNIT_ASSERT_LT_MSG() uses KUNIT_EXPECTATION
  - KUNIT_ASSERT_GT_MSG() uses KUNIT_EXPECTATION

A failing KUNIT_EXPECT_LE_MSG() test thus prevents further tests from
running, while failing KUNIT_ASSERT_{LT,GT}_MSG() tests do not prevent
further tests from running.  This is contrary to the documentation,
which states that failing KUNIT_EXPECT_* macros allow further tests to
run, while failing KUNIT_ASSERT_* macros should prevent this.

Revert the KUNIT_{ASSERTION,EXPECTATION} switches to fix the behaviour
for the affected macros.

Fixes: 40f39777ce4f ("kunit: decrease macro layering for integer asserts")
Signed-off-by: Sander Vanheule <sander@svanheule.net>
---
 include/kunit/test.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Daniel Latypov Aug. 22, 2022, 5:22 p.m. UTC | #1
On Sun, Aug 21, 2022 at 8:02 AM Sander Vanheule <sander@svanheule.net> wrote:
>
> When replacing KUNIT_BINARY_*_MSG_ASSERTION() macros with
> KUNIT_BINARY_INT_ASSERTION(), the assert_type parameter was not always
> correctly transferred.  Specifically, the following errors were
> introduced:
>   - KUNIT_EXPECT_LE_MSG() uses KUNIT_ASSERTION
>   - KUNIT_ASSERT_LT_MSG() uses KUNIT_EXPECTATION
>   - KUNIT_ASSERT_GT_MSG() uses KUNIT_EXPECTATION
>
> A failing KUNIT_EXPECT_LE_MSG() test thus prevents further tests from
> running, while failing KUNIT_ASSERT_{LT,GT}_MSG() tests do not prevent
> further tests from running.  This is contrary to the documentation,
> which states that failing KUNIT_EXPECT_* macros allow further tests to
> run, while failing KUNIT_ASSERT_* macros should prevent this.
>
> Revert the KUNIT_{ASSERTION,EXPECTATION} switches to fix the behaviour
> for the affected macros.
>
> Fixes: 40f39777ce4f ("kunit: decrease macro layering for integer asserts")
> Signed-off-by: Sander Vanheule <sander@svanheule.net>

Thanks for catching this!
I scanned over the file again looking for other errors. I think this
patch fixes all of them.

Reviewed-by: Daniel Latypov <dlatypov@google.com>
Brendan Higgins Aug. 29, 2022, 10:43 p.m. UTC | #2
On Sun, Aug 21, 2022 at 8:02 AM Sander Vanheule <sander@svanheule.net> wrote:
>
> When replacing KUNIT_BINARY_*_MSG_ASSERTION() macros with
> KUNIT_BINARY_INT_ASSERTION(), the assert_type parameter was not always
> correctly transferred.  Specifically, the following errors were
> introduced:
>   - KUNIT_EXPECT_LE_MSG() uses KUNIT_ASSERTION
>   - KUNIT_ASSERT_LT_MSG() uses KUNIT_EXPECTATION
>   - KUNIT_ASSERT_GT_MSG() uses KUNIT_EXPECTATION
>
> A failing KUNIT_EXPECT_LE_MSG() test thus prevents further tests from
> running, while failing KUNIT_ASSERT_{LT,GT}_MSG() tests do not prevent
> further tests from running.  This is contrary to the documentation,
> which states that failing KUNIT_EXPECT_* macros allow further tests to
> run, while failing KUNIT_ASSERT_* macros should prevent this.
>
> Revert the KUNIT_{ASSERTION,EXPECTATION} switches to fix the behaviour
> for the affected macros.
>
> Fixes: 40f39777ce4f ("kunit: decrease macro layering for integer asserts")
> Signed-off-by: Sander Vanheule <sander@svanheule.net>

Thanks for fixing this!

Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
diff mbox series

Patch

diff --git a/include/kunit/test.h b/include/kunit/test.h
index c958855681cc..840a2c375065 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -826,7 +826,7 @@  do {									       \
 
 #define KUNIT_EXPECT_LE_MSG(test, left, right, fmt, ...)		       \
 	KUNIT_BINARY_INT_ASSERTION(test,				       \
-				   KUNIT_ASSERTION,			       \
+				   KUNIT_EXPECTATION,			       \
 				   left, <=, right,			       \
 				   fmt,					       \
 				    ##__VA_ARGS__)
@@ -1116,7 +1116,7 @@  do {									       \
 
 #define KUNIT_ASSERT_LT_MSG(test, left, right, fmt, ...)		       \
 	KUNIT_BINARY_INT_ASSERTION(test,				       \
-				   KUNIT_EXPECTATION,			       \
+				   KUNIT_ASSERTION,			       \
 				   left, <, right,			       \
 				   fmt,					       \
 				    ##__VA_ARGS__)
@@ -1157,7 +1157,7 @@  do {									       \
 
 #define KUNIT_ASSERT_GT_MSG(test, left, right, fmt, ...)		       \
 	KUNIT_BINARY_INT_ASSERTION(test,				       \
-				   KUNIT_EXPECTATION,			       \
+				   KUNIT_ASSERTION,			       \
 				   left, >, right,			       \
 				   fmt,					       \
 				    ##__VA_ARGS__)