#!/usr/bin/env python3# SPDX-License-Identifier: GPL-2.0## A thin wrapper on top of the KUnit Kernel## Copyright (C) 2019, Google LLC.# Author: Felix Guo <felixguoxiuping@gmail.com># Author: Brendan Higgins <brendanhiggins@google.com> import argparseimport osimport reimport sysimport time assert sys.version_info >= (3, 7), "Python version is too old" from collections import namedtuplefrom enum import Enum, autofrom typing import Iterable, Sequence, List import kunit_jsonimport kunit_kernelimport kunit_parser KunitResult = namedtuple('KunitResult', ['status','result','elapsed_time']) KunitConfigRequest = namedtuple('KunitConfigRequest',				['build_dir', 'make_options'])KunitBuildRequest = namedtuple('KunitBuildRequest',			       ['jobs', 'build_dir', 'alltests',				'make_options'])KunitExecRequest = namedtuple('KunitExecRequest',			      ['timeout', 'build_dir', 'alltests',			       'filter_glob', 'kernel_args', 'run_isolated'])KunitParseRequest = namedtuple('KunitParseRequest',			       ['raw_output', 'build_dir', 'json'])KunitRequest = namedtuple('KunitRequest', ['raw_output','timeout', 'jobs',					   'build_dir', 'alltests', 'filter_glob',					   'kernel_args', 'run_isolated', 'json', 'make_options']) KernelDirectoryPath = sys.argv[0].split('tools/testing/kunit/')[0] class KunitStatus(Enum):	SUCCESS = auto()	CONFIG_FAILURE = auto()	BUILD_FAILURE = auto()	TEST_FAILURE = auto() def get_kernel_root_path() -> str:	path = sys.argv[0] if not __file__ else __file__	parts = os.path.realpath(path).split('tools/testing/kunit')	if len(parts) != 2:		sys.exit(1)	return parts[0] def config_tests(linux: kunit_kernel.LinuxSourceTree,		 request: KunitConfigRequest) -> KunitResult:	kunit_parser.print_with_timestamp('Configuring KUnit Kernel ...') 	config_start = time.time()	success = linux.build_reconfig(request.build_dir, request.make_options)	config_end = time.time()	if not success:		return KunitResult(KunitStatus.CONFIG_FAILURE,				   'could not configure kernel',				   config_end - config_start)	return KunitResult(KunitStatus.SUCCESS,			   'configured kernel successfully',			   config_end - config_start) def build_tests(linux: kunit_kernel.LinuxSourceTree,		request: KunitBuildRequest) -> KunitResult:	kunit_parser.print_with_timestamp('Building KUnit Kernel ...') 	build_start = time.time()	success = linux.build_kernel(request.alltests,				     request.jobs,				     request.build_dir,				     request.make_options)	build_end = time.time()	if not success:		return KunitResult(KunitStatus.BUILD_FAILURE,				   'could not build kernel',				   build_end - build_start)	if not success:		return KunitResult(KunitStatus.BUILD_FAILURE,				   'could not build kernel',				   build_end - build_start)	return KunitResult(KunitStatus.SUCCESS,			   'built kernel successfully',			   build_end - build_start) def _list_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) -> List[str]:	args = ['kunit.action=list']	if request.kernel_args:		args.extend(request.kernel_args) 	output = linux.run_kernel(args=args,			   timeout=None if request.alltests else request.timeout,			   filter_glob=request.filter_glob,			   build_dir=request.build_dir)	lines = kunit_parser.extract_tap_lines(output)	# Hack! Drop the dummy TAP version header that the executor prints out.	lines.pop() 	# Filter out any extraneous non-test output that might have gotten mixed in.	return [l for l in lines if re.match('^[^\s.]+\.[^\s.]+$', l)] def _suites_from_test_list(tests: List[str]) -> List[str]:	"""Extracts all the suites from an ordered list of tests."""	suites = []  # type: List[str]	for t in tests:		parts = t.split('.', maxsplit=2)		if len(parts) != 2:			raise ValueError(f'internal KUnit error, test name should be of the form "<suite>.<test>", got "{t}"')		suite, case = parts		if not suites or suites[-1] != suite:			suites.append(suite)	return suites   def exec_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest,	       parse_request: KunitParseRequest) -> KunitResult:	filter_globs = [request.filter_glob]	if request.run_isolated:		tests = _list_tests(linux, request)		if request.run_isolated == 'test':			filter_globs = tests		if request.run_isolated == 'suite':			filter_globs = _suites_from_test_list(tests)			# Apply the test-part of the user's glob, if present.			if '.' in request.filter_glob:				test_glob = request.filter_glob.split('.', maxsplit=2)[1]				filter_globs = [g + '.'+ test_glob for g in filter_globs] 	test_counts = kunit_parser.TestCounts()	exec_time = 0.0	for i, filter_glob in enumerate(filter_globs):		kunit_parser.print_with_timestamp('Starting KUnit Kernel ({}/{})...'.format(i+1, len(filter_globs))) 		test_start = time.time()		run_result = linux.run_kernel(			args=request.kernel_args,			timeout=None if request.alltests else request.timeout,			filter_glob=filter_glob,			build_dir=request.build_dir) 		result = parse_tests(parse_request, run_result)		# run_kernel() doesn't block on the kernel exiting.		# That only happens after we get the last line of output from `run_result`.		# So exec_time here actually contains parsing + execution time, which is fine.		test_end = time.time()		exec_time += test_end - test_start 		test_counts.add_subtest_counts(result.result.test.counts) 	kunit_status = _map_to_overall_status(test_counts.get_status())	return KunitResult(status=kunit_status, result=result.result, elapsed_time=exec_time) def _map_to_overall_status(test_status: kunit_parser.TestStatus) -> KunitStatus:	if test_status in (kunit_parser.TestStatus.SUCCESS, kunit_parser.TestStatus.SKIPPED):		return KunitStatus.SUCCESS	else:		return KunitStatus.TEST_FAILURE def parse_tests(request: KunitParseRequest, input_data: Iterable[str]) -> KunitResult:	parse_start = time.time() 	test_result = kunit_parser.TestResult(kunit_parser.TestStatus.SUCCESS,					      kunit_parser.Test(),					      'Tests not Parsed.') 	if request.raw_output:		# Treat unparsed results as one passing test.		test_result.test.status = kunit_parser.TestStatus.SUCCESS		test_result.test.counts.passed = 1 		output: Iterable[str] = 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(input_data)	parse_end = time.time() 	if request.json:		json_obj = kunit_json.get_json_result(					test_result=test_result,					def_config='kunit_defconfig',					build_dir=request.build_dir,					json_path=request.json)		if request.json == 'stdout':			print(json_obj) 	if test_result.status != kunit_parser.TestStatus.SUCCESS:		return KunitResult(KunitStatus.TEST_FAILURE, test_result,				   parse_end - parse_start) 	return KunitResult(KunitStatus.SUCCESS, test_result,				parse_end - parse_start) def run_tests(linux: kunit_kernel.LinuxSourceTree,	      request: KunitRequest) -> KunitResult:	run_start = time.time() 	config_request = KunitConfigRequest(request.build_dir,					    request.make_options)	config_result = config_tests(linux, config_request)	if config_result.status != KunitStatus.SUCCESS:		return config_result 	build_request = KunitBuildRequest(request.jobs, request.build_dir,					  request.alltests,					  request.make_options)	build_result = build_tests(linux, build_request)	if build_result.status != KunitStatus.SUCCESS:		return build_result 	exec_request = KunitExecRequest(request.timeout, request.build_dir,				 request.alltests, request.filter_glob,				 request.kernel_args, request.run_isolated)	parse_request = KunitParseRequest(request.raw_output,					  request.build_dir,					  request.json) 	exec_result = exec_tests(linux, exec_request, parse_request) 	run_end = time.time() 	kunit_parser.print_with_timestamp((		'Elapsed time: %.3fs total, %.3fs configuring, %.3fs ' +		'building, %.3fs running\n') % (				run_end - run_start,				config_result.elapsed_time,				build_result.elapsed_time,				exec_result.elapsed_time))	return exec_result # Problem:# $ kunit.py run --json# works as one would expect and prints the parsed test results as JSON.# $ kunit.py run --json suite_name# would *not* pass suite_name as the filter_glob and print as json.# argparse will consider it to be another way of writing# $ kunit.py run --json=suite_name# i.e. it would run all tests, and dump the json to a `suite_name` file.# So we hackily automatically rewrite --json => --json=stdoutpseudo_bool_flag_defaults = {		'--json': 'stdout',		'--raw_output': 'kunit',}def massage_argv(argv: Sequence[str]) -> Sequence[str]:	def massage_arg(arg: str) -> str:		if arg not in pseudo_bool_flag_defaults:			return arg		return  f'{arg}={pseudo_bool_flag_defaults[arg]}'	return list(map(massage_arg, argv)) 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')	parser.add_argument('--make_options',			    help='X=Y make option, can be repeated.',			    action='append')	parser.add_argument('--alltests',			    help='Run all KUnit tests through allyesconfig',			    action='store_true')	parser.add_argument('--kunitconfig',			     help='Path to Kconfig fragment that enables KUnit tests.'			     ' If given a directory, (e.g. lib/kunit), "/.kunitconfig" '			     'will get  automatically appended.',			     metavar='kunitconfig') 	parser.add_argument('--arch',			    help=('Specifies the architecture to run tests under. '				  'The architecture specified here must match the '				  'string passed to the ARCH make param, '				  'e.g. i386, x86_64, arm, um, etc. Non-UML '				  'architectures run on QEMU.'),			    type=str, default='um', metavar='arch') 	parser.add_argument('--cross_compile',			    help=('Sets make\'s CROSS_COMPILE variable; it should '				  'be set to a toolchain path prefix (the prefix '				  'of gcc and other tools in your toolchain, for '				  'example `sparc64-linux-gnu-` if you have the '				  'sparc toolchain installed on your system, or '				  '`$HOME/toolchains/microblaze/gcc-9.2.0-nolibc/microblaze-linux/bin/microblaze-linux-` '				  'if you have downloaded the microblaze toolchain '				  'from the 0-day website to a directory in your '				  'home directory called `toolchains`).'),			    metavar='cross_compile') 	parser.add_argument('--qemu_config',			    help=('Takes a path to a path to a file containing '				  'a QemuArchParams object.'),			    type=str, metavar='qemu_config') def add_build_opts(parser) -> None:	parser.add_argument('--jobs',			    help='As in the make command, "Specifies  the number of '			    'jobs (commands) to run simultaneously."',			    type=int, default=8, metavar='jobs') def add_exec_opts(parser) -> None:	parser.add_argument('--timeout',			    help='maximum number of seconds to allow for all tests '			    'to run. This does not include time taken to build the '			    'tests.',			    type=int,			    default=300,			    metavar='timeout')	parser.add_argument('filter_glob',			    help='Filter which KUnit test suites/tests run at '			    'boot-time, e.g. list* or list*.*del_test',			    type=str,			    nargs='?',			    default='',			    metavar='filter_glob')	parser.add_argument('--kernel_args',			    help='Kernel command-line parameters. Maybe be repeated',			     action='append')	parser.add_argument('--run_isolated', help='If set, boot the kernel for each '			    'individual suite/test. This is can be useful for debugging '			    'a non-hermetic test, one that might pass/fail based on '			    'what ran before it.',			    type=str,			    choices=['suite', 'test']), def add_parse_opts(parser) -> None:	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 '			    'prints to stdout or saves to file if a '			    'filename is specified',			    type=str, const='stdout', default=None) def main(argv, linux=None):	parser = argparse.ArgumentParser(			description='Helps writing and running KUnit tests.')	subparser = parser.add_subparsers(dest='subcommand') 	# The 'run' command will config, build, exec, and parse in one go.	run_parser = subparser.add_parser('run', help='Runs KUnit tests.')	add_common_opts(run_parser)	add_build_opts(run_parser)	add_exec_opts(run_parser)	add_parse_opts(run_parser) 	config_parser = subparser.add_parser('config',						help='Ensures that .config contains all of '						'the options in .kunitconfig')	add_common_opts(config_parser) 	build_parser = subparser.add_parser('build', help='Builds a kernel with KUnit tests')	add_common_opts(build_parser)	add_build_opts(build_parser) 	exec_parser = subparser.add_parser('exec', help='Run a kernel with KUnit tests')	add_common_opts(exec_parser)	add_exec_opts(exec_parser)	add_parse_opts(exec_parser) 	# The 'parse' option is special, as it doesn't need the kernel source	# (therefore there is no need for a build_dir, hence no add_common_opts)	# and the '--file' argument is not relevant to 'run', so isn't in	# add_parse_opts()	parse_parser = subparser.add_parser('parse',					    help='Parses KUnit results from a file, '					    'and parses formatted results.')	add_parse_opts(parse_parser)	parse_parser.add_argument('file',				  help='Specifies the file to read results from.',				  type=str, nargs='?', metavar='input_file') 	cli_args = parser.parse_args(massage_argv(argv)) 	if get_kernel_root_path():		os.chdir(get_kernel_root_path()) 	if cli_args.subcommand == 'run':		if not os.path.exists(cli_args.build_dir):			os.mkdir(cli_args.build_dir) 		if not linux:			linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir,					kunitconfig_path=cli_args.kunitconfig,					arch=cli_args.arch,					cross_compile=cli_args.cross_compile,					qemu_config_path=cli_args.qemu_config) 		request = KunitRequest(cli_args.raw_output,				       cli_args.timeout,				       cli_args.jobs,				       cli_args.build_dir,				       cli_args.alltests,				       cli_args.filter_glob,				       cli_args.kernel_args,				       cli_args.run_isolated,				       cli_args.json,				       cli_args.make_options)		result = run_tests(linux, request)		if result.status != KunitStatus.SUCCESS:			sys.exit(1)	elif cli_args.subcommand == 'config':		if cli_args.build_dir and (				not os.path.exists(cli_args.build_dir)):			os.mkdir(cli_args.build_dir) 		if not linux:			linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir,					kunitconfig_path=cli_args.kunitconfig,					arch=cli_args.arch,					cross_compile=cli_args.cross_compile,					qemu_config_path=cli_args.qemu_config) 		request = KunitConfigRequest(cli_args.build_dir,					     cli_args.make_options)		result = config_tests(linux, request)		kunit_parser.print_with_timestamp((			'Elapsed time: %.3fs\n') % (				result.elapsed_time))		if result.status != KunitStatus.SUCCESS:			sys.exit(1)	elif cli_args.subcommand == 'build':		if not linux:			linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir,					kunitconfig_path=cli_args.kunitconfig,					arch=cli_args.arch,					cross_compile=cli_args.cross_compile,					qemu_config_path=cli_args.qemu_config) 		request = KunitBuildRequest(cli_args.jobs,					    cli_args.build_dir,					    cli_args.alltests,					    cli_args.make_options)		result = build_tests(linux, request)		kunit_parser.print_with_timestamp((			'Elapsed time: %.3fs\n') % (				result.elapsed_time))		if result.status != KunitStatus.SUCCESS:			sys.exit(1)	elif cli_args.subcommand == 'exec':		if not linux:			linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir,					kunitconfig_path=cli_args.kunitconfig,					arch=cli_args.arch,					cross_compile=cli_args.cross_compile,					qemu_config_path=cli_args.qemu_config) 		exec_request = KunitExecRequest(cli_args.timeout,						cli_args.build_dir,						cli_args.alltests,						cli_args.filter_glob,						cli_args.kernel_args,						cli_args.run_isolated)		parse_request = KunitParseRequest(cli_args.raw_output,						  cli_args.build_dir,						  cli_args.json)		result = exec_tests(linux, exec_request, parse_request)		kunit_parser.print_with_timestamp((			'Elapsed time: %.3fs\n') % (result.elapsed_time))		if result.status != KunitStatus.SUCCESS:			sys.exit(1)	elif cli_args.subcommand == 'parse':		if cli_args.file == None:			sys.stdin.reconfigure(errors='backslashreplace')  # pytype: disable=attribute-error			kunit_output = sys.stdin		else:			with open(cli_args.file, 'r', errors='backslashreplace') as f:				kunit_output = f.read().splitlines()		request = KunitParseRequest(cli_args.raw_output,					    None,					    cli_args.json)		result = parse_tests(request, kunit_output)		if result.status != KunitStatus.SUCCESS:			sys.exit(1)	else:		parser.print_help() if __name__ == '__main__':	main(sys.argv[1:])