On Fri, Aug 6, 2021 at 7:51 AM Daniel Latypov <dlatypov@xxxxxxxxxx> wrote:
>
> --raw_output is nice, but it would be nicer if could show only output
> after KUnit tests have started.
>
> So change the flag to allow specifying a string ('kunit').
> Make it so `--raw_output` alone will default to `--raw_output=all` and
> have the same original behavior.
>
> Drop the small kunit_parser.raw_output() function since it feels wrong
> to put it in "kunit_parser.py" when the point of it is to not parse
> anything.
>
> E.g.
>
> $ ./tools/testing/kunit/kunit.py run --raw_output=kunit
> ...
> [15:24:07] Starting KUnit Kernel ...
> TAP version 14
> 1..1
> # Subtest: example
> 1..3
> # example_simple_test: initializing
> ok 1 - example_simple_test
> # example_skip_test: initializing
> # example_skip_test: You should not see a line below.
> ok 2 - example_skip_test # SKIP this test should be skipped
> # example_mark_skipped_test: initializing
> # example_mark_skipped_test: You should see a line below.
> # example_mark_skipped_test: You should see this line.
> ok 3 - example_mark_skipped_test # SKIP this test should be skipped
> ok 1 - example
> [15:24:10] Elapsed time: 6.487s total, 0.001s configuring, 3.510s building, 0.000s running
>
> Signed-off-by: Daniel Latypov <dlatypov@xxxxxxxxxx>
> ---
Thanks: this is something I've secretly wanted for a long time, and I
really like the interface here of "--raw_output=kunit". I do wonder if
we want to make this behaviour the default, though...
The only other note I'd have, though this was a problem with the
previous version as well, is that the output still includes the other
kunit_tool output lines, e.g.:
[23:42:01] Configuring KUnit Kernel ...
[23:42:01] Building KUnit Kernel ...
This means that the "raw" output still can't easily just be redirected
elsewhere and used. That's probably a separate fix though, and I still
think this is a massive improvement over what we have.
Reviewed-by: David Gow <davidgow@xxxxxxxxxx>
-- David
> Documentation/dev-tools/kunit/kunit-tool.rst | 9 ++++++---
> tools/testing/kunit/kunit.py | 20 +++++++++++++++-----
> tools/testing/kunit/kunit_parser.py | 4 ----
> tools/testing/kunit/kunit_tool_test.py | 9 +++++++++
> 4 files changed, 30 insertions(+), 12 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/kunit-tool.rst b/Documentation/dev-tools/kunit/kunit-tool.rst
> index c7ff9afe407a..ae52e0f489f9 100644
> --- a/Documentation/dev-tools/kunit/kunit-tool.rst
> +++ b/Documentation/dev-tools/kunit/kunit-tool.rst
> @@ -114,9 +114,12 @@ results in TAP format, you can pass the ``--raw_output`` argument.
>
> ./tools/testing/kunit/kunit.py run --raw_output
>
> -.. note::
> - The raw output from test runs may contain other, non-KUnit kernel log
> - lines.
> +The raw output from test runs may contain other, non-KUnit kernel log
> +lines. You can see just KUnit output with ``--raw_output=kunit``:
> +
> +.. code-block:: bash
> +
> + ./tools/testing/kunit/kunit.py run --raw_output=kunit
>
> If you have KUnit results in their raw TAP format, you can parse them and print
> the human-readable summary with the ``parse`` command for kunit_tool. This
> diff --git a/tools/testing/kunit/kunit.py b/tools/testing/kunit/kunit.py
> index 7174377c2172..5a931456e718 100755
> --- a/tools/testing/kunit/kunit.py
> +++ b/tools/testing/kunit/kunit.py
> @@ -16,6 +16,7 @@ assert sys.version_info >= (3, 7), "Python version is too old"
>
> from collections import namedtuple
> from enum import Enum, auto
> +from typing import Iterable
>
> import kunit_config
> import kunit_json
> @@ -114,7 +115,16 @@ def parse_tests(request: KunitParseRequest) -> KunitResult:
> 'Tests not Parsed.')
>
> if request.raw_output:
> - kunit_parser.raw_output(request.input_data)
> + output: Iterable[str] = request.input_data
> + if request.raw_output == 'all':
> + pass
> + elif request.raw_output == 'kunit':
> + output = kunit_parser.extract_tap_lines(output)
> + else:
> + print(f'Unknown --raw_output option "{request.raw_output}"', file=sys.stderr)
> + for line in output:
> + print(line.rstrip())
> +
> else:
> test_result = kunit_parser.parse_run_tests(request.input_data)
> parse_end = time.time()
> @@ -135,7 +145,6 @@ def parse_tests(request: KunitParseRequest) -> KunitResult:
> return KunitResult(KunitStatus.SUCCESS, test_result,
> parse_end - parse_start)
>
> -
> def run_tests(linux: kunit_kernel.LinuxSourceTree,
> request: KunitRequest) -> KunitResult:
> run_start = time.time()
> @@ -181,7 +190,7 @@ def add_common_opts(parser) -> None:
> parser.add_argument('--build_dir',
> help='As in the make command, it specifies the build '
> 'directory.',
> - type=str, default='.kunit', metavar='build_dir')
> + type=str, default='.kunit', metavar='build_dir')
> parser.add_argument('--make_options',
> help='X=Y make option, can be repeated.',
> action='append')
> @@ -246,8 +255,9 @@ def add_exec_opts(parser) -> None:
> action='append')
>
> def add_parse_opts(parser) -> None:
> - parser.add_argument('--raw_output', help='don\'t format output from kernel',
> - action='store_true')
> + parser.add_argument('--raw_output', help='If set don\'t format output from kernel. '
> + 'If set to --raw_output=kunit, filters to just KUnit output.',
> + type=str, nargs='?', const='all', default=None)
> parser.add_argument('--json',
> nargs='?',
> help='Stores test results in a JSON, and either '
> diff --git a/tools/testing/kunit/kunit_parser.py b/tools/testing/kunit/kunit_parser.py
> index b88db3f51dc5..84938fefbac0 100644
> --- a/tools/testing/kunit/kunit_parser.py
> +++ b/tools/testing/kunit/kunit_parser.py
> @@ -106,10 +106,6 @@ def extract_tap_lines(kernel_output: Iterable[str]) -> LineStream:
> yield line_num, line[prefix_len:]
> return LineStream(lines=isolate_kunit_output(kernel_output))
>
> -def raw_output(kernel_output) -> None:
> - for line in kernel_output:
> - print(line.rstrip())
> -
> DIVIDER = '=' * 60
>
> RESET = '\033[0;0m'
> diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py
> index 628ab00f74bc..619c4554cbff 100755
> --- a/tools/testing/kunit/kunit_tool_test.py
> +++ b/tools/testing/kunit/kunit_tool_test.py
> @@ -399,6 +399,15 @@ class KUnitMainTest(unittest.TestCase):
> self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
> self.assertNotEqual(call, mock.call(StrContains(' 0 tests run')))
>
> + def test_run_raw_output_kunit(self):
> + self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
> + kunit.main(['run', '--raw_output=kunit'], self.linux_source_mock)
> + self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
> + self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
> + for call in self.print_mock.call_args_list:
> + self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
> + self.assertNotEqual(call, mock.call(StrContains(' 0 tests run')))
> +
This is basically identical to test_run_raw_output(). Is there an easy
way of making sure this test can distinguish between them?
> def test_exec_timeout(self):
> timeout = 3453
> kunit.main(['exec', '--timeout', str(timeout)], self.linux_source_mock)
>
> base-commit: f684616e08e9cd9db3cd53fe2e068dfe02481657
> --
> 2.32.0.605.g8dce9f2422-goog
>
