Commit ec0a42a1 authored by Daniel Latypov's avatar Daniel Latypov Committed by Shuah Khan

Documentation: KUnit: reword description of assertions

The existing wording implies that kunit_kmalloc_array() is "the method
under test". We're actually testing the sort() function in that example.
This is because the example was changed in commit 95357439
("Documentation: KUnit: Rework writing page to focus on writing tests"),
but the wording was not.

Also add a `note` telling people they can use the KUNIT_ASSERT_EQ()
macros from any function. Some users might be coming from a framework
like gUnit where that'll compile but silently do the wrong thing.
Signed-off-by: default avatarDaniel Latypov <dlatypov@google.com>
Reviewed-by: default avatarSadiya Kazi <sadiyakazi@google.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 65c48a48
...@@ -112,11 +112,14 @@ terminates the test case if the condition is not satisfied. For example: ...@@ -112,11 +112,14 @@ terminates the test case if the condition is not satisfied. For example:
KUNIT_EXPECT_LE(test, a[i], a[i + 1]); KUNIT_EXPECT_LE(test, a[i], a[i + 1]);
} }
In this example, the method under test should return pointer to a value. If the In this example, we need to be able to allocate an array to test the ``sort()``
pointer returns null or an errno, we want to stop the test since the following function. So we use ``KUNIT_ASSERT_NOT_ERR_OR_NULL()`` to abort the test if
expectation could crash the test case. `ASSERT_NOT_ERR_OR_NULL(...)` allows us there's an allocation error.
to bail out of the test case if the appropriate conditions are not satisfied to
complete the test. .. note::
In other test frameworks, ``ASSERT`` macros are often implemented by calling
``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.
Customizing error messages Customizing error messages
-------------------------- --------------------------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment