lkml.org 
[lkml]   [2022]   [Nov]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    Subject[PATCH v2 2/3] Documentation: KUnit: reword description of assertions
    From
    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 953574390634
    ("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: Daniel Latypov <dlatypov@google.com>
    ---
    Documentation/dev-tools/kunit/usage.rst | 13 ++++++++-----
    1 file changed, 8 insertions(+), 5 deletions(-)

    diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
    index b0a6c3bc0eeb..8060114e3aa6 100644
    --- a/Documentation/dev-tools/kunit/usage.rst
    +++ b/Documentation/dev-tools/kunit/usage.rst
    @@ -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]);
    }

    -In this example, the method under test should return pointer to a value. If the
    -pointer returns null or an errno, we want to stop the test since the following
    -expectation could crash the test case. `ASSERT_NOT_ERR_OR_NULL(...)` allows us
    -to bail out of the test case if the appropriate conditions are not satisfied to
    -complete the test.
    +In this example, we need to be able to allocate an array to test the ``sort()``
    +function. So we use ``KUNIT_ASSERT_NOT_ERR_OR_NULL()`` to abort the test if
    +we there's an allocation error.
    +
    +.. 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
    --------------------------
    --
    2.38.1.431.g37b22c650d-goog
    \
     
     \ /
      Last update: 2022-11-09 01:37    [W:5.713 / U:0.012 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site