From patchwork Wed Nov 23 18:25:58 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 628920 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4F174C3A59F for ; Wed, 23 Nov 2022 18:26:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239651AbiKWS0Y (ORCPT ); Wed, 23 Nov 2022 13:26:24 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54988 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239544AbiKWS0W (ORCPT ); Wed, 23 Nov 2022 13:26:22 -0500 Received: from mail-yw1-x114a.google.com (mail-yw1-x114a.google.com [IPv6:2607:f8b0:4864:20::114a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A131670180 for ; Wed, 23 Nov 2022 10:26:18 -0800 (PST) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-39afd53dcdbso110362137b3.8 for ; Wed, 23 Nov 2022 10:26:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=content-transfer-encoding:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:from:to:cc:subject:date:message-id :reply-to; bh=Afz8PsANDnUvtBvSoF0QFvNdyMeaZ1ofX1YaO/pgZVM=; b=sBiuo8a2cIxrSgYaooXOob5HMsTHvVXAiUBTZJ9mlC+f6Y0+nHeU645NZr8dij4w19 EnpZ3hLjNRGdS4OPRryWUEWC/tvr+pe3UYsOoO88O/FL5ZwGcrGlzuzCnpyxxq3Z/Ji/ mNenC1rJc23zXngdfoCpK1n7nMvrP3l+XcFA2MP0QbP+EuZE/7nXeSuonVHuS/I6cmwX BlBQMrpxofgI9snuABMtw32wVWrEL4StVttByA8MnLsKK/ZRC2+BZuThtI4XMs6voMll vbpxGbAdsaJqEkiJRvzD2UB3rlhd72xmL28QzmeD9jEGADIqMf4+JJz5miw7HxFldVnn NjDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=Afz8PsANDnUvtBvSoF0QFvNdyMeaZ1ofX1YaO/pgZVM=; b=67rqTIuMSjFiMBA8eouSqzo5HukdjjkzAEpXABMsKtq+JrslQRidyun5m8wNMXXBpd 1Uy0j64QxObjIH3qG8MAG48pny8/6Mh5F+e49zIRkDjMcmI4kiL6URHcgpTPJpTvYAhh R+No9RZsIqGRAiPhBbEyqG3AIL6cAsSAKTmuGWHmKHgKAw5eWijG+4AhRtMM5yvGOPEc IUaBJ0r1AyPArF78s9T2pERIDVI7S40VFZoHj3fDkzUWJBVp23njOE857XtxjP49AE7j +/xOxNG/1ykkbkvhlFAVKEjsVJiU2Tu/7JTJXcVgdkzTn8hXDYkKQkjKkUFG6kiDNE/g iieQ== X-Gm-Message-State: ANoB5pnIuoAaL/XMzbdyz61WVw686whWMIdFkqkdi/Lv6gwx6LwMdT2T UMg2GxotJwiylkAJSwEoFBUX9P+jvQ== X-Google-Smtp-Source: AA0mqf6ZoB0Uy7y/SdWtM2cSZrRxbN7wf6VAUau2kP+ATiEfRQLlegtgUz26MstbcT9O8JzRRQDHBjJQiQ== X-Received: from rmoar.c.googlers.com ([fda3:e722:ac3:cc00:2b:7d90:c0a8:4259]) (user=rmoar job=sendgmr) by 2002:a0d:e943:0:b0:38c:6e92:e2f9 with SMTP id s64-20020a0de943000000b0038c6e92e2f9mr4ywe.379.1669227977595; Wed, 23 Nov 2022 10:26:17 -0800 (PST) Date: Wed, 23 Nov 2022 18:25:58 +0000 In-Reply-To: <20221123182558.2203639-1-rmoar@google.com> Mime-Version: 1.0 References: <20221123182558.2203639-1-rmoar@google.com> X-Mailer: git-send-email 2.38.1.584.g0f3c55d4c2-goog Message-ID: <20221123182558.2203639-2-rmoar@google.com> Subject: [PATCH v3 2/2] kunit: improve KTAP compliance of KUnit test output From: Rae Moar To: brendanhiggins@google.com, davidgow@google.com, dlatypov@google.com Cc: skhan@linuxfoundation.org, mauro.chehab@linux.intel.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, isabbasso@riseup.net, anders.roxell@linaro.org, Rae Moar Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Change KUnit test output to better comply with KTAP v1 specifications found here: https://kernel.org/doc/html/latest/dev-tools/ktap.html. 1) Use "KTAP version 1" instead of "TAP version 14" as test output header 2) Remove '-' between test number and test name on test result lines 2) Add KTAP version lines to each subtest header as well Note that the new KUnit output still includes the “# Subtest” line now located after the KTAP version line. This does not completely match the KTAP v1 spec but since it is classified as a diagnostic line, it is not expected to be disruptive or break any existing parsers. This “# Subtest” line comes from the TAP 14 spec (https://testanything.org/tap-version-14-specification.html) and it is used to define the test name before the results. Original output: TAP version 14 1..1 # Subtest: kunit-test-suite 1..3 ok 1 - kunit_test_1 ok 2 - kunit_test_2 ok 3 - kunit_test_3 # kunit-test-suite: pass:3 fail:0 skip:0 total:3 # Totals: pass:3 fail:0 skip:0 total:3 ok 1 - kunit-test-suite New output: KTAP version 1 1..1 KTAP version 1 # Subtest: kunit-test-suite 1..3 ok 1 kunit_test_1 ok 2 kunit_test_2 ok 3 kunit_test_3 # kunit-test-suite: pass:3 fail:0 skip:0 total:3 # Totals: pass:3 fail:0 skip:0 total:3 ok 1 kunit-test-suite Signed-off-by: Rae Moar Reviewed-by: Daniel Latypov Reviewed-by: David Gow --- Changes since v2: https://lore.kernel.org/all/20221121184743.1123556-2-rmoar@google.com/ - Made fixes discussed on the v2 patch to now correctly output test results after second level testing Changes since v1: https://lore.kernel.org/all/20221104194705.3245738-1-rmoar@google.com/ - Switch order of patches to make changes to the parser before making changes to the test output - Change location of the new KTAP version line in subtest header to be before the subtest header line lib/kunit/debugfs.c | 2 +- lib/kunit/executor.c | 6 +++--- lib/kunit/test.c | 9 ++++++--- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/lib/kunit/debugfs.c b/lib/kunit/debugfs.c index 1048ef1b8d6e..de0ee2e03ed6 100644 --- a/lib/kunit/debugfs.c +++ b/lib/kunit/debugfs.c @@ -63,7 +63,7 @@ static int debugfs_print_results(struct seq_file *seq, void *v) kunit_suite_for_each_test_case(suite, test_case) debugfs_print_result(seq, suite, test_case); - seq_printf(seq, "%s %d - %s\n", + seq_printf(seq, "%s %d %s\n", kunit_status_to_ok_not_ok(success), 1, suite->name); return 0; } diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c index 9bbc422c284b..74982b83707c 100644 --- a/lib/kunit/executor.c +++ b/lib/kunit/executor.c @@ -166,7 +166,7 @@ static void kunit_exec_run_tests(struct suite_set *suite_set) { size_t num_suites = suite_set->end - suite_set->start; - pr_info("TAP version 14\n"); + pr_info("KTAP version 1\n"); pr_info("1..%zu\n", num_suites); __kunit_test_suites_init(suite_set->start, num_suites); @@ -177,8 +177,8 @@ static void kunit_exec_list_tests(struct suite_set *suite_set) struct kunit_suite * const *suites; struct kunit_case *test_case; - /* Hack: print a tap header so kunit.py can find the start of KUnit output. */ - pr_info("TAP version 14\n"); + /* Hack: print a ktap header so kunit.py can find the start of KUnit output. */ + pr_info("KTAP version 1\n"); for (suites = suite_set->start; suites < suite_set->end; suites++) kunit_suite_for_each_test_case((*suites), test_case) { diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 90640a43cf62..1c9d8d962d67 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -149,6 +149,7 @@ EXPORT_SYMBOL_GPL(kunit_suite_num_test_cases); static void kunit_print_suite_start(struct kunit_suite *suite) { + kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "KTAP version 1\n"); kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "# Subtest: %s", suite->name); kunit_log(KERN_INFO, suite, KUNIT_SUBTEST_INDENT "1..%zd", @@ -175,13 +176,13 @@ static void kunit_print_ok_not_ok(void *test_or_suite, * representation. */ if (suite) - pr_info("%s %zd - %s%s%s\n", + pr_info("%s %zd %s%s%s\n", kunit_status_to_ok_not_ok(status), test_number, description, directive_header, (status == KUNIT_SKIPPED) ? directive : ""); else kunit_log(KERN_INFO, test, - KUNIT_SUBTEST_INDENT "%s %zd - %s%s%s", + KUNIT_SUBTEST_INDENT "%s %zd %s%s%s", kunit_status_to_ok_not_ok(status), test_number, description, directive_header, (status == KUNIT_SKIPPED) ? directive : ""); @@ -542,6 +543,8 @@ int kunit_run_tests(struct kunit_suite *suite) /* Get initial param. */ param_desc[0] = '\0'; test.param_value = test_case->generate_params(NULL, param_desc); + kunit_log(KERN_INFO, &test, KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT + "KTAP version 1\n"); kunit_log(KERN_INFO, &test, KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT "# Subtest: %s", test_case->name); @@ -555,7 +558,7 @@ int kunit_run_tests(struct kunit_suite *suite) kunit_log(KERN_INFO, &test, KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT - "%s %d - %s", + "%s %d %s", kunit_status_to_ok_not_ok(test.status), test.param_index + 1, param_desc);