mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-26 10:49:33 +00:00
![Daniel Latypov](/assets/img/avatar_default.png)
Currently, given something (fairly dystopian) like > KUNIT_EXPECT_EQ(test, 2 + 2, 5) KUnit will prints a failure message like this. > Expected 2 + 2 == 5, but > 2 + 2 == 4 > 5 == 5 With this patch, the output just becomes > Expected 2 + 2 == 5, but > 2 + 2 == 4 This patch is slightly hacky, but it's quite common* to compare an expression to a literal integer value, so this can make KUnit less chatty in many cases. (This patch also fixes variants like KUNIT_EXPECT_GT, LE, et al.). It also allocates an additional string briefly, but given this only happens on test failures, it doesn't seem too bad a tradeoff. Also, in most cases it'll realize the lengths are unequal and bail out before the allocation. We could save the result of the formatted string to avoid wasting this extra work, but it felt cleaner to leave it as-is. Edge case: for something silly and unrealistic like > KUNIT_EXPECT_EQ(test, 4, 5); It'll generate this message with a trailing "but" > Expected 4 == 5, but > <next line of normal output> It didn't feel worth adding a check up-front to see if both sides are literals to handle this better. *A quick grep suggests 100+ comparisons to an integer literal as the right hand side. Signed-off-by: Daniel Latypov <dlatypov@google.com> Tested-by: David Gow <davidgow@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
179 lines
5.5 KiB
C
179 lines
5.5 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
|
/*
|
|
* Assertion and expectation serialization API.
|
|
*
|
|
* Copyright (C) 2019, Google LLC.
|
|
* Author: Brendan Higgins <brendanhiggins@google.com>
|
|
*/
|
|
#include <kunit/assert.h>
|
|
#include <kunit/test.h>
|
|
|
|
#include "string-stream.h"
|
|
|
|
void kunit_base_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
const char *expect_or_assert = NULL;
|
|
|
|
switch (assert->type) {
|
|
case KUNIT_EXPECTATION:
|
|
expect_or_assert = "EXPECTATION";
|
|
break;
|
|
case KUNIT_ASSERTION:
|
|
expect_or_assert = "ASSERTION";
|
|
break;
|
|
}
|
|
|
|
string_stream_add(stream, "%s FAILED at %s:%d\n",
|
|
expect_or_assert, assert->file, assert->line);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_base_assert_format);
|
|
|
|
void kunit_assert_print_msg(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
if (assert->message.fmt)
|
|
string_stream_add(stream, "\n%pV", &assert->message);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_assert_print_msg);
|
|
|
|
void kunit_fail_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
kunit_base_assert_format(assert, stream);
|
|
string_stream_add(stream, "%pV", &assert->message);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_fail_assert_format);
|
|
|
|
void kunit_unary_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
struct kunit_unary_assert *unary_assert = container_of(
|
|
assert, struct kunit_unary_assert, assert);
|
|
|
|
kunit_base_assert_format(assert, stream);
|
|
if (unary_assert->expected_true)
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s to be true, but is false\n",
|
|
unary_assert->condition);
|
|
else
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s to be false, but is true\n",
|
|
unary_assert->condition);
|
|
kunit_assert_print_msg(assert, stream);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_unary_assert_format);
|
|
|
|
void kunit_ptr_not_err_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
struct kunit_ptr_not_err_assert *ptr_assert = container_of(
|
|
assert, struct kunit_ptr_not_err_assert, assert);
|
|
|
|
kunit_base_assert_format(assert, stream);
|
|
if (!ptr_assert->value) {
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s is not null, but is\n",
|
|
ptr_assert->text);
|
|
} else if (IS_ERR(ptr_assert->value)) {
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s is not error, but is: %ld\n",
|
|
ptr_assert->text,
|
|
PTR_ERR(ptr_assert->value));
|
|
}
|
|
kunit_assert_print_msg(assert, stream);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_ptr_not_err_assert_format);
|
|
|
|
/* Checks if `text` is a literal representing `value`, e.g. "5" and 5 */
|
|
static bool is_literal(struct kunit *test, const char *text, long long value,
|
|
gfp_t gfp)
|
|
{
|
|
char *buffer;
|
|
int len;
|
|
bool ret;
|
|
|
|
len = snprintf(NULL, 0, "%lld", value);
|
|
if (strlen(text) != len)
|
|
return false;
|
|
|
|
buffer = kunit_kmalloc(test, len+1, gfp);
|
|
if (!buffer)
|
|
return false;
|
|
|
|
snprintf(buffer, len+1, "%lld", value);
|
|
ret = strncmp(buffer, text, len) == 0;
|
|
|
|
kunit_kfree(test, buffer);
|
|
return ret;
|
|
}
|
|
|
|
void kunit_binary_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
struct kunit_binary_assert *binary_assert = container_of(
|
|
assert, struct kunit_binary_assert, assert);
|
|
|
|
kunit_base_assert_format(assert, stream);
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
|
|
binary_assert->left_text,
|
|
binary_assert->operation,
|
|
binary_assert->right_text);
|
|
if (!is_literal(stream->test, binary_assert->left_text,
|
|
binary_assert->left_value, stream->gfp))
|
|
string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s == %lld\n",
|
|
binary_assert->left_text,
|
|
binary_assert->left_value);
|
|
if (!is_literal(stream->test, binary_assert->right_text,
|
|
binary_assert->right_value, stream->gfp))
|
|
string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s == %lld",
|
|
binary_assert->right_text,
|
|
binary_assert->right_value);
|
|
kunit_assert_print_msg(assert, stream);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_binary_assert_format);
|
|
|
|
void kunit_binary_ptr_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
struct kunit_binary_ptr_assert *binary_assert = container_of(
|
|
assert, struct kunit_binary_ptr_assert, assert);
|
|
|
|
kunit_base_assert_format(assert, stream);
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
|
|
binary_assert->left_text,
|
|
binary_assert->operation,
|
|
binary_assert->right_text);
|
|
string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s == %px\n",
|
|
binary_assert->left_text,
|
|
binary_assert->left_value);
|
|
string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s == %px",
|
|
binary_assert->right_text,
|
|
binary_assert->right_value);
|
|
kunit_assert_print_msg(assert, stream);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_binary_ptr_assert_format);
|
|
|
|
void kunit_binary_str_assert_format(const struct kunit_assert *assert,
|
|
struct string_stream *stream)
|
|
{
|
|
struct kunit_binary_str_assert *binary_assert = container_of(
|
|
assert, struct kunit_binary_str_assert, assert);
|
|
|
|
kunit_base_assert_format(assert, stream);
|
|
string_stream_add(stream,
|
|
KUNIT_SUBTEST_INDENT "Expected %s %s %s, but\n",
|
|
binary_assert->left_text,
|
|
binary_assert->operation,
|
|
binary_assert->right_text);
|
|
string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s == %s\n",
|
|
binary_assert->left_text,
|
|
binary_assert->left_value);
|
|
string_stream_add(stream, KUNIT_SUBSUBTEST_INDENT "%s == %s",
|
|
binary_assert->right_text,
|
|
binary_assert->right_value);
|
|
kunit_assert_print_msg(assert, stream);
|
|
}
|
|
EXPORT_SYMBOL_GPL(kunit_binary_str_assert_format);
|