Commit 7d4087b0 authored by Eric Chan's avatar Eric Chan Committed by Shuah Khan
Browse files

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: default avatarEric Chan <ericchancf@google.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 2be32bbe

drivers/input/tests/input_test.c

+1 −1
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ static int input_test_init(struct kunit *test) 
	ret = input_register_device(input_dev);

	if (ret) {

		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;

include/kunit/assert.h

+1 −1
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ void kunit_assert_prologue(const struct kunit_loc *loc, 
 * struct kunit_fail_assert - Represents a plain fail expectation/assertion.

 * @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_assert assert;

include/kunit/test.h

+12 −1
Original line number Diff line number Diff line
@@ -1228,7 +1228,18 @@ do { \ 
						fmt,			       \

						##__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__)



/**