1#!/usr/bin/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 <felixguoxiuping@gmail.com> 8# Author: Brendan Higgins <brendanhiggins@google.com> 9 10import argparse 11import sys 12import os 13import time 14import shutil 15 16from collections import namedtuple 17from enum import Enum, auto 18 19import kunit_config 20import kunit_kernel 21import kunit_parser 22 23KunitResult = namedtuple('KunitResult', ['status','result']) 24 25KunitRequest = namedtuple('KunitRequest', ['raw_output','timeout', 'jobs', 'build_dir', 'defconfig']) 26 27class KunitStatus(Enum): 28 SUCCESS = auto() 29 CONFIG_FAILURE = auto() 30 BUILD_FAILURE = auto() 31 TEST_FAILURE = auto() 32 33def create_default_kunitconfig(): 34 if not os.path.exists(kunit_kernel.KUNITCONFIG_PATH): 35 shutil.copyfile('arch/um/configs/kunit_defconfig', 36 kunit_kernel.KUNITCONFIG_PATH) 37 38def run_tests(linux: kunit_kernel.LinuxSourceTree, 39 request: KunitRequest) -> KunitResult: 40 if request.defconfig: 41 create_default_kunitconfig() 42 43 config_start = time.time() 44 success = linux.build_reconfig(request.build_dir) 45 config_end = time.time() 46 if not success: 47 return KunitResult(KunitStatus.CONFIG_FAILURE, 'could not configure kernel') 48 49 kunit_parser.print_with_timestamp('Building KUnit Kernel ...') 50 51 build_start = time.time() 52 success = linux.build_um_kernel(request.jobs, request.build_dir) 53 build_end = time.time() 54 if not success: 55 return KunitResult(KunitStatus.BUILD_FAILURE, 'could not build kernel') 56 57 kunit_parser.print_with_timestamp('Starting KUnit Kernel ...') 58 test_start = time.time() 59 60 test_result = kunit_parser.TestResult(kunit_parser.TestStatus.SUCCESS, 61 [], 62 'Tests not Parsed.') 63 if request.raw_output: 64 kunit_parser.raw_output( 65 linux.run_kernel(timeout=request.timeout)) 66 else: 67 kunit_output = linux.run_kernel(timeout=request.timeout) 68 test_result = kunit_parser.parse_run_tests(kunit_output) 69 test_end = time.time() 70 71 kunit_parser.print_with_timestamp(( 72 'Elapsed time: %.3fs total, %.3fs configuring, %.3fs ' + 73 'building, %.3fs running\n') % ( 74 test_end - config_start, 75 config_end - config_start, 76 build_end - build_start, 77 test_end - test_start)) 78 79 if test_result.status != kunit_parser.TestStatus.SUCCESS: 80 return KunitResult(KunitStatus.TEST_FAILURE, test_result) 81 else: 82 return KunitResult(KunitStatus.SUCCESS, test_result) 83 84def main(argv, linux=None): 85 parser = argparse.ArgumentParser( 86 description='Helps writing and running KUnit tests.') 87 subparser = parser.add_subparsers(dest='subcommand') 88 89 run_parser = subparser.add_parser('run', help='Runs KUnit tests.') 90 run_parser.add_argument('--raw_output', help='don\'t format output from kernel', 91 action='store_true') 92 93 run_parser.add_argument('--timeout', 94 help='maximum number of seconds to allow for all tests ' 95 'to run. This does not include time taken to build the ' 96 'tests.', 97 type=int, 98 default=300, 99 metavar='timeout') 100 101 run_parser.add_argument('--jobs', 102 help='As in the make command, "Specifies the number of ' 103 'jobs (commands) to run simultaneously."', 104 type=int, default=8, metavar='jobs') 105 106 run_parser.add_argument('--build_dir', 107 help='As in the make command, it specifies the build ' 108 'directory.', 109 type=str, default=None, metavar='build_dir') 110 111 run_parser.add_argument('--defconfig', 112 help='Uses a default kunitconfig.', 113 action='store_true') 114 115 cli_args = parser.parse_args(argv) 116 117 if cli_args.subcommand == 'run': 118 if cli_args.defconfig: 119 create_default_kunitconfig() 120 121 if not linux: 122 linux = kunit_kernel.LinuxSourceTree() 123 124 request = KunitRequest(cli_args.raw_output, 125 cli_args.timeout, 126 cli_args.jobs, 127 cli_args.build_dir, 128 cli_args.defconfig) 129 result = run_tests(linux, request) 130 if result.status != KunitStatus.SUCCESS: 131 sys.exit(1) 132 else: 133 parser.print_help() 134 135if __name__ == '__main__': 136 main(sys.argv[1:]) 137