tools/testing/kunit/kunit.py

   1 #!/usr/bin/env python3
   2 # SPDX-License-Identifier: GPL-2.0
   3 #
   4 # A thin wrapper on top of the KUnit Kernel
   5 #
   6 # Copyright (C) 2019, Google LLC.
   7 # Author: Felix Guo <[email protected]>
   8 # Author: Brendan Higgins <[email protected]>
   9
  10 import argparse
  11 import os
  12 import re
  13 import shlex
  14 import sys
  15 import time
  16
  17 assert sys.version_info >= (3, 7), "Python version is too old"
  18
  19 from dataclasses import dataclass
  20 from enum import Enum, auto
  21 from typing import Iterable, List, Optional, Sequence, Tuple
  22
  23 import kunit_json
  24 import kunit_kernel
  25 import kunit_parser
  26 from kunit_printer import stdout
  27
  28 class KunitStatus(Enum):
  29         SUCCESS = auto()
  30         CONFIG_FAILURE = auto()
  31         BUILD_FAILURE = auto()
  32         TEST_FAILURE = auto()
  33
  34 @dataclass
  35 class KunitResult:
  36         status: KunitStatus
  37         elapsed_time: float
  38
  39 @dataclass
  40 class KunitConfigRequest:
  41         build_dir: str
  42         make_options: Optional[List[str]]
  43
  44 @dataclass
  45 class KunitBuildRequest(KunitConfigRequest):
  46         jobs: int
  47
  48 @dataclass
  49 class KunitParseRequest:
  50         raw_output: Optional[str]
  51         json: Optional[str]
  52
  53 @dataclass
  54 class KunitExecRequest(KunitParseRequest):
  55         build_dir: str
  56         timeout: int
  57         filter_glob: str
  58         kernel_args: Optional[List[str]]
  59         run_isolated: Optional[str]
  60
  61 @dataclass
  62 class KunitRequest(KunitExecRequest, KunitBuildRequest):
  63         pass
  64
  65
  66 def get_kernel_root_path() -> str:
  67         path = sys.argv[0] if not __file__ else __file__
  68         parts = os.path.realpath(path).split('tools/testing/kunit')
  69         if len(parts) != 2:
  70                 sys.exit(1)
  71         return parts[0]
  72
  73 def config_tests(linux: kunit_kernel.LinuxSourceTree,
  74                  request: KunitConfigRequest) -> KunitResult:
  75         stdout.print_with_timestamp('Configuring KUnit Kernel ...')
  76
  77         config_start = time.time()
  78         success = linux.build_reconfig(request.build_dir, request.make_options)
  79         config_end = time.time()
  80         if not success:
  81                 return KunitResult(KunitStatus.CONFIG_FAILURE,
  82                                    config_end - config_start)
  83         return KunitResult(KunitStatus.SUCCESS,
  84                            config_end - config_start)
  85
  86 def build_tests(linux: kunit_kernel.LinuxSourceTree,
  87                 request: KunitBuildRequest) -> KunitResult:
  88         stdout.print_with_timestamp('Building KUnit Kernel ...')
  89
  90         build_start = time.time()
  91         success = linux.build_kernel(request.jobs,
  92                                      request.build_dir,
  93                                      request.make_options)
  94         build_end = time.time()
  95         if not success:
  96                 return KunitResult(KunitStatus.BUILD_FAILURE,
  97                                    build_end - build_start)
  98         if not success:
  99                 return KunitResult(KunitStatus.BUILD_FAILURE,
 100                                    build_end - build_start)
 101         return KunitResult(KunitStatus.SUCCESS,
 102                            build_end - build_start)
 103
 104 def config_and_build_tests(linux: kunit_kernel.LinuxSourceTree,
 105                            request: KunitBuildRequest) -> KunitResult:
 106         config_result = config_tests(linux, request)
 107         if config_result.status != KunitStatus.SUCCESS:
 108                 return config_result
 109
 110         return build_tests(linux, request)
 111
 112 def _list_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) -> List[str]:
 113         args = ['kunit.action=list']
 114         if request.kernel_args:
 115                 args.extend(request.kernel_args)
 116
 117         output = linux.run_kernel(args=args,
 118                            timeout=request.timeout,
 119                            filter_glob=request.filter_glob,
 120                            build_dir=request.build_dir)
 121         lines = kunit_parser.extract_tap_lines(output)
 122         # Hack! Drop the dummy TAP version header that the executor prints out.
 123         lines.pop()
 124
 125         # Filter out any extraneous non-test output that might have gotten mixed in.
 126         return [l for l in lines if re.match(r'^[^\s.]+\.[^\s.]+$', l)]
 127
 128 def _suites_from_test_list(tests: List[str]) -> List[str]:
 129         """Extracts all the suites from an ordered list of tests."""
 130         suites = []  # type: List[str]
 131         for t in tests:
 132                 parts = t.split('.', maxsplit=2)
 133                 if len(parts) != 2:
 134                         raise ValueError(f'internal KUnit error, test name should be of the form "<suite>.<test>", got "{t}"')
 135                 suite, case = parts
 136                 if not suites or suites[-1] != suite:
 137                         suites.append(suite)
 138         return suites
 139
 140
 141
 142 def exec_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) -> KunitResult:
 143         filter_globs = [request.filter_glob]
 144         if request.run_isolated:
 145                 tests = _list_tests(linux, request)
 146                 if request.run_isolated == 'test':
 147                         filter_globs = tests
 148                 if request.run_isolated == 'suite':
 149                         filter_globs = _suites_from_test_list(tests)
 150                         # Apply the test-part of the user's glob, if present.
 151                         if '.' in request.filter_glob:
 152                                 test_glob = request.filter_glob.split('.', maxsplit=2)[1]
 153                                 filter_globs = [g + '.'+ test_glob for g in filter_globs]
 154
 155         metadata = kunit_json.Metadata(arch=linux.arch(), build_dir=request.build_dir, def_config='kunit_defconfig')
 156
 157         test_counts = kunit_parser.TestCounts()
 158         exec_time = 0.0
 159         for i, filter_glob in enumerate(filter_globs):
 160                 stdout.print_with_timestamp('Starting KUnit Kernel ({}/{})...'.format(i+1, len(filter_globs)))
 161
 162                 test_start = time.time()
 163                 run_result = linux.run_kernel(
 164                         args=request.kernel_args,
 165                         timeout=request.timeout,
 166                         filter_glob=filter_glob,
 167                         build_dir=request.build_dir)
 168
 169                 _, test_result = parse_tests(request, metadata, run_result)
 170                 # run_kernel() doesn't block on the kernel exiting.
 171                 # That only happens after we get the last line of output from `run_result`.
 172                 # So exec_time here actually contains parsing + execution time, which is fine.
 173                 test_end = time.time()
 174                 exec_time += test_end - test_start
 175
 176                 test_counts.add_subtest_counts(test_result.counts)
 177
 178         if len(filter_globs) == 1 and test_counts.crashed > 0:
 179                 bd = request.build_dir
 180                 print('The kernel seems to have crashed; you can decode the stack traces with:')
 181                 print('$ scripts/decode_stacktrace.sh {}/vmlinux {} < {} | tee {}/decoded.log | {} parse'.format(
 182                                 bd, bd, kunit_kernel.get_outfile_path(bd), bd, sys.argv[0]))
 183
 184         kunit_status = _map_to_overall_status(test_counts.get_status())
 185         return KunitResult(status=kunit_status, elapsed_time=exec_time)
 186
 187 def _map_to_overall_status(test_status: kunit_parser.TestStatus) -> KunitStatus:
 188         if test_status in (kunit_parser.TestStatus.SUCCESS, kunit_parser.TestStatus.SKIPPED):
 189                 return KunitStatus.SUCCESS
 190         return KunitStatus.TEST_FAILURE
 191
 192 def parse_tests(request: KunitParseRequest, metadata: kunit_json.Metadata, input_data: Iterable[str]) -> Tuple[KunitResult, kunit_parser.Test]:
 193         parse_start = time.time()
 194
 195         if request.raw_output:
 196                 # Treat unparsed results as one passing test.
 197                 fake_test = kunit_parser.Test()
 198                 fake_test.status = kunit_parser.TestStatus.SUCCESS
 199                 fake_test.counts.passed = 1
 200
 201                 output: Iterable[str] = input_data
 202                 if request.raw_output == 'all':
 203                         pass
 204                 elif request.raw_output == 'kunit':
 205                         output = kunit_parser.extract_tap_lines(output)
 206                 for line in output:
 207                         print(line.rstrip())
 208                 parse_time = time.time() - parse_start
 209                 return KunitResult(KunitStatus.SUCCESS, parse_time), fake_test
 210
 211
 212         # Actually parse the test results.
 213         test = kunit_parser.parse_run_tests(input_data)
 214         parse_time = time.time() - parse_start
 215
 216         if request.json:
 217                 json_str = kunit_json.get_json_result(
 218                                         test=test,
 219                                         metadata=metadata)
 220                 if request.json == 'stdout':
 221                         print(json_str)
 222                 else:
 223                         with open(request.json, 'w') as f:
 224                                 f.write(json_str)
 225                         stdout.print_with_timestamp("Test results stored in %s" %
 226                                 os.path.abspath(request.json))
 227
 228         if test.status != kunit_parser.TestStatus.SUCCESS:
 229                 return KunitResult(KunitStatus.TEST_FAILURE, parse_time), test
 230
 231         return KunitResult(KunitStatus.SUCCESS, parse_time), test
 232
 233 def run_tests(linux: kunit_kernel.LinuxSourceTree,
 234               request: KunitRequest) -> KunitResult:
 235         run_start = time.time()
 236
 237         config_result = config_tests(linux, request)
 238         if config_result.status != KunitStatus.SUCCESS:
 239                 return config_result
 240
 241         build_result = build_tests(linux, request)
 242         if build_result.status != KunitStatus.SUCCESS:
 243                 return build_result
 244
 245         exec_result = exec_tests(linux, request)
 246
 247         run_end = time.time()
 248
 249         stdout.print_with_timestamp((
 250                 'Elapsed time: %.3fs total, %.3fs configuring, %.3fs ' +
 251                 'building, %.3fs running\n') % (
 252                                 run_end - run_start,
 253                                 config_result.elapsed_time,
 254                                 build_result.elapsed_time,
 255                                 exec_result.elapsed_time))
 256         return exec_result
 257
 258 # Problem:
 259 # $ kunit.py run --json
 260 # works as one would expect and prints the parsed test results as JSON.
 261 # $ kunit.py run --json suite_name
 262 # would *not* pass suite_name as the filter_glob and print as json.
 263 # argparse will consider it to be another way of writing
 264 # $ kunit.py run --json=suite_name
 265 # i.e. it would run all tests, and dump the json to a `suite_name` file.
 266 # So we hackily automatically rewrite --json => --json=stdout
 267 pseudo_bool_flag_defaults = {
 268                 '--json': 'stdout',
 269                 '--raw_output': 'kunit',
 270 }
 271 def massage_argv(argv: Sequence[str]) -> Sequence[str]:
 272         def massage_arg(arg: str) -> str:
 273                 if arg not in pseudo_bool_flag_defaults:
 274                         return arg
 275                 return  f'{arg}={pseudo_bool_flag_defaults[arg]}'
 276         return list(map(massage_arg, argv))
 277
 278 def get_default_jobs() -> int:
 279         return len(os.sched_getaffinity(0))
 280
 281 def add_common_opts(parser) -> None:
 282         parser.add_argument('--build_dir',
 283                             help='As in the make command, it specifies the build '
 284                             'directory.',
 285                             type=str, default='.kunit', metavar='DIR')
 286         parser.add_argument('--make_options',
 287                             help='X=Y make option, can be repeated.',
 288                             action='append', metavar='X=Y')
 289         parser.add_argument('--alltests',
 290                             help='Run all KUnit tests via tools/testing/kunit/configs/all_tests.config',
 291                             action='store_true')
 292         parser.add_argument('--kunitconfig',
 293                              help='Path to Kconfig fragment that enables KUnit tests.'
 294                              ' If given a directory, (e.g. lib/kunit), "/.kunitconfig" '
 295                              'will get  automatically appended. If repeated, the files '
 296                              'blindly concatenated, which might not work in all cases.',
 297                              action='append', metavar='PATHS')
 298         parser.add_argument('--kconfig_add',
 299                              help='Additional Kconfig options to append to the '
 300                              '.kunitconfig, e.g. CONFIG_KASAN=y. Can be repeated.',
 301                             action='append', metavar='CONFIG_X=Y')
 302
 303         parser.add_argument('--arch',
 304                             help=('Specifies the architecture to run tests under. '
 305                                   'The architecture specified here must match the '
 306                                   'string passed to the ARCH make param, '
 307                                   'e.g. i386, x86_64, arm, um, etc. Non-UML '
 308                                   'architectures run on QEMU.'),
 309                             type=str, default='um', metavar='ARCH')
 310
 311         parser.add_argument('--cross_compile',
 312                             help=('Sets make\'s CROSS_COMPILE variable; it should '
 313                                   'be set to a toolchain path prefix (the prefix '
 314                                   'of gcc and other tools in your toolchain, for '
 315                                   'example `sparc64-linux-gnu-` if you have the '
 316                                   'sparc toolchain installed on your system, or '
 317                                   '`$HOME/toolchains/microblaze/gcc-9.2.0-nolibc/microblaze-linux/bin/microblaze-linux-` '
 318                                   'if you have downloaded the microblaze toolchain '
 319                                   'from the 0-day website to a directory in your '
 320                                   'home directory called `toolchains`).'),
 321                             metavar='PREFIX')
 322
 323         parser.add_argument('--qemu_config',
 324                             help=('Takes a path to a path to a file containing '
 325                                   'a QemuArchParams object.'),
 326                             type=str, metavar='FILE')
 327
 328         parser.add_argument('--qemu_args',
 329                             help='Additional QEMU arguments, e.g. "-smp 8"',
 330                             action='append', metavar='')
 331
 332 def add_build_opts(parser) -> None:
 333         parser.add_argument('--jobs',
 334                             help='As in the make command, "Specifies  the number of '
 335                             'jobs (commands) to run simultaneously."',
 336                             type=int, default=get_default_jobs(), metavar='N')
 337
 338 def add_exec_opts(parser) -> None:
 339         parser.add_argument('--timeout',
 340                             help='maximum number of seconds to allow for all tests '
 341                             'to run. This does not include time taken to build the '
 342                             'tests.',
 343                             type=int,
 344                             default=300,
 345                             metavar='SECONDS')
 346         parser.add_argument('filter_glob',
 347                             help='Filter which KUnit test suites/tests run at '
 348                             'boot-time, e.g. list* or list*.*del_test',
 349                             type=str,
 350                             nargs='?',
 351                             default='',
 352                             metavar='filter_glob')
 353         parser.add_argument('--kernel_args',
 354                             help='Kernel command-line parameters. Maybe be repeated',
 355                              action='append', metavar='')
 356         parser.add_argument('--run_isolated', help='If set, boot the kernel for each '
 357                             'individual suite/test. This is can be useful for debugging '
 358                             'a non-hermetic test, one that might pass/fail based on '
 359                             'what ran before it.',
 360                             type=str,
 361                             choices=['suite', 'test'])
 362
 363 def add_parse_opts(parser) -> None:
 364         parser.add_argument('--raw_output', help='If set don\'t parse output from kernel. '
 365                             'By default, filters to just KUnit output. Use '
 366                             '--raw_output=all to show everything',
 367                              type=str, nargs='?', const='all', default=None, choices=['all', 'kunit'])
 368         parser.add_argument('--json',
 369                             nargs='?',
 370                             help='Prints parsed test results as JSON to stdout or a file if '
 371                             'a filename is specified. Does nothing if --raw_output is set.',
 372                             type=str, const='stdout', default=None, metavar='FILE')
 373
 374
 375 def tree_from_args(cli_args: argparse.Namespace) -> kunit_kernel.LinuxSourceTree:
 376         """Returns a LinuxSourceTree based on the user's arguments."""
 377         # Allow users to specify multiple arguments in one string, e.g. '-smp 8'
 378         qemu_args: List[str] = []
 379         if cli_args.qemu_args:
 380                 for arg in cli_args.qemu_args:
 381                         qemu_args.extend(shlex.split(arg))
 382
 383         kunitconfigs = cli_args.kunitconfig if cli_args.kunitconfig else []
 384         if cli_args.alltests:
 385                 # Prepend so user-specified options take prio if we ever allow
 386                 # --kunitconfig options to have differing options.
 387                 kunitconfigs = [kunit_kernel.ALL_TESTS_CONFIG_PATH] + kunitconfigs
 388
 389         return kunit_kernel.LinuxSourceTree(cli_args.build_dir,
 390                         kunitconfig_paths=kunitconfigs,
 391                         kconfig_add=cli_args.kconfig_add,
 392                         arch=cli_args.arch,
 393                         cross_compile=cli_args.cross_compile,
 394                         qemu_config_path=cli_args.qemu_config,
 395                         extra_qemu_args=qemu_args)
 396
 397
 398 def main(argv):
 399         parser = argparse.ArgumentParser(
 400                         description='Helps writing and running KUnit tests.')
 401         subparser = parser.add_subparsers(dest='subcommand')
 402
 403         # The 'run' command will config, build, exec, and parse in one go.
 404         run_parser = subparser.add_parser('run', help='Runs KUnit tests.')
 405         add_common_opts(run_parser)
 406         add_build_opts(run_parser)
 407         add_exec_opts(run_parser)
 408         add_parse_opts(run_parser)
 409
 410         config_parser = subparser.add_parser('config',
 411                                                 help='Ensures that .config contains all of '
 412                                                 'the options in .kunitconfig')
 413         add_common_opts(config_parser)
 414
 415         build_parser = subparser.add_parser('build', help='Builds a kernel with KUnit tests')
 416         add_common_opts(build_parser)
 417         add_build_opts(build_parser)
 418
 419         exec_parser = subparser.add_parser('exec', help='Run a kernel with KUnit tests')
 420         add_common_opts(exec_parser)
 421         add_exec_opts(exec_parser)
 422         add_parse_opts(exec_parser)
 423
 424         # The 'parse' option is special, as it doesn't need the kernel source
 425         # (therefore there is no need for a build_dir, hence no add_common_opts)
 426         # and the '--file' argument is not relevant to 'run', so isn't in
 427         # add_parse_opts()
 428         parse_parser = subparser.add_parser('parse',
 429                                             help='Parses KUnit results from a file, '
 430                                             'and parses formatted results.')
 431         add_parse_opts(parse_parser)
 432         parse_parser.add_argument('file',
 433                                   help='Specifies the file to read results from.',
 434                                   type=str, nargs='?', metavar='input_file')
 435
 436         cli_args = parser.parse_args(massage_argv(argv))
 437
 438         if get_kernel_root_path():
 439                 os.chdir(get_kernel_root_path())
 440
 441         if cli_args.subcommand == 'run':
 442                 if not os.path.exists(cli_args.build_dir):
 443                         os.mkdir(cli_args.build_dir)
 444
 445                 linux = tree_from_args(cli_args)
 446                 request = KunitRequest(build_dir=cli_args.build_dir,
 447                                        make_options=cli_args.make_options,
 448                                        jobs=cli_args.jobs,
 449                                        raw_output=cli_args.raw_output,
 450                                        json=cli_args.json,
 451                                        timeout=cli_args.timeout,
 452                                        filter_glob=cli_args.filter_glob,
 453                                        kernel_args=cli_args.kernel_args,
 454                                        run_isolated=cli_args.run_isolated)
 455                 result = run_tests(linux, request)
 456                 if result.status != KunitStatus.SUCCESS:
 457                         sys.exit(1)
 458         elif cli_args.subcommand == 'config':
 459                 if cli_args.build_dir and (
 460                                 not os.path.exists(cli_args.build_dir)):
 461                         os.mkdir(cli_args.build_dir)
 462
 463                 linux = tree_from_args(cli_args)
 464                 request = KunitConfigRequest(build_dir=cli_args.build_dir,
 465                                              make_options=cli_args.make_options)
 466                 result = config_tests(linux, request)
 467                 stdout.print_with_timestamp((
 468                         'Elapsed time: %.3fs\n') % (
 469                                 result.elapsed_time))
 470                 if result.status != KunitStatus.SUCCESS:
 471                         sys.exit(1)
 472         elif cli_args.subcommand == 'build':
 473                 linux = tree_from_args(cli_args)
 474                 request = KunitBuildRequest(build_dir=cli_args.build_dir,
 475                                             make_options=cli_args.make_options,
 476                                             jobs=cli_args.jobs)
 477                 result = config_and_build_tests(linux, request)
 478                 stdout.print_with_timestamp((
 479                         'Elapsed time: %.3fs\n') % (
 480                                 result.elapsed_time))
 481                 if result.status != KunitStatus.SUCCESS:
 482                         sys.exit(1)
 483         elif cli_args.subcommand == 'exec':
 484                 linux = tree_from_args(cli_args)
 485                 exec_request = KunitExecRequest(raw_output=cli_args.raw_output,
 486                                                 build_dir=cli_args.build_dir,
 487                                                 json=cli_args.json,
 488                                                 timeout=cli_args.timeout,
 489                                                 filter_glob=cli_args.filter_glob,
 490                                                 kernel_args=cli_args.kernel_args,
 491                                                 run_isolated=cli_args.run_isolated)
 492                 result = exec_tests(linux, exec_request)
 493                 stdout.print_with_timestamp((
 494                         'Elapsed time: %.3fs\n') % (result.elapsed_time))
 495                 if result.status != KunitStatus.SUCCESS:
 496                         sys.exit(1)
 497         elif cli_args.subcommand == 'parse':
 498                 if cli_args.file is None:
 499                         sys.stdin.reconfigure(errors='backslashreplace')  # pytype: disable=attribute-error
 500                         kunit_output = sys.stdin
 501                 else:
 502                         with open(cli_args.file, 'r', errors='backslashreplace') as f:
 503                                 kunit_output = f.read().splitlines()
 504                 # We know nothing about how the result was created!
 505                 metadata = kunit_json.Metadata()
 506                 request = KunitParseRequest(raw_output=cli_args.raw_output,
 507                                             json=cli_args.json)
 508                 result, _ = parse_tests(request, metadata, kunit_output)
 509                 if result.status != KunitStatus.SUCCESS:
 510                         sys.exit(1)
 511         else:
 512                 parser.print_help()
 513
 514 if __name__ == '__main__':
 515         main(sys.argv[1:])