Anders Blomdell / mbed-sdk-tools

Clone of official tools

test.py@24:25bff2709c20, 2016-08-01 (annotated)

Committer:
screamer
Date:
Mon Aug 01 09:10:17 2016 +0100
Revision:
24:25bff2709c20
Parent:
22:9e85236d8716
Child:
29:1210849dba19
Major update to tools from ARMmbed/mbed-os

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
screamer 13:ab47a20b66f0 29 from tools.test_api import test_path_to_name, find_tests, print_tests, build_tests, test_spec_from_test_builds
screamer 0:66f3b5499f7f 30 from tools.options import get_default_options_parser
screamer 0:66f3b5499f7f 31 from tools.build_api import build_project, build_library
screamer 22:9e85236d8716 32 from tools.build_api import print_build_memory_usage_results
screamer 0:66f3b5499f7f 33 from tools.targets import TARGET_MAP
screamer 24:25bff2709c20 34 from tools.utils import mkdir, ToolException, NotSupportedException, args_error
screamer 13:ab47a20b66f0 35 from tools.test_exporters import ReportExporter, ResultExporterType
screamer 22:9e85236d8716 36 from utils import argparse_filestring_type, argparse_lowercase_type, argparse_many
screamer 24:25bff2709c20 37 from utils import argparse_dir_not_parent
screamer 22:9e85236d8716 38 from tools.toolchains import mbedToolchain
screamer 22:9e85236d8716 39 from tools.settings import CLI_COLOR_MAP
screamer 0:66f3b5499f7f 40
screamer 0:66f3b5499f7f 41 if __name__ == '__main__':
screamer 0:66f3b5499f7f 42 try:
screamer 0:66f3b5499f7f 43 # Parse Options
screamer 0:66f3b5499f7f 44 parser = get_default_options_parser()
screamer 0:66f3b5499f7f 45
screamer 22:9e85236d8716 46 parser.add_argument("-D",
screamer 13:ab47a20b66f0 47 action="append",
screamer 13:ab47a20b66f0 48 dest="macros",
screamer 13:ab47a20b66f0 49 help="Add a macro definition")
screamer 22:9e85236d8716 50
screamer 22:9e85236d8716 51 parser.add_argument("-j", "--jobs",
screamer 22:9e85236d8716 52 type=int,
screamer 0:66f3b5499f7f 53 dest="jobs",
screamer 13:ab47a20b66f0 54 default=0,
screamer 13:ab47a20b66f0 55 help="Number of concurrent jobs. Default: 0/auto (based on host machine's number of CPUs)")
screamer 0:66f3b5499f7f 56
screamer 22:9e85236d8716 57 parser.add_argument("--source", dest="source_dir",
screamer 22:9e85236d8716 58 type=argparse_filestring_type,
screamer 22:9e85236d8716 59 default=None, help="The source (input) directory (for sources other than tests). Defaults to current directory.", action="append")
screamer 0:66f3b5499f7f 60
screamer 24:25bff2709c20 61 parser.add_argument("--build", dest="build_dir", type=argparse_dir_not_parent(ROOT),
screamer 0:66f3b5499f7f 62 default=None, help="The build (output) directory")
screamer 0:66f3b5499f7f 63
screamer 22:9e85236d8716 64 parser.add_argument("-l", "--list", action="store_true", dest="list",
screamer 0:66f3b5499f7f 65 default=False, help="List (recursively) available tests in order and exit")
screamer 0:66f3b5499f7f 66
screamer 22:9e85236d8716 67 parser.add_argument("-p", "--paths", dest="paths",
screamer 22:9e85236d8716 68 type=argparse_many(argparse_filestring_type),
screamer 0:66f3b5499f7f 69 default=None, help="Limit the tests to those within the specified comma separated list of paths")
screamer 22:9e85236d8716 70
screamer 0:66f3b5499f7f 71 format_choices = ["list", "json"]
screamer 0:66f3b5499f7f 72 format_default_choice = "list"
screamer 0:66f3b5499f7f 73 format_help = "Change the format in which tests are listed. Choices include: %s. Default: %s" % (", ".join(format_choices), format_default_choice)
screamer 22:9e85236d8716 74 parser.add_argument("-f", "--format", dest="format",
screamer 22:9e85236d8716 75 type=argparse_lowercase_type(format_choices, "format"),
screamer 22:9e85236d8716 76 default=format_default_choice, help=format_help)
screamer 0:66f3b5499f7f 77
screamer 22:9e85236d8716 78 parser.add_argument("--continue-on-build-fail", action="store_true", dest="continue_on_build_fail",
screamer 13:ab47a20b66f0 79 default=None, help="Continue trying to build all tests if a build failure occurs")
screamer 13:ab47a20b66f0 80
screamer 22:9e85236d8716 81 #TODO validate the names instead of just passing through str
screamer 22:9e85236d8716 82 parser.add_argument("-n", "--names", dest="names", type=argparse_many(str),
screamer 0:66f3b5499f7f 83 default=None, help="Limit the tests to a comma separated list of names")
screamer 0:66f3b5499f7f 84
screamer 22:9e85236d8716 85 parser.add_argument("--test-spec", dest="test_spec",
screamer 0:66f3b5499f7f 86 default=None, help="Destination path for a test spec file that can be used by the Greentea automated test tool")
screamer 0:66f3b5499f7f 87
screamer 22:9e85236d8716 88 parser.add_argument("--build-report-junit", dest="build_report_junit",
screamer 13:ab47a20b66f0 89 default=None, help="Destination path for a build report in the JUnit xml format")
screamer 13:ab47a20b66f0 90
screamer 22:9e85236d8716 91 parser.add_argument("-v", "--verbose",
screamer 0:66f3b5499f7f 92 action="store_true",
screamer 0:66f3b5499f7f 93 dest="verbose",
screamer 0:66f3b5499f7f 94 default=False,
screamer 0:66f3b5499f7f 95 help="Verbose diagnostic output")
screamer 0:66f3b5499f7f 96
screamer 22:9e85236d8716 97 options = parser.parse_args()
screamer 0:66f3b5499f7f 98
screamer 22:9e85236d8716 99 # Filter tests by path if specified
screamer 0:66f3b5499f7f 100 if options.paths:
screamer 22:9e85236d8716 101 all_paths = options.paths
screamer 0:66f3b5499f7f 102 else:
screamer 0:66f3b5499f7f 103 all_paths = ["."]
screamer 22:9e85236d8716 104
screamer 0:66f3b5499f7f 105 all_tests = {}
screamer 0:66f3b5499f7f 106 tests = {}
screamer 22:9e85236d8716 107
screamer 24:25bff2709c20 108 # Target
screamer 24:25bff2709c20 109 if options.mcu is None :
screamer 24:25bff2709c20 110 args_error(parser, "[ERROR] You should specify an MCU")
screamer 24:25bff2709c20 111 mcu = options.mcu[0]
screamer 24:25bff2709c20 112
screamer 24:25bff2709c20 113 # Toolchain
screamer 24:25bff2709c20 114 if options.tool is None:
screamer 24:25bff2709c20 115 args_error(parser, "[ERROR] You should specify a TOOLCHAIN")
screamer 24:25bff2709c20 116 toolchain = options.tool[0]
screamer 24:25bff2709c20 117
screamer 0:66f3b5499f7f 118 # Find all tests in the relevant paths
screamer 0:66f3b5499f7f 119 for path in all_paths:
screamer 24:25bff2709c20 120 all_tests.update(find_tests(path, mcu, toolchain, options.options))
screamer 22:9e85236d8716 121
screamer 0:66f3b5499f7f 122 # Filter tests by name if specified
screamer 0:66f3b5499f7f 123 if options.names:
screamer 22:9e85236d8716 124 all_names = options.names
screamer 13:ab47a20b66f0 125 all_names = [x.lower() for x in all_names]
screamer 22:9e85236d8716 126
screamer 0:66f3b5499f7f 127 for name in all_names:
screamer 13:ab47a20b66f0 128 if any(fnmatch.fnmatch(testname, name) for testname in all_tests):
screamer 13:ab47a20b66f0 129 for testname, test in all_tests.items():
screamer 13:ab47a20b66f0 130 if fnmatch.fnmatch(testname, name):
screamer 13:ab47a20b66f0 131 tests[testname] = test
screamer 0:66f3b5499f7f 132 else:
screamer 0:66f3b5499f7f 133 print "[Warning] Test with name '%s' was not found in the available tests" % (name)
screamer 0:66f3b5499f7f 134 else:
screamer 0:66f3b5499f7f 135 tests = all_tests
screamer 0:66f3b5499f7f 136
screamer 22:9e85236d8716 137 if options.color:
screamer 22:9e85236d8716 138 # This import happens late to prevent initializing colorization when we don't need it
screamer 22:9e85236d8716 139 import colorize
screamer 22:9e85236d8716 140 if options.verbose:
screamer 22:9e85236d8716 141 notify = mbedToolchain.print_notify_verbose
screamer 22:9e85236d8716 142 else:
screamer 22:9e85236d8716 143 notify = mbedToolchain.print_notify
screamer 22:9e85236d8716 144 notify = colorize.print_in_color_notifier(CLI_COLOR_MAP, notify)
screamer 22:9e85236d8716 145 else:
screamer 22:9e85236d8716 146 notify = None
screamer 22:9e85236d8716 147
screamer 0:66f3b5499f7f 148 if options.list:
screamer 0:66f3b5499f7f 149 # Print available tests in order and exit
screamer 0:66f3b5499f7f 150 print_tests(tests, options.format)
screamer 13:ab47a20b66f0 151 sys.exit(0)
screamer 0:66f3b5499f7f 152 else:
screamer 0:66f3b5499f7f 153 # Build all tests
screamer 0:66f3b5499f7f 154 if not options.build_dir:
screamer 0:66f3b5499f7f 155 print "[ERROR] You must specify a build path"
screamer 0:66f3b5499f7f 156 sys.exit(1)
screamer 22:9e85236d8716 157
screamer 0:66f3b5499f7f 158 base_source_paths = options.source_dir
screamer 22:9e85236d8716 159
screamer 0:66f3b5499f7f 160 # Default base source path is the current directory
screamer 0:66f3b5499f7f 161 if not base_source_paths:
screamer 0:66f3b5499f7f 162 base_source_paths = ['.']
screamer 0:66f3b5499f7f 163
screamer 13:ab47a20b66f0 164 build_report = {}
screamer 13:ab47a20b66f0 165 build_properties = {}
screamer 13:ab47a20b66f0 166
screamer 13:ab47a20b66f0 167 library_build_success = False
screamer 13:ab47a20b66f0 168 try:
screamer 13:ab47a20b66f0 169 # Build sources
screamer 24:25bff2709c20 170 build_library(base_source_paths, options.build_dir, mcu, toolchain,
screamer 13:ab47a20b66f0 171 options=options.options,
screamer 13:ab47a20b66f0 172 jobs=options.jobs,
screamer 13:ab47a20b66f0 173 clean=options.clean,
screamer 13:ab47a20b66f0 174 report=build_report,
screamer 13:ab47a20b66f0 175 properties=build_properties,
screamer 13:ab47a20b66f0 176 name="mbed-build",
screamer 13:ab47a20b66f0 177 macros=options.macros,
screamer 13:ab47a20b66f0 178 verbose=options.verbose,
screamer 22:9e85236d8716 179 notify=notify,
screamer 13:ab47a20b66f0 180 archive=False)
screamer 22:9e85236d8716 181
screamer 13:ab47a20b66f0 182 library_build_success = True
screamer 13:ab47a20b66f0 183 except ToolException, e:
screamer 13:ab47a20b66f0 184 # ToolException output is handled by the build log
screamer 13:ab47a20b66f0 185 pass
screamer 13:ab47a20b66f0 186 except NotSupportedException, e:
screamer 13:ab47a20b66f0 187 # NotSupportedException is handled by the build log
screamer 13:ab47a20b66f0 188 pass
screamer 13:ab47a20b66f0 189 except Exception, e:
screamer 13:ab47a20b66f0 190 # Some other exception occurred, print the error message
screamer 13:ab47a20b66f0 191 print e
screamer 22:9e85236d8716 192
screamer 13:ab47a20b66f0 193 if not library_build_success:
screamer 13:ab47a20b66f0 194 print "Failed to build library"
screamer 13:ab47a20b66f0 195 else:
screamer 13:ab47a20b66f0 196 # Build all the tests
screamer 24:25bff2709c20 197 test_build_success, test_build = build_tests(tests, [options.build_dir], options.build_dir, mcu, toolchain,
screamer 13:ab47a20b66f0 198 options=options.options,
screamer 13:ab47a20b66f0 199 clean=options.clean,
screamer 13:ab47a20b66f0 200 report=build_report,
screamer 13:ab47a20b66f0 201 properties=build_properties,
screamer 13:ab47a20b66f0 202 macros=options.macros,
screamer 13:ab47a20b66f0 203 verbose=options.verbose,
screamer 22:9e85236d8716 204 notify=notify,
screamer 13:ab47a20b66f0 205 jobs=options.jobs,
screamer 13:ab47a20b66f0 206 continue_on_build_fail=options.continue_on_build_fail)
screamer 22:9e85236d8716 207
screamer 13:ab47a20b66f0 208 # If a path to a test spec is provided, write it to a file
screamer 13:ab47a20b66f0 209 if options.test_spec:
screamer 13:ab47a20b66f0 210 test_spec_data = test_spec_from_test_builds(test_build)
screamer 22:9e85236d8716 211
screamer 13:ab47a20b66f0 212 # Create the target dir for the test spec if necessary
screamer 13:ab47a20b66f0 213 # mkdir will not create the dir if it already exists
screamer 13:ab47a20b66f0 214 test_spec_dir = os.path.dirname(options.test_spec)
screamer 13:ab47a20b66f0 215 if test_spec_dir:
screamer 13:ab47a20b66f0 216 mkdir(test_spec_dir)
screamer 22:9e85236d8716 217
screamer 13:ab47a20b66f0 218 try:
screamer 13:ab47a20b66f0 219 with open(options.test_spec, 'w') as f:
screamer 13:ab47a20b66f0 220 f.write(json.dumps(test_spec_data, indent=2))
screamer 13:ab47a20b66f0 221 except IOError, e:
screamer 13:ab47a20b66f0 222 print "[ERROR] Error writing test spec to file"
screamer 13:ab47a20b66f0 223 print e
screamer 22:9e85236d8716 224
screamer 13:ab47a20b66f0 225 # If a path to a JUnit build report spec is provided, write it to a file
screamer 13:ab47a20b66f0 226 if options.build_report_junit:
screamer 13:ab47a20b66f0 227 report_exporter = ReportExporter(ResultExporterType.JUNIT, package="build")
screamer 13:ab47a20b66f0 228 report_exporter.report_to_file(build_report, options.build_report_junit, test_suite_properties=build_properties)
screamer 22:9e85236d8716 229
screamer 22:9e85236d8716 230 # Print memory map summary on screen
screamer 22:9e85236d8716 231 if build_report:
screamer 22:9e85236d8716 232 print
screamer 22:9e85236d8716 233 print print_build_memory_usage_results(build_report)
screamer 22:9e85236d8716 234
screamer 13:ab47a20b66f0 235 print_report_exporter = ReportExporter(ResultExporterType.PRINT, package="build")
screamer 13:ab47a20b66f0 236 status = print_report_exporter.report(build_report)
screamer 22:9e85236d8716 237
screamer 13:ab47a20b66f0 238 if status:
screamer 13:ab47a20b66f0 239 sys.exit(0)
screamer 13:ab47a20b66f0 240 else:
screamer 13:ab47a20b66f0 241 sys.exit(1)
screamer 0:66f3b5499f7f 242
screamer 0:66f3b5499f7f 243 except KeyboardInterrupt, e:
screamer 0:66f3b5499f7f 244 print "\n[CTRL+c] exit"
screamer 0:66f3b5499f7f 245 except Exception,e:
screamer 0:66f3b5499f7f 246 import traceback
screamer 0:66f3b5499f7f 247 traceback.print_exc(file=sys.stdout)
screamer 0:66f3b5499f7f 248 print "[ERROR] %s" % str(e)
screamer 0:66f3b5499f7f 249 sys.exit(1)