Anders Blomdell / mbed-sdk-tools

Clone of official tools

test.py@36:96847d42f010, 2017-06-22 (annotated)

Committer:
The Other Jimmy
Date:
Thu Jun 22 11:12:28 2017 -0500
Revision:
36:96847d42f010
Parent:
31:8ea194f6145b
Child:
38:399953da035d
Tools release 5.5.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:66f3b5499f7f 1 #! /usr/bin/env python2
screamer 0:66f3b5499f7f 2 """
screamer 0:66f3b5499f7f 3 mbed SDK
screamer 0:66f3b5499f7f 4 Copyright (c) 2011-2013 ARM Limited
screamer 0:66f3b5499f7f 5
screamer 0:66f3b5499f7f 6 Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:66f3b5499f7f 7 you may not use this file except in compliance with the License.
screamer 0:66f3b5499f7f 8 You may obtain a copy of the License at
screamer 0:66f3b5499f7f 9
screamer 0:66f3b5499f7f 10 http://www.apache.org/licenses/LICENSE-2.0
screamer 0:66f3b5499f7f 11
screamer 0:66f3b5499f7f 12 Unless required by applicable law or agreed to in writing, software
screamer 0:66f3b5499f7f 13 distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:66f3b5499f7f 14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:66f3b5499f7f 15 See the License for the specific language governing permissions and
screamer 0:66f3b5499f7f 16 limitations under the License.
screamer 0:66f3b5499f7f 17
screamer 0:66f3b5499f7f 18
screamer 0:66f3b5499f7f 19 TEST BUILD & RUN
screamer 0:66f3b5499f7f 20 """
screamer 0:66f3b5499f7f 21 import sys
screamer 0:66f3b5499f7f 22 import os
screamer 0:66f3b5499f7f 23 import json
screamer 13:ab47a20b66f0 24 import fnmatch
screamer 0:66f3b5499f7f 25
screamer 0:66f3b5499f7f 26 ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
screamer 0:66f3b5499f7f 27 sys.path.insert(0, ROOT)
screamer 0:66f3b5499f7f 28
The Other Jimmy 31:8ea194f6145b 29 from tools.config import ConfigException
screamer 13:ab47a20b66f0 30 from tools.test_api import test_path_to_name, find_tests, print_tests, build_tests, test_spec_from_test_builds
The Other Jimmy 31:8ea194f6145b 31 from tools.options import get_default_options_parser, extract_profile
screamer 0:66f3b5499f7f 32 from tools.build_api import build_project, build_library
screamer 29:1210849dba19 33 from tools.build_api import print_build_memory_usage
The Other Jimmy 36:96847d42f010 34 from tools.build_api import merge_build_data
screamer 0:66f3b5499f7f 35 from tools.targets import TARGET_MAP
screamer 24:25bff2709c20 36 from tools.utils import mkdir, ToolException, NotSupportedException, args_error
screamer 13:ab47a20b66f0 37 from tools.test_exporters import ReportExporter, ResultExporterType
screamer 22:9e85236d8716 38 from utils import argparse_filestring_type, argparse_lowercase_type, argparse_many
screamer 24:25bff2709c20 39 from utils import argparse_dir_not_parent
The Other Jimmy 31:8ea194f6145b 40 from tools.toolchains import mbedToolchain, TOOLCHAIN_PATHS, TOOLCHAIN_CLASSES
screamer 22:9e85236d8716 41 from tools.settings import CLI_COLOR_MAP
screamer 0:66f3b5499f7f 42
screamer 0:66f3b5499f7f 43 if __name__ == '__main__':
screamer 0:66f3b5499f7f 44 try:
screamer 0:66f3b5499f7f 45 # Parse Options
The Other Jimmy 31:8ea194f6145b 46 parser = get_default_options_parser(add_app_config=True)
screamer 0:66f3b5499f7f 47
screamer 22:9e85236d8716 48 parser.add_argument("-D",
screamer 13:ab47a20b66f0 49 action="append",
screamer 13:ab47a20b66f0 50 dest="macros",
screamer 13:ab47a20b66f0 51 help="Add a macro definition")
screamer 22:9e85236d8716 52
screamer 22:9e85236d8716 53 parser.add_argument("-j", "--jobs",
screamer 22:9e85236d8716 54 type=int,
screamer 0:66f3b5499f7f 55 dest="jobs",
screamer 13:ab47a20b66f0 56 default=0,
screamer 13:ab47a20b66f0 57 help="Number of concurrent jobs. Default: 0/auto (based on host machine's number of CPUs)")
screamer 0:66f3b5499f7f 58
screamer 22:9e85236d8716 59 parser.add_argument("--source", dest="source_dir",
screamer 22:9e85236d8716 60 type=argparse_filestring_type,
screamer 22:9e85236d8716 61 default=None, help="The source (input) directory (for sources other than tests). Defaults to current directory.", action="append")
screamer 0:66f3b5499f7f 62
screamer 24:25bff2709c20 63 parser.add_argument("--build", dest="build_dir", type=argparse_dir_not_parent(ROOT),
screamer 0:66f3b5499f7f 64 default=None, help="The build (output) directory")
screamer 0:66f3b5499f7f 65
screamer 22:9e85236d8716 66 parser.add_argument("-l", "--list", action="store_true", dest="list",
screamer 0:66f3b5499f7f 67 default=False, help="List (recursively) available tests in order and exit")
screamer 0:66f3b5499f7f 68
screamer 22:9e85236d8716 69 parser.add_argument("-p", "--paths", dest="paths",
screamer 22:9e85236d8716 70 type=argparse_many(argparse_filestring_type),
screamer 0:66f3b5499f7f 71 default=None, help="Limit the tests to those within the specified comma separated list of paths")
screamer 22:9e85236d8716 72
screamer 0:66f3b5499f7f 73 format_choices = ["list", "json"]
screamer 0:66f3b5499f7f 74 format_default_choice = "list"
screamer 0:66f3b5499f7f 75 format_help = "Change the format in which tests are listed. Choices include: %s. Default: %s" % (", ".join(format_choices), format_default_choice)
screamer 22:9e85236d8716 76 parser.add_argument("-f", "--format", dest="format",
screamer 22:9e85236d8716 77 type=argparse_lowercase_type(format_choices, "format"),
screamer 22:9e85236d8716 78 default=format_default_choice, help=format_help)
screamer 0:66f3b5499f7f 79
screamer 22:9e85236d8716 80 parser.add_argument("--continue-on-build-fail", action="store_true", dest="continue_on_build_fail",
screamer 13:ab47a20b66f0 81 default=None, help="Continue trying to build all tests if a build failure occurs")
screamer 13:ab47a20b66f0 82
screamer 22:9e85236d8716 83 #TODO validate the names instead of just passing through str
screamer 22:9e85236d8716 84 parser.add_argument("-n", "--names", dest="names", type=argparse_many(str),
screamer 0:66f3b5499f7f 85 default=None, help="Limit the tests to a comma separated list of names")
screamer 0:66f3b5499f7f 86
screamer 22:9e85236d8716 87 parser.add_argument("--test-spec", dest="test_spec",
screamer 0:66f3b5499f7f 88 default=None, help="Destination path for a test spec file that can be used by the Greentea automated test tool")
screamer 0:66f3b5499f7f 89
screamer 22:9e85236d8716 90 parser.add_argument("--build-report-junit", dest="build_report_junit",
screamer 13:ab47a20b66f0 91 default=None, help="Destination path for a build report in the JUnit xml format")
The Other Jimmy 36:96847d42f010 92 parser.add_argument("--build-data",
The Other Jimmy 36:96847d42f010 93 dest="build_data",
The Other Jimmy 36:96847d42f010 94 default=None,
The Other Jimmy 36:96847d42f010 95 help="Dump build_data to this file")
screamer 13:ab47a20b66f0 96
screamer 22:9e85236d8716 97 parser.add_argument("-v", "--verbose",
screamer 0:66f3b5499f7f 98 action="store_true",
screamer 0:66f3b5499f7f 99 dest="verbose",
screamer 0:66f3b5499f7f 100 default=False,
screamer 0:66f3b5499f7f 101 help="Verbose diagnostic output")
screamer 0:66f3b5499f7f 102
screamer 22:9e85236d8716 103 options = parser.parse_args()
screamer 0:66f3b5499f7f 104
screamer 22:9e85236d8716 105 # Filter tests by path if specified
screamer 0:66f3b5499f7f 106 if options.paths:
screamer 22:9e85236d8716 107 all_paths = options.paths
screamer 0:66f3b5499f7f 108 else:
screamer 0:66f3b5499f7f 109 all_paths = ["."]
screamer 22:9e85236d8716 110
screamer 0:66f3b5499f7f 111 all_tests = {}
screamer 0:66f3b5499f7f 112 tests = {}
screamer 22:9e85236d8716 113
screamer 24:25bff2709c20 114 # Target
screamer 24:25bff2709c20 115 if options.mcu is None :
The Other Jimmy 31:8ea194f6145b 116 args_error(parser, "argument -m/--mcu is required")
screamer 24:25bff2709c20 117 mcu = options.mcu[0]
screamer 24:25bff2709c20 118
screamer 24:25bff2709c20 119 # Toolchain
screamer 24:25bff2709c20 120 if options.tool is None:
The Other Jimmy 31:8ea194f6145b 121 args_error(parser, "argument -t/--tool is required")
screamer 24:25bff2709c20 122 toolchain = options.tool[0]
screamer 24:25bff2709c20 123
The Other Jimmy 31:8ea194f6145b 124 if not TOOLCHAIN_CLASSES[toolchain].check_executable():
The Other Jimmy 31:8ea194f6145b 125 search_path = TOOLCHAIN_PATHS[toolchain] or "No path set"
The Other Jimmy 31:8ea194f6145b 126 args_error(parser, "Could not find executable for %s.\n"
The Other Jimmy 31:8ea194f6145b 127 "Currently set search path: %s"
The Other Jimmy 31:8ea194f6145b 128 % (toolchain, search_path))
The Other Jimmy 31:8ea194f6145b 129
screamer 0:66f3b5499f7f 130 # Find all tests in the relevant paths
screamer 0:66f3b5499f7f 131 for path in all_paths:
The Other Jimmy 31:8ea194f6145b 132 all_tests.update(find_tests(path, mcu, toolchain,
The Other Jimmy 31:8ea194f6145b 133 app_config=options.app_config))
screamer 22:9e85236d8716 134
screamer 0:66f3b5499f7f 135 # Filter tests by name if specified
screamer 0:66f3b5499f7f 136 if options.names:
screamer 22:9e85236d8716 137 all_names = options.names
screamer 13:ab47a20b66f0 138 all_names = [x.lower() for x in all_names]
screamer 22:9e85236d8716 139
screamer 0:66f3b5499f7f 140 for name in all_names:
screamer 13:ab47a20b66f0 141 if any(fnmatch.fnmatch(testname, name) for testname in all_tests):
screamer 13:ab47a20b66f0 142 for testname, test in all_tests.items():
screamer 13:ab47a20b66f0 143 if fnmatch.fnmatch(testname, name):
screamer 13:ab47a20b66f0 144 tests[testname] = test
screamer 0:66f3b5499f7f 145 else:
screamer 0:66f3b5499f7f 146 print "[Warning] Test with name '%s' was not found in the available tests" % (name)
screamer 0:66f3b5499f7f 147 else:
screamer 0:66f3b5499f7f 148 tests = all_tests
screamer 0:66f3b5499f7f 149
screamer 22:9e85236d8716 150 if options.color:
screamer 22:9e85236d8716 151 # This import happens late to prevent initializing colorization when we don't need it
screamer 22:9e85236d8716 152 import colorize
screamer 22:9e85236d8716 153 if options.verbose:
screamer 22:9e85236d8716 154 notify = mbedToolchain.print_notify_verbose
screamer 22:9e85236d8716 155 else:
screamer 22:9e85236d8716 156 notify = mbedToolchain.print_notify
screamer 22:9e85236d8716 157 notify = colorize.print_in_color_notifier(CLI_COLOR_MAP, notify)
screamer 22:9e85236d8716 158 else:
screamer 22:9e85236d8716 159 notify = None
screamer 22:9e85236d8716 160
screamer 0:66f3b5499f7f 161 if options.list:
screamer 0:66f3b5499f7f 162 # Print available tests in order and exit
screamer 0:66f3b5499f7f 163 print_tests(tests, options.format)
screamer 13:ab47a20b66f0 164 sys.exit(0)
screamer 0:66f3b5499f7f 165 else:
screamer 0:66f3b5499f7f 166 # Build all tests
screamer 0:66f3b5499f7f 167 if not options.build_dir:
The Other Jimmy 31:8ea194f6145b 168 args_error(parser, "argument --build is required")
screamer 22:9e85236d8716 169
screamer 0:66f3b5499f7f 170 base_source_paths = options.source_dir
screamer 22:9e85236d8716 171
screamer 0:66f3b5499f7f 172 # Default base source path is the current directory
screamer 0:66f3b5499f7f 173 if not base_source_paths:
screamer 0:66f3b5499f7f 174 base_source_paths = ['.']
screamer 0:66f3b5499f7f 175
screamer 13:ab47a20b66f0 176 build_report = {}
screamer 13:ab47a20b66f0 177 build_properties = {}
screamer 13:ab47a20b66f0 178
screamer 13:ab47a20b66f0 179 library_build_success = False
The Other Jimmy 31:8ea194f6145b 180 profile = extract_profile(parser, options, toolchain)
screamer 13:ab47a20b66f0 181 try:
screamer 13:ab47a20b66f0 182 # Build sources
The Other Jimmy 36:96847d42f010 183 build_library(base_source_paths, options.build_dir, mcu,
The Other Jimmy 36:96847d42f010 184 toolchain, jobs=options.jobs,
The Other Jimmy 36:96847d42f010 185 clean=options.clean, report=build_report,
The Other Jimmy 36:96847d42f010 186 properties=build_properties, name="mbed-build",
The Other Jimmy 36:96847d42f010 187 macros=options.macros, verbose=options.verbose,
The Other Jimmy 36:96847d42f010 188 notify=notify, archive=False,
The Other Jimmy 36:96847d42f010 189 app_config=options.app_config,
The Other Jimmy 31:8ea194f6145b 190 build_profile=profile)
screamer 22:9e85236d8716 191
screamer 13:ab47a20b66f0 192 library_build_success = True
screamer 13:ab47a20b66f0 193 except ToolException, e:
screamer 13:ab47a20b66f0 194 # ToolException output is handled by the build log
screamer 13:ab47a20b66f0 195 pass
screamer 13:ab47a20b66f0 196 except NotSupportedException, e:
screamer 13:ab47a20b66f0 197 # NotSupportedException is handled by the build log
screamer 13:ab47a20b66f0 198 pass
screamer 13:ab47a20b66f0 199 except Exception, e:
screamer 13:ab47a20b66f0 200 # Some other exception occurred, print the error message
screamer 13:ab47a20b66f0 201 print e
screamer 22:9e85236d8716 202
screamer 13:ab47a20b66f0 203 if not library_build_success:
screamer 13:ab47a20b66f0 204 print "Failed to build library"
screamer 13:ab47a20b66f0 205 else:
screamer 13:ab47a20b66f0 206 # Build all the tests
The Other Jimmy 31:8ea194f6145b 207
screamer 24:25bff2709c20 208 test_build_success, test_build = build_tests(tests, [options.build_dir], options.build_dir, mcu, toolchain,
screamer 13:ab47a20b66f0 209 clean=options.clean,
screamer 13:ab47a20b66f0 210 report=build_report,
screamer 13:ab47a20b66f0 211 properties=build_properties,
screamer 13:ab47a20b66f0 212 macros=options.macros,
screamer 13:ab47a20b66f0 213 verbose=options.verbose,
screamer 22:9e85236d8716 214 notify=notify,
screamer 13:ab47a20b66f0 215 jobs=options.jobs,
The Other Jimmy 31:8ea194f6145b 216 continue_on_build_fail=options.continue_on_build_fail,
The Other Jimmy 31:8ea194f6145b 217 app_config=options.app_config,
The Other Jimmy 31:8ea194f6145b 218 build_profile=profile)
screamer 22:9e85236d8716 219
screamer 13:ab47a20b66f0 220 # If a path to a test spec is provided, write it to a file
screamer 13:ab47a20b66f0 221 if options.test_spec:
screamer 13:ab47a20b66f0 222 test_spec_data = test_spec_from_test_builds(test_build)
screamer 22:9e85236d8716 223
screamer 13:ab47a20b66f0 224 # Create the target dir for the test spec if necessary
screamer 13:ab47a20b66f0 225 # mkdir will not create the dir if it already exists
screamer 13:ab47a20b66f0 226 test_spec_dir = os.path.dirname(options.test_spec)
screamer 13:ab47a20b66f0 227 if test_spec_dir:
screamer 13:ab47a20b66f0 228 mkdir(test_spec_dir)
screamer 22:9e85236d8716 229
screamer 13:ab47a20b66f0 230 try:
screamer 13:ab47a20b66f0 231 with open(options.test_spec, 'w') as f:
screamer 13:ab47a20b66f0 232 f.write(json.dumps(test_spec_data, indent=2))
screamer 13:ab47a20b66f0 233 except IOError, e:
screamer 13:ab47a20b66f0 234 print "[ERROR] Error writing test spec to file"
screamer 13:ab47a20b66f0 235 print e
screamer 22:9e85236d8716 236
screamer 13:ab47a20b66f0 237 # If a path to a JUnit build report spec is provided, write it to a file
screamer 13:ab47a20b66f0 238 if options.build_report_junit:
screamer 13:ab47a20b66f0 239 report_exporter = ReportExporter(ResultExporterType.JUNIT, package="build")
screamer 13:ab47a20b66f0 240 report_exporter.report_to_file(build_report, options.build_report_junit, test_suite_properties=build_properties)
screamer 22:9e85236d8716 241
screamer 22:9e85236d8716 242 # Print memory map summary on screen
screamer 22:9e85236d8716 243 if build_report:
screamer 22:9e85236d8716 244 print
screamer 29:1210849dba19 245 print print_build_memory_usage(build_report)
screamer 22:9e85236d8716 246
screamer 13:ab47a20b66f0 247 print_report_exporter = ReportExporter(ResultExporterType.PRINT, package="build")
screamer 13:ab47a20b66f0 248 status = print_report_exporter.report(build_report)
The Other Jimmy 36:96847d42f010 249 if options.build_data:
The Other Jimmy 36:96847d42f010 250 merge_build_data(options.build_data, build_report, "test")
screamer 22:9e85236d8716 251
screamer 13:ab47a20b66f0 252 if status:
screamer 13:ab47a20b66f0 253 sys.exit(0)
screamer 13:ab47a20b66f0 254 else:
screamer 13:ab47a20b66f0 255 sys.exit(1)
screamer 0:66f3b5499f7f 256
screamer 0:66f3b5499f7f 257 except KeyboardInterrupt, e:
screamer 0:66f3b5499f7f 258 print "\n[CTRL+c] exit"
The Other Jimmy 31:8ea194f6145b 259 except ConfigException, e:
The Other Jimmy 31:8ea194f6145b 260 # Catching ConfigException here to prevent a traceback
The Other Jimmy 31:8ea194f6145b 261 print "[ERROR] %s" % str(e)
screamer 0:66f3b5499f7f 262 except Exception,e:
screamer 0:66f3b5499f7f 263 import traceback
screamer 0:66f3b5499f7f 264 traceback.print_exc(file=sys.stdout)
screamer 0:66f3b5499f7f 265 print "[ERROR] %s" % str(e)
screamer 0:66f3b5499f7f 266 sys.exit(1)