Skip to content

Commit 7d4087b

Browse files
ericchancfshuahkh
authored andcommitted
kunit: Rename KUNIT_ASSERT_FAILURE to KUNIT_FAIL_AND_ABORT for readability
Both KUNIT_FAIL and KUNIT_ASSERT_FAILURE defined to KUNIT_FAIL_ASSERTION with different tpye of kunit_assert_type. The current naming of KUNIT_ASSERT_FAILURE and KUNIT_FAIL_ASSERTION is confusing due to their similarities. To improve readability and symmetry, renames KUNIT_ASSERT_FAILURE to KUNIT_FAIL_AND_ABORT. Makes the naming consistent, with KUNIT_FAIL and KUNIT_FAIL_AND_ABORT being symmetrical. Additionally, an explanation for KUNIT_FAIL_AND_ABORT has been added to clarify its usage. Signed-off-by: Eric Chan <ericchancf@google.com> Reviewed-by: David Gow <davidgow@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
1 parent 2be32bb commit 7d4087b

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

drivers/input/tests/input_test.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ static int input_test_init(struct kunit *test)
3131
ret = input_register_device(input_dev);
3232
if (ret) {
3333
input_free_device(input_dev);
34-
KUNIT_ASSERT_FAILURE(test, "Register device failed: %d", ret);
34+
KUNIT_FAIL_AND_ABORT(test, "Register device failed: %d", ret);
3535
}
3636

3737
test->priv = input_dev;

include/kunit/assert.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ void kunit_assert_prologue(const struct kunit_loc *loc,
6060
* struct kunit_fail_assert - Represents a plain fail expectation/assertion.
6161
* @assert: The parent of this type.
6262
*
63-
* Represents a simple KUNIT_FAIL/KUNIT_ASSERT_FAILURE that always fails.
63+
* Represents a simple KUNIT_FAIL/KUNIT_FAIL_AND_ABORT that always fails.
6464
*/
6565
struct kunit_fail_assert {
6666
struct kunit_assert assert;

include/kunit/test.h

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1228,7 +1228,18 @@ do { \
12281228
fmt, \
12291229
##__VA_ARGS__)
12301230

1231-
#define KUNIT_ASSERT_FAILURE(test, fmt, ...) \
1231+
/**
1232+
* KUNIT_FAIL_AND_ABORT() - Always causes a test to fail and abort when evaluated.
1233+
* @test: The test context object.
1234+
* @fmt: an informational message to be printed when the assertion is made.
1235+
* @...: string format arguments.
1236+
*
1237+
* The opposite of KUNIT_SUCCEED(), it is an assertion that always fails. In
1238+
* other words, it always results in a failed assertion, and consequently
1239+
* always causes the test case to fail and abort when evaluated.
1240+
* See KUNIT_ASSERT_TRUE() for more information.
1241+
*/
1242+
#define KUNIT_FAIL_AND_ABORT(test, fmt, ...) \
12321243
KUNIT_FAIL_ASSERTION(test, KUNIT_ASSERTION, fmt, ##__VA_ARGS__)
12331244

12341245
/**

0 commit comments

Comments
 (0)