From patchwork Mon Nov 21 18:47:43 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 23990 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp1767032wrr; Mon, 21 Nov 2022 10:49:40 -0800 (PST) X-Google-Smtp-Source: AA0mqf6pM/Wxb7xttsCJvm4nxtpL5+J5Na3LsGbC9HHmrHvnHX2oM2/terFumXeeZTWtG2xRvQKH X-Received: by 2002:a63:2251:0:b0:477:9bc8:dffb with SMTP id t17-20020a632251000000b004779bc8dffbmr4958pgm.306.1669056579791; Mon, 21 Nov 2022 10:49:39 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669056579; cv=none; d=google.com; s=arc-20160816; b=PI6XNCyNJ1lRCP6nReceQVcC4gqUNYwjN5qaOCyMtCgx2RJRdnrI3YtI1BhkYw5RPg qiipe+RK3mgoIXTbDCdZ90he6i0A6B42Cq6DLq+OZUbliDxyAfYYuMyJ5sNDLHzDvNvT bGJxZ1kP/oJzZGuQk4XrFhtnmxgR0SHh2l6nq2HYjM1Vd0WVxanlU95mmKwlxAzNF3v3 hx4WaHDDLeewliBx8JC9syq5OyumGC1mqz2oKX6TDYoFzkDxND9CEO4YRsvCZMGkhY2N XLVxQy+Vd8mpMBV9+cMIRh+z4WSB31OQiTMGZqLK7D3jZ/2R7EhcLoSyo0Rci7Hr60xx jHSw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:cc:to:from:subject :message-id:references:mime-version:in-reply-to:date:dkim-signature; bh=bQcwB4vN/QPlHNzIeMIdeVxHrWjoYtLVSwX3XdqNUTk=; b=oWF3Yc0Fjm4MvunkUz75/VrY4IV0ts283e4kfUbLI8pB9o7dYJ2psKf6Yz2Sc0NmWm 3lpQj7fG/CIHjP51Nn56nOb36wDkWjL1/xtmK0a4uL+RpR2XT4Y2glWUJ1mI8lS6CD6+ XCLAnpMmgROFnHdKR8c3UJaAUv+9XBBD0LZhLYOVHjQLHwYTlDvZXO7B6hPA6F1ucWxt DmV0wcSLJ+tyXMlkWoFsiUkuY4oTcDRZhocYXCgVXxzGtyY0rUiE3xx59BtX6xXdam7K 0ZTLBq+VYCu0dfUvCY/4p+57ImZ+GGdbO1ue8Yks19w31jpXdiqjq3ZDUOBrabpKnWlm 4djg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=ku2ue9y1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id u13-20020a170903124d00b00188f3bd383csi12791094plh.266.2022.11.21.10.49.25; Mon, 21 Nov 2022 10:49:39 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=ku2ue9y1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230357AbiKUSsu (ORCPT + 99 others); Mon, 21 Nov 2022 13:48:50 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52958 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230148AbiKUSs3 (ORCPT ); Mon, 21 Nov 2022 13:48:29 -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 0625BC67F5 for ; Mon, 21 Nov 2022 10:48:28 -0800 (PST) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-38f92b4b3f2so119585977b3.1 for ; Mon, 21 Nov 2022 10:48:27 -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=bQcwB4vN/QPlHNzIeMIdeVxHrWjoYtLVSwX3XdqNUTk=; b=ku2ue9y1mdoW8zdPD9kQYrtqkg33ektbEwOoHHSQag6bzrTtNPLAUsCBaUc5+0nf+2 SNosJeorNGuwPC1A7ZYERV5egi/7X7+RSWzN+XvTcGtky/eS2TEIsnD089ckE/XINOQb U/xkvoEZmNVvePV1MCgiOY5Eh7jgXefg2ZfPzk3YW/Oi9Njw3WQdssi+P4IaavtZt/ce Dr98V+qBqqKH9PC7LIGREwmH8OlQ70ZfSraJG3FyjABtoGcvtCj9YUUGdka5NMu8RnnF 8lwFVQPjzltvMYGaxx7GUS2kJMncAZepn/Q7a6eHzqkwm8Jkt8bPGuRcsZwr/i6fZ4R3 0sBg== 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=bQcwB4vN/QPlHNzIeMIdeVxHrWjoYtLVSwX3XdqNUTk=; b=dlRTmkcHMEBOk2/Bs2Z4TS2FvrKfZ7PIPiiJKH8qOs2X9svnQLNodlvwNimz5j5+j5 KLTmI8HEdC4mrR2vPm/WV7pQSAWRO+Qr9PGtTj2VpwA7k/Rzkke5LTeOkN6uYPPpa9PC 69dvbB+XylKJhCwdqZaCsPX4fvEBKZhjGaERK5XvTHtIn12o+fHnxsp503zUC8cjj+YB ixhrE1dt49k+xg6UxadGUwv+PhU5hyiQ6tUMVZt154Ib5YmR57/xknsobS3LbRLKOgwW ZjaFBF3hVc0rTa8ZhoOYlCQoh3vOTk320iwtthgz4Fic22o97E5TkAJKgVU7JbAWOhzy Vr0g== X-Gm-Message-State: ANoB5pms3nwcpQvHMU6lcskM5Z/j99M0+6RKHcS+obRXCf8ogCCbfOLS GDpsxA0KqFQ4ZOpJW1da10Gn852brQ== X-Received: from rmoar.c.googlers.com ([fda3:e722:ac3:cc00:2b:7d90:c0a8:4259]) (user=rmoar job=sendgmr) by 2002:a81:ec0b:0:b0:3a7:c4eb:4955 with SMTP id j11-20020a81ec0b000000b003a7c4eb4955mr0ywm.126.1669056506889; Mon, 21 Nov 2022 10:48:26 -0800 (PST) Date: Mon, 21 Nov 2022 18:47:43 +0000 In-Reply-To: <20221121184743.1123556-1-rmoar@google.com> Mime-Version: 1.0 References: <20221121184743.1123556-1-rmoar@google.com> X-Mailer: git-send-email 2.38.1.584.g0f3c55d4c2-goog Message-ID: <20221121184743.1123556-2-rmoar@google.com> Subject: [PATCH v2 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 X-Spam-Status: No, score=-9.6 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1750132672388202480?= X-GMAIL-MSGID: =?utf-8?q?1750132672388202480?= 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 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/executor.c | 6 +++--- lib/kunit/test.c | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) 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..19344cb501c5 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 : "");