From patchwork Mon Nov 21 18:47:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 23989 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp1766904wrr; Mon, 21 Nov 2022 10:49:21 -0800 (PST) X-Google-Smtp-Source: AA0mqf64T5NfU1tLJzrcukXPKNdV2aNaAPgoe2vCZOKiMTzO8/eZMWnCGastLe2U2dN/hDejFnXK X-Received: by 2002:a63:1f08:0:b0:43c:e3c8:8c30 with SMTP id f8-20020a631f08000000b0043ce3c88c30mr305514pgf.579.1669056561055; Mon, 21 Nov 2022 10:49:21 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669056561; cv=none; d=google.com; s=arc-20160816; b=YahXFiMopPmRVf7Yhl6jXeylu0I0VBof5GvQXPWje9c7SvSiglUjjA8384cVvCjSXn Li0aFm3JD0U0z7mnqw4AyavzQdPL/hAxNLmb6Ad+G/owB6RyMt6kZCUkO7+JMz746WXZ bKn+M3rkOfg06H5/kJoYNdLpj18ZA5VPPbsvgurRjg1Ca4Sg7tgFtN4Ce2hECkTJR94K R+jexykOJYqvxbNPPphJZyYHHjPJB5PLBQ8uwkXT1ROK1uNe9r75q889mqJe3Wpspu2P fvsSlGr3hGTu5vkXQpGTKIIXN9zXKhz8rDA3KBbGnZ2xXtUAoSucqJD8pwXNAXExIMyS KwUw== 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:mime-version:date:dkim-signature; bh=+v9EeIFZ7RyvUerteODN5H9jhdDgoezlYo0pDlayPT0=; b=XTqXy0NwTXepal+BqP6yr5VkO9nQMC9GgCMoWENauiqLYOAbk7O/Z61pxP+uFxQX+s 4SxgWFmFkBJKilXo1hbGpYCLmgktF0G/DdrevsBsJYvUDmZu8f4H5oh6Wv/MABH1W/MT /COyB57CXI8A180INbt+fY7P8xGtyTbGdlLpkmZ5FH+72DUgLtqjHAfm7fD+2tbJNOyE Q0fODBQkAoUQ2QSICUb4CewtKeSeYmSFNlgkObkkE+fG3nFG6zjEzkNWeQOeYLXFQiGy KcRbrDgGi3CPKHjRHt+OKNNHrX0kqCegYLVojEJJ5z8oV1ncKoJvbPWPTMNMAW606syd 3NjQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20210112 header.b=NqaHSmHA; 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 f20-20020a635114000000b0046f729604fesi12146733pgb.170.2022.11.21.10.49.07; Mon, 21 Nov 2022 10:49:21 -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=NqaHSmHA; 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 S230150AbiKUSsa (ORCPT + 99 others); Mon, 21 Nov 2022 13:48:30 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52864 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229585AbiKUSsY (ORCPT ); Mon, 21 Nov 2022 13:48:24 -0500 Received: from mail-yb1-xb4a.google.com (mail-yb1-xb4a.google.com [IPv6:2607:f8b0:4864:20::b4a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7DD92DF2D for ; Mon, 21 Nov 2022 10:48:21 -0800 (PST) Received: by mail-yb1-xb4a.google.com with SMTP id e189-20020a25e7c6000000b006e37f21e689so11805689ybh.10 for ; Mon, 21 Nov 2022 10:48:21 -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 :mime-version:date:from:to:cc:subject:date:message-id:reply-to; bh=+v9EeIFZ7RyvUerteODN5H9jhdDgoezlYo0pDlayPT0=; b=NqaHSmHAe7/TLGkCIAtqeIDQkfzZRFvowtcoC4eUtQjXP6D9oaVh8jJEEtejYtZ1wr InRjVIVNilE9GLLkC1E3/Q7ItH2WElvNiFz+H5lP0GeOAj0ivZpC3d20KWHQa1tXRgS4 0zybMy3wWj3ZB40qbhaXkBsrh50IWmJBHgq9E1wgeq6UMieeQFwU1HTbxaEc3RjJUZ8V wXMgtyFG61i7ejRvAUVH3EVahESmapTGI4UkMwi3kypXsVxGWWUrrvGfDnQJWKzpfpCn Gs0WpX0F0fWDOBjnMHfTW3GwjyM37Vknpdf+/TFNbjTZnXbTLYTfsCnBCJ7UdIZzr3gF j1sA== 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 :mime-version:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=+v9EeIFZ7RyvUerteODN5H9jhdDgoezlYo0pDlayPT0=; b=4Gm4jFiJIQOWgMxC4pRmQ6d0EnowWBd6iOzaVeRBld7iP4xn7/DrhPPAaNvYziD3fN HIbuYzmOfGQEbV+Jy9kfIIU60dXaKBcG3Z2uF6cxRC2FqYIynzocC8Sl+TFC77pkWl3v 3w2JmeEbx2vU1eJSrhrNNKG2G97cZocxu0dIZqbQBRV9/0CoyjfFiI+yGqsh1YfgJXur NpF/bfLKa/bfcs6uk3ypur2jbM6eQcm/xXhF2nNwO2jGlK+mPMcW9CfIrD5CGeLde8qt Qb7hvzQee3bUvqEjZ0noFggjU+ePjqSEqC8DRMWMIGe4EGQlFMJDPhPXkBjkwib3hbBH +xWw== X-Gm-Message-State: ANoB5pljCkHyKPsJfKEDmnavFXIdNHzDy7mUlC88fUOtplVlkyxYghON 7ZuX49dRaV+FGxdxsjwpZnK3BIj4mQ== X-Received: from rmoar.c.googlers.com ([fda3:e722:ac3:cc00:2b:7d90:c0a8:4259]) (user=rmoar job=sendgmr) by 2002:a25:ad8b:0:b0:6de:6c43:3991 with SMTP id z11-20020a25ad8b000000b006de6c433991mr9821ybi.604.1669056501142; Mon, 21 Nov 2022 10:48:21 -0800 (PST) Date: Mon, 21 Nov 2022 18:47:42 +0000 Mime-Version: 1.0 X-Mailer: git-send-email 2.38.1.584.g0f3c55d4c2-goog Message-ID: <20221121184743.1123556-1-rmoar@google.com> Subject: [PATCH v2 1/2] kunit: tool: parse KTAP compliant 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=ham 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?1750132652487075298?= X-GMAIL-MSGID: =?utf-8?q?1750132652487075298?= Change the KUnit parser to be able to parse test output that complies with the KTAP version 1 specification format found here: https://kernel.org/doc/html/latest/dev-tools/ktap.html. Ensure the parser is able to parse tests with the original KUnit test output format as well. KUnit parser now accepts any of the following test output formats: Original KUnit test output format: 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 KTAP version 1 test output format: KTAP version 1 1..1 KTAP version 1 1..3 ok 1 kunit_test_1 ok 2 kunit_test_2 ok 3 kunit_test_3 ok 1 kunit-test-suite New KUnit test output format (changes made in the next patch of this series): 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-2-rmoar@google.com/ - Switch order of patches to make changes to the parser before making changes to the test output - Change placeholder label for test header from “Test suite” to empty string - Change parser to approve the new KTAP version line in the subtest header to be before the subtest header line rather than after. - Note: Considered changing parser to allow for the top-level of testing to have a '# Subtest' line as discussed in v1 but this breaks the missing test plan test. So I think it would be best to add this ability at a later time or after top-level test name and result lines are discussed for KTAP v2. tools/testing/kunit/kunit_parser.py | 79 ++++++++++++------- tools/testing/kunit/kunit_tool_test.py | 8 ++ .../test_data/test_parse_ktap_output.log | 8 ++ 3 files changed, 67 insertions(+), 28 deletions(-) create mode 100644 tools/testing/kunit/test_data/test_parse_ktap_output.log base-commit: 6fe1ad4a156095859721fef85073df3ed43081d4 diff --git a/tools/testing/kunit/kunit_parser.py b/tools/testing/kunit/kunit_parser.py index a56c75a973b5..ed752d53d6a8 100644 --- a/tools/testing/kunit/kunit_parser.py +++ b/tools/testing/kunit/kunit_parser.py @@ -441,6 +441,7 @@ def parse_diagnostic(lines: LineStream) -> List[str]: - '# Subtest: [test name]' - '[ok|not ok] [test number] [-] [test name] [optional skip directive]' + - 'KTAP version [version number]' Parameters: lines - LineStream of KTAP output to parse @@ -449,8 +450,9 @@ def parse_diagnostic(lines: LineStream) -> List[str]: Log of diagnostic lines """ log = [] # type: List[str] - while lines and not TEST_RESULT.match(lines.peek()) and not \ - TEST_HEADER.match(lines.peek()): + non_diagnostic_lines = [TEST_RESULT, TEST_HEADER, KTAP_START] + while lines and not any(re.match(lines.peek()) + for re in non_diagnostic_lines): log.append(lines.pop()) return log @@ -496,11 +498,15 @@ def print_test_header(test: Test) -> None: test - Test object representing current test being printed """ message = test.name + if message != "": + # Add a leading space before the subtest counts only if a test name + # is provided using a "# Subtest" header line. + message += " " if test.expected_count: if test.expected_count == 1: - message += ' (1 subtest)' + message += '(1 subtest)' else: - message += f' ({test.expected_count} subtests)' + message += f'({test.expected_count} subtests)' stdout.print_with_timestamp(format_test_divider(message, len(message))) def print_log(log: Iterable[str]) -> None: @@ -647,7 +653,7 @@ def bubble_up_test_results(test: Test) -> None: elif test.counts.get_status() == TestStatus.TEST_CRASHED: test.status = TestStatus.TEST_CRASHED -def parse_test(lines: LineStream, expected_num: int, log: List[str]) -> Test: +def parse_test(lines: LineStream, expected_num: int, log: List[str], is_subtest: bool) -> Test: """ Finds next test to parse in LineStream, creates new Test object, parses any subtests of the test, populates Test object with all @@ -665,15 +671,32 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str]) -> Test: 1..4 [subtests] - - Subtest header line + - Subtest header (must include either the KTAP version line or + "# Subtest" header line) - Example: + Example (preferred format with both KTAP version line and + "# Subtest" line): + + KTAP version 1 + # Subtest: name + 1..3 + [subtests] + ok 1 name + + Example (only "# Subtest" line): # Subtest: name 1..3 [subtests] ok 1 name + Example (only KTAP version line, compliant with KTAP v1 spec): + + KTAP version 1 + 1..3 + [subtests] + ok 1 name + - Test result line Example: @@ -685,28 +708,29 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str]) -> Test: expected_num - expected test number for test to be parsed log - list of strings containing any preceding diagnostic lines corresponding to the current test + is_subtest - boolean indicating whether test is a subtest Return: Test object populated with characteristics and any subtests """ test = Test() test.log.extend(log) - parent_test = False - main = parse_ktap_header(lines, test) - if main: - # If KTAP/TAP header is found, attempt to parse + if not is_subtest: + # If parsing the main/top-level test, parse KTAP version line and # test plan test.name = "main" + ktap_line = parse_ktap_header(lines, test) parse_test_plan(lines, test) parent_test = True else: - # If KTAP/TAP header is not found, test must be subtest - # header or test result line so parse attempt to parser - # subtest header - parent_test = parse_test_header(lines, test) + # If not the main test, attempt to parse a test header contatining + # the KTAP version line and/or subtest header line + ktap_line = parse_ktap_header(lines, test) + subtest_line = parse_test_header(lines, test) + parent_test = (ktap_line or subtest_line) if parent_test: - # If subtest header is found, attempt to parse - # test plan and print header + # If KTAP version line and/or subtest header is found, attempt + # to parse test plan and print test header parse_test_plan(lines, test) print_test_header(test) expected_count = test.expected_count @@ -721,7 +745,7 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str]) -> Test: sub_log = parse_diagnostic(lines) sub_test = Test() if not lines or (peek_test_name_match(lines, test) and - not main): + is_subtest): if expected_count and test_num <= expected_count: # If parser reaches end of test before # parsing expected number of subtests, print @@ -735,20 +759,19 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str]) -> Test: test.log.extend(sub_log) break else: - sub_test = parse_test(lines, test_num, sub_log) + sub_test = parse_test(lines, test_num, sub_log, True) subtests.append(sub_test) test_num += 1 test.subtests = subtests - if not main: + if is_subtest: # If not main test, look for test result line test.log.extend(parse_diagnostic(lines)) - if (parent_test and peek_test_name_match(lines, test)) or \ - not parent_test: - parse_test_result(lines, test, expected_num) - else: + if test.name != "" and not peek_test_name_match(lines, test): test.add_error('missing subtest result line!') + else: + parse_test_result(lines, test, expected_num) - # Check for there being no tests + # Check for there being no subtests within parent test if parent_test and len(subtests) == 0: # Don't override a bad status if this test had one reported. # Assumption: no subtests means CRASHED is from Test.__init__() @@ -758,11 +781,11 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str]) -> Test: # Add statuses to TestCounts attribute in Test object bubble_up_test_results(test) - if parent_test and not main: + if parent_test and is_subtest: # If test has subtests and is not the main test object, print # footer. print_test_footer(test) - elif not main: + elif is_subtest: print_test_result(test) return test @@ -785,7 +808,7 @@ def parse_run_tests(kernel_output: Iterable[str]) -> Test: test.add_error('could not find any KTAP output!') test.status = TestStatus.FAILURE_TO_PARSE_TESTS else: - test = parse_test(lines, 0, []) + test = parse_test(lines, 0, [], False) if test.status != TestStatus.NO_TESTS: test.status = test.counts.get_status() stdout.print_with_timestamp(DIVIDER) diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py index 90c65b072be9..7c2e2a45f330 100755 --- a/tools/testing/kunit/kunit_tool_test.py +++ b/tools/testing/kunit/kunit_tool_test.py @@ -312,6 +312,14 @@ class KUnitParserTest(unittest.TestCase): self.assertEqual(kunit_parser._summarize_failed_tests(result), 'Failures: all_failed_suite, some_failed_suite.test2') + def test_ktap_format(self): + ktap_log = test_data_path('test_parse_ktap_output.log') + with open(ktap_log) as file: + result = kunit_parser.parse_run_tests(file.readlines()) + self.assertEqual(result.counts, kunit_parser.TestCounts(passed=3)) + self.assertEqual('suite', result.subtests[0].name) + self.assertEqual('case_1', result.subtests[0].subtests[0].name) + self.assertEqual('case_2', result.subtests[0].subtests[1].name) def line_stream_from_strs(strs: Iterable[str]) -> kunit_parser.LineStream: return kunit_parser.LineStream(enumerate(strs, start=1)) diff --git a/tools/testing/kunit/test_data/test_parse_ktap_output.log b/tools/testing/kunit/test_data/test_parse_ktap_output.log new file mode 100644 index 000000000000..ccdf244e5303 --- /dev/null +++ b/tools/testing/kunit/test_data/test_parse_ktap_output.log @@ -0,0 +1,8 @@ +KTAP version 1 +1..1 + KTAP version 1 + 1..3 + ok 1 case_1 + ok 2 case_2 + ok 3 case_3 +ok 1 suite 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 : "");