2 # SPDX-License-Identifier: GPL-2.0
4 # A thin wrapper on top of the KUnit Kernel
6 # Copyright (C) 2019, Google LLC.
7 # Author: Felix Guo <felixguoxiuping@gmail.com>
8 # Author: Brendan Higgins <brendanhiggins@google.com>
15 from collections import namedtuple
16 from enum import Enum, auto
23 KunitResult = namedtuple('KunitResult', ['status','result','elapsed_time'])
25 KunitConfigRequest = namedtuple('KunitConfigRequest',
26 ['build_dir', 'make_options'])
27 KunitBuildRequest = namedtuple('KunitBuildRequest',
28 ['jobs', 'build_dir', 'alltests',
30 KunitExecRequest = namedtuple('KunitExecRequest',
31 ['timeout', 'build_dir', 'alltests', 'filter_glob'])
32 KunitParseRequest = namedtuple('KunitParseRequest',
33 ['raw_output', 'input_data', 'build_dir', 'json'])
34 KunitRequest = namedtuple('KunitRequest', ['raw_output','timeout', 'jobs',
35 'build_dir', 'alltests', 'filter_glob',
36 'json', 'make_options'])
38 KernelDirectoryPath = sys.argv[0].split('tools/testing/kunit/')[0]
40 class KunitStatus(Enum):
42 CONFIG_FAILURE = auto()
43 BUILD_FAILURE = auto()
46 def get_kernel_root_path() -> str:
47 path = sys.argv[0] if not __file__ else __file__
48 parts = os.path.realpath(path).split('tools/testing/kunit')
53 def config_tests(linux: kunit_kernel.LinuxSourceTree,
54 request: KunitConfigRequest) -> KunitResult:
55 kunit_parser.print_with_timestamp('Configuring KUnit Kernel ...')
57 config_start = time.time()
58 success = linux.build_reconfig(request.build_dir, request.make_options)
59 config_end = time.time()
61 return KunitResult(KunitStatus.CONFIG_FAILURE,
62 'could not configure kernel',
63 config_end - config_start)
64 return KunitResult(KunitStatus.SUCCESS,
65 'configured kernel successfully',
66 config_end - config_start)
68 def build_tests(linux: kunit_kernel.LinuxSourceTree,
69 request: KunitBuildRequest) -> KunitResult:
70 kunit_parser.print_with_timestamp('Building KUnit Kernel ...')
72 build_start = time.time()
73 success = linux.build_um_kernel(request.alltests,
77 build_end = time.time()
79 return KunitResult(KunitStatus.BUILD_FAILURE,
80 'could not build kernel',
81 build_end - build_start)
83 return KunitResult(KunitStatus.BUILD_FAILURE,
84 'could not build kernel',
85 build_end - build_start)
86 return KunitResult(KunitStatus.SUCCESS,
87 'built kernel successfully',
88 build_end - build_start)
90 def exec_tests(linux: kunit_kernel.LinuxSourceTree,
91 request: KunitExecRequest) -> KunitResult:
92 kunit_parser.print_with_timestamp('Starting KUnit Kernel ...')
93 test_start = time.time()
94 result = linux.run_kernel(
95 timeout=None if request.alltests else request.timeout,
96 filter_glob=request.filter_glob,
97 build_dir=request.build_dir)
99 test_end = time.time()
101 return KunitResult(KunitStatus.SUCCESS,
103 test_end - test_start)
105 def parse_tests(request: KunitParseRequest) -> KunitResult:
106 parse_start = time.time()
108 test_result = kunit_parser.TestResult(kunit_parser.TestStatus.SUCCESS,
112 if request.raw_output:
113 kunit_parser.raw_output(request.input_data)
115 test_result = kunit_parser.parse_run_tests(request.input_data)
116 parse_end = time.time()
119 json_obj = kunit_json.get_json_result(
120 test_result=test_result,
121 def_config='kunit_defconfig',
122 build_dir=request.build_dir,
123 json_path=request.json)
124 if request.json == 'stdout':
127 if test_result.status != kunit_parser.TestStatus.SUCCESS:
128 return KunitResult(KunitStatus.TEST_FAILURE, test_result,
129 parse_end - parse_start)
131 return KunitResult(KunitStatus.SUCCESS, test_result,
132 parse_end - parse_start)
135 def run_tests(linux: kunit_kernel.LinuxSourceTree,
136 request: KunitRequest) -> KunitResult:
137 run_start = time.time()
139 config_request = KunitConfigRequest(request.build_dir,
140 request.make_options)
141 config_result = config_tests(linux, config_request)
142 if config_result.status != KunitStatus.SUCCESS:
145 build_request = KunitBuildRequest(request.jobs, request.build_dir,
147 request.make_options)
148 build_result = build_tests(linux, build_request)
149 if build_result.status != KunitStatus.SUCCESS:
152 exec_request = KunitExecRequest(request.timeout, request.build_dir,
153 request.alltests, request.filter_glob)
154 exec_result = exec_tests(linux, exec_request)
155 if exec_result.status != KunitStatus.SUCCESS:
158 parse_request = KunitParseRequest(request.raw_output,
162 parse_result = parse_tests(parse_request)
164 run_end = time.time()
166 kunit_parser.print_with_timestamp((
167 'Elapsed time: %.3fs total, %.3fs configuring, %.3fs ' +
168 'building, %.3fs running\n') % (
170 config_result.elapsed_time,
171 build_result.elapsed_time,
172 exec_result.elapsed_time))
175 def add_common_opts(parser) -> None:
176 parser.add_argument('--build_dir',
177 help='As in the make command, it specifies the build '
179 type=str, default='.kunit', metavar='build_dir')
180 parser.add_argument('--make_options',
181 help='X=Y make option, can be repeated.',
183 parser.add_argument('--alltests',
184 help='Run all KUnit tests through allyesconfig',
186 parser.add_argument('--kunitconfig',
187 help='Path to Kconfig fragment that enables KUnit tests.'
188 ' If given a directory, (e.g. lib/kunit), "/.kunitconfig" '
189 'will get automatically appended.',
190 metavar='kunitconfig')
192 def add_build_opts(parser) -> None:
193 parser.add_argument('--jobs',
194 help='As in the make command, "Specifies the number of '
195 'jobs (commands) to run simultaneously."',
196 type=int, default=8, metavar='jobs')
198 def add_exec_opts(parser) -> None:
199 parser.add_argument('--timeout',
200 help='maximum number of seconds to allow for all tests '
201 'to run. This does not include time taken to build the '
206 parser.add_argument('filter_glob',
207 help='maximum number of seconds to allow for all tests '
208 'to run. This does not include time taken to build the '
213 metavar='filter_glob')
215 def add_parse_opts(parser) -> None:
216 parser.add_argument('--raw_output', help='don\'t format output from kernel',
218 parser.add_argument('--json',
220 help='Stores test results in a JSON, and either '
221 'prints to stdout or saves to file if a '
222 'filename is specified',
223 type=str, const='stdout', default=None)
225 def main(argv, linux=None):
226 parser = argparse.ArgumentParser(
227 description='Helps writing and running KUnit tests.')
228 subparser = parser.add_subparsers(dest='subcommand')
230 # The 'run' command will config, build, exec, and parse in one go.
231 run_parser = subparser.add_parser('run', help='Runs KUnit tests.')
232 add_common_opts(run_parser)
233 add_build_opts(run_parser)
234 add_exec_opts(run_parser)
235 add_parse_opts(run_parser)
237 config_parser = subparser.add_parser('config',
238 help='Ensures that .config contains all of '
239 'the options in .kunitconfig')
240 add_common_opts(config_parser)
242 build_parser = subparser.add_parser('build', help='Builds a kernel with KUnit tests')
243 add_common_opts(build_parser)
244 add_build_opts(build_parser)
246 exec_parser = subparser.add_parser('exec', help='Run a kernel with KUnit tests')
247 add_common_opts(exec_parser)
248 add_exec_opts(exec_parser)
249 add_parse_opts(exec_parser)
251 # The 'parse' option is special, as it doesn't need the kernel source
252 # (therefore there is no need for a build_dir, hence no add_common_opts)
253 # and the '--file' argument is not relevant to 'run', so isn't in
255 parse_parser = subparser.add_parser('parse',
256 help='Parses KUnit results from a file, '
257 'and parses formatted results.')
258 add_parse_opts(parse_parser)
259 parse_parser.add_argument('file',
260 help='Specifies the file to read results from.',
261 type=str, nargs='?', metavar='input_file')
263 cli_args = parser.parse_args(argv)
265 if get_kernel_root_path():
266 os.chdir(get_kernel_root_path())
268 if cli_args.subcommand == 'run':
269 if not os.path.exists(cli_args.build_dir):
270 os.mkdir(cli_args.build_dir)
273 linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir, kunitconfig_path=cli_args.kunitconfig)
275 request = KunitRequest(cli_args.raw_output,
280 cli_args.filter_glob,
282 cli_args.make_options)
283 result = run_tests(linux, request)
284 if result.status != KunitStatus.SUCCESS:
286 elif cli_args.subcommand == 'config':
287 if cli_args.build_dir and (
288 not os.path.exists(cli_args.build_dir)):
289 os.mkdir(cli_args.build_dir)
292 linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir, kunitconfig_path=cli_args.kunitconfig)
294 request = KunitConfigRequest(cli_args.build_dir,
295 cli_args.make_options)
296 result = config_tests(linux, request)
297 kunit_parser.print_with_timestamp((
298 'Elapsed time: %.3fs\n') % (
299 result.elapsed_time))
300 if result.status != KunitStatus.SUCCESS:
302 elif cli_args.subcommand == 'build':
304 linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir, kunitconfig_path=cli_args.kunitconfig)
306 request = KunitBuildRequest(cli_args.jobs,
309 cli_args.make_options)
310 result = build_tests(linux, request)
311 kunit_parser.print_with_timestamp((
312 'Elapsed time: %.3fs\n') % (
313 result.elapsed_time))
314 if result.status != KunitStatus.SUCCESS:
316 elif cli_args.subcommand == 'exec':
318 linux = kunit_kernel.LinuxSourceTree(cli_args.build_dir)
320 exec_request = KunitExecRequest(cli_args.timeout,
323 cli_args.filter_glob)
324 exec_result = exec_tests(linux, exec_request)
325 parse_request = KunitParseRequest(cli_args.raw_output,
329 result = parse_tests(parse_request)
330 kunit_parser.print_with_timestamp((
331 'Elapsed time: %.3fs\n') % (
332 exec_result.elapsed_time))
333 if result.status != KunitStatus.SUCCESS:
335 elif cli_args.subcommand == 'parse':
336 if cli_args.file == None:
337 kunit_output = sys.stdin
339 with open(cli_args.file, 'r') as f:
340 kunit_output = f.read().splitlines()
341 request = KunitParseRequest(cli_args.raw_output,
345 result = parse_tests(request)
346 if result.status != KunitStatus.SUCCESS:
351 if __name__ == '__main__':