From patchwork Wed Jul 17 01:55:29 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Brendan Higgins X-Patchwork-Id: 11046929 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 359FD13BD for ; Wed, 17 Jul 2019 01:56:08 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2709928702 for ; Wed, 17 Jul 2019 01:56:08 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 1A73128715; Wed, 17 Jul 2019 01:56:08 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.5 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, USER_IN_DEF_DKIM_WL autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 175F228708 for ; Wed, 17 Jul 2019 01:56:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727035AbfGQB4G (ORCPT ); Tue, 16 Jul 2019 21:56:06 -0400 Received: from mail-pl1-f201.google.com ([209.85.214.201]:36000 "EHLO mail-pl1-f201.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726724AbfGQB4F (ORCPT ); Tue, 16 Jul 2019 21:56:05 -0400 Received: by mail-pl1-f201.google.com with SMTP id a5so11180744pla.3 for ; Tue, 16 Jul 2019 18:56:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=Nz8aHV39st6C14LfpoASArc0NcKx9jRy4dn2kjWwnX8=; b=qQsx0jtc8w1sgJvUe/HBL6sYcJv0mQpi1pE2DODOu7wiK8hBgAw5eKIanqIz+MCPP+ T42lXg62zCQUHH1HcPy+rdJrTlLvly2oxydW9AA+AjKUYSDQtHbxiyurLQa0sTzRzQts fusFLoxwz9RW6IYhqoi3Ao7MDICk3idt/q3hKTTBtnLnA4p1QwXAZjBEWWAe7eJWUlpp Z38Ah5SBDsoKrms0G12A/N9VrKF5r3sKdxZ19JzADgdQNWdhpmAFlKCck/2cTkzDpCKI dAbG4gSaB9PO3ZSIHlsHXkIEKonQY/W+nK0Hz+7X7ebdQ3z92PNyFoxS94t2MGImlEeh 0C8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=Nz8aHV39st6C14LfpoASArc0NcKx9jRy4dn2kjWwnX8=; b=bYSTMmpUeTN9+IDgjJmt85IfEYz5ZD/LYf4Dc5PKLT4KfWvwyj6XsMIK8XoH5SpPeV kaqbJszrzHGbMhfahPgogMm0ZQwIraugvJs5yWZl8fCSNPY5z9nmnQRdMXBNVsO3gsMg Ubb+6FSJB/3lZAheKDJmUNqbSdSrWCSPbCjEPPmgPhE9J+L5lgPje8ELte0ms/iQO7sC obM4eE+/PnjisKgeA7/padzyxcD6l1otOdMtDQqeFSVdT+SoVADiqBzUHmbvr4gm5mrn mOMEdqI0OODtfuRbYLfG4e+sXUDeKwblgBU9AcRRRSXCxnI13G2tIGSrypkWyBphp3EA Folg== X-Gm-Message-State: APjAAAX2j8CrqGmEwrnI0qtYk8cWbncSvbjRpZZoFicAgZklrUWNuviW WjJL9M5ahN+KidQC62cP5D2cTt8XmGdTYdC4VSOH6Q== X-Google-Smtp-Source: APXvYqz0kOQ0kjtDlOHNl7pfytCE13iMAmvjEs4xHUGo47xOC7cuwiN8PWab0JpIXXH5u0DcT8cEF0Ve3SFX6VxWkHAAiw== X-Received: by 2002:a63:e907:: with SMTP id i7mr37161686pgh.84.1563328563771; Tue, 16 Jul 2019 18:56:03 -0700 (PDT) Date: Tue, 16 Jul 2019 18:55:29 -0700 In-Reply-To: <20190717015543.152251-1-brendanhiggins@google.com> Message-Id: <20190717015543.152251-5-brendanhiggins@google.com> Mime-Version: 1.0 References: <20190717015543.152251-1-brendanhiggins@google.com> X-Mailer: git-send-email 2.22.0.510.g264f2c817a-goog Subject: [PATCH v11 04/18] kunit: test: add kunit_stream a std::stream like logger From: Brendan Higgins To: frowand.list@gmail.com, gregkh@linuxfoundation.org, jpoimboe@redhat.com, keescook@google.com, kieran.bingham@ideasonboard.com, mcgrof@kernel.org, peterz@infradead.org, robh@kernel.org, sboyd@kernel.org, shuah@kernel.org, tytso@mit.edu, yamada.masahiro@socionext.com Cc: devicetree@vger.kernel.org, dri-devel@lists.freedesktop.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-nvdimm@lists.01.org, linux-um@lists.infradead.org, Alexander.Levin@microsoft.com, Tim.Bird@sony.com, amir73il@gmail.com, dan.carpenter@oracle.com, daniel@ffwll.ch, jdike@addtoit.com, joel@jms.id.au, julia.lawall@lip6.fr, khilman@baylibre.com, knut.omang@oracle.com, logang@deltatee.com, mpe@ellerman.id.au, pmladek@suse.com, rdunlap@infradead.org, richard@nod.at, rientjes@google.com, rostedt@goodmis.org, wfg@linux.intel.com, Brendan Higgins Sender: linux-kbuild-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP A lot of the expectation and assertion infrastructure prints out fairly complicated test failure messages, so add a C++ style log library for for logging test results called `struct kunit_stream`. kunit_stream allows us to construct a message before we know whether we want to print it out; this can be extremely handy if there is information you might need for a failure message that is easiest to collect in the steps leading up to the actual check. Note that kunit_stream is distinct from string_stream: whereas string_stream is really just a string builder, kunit_stream is specifically used for constructing expectation/assertion (introduced later in this series) messages to a user of KUnit. Signed-off-by: Brendan Higgins Reviewed-by: Greg Kroah-Hartman Reviewed-by: Logan Gunthorpe --- include/kunit/kunit-stream.h | 97 +++++++++++++++++++++++++++++ include/kunit/test.h | 3 + kunit/Makefile | 3 +- kunit/kunit-stream.c | 115 +++++++++++++++++++++++++++++++++++ kunit/test.c | 6 ++ 5 files changed, 223 insertions(+), 1 deletion(-) create mode 100644 include/kunit/kunit-stream.h create mode 100644 kunit/kunit-stream.c diff --git a/include/kunit/kunit-stream.h b/include/kunit/kunit-stream.h new file mode 100644 index 0000000000000..ba0ff553b8301 --- /dev/null +++ b/include/kunit/kunit-stream.h @@ -0,0 +1,97 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * C++ stream style string formatter and printer used in KUnit for outputting + * KUnit messages. + * + * Copyright (C) 2019, Google LLC. + * Author: Brendan Higgins + */ + +#ifndef _KUNIT_KUNIT_STREAM_H +#define _KUNIT_KUNIT_STREAM_H + +#include +#include + +struct kunit; + +/** + * struct kunit_stream - a std::stream style string builder. + * + * A std::stream style string builder. Allows messages to be built up and + * printed all at once. Note that the intention is to only use + * &struct kunit_stream to communicate with a user of KUnit, most often to + * communicate something about an expectation or an assertion to the user. If + * you want a similar interface, but aren't sure if this is the right class for + * you to use, you probably want to use the related string_stream class, which + * is allowed for generic string construction in a similar manner. This class is + * really only for the KUnit library to communicate certain kinds of information + * to KUnit users and should not be used by anyone else. + * + * A note on &struct kunit_stream's usage: a kunit_stream will generally + * accompany *one* expectation or assertion. Multiple expectations/assertions + * may be validated concurrently at any given time, even within a single test + * case, so sharing a kunit_stream between expectations/assertions may result in + * unintended consequences. + */ +struct kunit_stream { + /* private: internal use only. */ + struct kunit *test; + const char *level; + struct string_stream *internal_stream; +}; + +/** + * alloc_kunit_stream() - constructs a new &struct kunit_stream. + * @test: The test context object. + * @level: The log level at which to print out the message. + * @gfp: The GFP flags to use for internal allocations. + * + * Constructs a new test managed &struct kunit_stream. + */ +struct kunit_stream *alloc_kunit_stream(struct kunit *test, + const char *level, + gfp_t gfp); + +/** + * kunit_stream_add(): adds the formatted input to the internal buffer. + * @kstream: the stream being operated on. + * @fmt: printf style format string to append to stream. + * + * Appends the formatted string, @fmt, to the internal buffer. + */ +void __printf(2, 3) kunit_stream_add(struct kunit_stream *kstream, + const char *fmt, ...); + +/** + * kunit_stream_append(): appends the contents of @other to @kstream. + * @kstream: the stream to which @other is appended. + * @other: the stream whose contents are appended to @kstream. + * + * Appends the contents of @other to @kstream. + */ +void kunit_stream_append(struct kunit_stream *kstream, + struct kunit_stream *other); + +/** + * kunit_stream_commit(): prints out the internal buffer to the user. + * @kstream: the stream being operated on. + * + * Outputs the contents of the internal buffer as a kunit_printk formatted + * output. KUNIT_STREAM ONLY OUTPUTS ITS BUFFER TO THE USER IF COMMIT IS + * CALLED!!! The reason for this is that it allows us to construct a message + * before we know whether we want to print it out; this can be extremely handy + * if there is information you might need for a failure message that is easiest + * to collect in the steps leading up to the actual check. + */ +void kunit_stream_commit(struct kunit_stream *kstream); + +/** + * kunit_stream_clear(): clears the internal buffer. + * @kstream: the stream being operated on. + * + * Clears the contents of the internal buffer. + */ +void kunit_stream_clear(struct kunit_stream *kstream); + +#endif /* _KUNIT_KUNIT_STREAM_H */ diff --git a/include/kunit/test.h b/include/kunit/test.h index d0bf112910caf..4b6e7d91afd34 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -11,6 +11,7 @@ #include #include +#include struct kunit_resource; @@ -184,6 +185,8 @@ struct kunit { void kunit_init_test(struct kunit *test, const char *name); +void kunit_fail(struct kunit *test, struct kunit_stream *stream); + int kunit_run_tests(struct kunit_suite *suite); /** diff --git a/kunit/Makefile b/kunit/Makefile index 275b565a0e81f..6ddc622ee6b1c 100644 --- a/kunit/Makefile +++ b/kunit/Makefile @@ -1,2 +1,3 @@ obj-$(CONFIG_KUNIT) += test.o \ - string-stream.o + string-stream.o \ + kunit-stream.o diff --git a/kunit/kunit-stream.c b/kunit/kunit-stream.c new file mode 100644 index 0000000000000..42fcef8188b3a --- /dev/null +++ b/kunit/kunit-stream.c @@ -0,0 +1,115 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * C++ stream style string formatter and printer used in KUnit for outputting + * KUnit messages. + * + * Copyright (C) 2019, Google LLC. + * Author: Brendan Higgins + */ + +#include +#include +#include + +void kunit_stream_add(struct kunit_stream *kstream, const char *fmt, ...) +{ + va_list args; + struct string_stream *stream = kstream->internal_stream; + + va_start(args, fmt); + + if (string_stream_vadd(stream, fmt, args)) + kunit_err(kstream->test, + "Failed to allocate fragment: %s\n", + fmt); + + va_end(args); +} + +void kunit_stream_append(struct kunit_stream *kstream, + struct kunit_stream *other) +{ + int ret; + + ret = string_stream_append(kstream->internal_stream, + other->internal_stream); + + if (ret) + kunit_err(kstream->test, + "Failed to append other stream: %d\n", ret); +} + +void kunit_stream_clear(struct kunit_stream *kstream) +{ + string_stream_clear(kstream->internal_stream); +} + +void kunit_stream_commit(struct kunit_stream *kstream) +{ + struct string_stream *stream = kstream->internal_stream; + struct string_stream_fragment *fragment; + struct kunit *test = kstream->test; + char *buf; + + buf = string_stream_get_string(stream); + if (!buf) { + kunit_err(test, + "Could not allocate buffer, dumping stream:\n"); + list_for_each_entry(fragment, &stream->fragments, node) { + kunit_err(test, fragment->fragment); + } + kunit_err(test, "\n"); + } else { + kunit_printk(kstream->level, test, buf); + } + + kunit_stream_clear(kstream); +} + +struct kunit_stream_alloc_context { + struct kunit *test; + const char *level; + gfp_t gfp; +}; + +static int kunit_stream_init(struct kunit_resource *res, void *context) +{ + struct kunit_stream_alloc_context *ctx = context; + struct kunit_stream *stream; + + stream = kunit_kzalloc(ctx->test, sizeof(*stream), ctx->gfp); + if (!stream) + return -ENOMEM; + + res->allocation = stream; + stream->test = ctx->test; + stream->level = ctx->level; + stream->internal_stream = alloc_string_stream(ctx->test, ctx->gfp); + + if (!stream->internal_stream) + return -ENOMEM; + + return 0; +} + +static void kunit_stream_free(struct kunit_resource *res) +{ + /* Do nothing because cleanup is handled by KUnit managed resources */ +} + +struct kunit_stream *alloc_kunit_stream(struct kunit *test, + const char *level, + gfp_t gfp) +{ + struct kunit_stream_alloc_context ctx = { + .test = test, + .level = level, + .gfp = gfp + }; + + return kunit_alloc_resource(test, + kunit_stream_init, + kunit_stream_free, + gfp, + &ctx); +} diff --git a/kunit/test.c b/kunit/test.c index 4c178a817f2fe..fdab07bb0b529 100644 --- a/kunit/test.c +++ b/kunit/test.c @@ -120,6 +120,12 @@ static void kunit_print_test_case_ok_not_ok(struct kunit_case *test_case, test_case->name); } +void kunit_fail(struct kunit *test, struct kunit_stream *stream) +{ + kunit_set_failure(test); + kunit_stream_commit(stream); +} + void kunit_init_test(struct kunit *test, const char *name) { spin_lock_init(&test->lock);