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>
This commit is contained in:
Eric Chan 2024-07-11 19:39:31 +00:00 committed by Shuah Khan
parent 2be32bbe69
commit 7d4087b013
3 changed files with 14 additions and 3 deletions

View File

@ -31,7 +31,7 @@ static int input_test_init(struct kunit *test)
ret = input_register_device(input_dev); ret = input_register_device(input_dev);
if (ret) { if (ret) {
input_free_device(input_dev); input_free_device(input_dev);
KUNIT_ASSERT_FAILURE(test, "Register device failed: %d", ret); KUNIT_FAIL_AND_ABORT(test, "Register device failed: %d", ret);
} }
test->priv = input_dev; test->priv = input_dev;

View File

@ -60,7 +60,7 @@ void kunit_assert_prologue(const struct kunit_loc *loc,
* struct kunit_fail_assert - Represents a plain fail expectation/assertion. * struct kunit_fail_assert - Represents a plain fail expectation/assertion.
* @assert: The parent of this type. * @assert: The parent of this type.
* *
* Represents a simple KUNIT_FAIL/KUNIT_ASSERT_FAILURE that always fails. * Represents a simple KUNIT_FAIL/KUNIT_FAIL_AND_ABORT that always fails.
*/ */
struct kunit_fail_assert { struct kunit_fail_assert {
struct kunit_assert assert; struct kunit_assert assert;

View File

@ -1228,7 +1228,18 @@ do { \
fmt, \ fmt, \
##__VA_ARGS__) ##__VA_ARGS__)
#define KUNIT_ASSERT_FAILURE(test, fmt, ...) \ /**
* KUNIT_FAIL_AND_ABORT() - Always causes a test to fail and abort when evaluated.
* @test: The test context object.
* @fmt: an informational message to be printed when the assertion is made.
* @...: string format arguments.
*
* The opposite of KUNIT_SUCCEED(), it is an assertion that always fails. In
* other words, it always results in a failed assertion, and consequently
* always causes the test case to fail and abort when evaluated.
* See KUNIT_ASSERT_TRUE() for more information.
*/
#define KUNIT_FAIL_AND_ABORT(test, fmt, ...) \
KUNIT_FAIL_ASSERTION(test, KUNIT_ASSERTION, fmt, ##__VA_ARGS__) KUNIT_FAIL_ASSERTION(test, KUNIT_ASSERTION, fmt, ##__VA_ARGS__)
/** /**