Commit 410f0749 authored May 10, 2023 by David Gow Committed by Shuah Khan May 11, 2023

Documentation: kunit: Note that assertions should not be used in cleanup



As assertions abort the test cleanup process, they should be avoided
from within a suite's exit function, or from within resource 'free'
functions. Unlike with initialisation or main test execution, no further
cleanup will be performed after a failed assertion, potentially causing
a leak of resources.

Reviewed-by: Sadiya Kazi <sadiyakazi@google.com>
Signed-off-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>

parent 55e8c1b4

Documentation/dev-tools/kunit/usage.rst

+6 −0

Original line number	Diff line number	Diff line
		@@ -121,6 +121,12 @@ there's an allocation error.
		``return`` so they only work from the test function. In KUnit, we stop the
		current kthread on failure, so you can call them from anywhere.

		.. note::
		Warning: There is an exception to the above rule. You shouldn't use assertions
		in the suite's exit() function, or in the free function for a resource. These
		run when a test is shutting down, and an assertion here prevents further
		cleanup code from running, potentially leading to a memory leak.

		Customizing error messages
		--------------------------