| 1 | #!/usr/bin/python3 |
|---|
| 2 | |
|---|
| 3 | from pybin.tools import * |
|---|
| 4 | from pybin.test_run import * |
|---|
| 5 | from pybin import settings |
|---|
| 6 | |
|---|
| 7 | import argparse |
|---|
| 8 | import itertools |
|---|
| 9 | import re |
|---|
| 10 | import sys |
|---|
| 11 | import tempfile |
|---|
| 12 | import time |
|---|
| 13 | |
|---|
| 14 | import os |
|---|
| 15 | import signal |
|---|
| 16 | |
|---|
| 17 | ################################################################################ |
|---|
| 18 | # help functions |
|---|
| 19 | ################################################################################ |
|---|
| 20 | |
|---|
| 21 | def find_tests(): |
|---|
| 22 | expected = [] |
|---|
| 23 | |
|---|
| 24 | def match_test(path): |
|---|
| 25 | match = re.search("^%s\/([\w\/\-_]*).expect\/([\w\-_\+]+)(\.[\w\-_]+)?\.txt$" % settings.SRCDIR, path) |
|---|
| 26 | if match : |
|---|
| 27 | test = Test() |
|---|
| 28 | test.name = match.group(2) |
|---|
| 29 | test.path = match.group(1) |
|---|
| 30 | test.arch = match.group(3)[1:] if match.group(3) else None |
|---|
| 31 | |
|---|
| 32 | expected.append(test) |
|---|
| 33 | |
|---|
| 34 | path_walk( match_test ) |
|---|
| 35 | |
|---|
| 36 | return expected |
|---|
| 37 | |
|---|
| 38 | # reads the directory ./.expect and indentifies the tests |
|---|
| 39 | def list_tests( includes, excludes ): |
|---|
| 40 | # tests directly in the .expect folder will always be processed |
|---|
| 41 | test_list = find_tests() |
|---|
| 42 | |
|---|
| 43 | # if we have a limited number of includes, filter by them |
|---|
| 44 | if includes: |
|---|
| 45 | test_list = [x for x in test_list if |
|---|
| 46 | x.target().startswith( tuple(includes) ) |
|---|
| 47 | ] |
|---|
| 48 | |
|---|
| 49 | # # if we have a folders to excludes, filter by them |
|---|
| 50 | if excludes: |
|---|
| 51 | test_list = [x for x in test_list if not |
|---|
| 52 | x.target().startswith( tuple(excludes) ) |
|---|
| 53 | ] |
|---|
| 54 | |
|---|
| 55 | # sort the test alphabetically for convenience |
|---|
| 56 | test_list.sort(key=lambda t: ('~' if t.arch else '') + t.target() + (t.arch if t.arch else '')) |
|---|
| 57 | |
|---|
| 58 | return test_list |
|---|
| 59 | |
|---|
| 60 | # from the found tests, filter all the valid tests/desired tests |
|---|
| 61 | def valid_tests( options ): |
|---|
| 62 | tests = [] |
|---|
| 63 | |
|---|
| 64 | # if we are regenerating the tests we need to find the information of the |
|---|
| 65 | # already existing tests and create new info for the new tests |
|---|
| 66 | if options.regenerate_expected : |
|---|
| 67 | for testname in options.tests : |
|---|
| 68 | testname = os.path.normpath( os.path.join(settings.SRCDIR, testname) ) |
|---|
| 69 | |
|---|
| 70 | # first check if this is a valid name to regenerate |
|---|
| 71 | if Test.valid_name(testname): |
|---|
| 72 | # this is a valid name, let's check if it already exists |
|---|
| 73 | found = [test for test in all_tests if canonical_path( test.target() ) == testname] |
|---|
| 74 | setup = settings.all_arch if options.arch else [None] |
|---|
| 75 | if not found: |
|---|
| 76 | # it's a new name, create it according to the name and specified architecture |
|---|
| 77 | tests.extend( [Test.new_target(testname, arch) for arch in setup] ) |
|---|
| 78 | elif len(found) == 1 and not found[0].arch: |
|---|
| 79 | # we found a single test, the user better be wanting to create a cross platform test |
|---|
| 80 | if options.arch: |
|---|
| 81 | print('ERROR: "%s", test has no specified architecture but --arch was specified, ignoring it' % testname, file=sys.stderr) |
|---|
| 82 | else: |
|---|
| 83 | tests.append( found[0] ) |
|---|
| 84 | else: |
|---|
| 85 | # this test is already cross platform, just add a test for each platform the user asked |
|---|
| 86 | tests.extend( [Test.new_target(testname, arch) for arch in setup] ) |
|---|
| 87 | |
|---|
| 88 | # print a warning if it users didn't ask for a specific architecture |
|---|
| 89 | found_arch = [f.arch for f in found if f.arch] |
|---|
| 90 | if found_arch and not options.arch: |
|---|
| 91 | print('WARNING: "%s", test has architecture specific expected files but --arch was not specified, regenerating only for current host' % testname, file=sys.stderr) |
|---|
| 92 | |
|---|
| 93 | else : |
|---|
| 94 | print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr) |
|---|
| 95 | |
|---|
| 96 | else : |
|---|
| 97 | # otherwise we only need to validate that all tests are present in the complete list |
|---|
| 98 | for testname in options.tests: |
|---|
| 99 | test = [t for t in all_tests if path_cmp( t.target(), testname )] |
|---|
| 100 | |
|---|
| 101 | if test : |
|---|
| 102 | tests.extend( test ) |
|---|
| 103 | else : |
|---|
| 104 | print('ERROR: No expected file for test %s, ignoring it' % testname, file=sys.stderr) |
|---|
| 105 | |
|---|
| 106 | return tests |
|---|
| 107 | |
|---|
| 108 | # parses the option |
|---|
| 109 | def parse_args(): |
|---|
| 110 | # create a parser with the arguments for the tests script |
|---|
| 111 | parser = argparse.ArgumentParser(description='Script which runs cforall tests') |
|---|
| 112 | parser.add_argument('--arch', help='Test for specific architecture', type=comma_separated(str), default=None) |
|---|
| 113 | parser.add_argument('--debug', help='Run all tests in debug or release', type=comma_separated(yes_no), default='yes') |
|---|
| 114 | parser.add_argument('--install', help='Run all tests based on installed binaries or tree binaries', type=comma_separated(yes_no), default='no') |
|---|
| 115 | parser.add_argument('--continue', help='When multiple specifications are passed (debug/install/arch), sets whether or not to continue if the last specification failed', type=yes_no, default='yes', dest='continue_') |
|---|
| 116 | parser.add_argument('--invariant', help='Tell the compiler to check invariants while running.', action='store_true') |
|---|
| 117 | parser.add_argument('--timeout', help='Maximum duration in seconds after a single test is considered to have timed out', type=int, default=180) |
|---|
| 118 | parser.add_argument('--global-timeout', help='Maximum cumulative duration in seconds after the ALL tests are considered to have timed out', type=int, default=7200) |
|---|
| 119 | parser.add_argument('--timeout-with-gdb', help='Instead of killing the command when it times out, orphan it and print process id to allow gdb to attach', type=yes_no, default="no") |
|---|
| 120 | parser.add_argument('--dry-run', help='Don\'t run the tests, only output the commands', action='store_true') |
|---|
| 121 | parser.add_argument('--list', help='List all test available', action='store_true') |
|---|
| 122 | parser.add_argument('--all', help='Run all test available', action='store_true') |
|---|
| 123 | parser.add_argument('--regenerate-expected', help='Regenerate the .expect by running the specified tets, can be used with --all option', action='store_true') |
|---|
| 124 | parser.add_argument('--archive-errors', help='If called with a valid path, on test crashes the test script will copy the core dump and the executable to the specified path.', type=str, default='') |
|---|
| 125 | parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously, 0 (default) for unlimited', nargs='?', const=0, type=int) |
|---|
| 126 | parser.add_argument('--list-comp', help='List all valide arguments', action='store_true') |
|---|
| 127 | parser.add_argument('--list-dist', help='List all tests for distribution', action='store_true') |
|---|
| 128 | parser.add_argument('-I','--include', help='Directory of test to include, can be used multiple time, All if omitted', action='append') |
|---|
| 129 | parser.add_argument('-E','--exclude', help='Directory of test to exclude, can be used multiple time, None if omitted', action='append') |
|---|
| 130 | parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run') |
|---|
| 131 | |
|---|
| 132 | try: |
|---|
| 133 | options = parser.parse_args() |
|---|
| 134 | except: |
|---|
| 135 | print('ERROR: invalid arguments', file=sys.stderr) |
|---|
| 136 | parser.print_help(sys.stderr) |
|---|
| 137 | sys.exit(1) |
|---|
| 138 | |
|---|
| 139 | # script must have at least some tests to run or be listing |
|---|
| 140 | listing = options.list or options.list_comp or options.list_dist |
|---|
| 141 | all_tests = options.all |
|---|
| 142 | some_tests = len(options.tests) > 0 |
|---|
| 143 | some_dirs = len(options.include) > 0 if options.include else 0 |
|---|
| 144 | |
|---|
| 145 | # check that exactly one of the booleans is set to true |
|---|
| 146 | if not sum( (listing, all_tests, some_tests, some_dirs) ) > 0 : |
|---|
| 147 | print('''ERROR: must have option '--all', '--list', '--include', '-I' or non-empty test list''', file=sys.stderr) |
|---|
| 148 | parser.print_help() |
|---|
| 149 | sys.exit(1) |
|---|
| 150 | |
|---|
| 151 | return options |
|---|
| 152 | |
|---|
| 153 | ################################################################################ |
|---|
| 154 | # running test functions |
|---|
| 155 | ################################################################################ |
|---|
| 156 | def success(val): |
|---|
| 157 | return val == 0 or settings.dry_run |
|---|
| 158 | |
|---|
| 159 | def no_rule(file, target): |
|---|
| 160 | return not settings.dry_run and file_contains_only(file, "make: *** No rule to make target `%s'. Stop." % target) |
|---|
| 161 | |
|---|
| 162 | # logic to run a single test and return the result (No handling of printing or other test framework logic) |
|---|
| 163 | def run_single_test(test): |
|---|
| 164 | |
|---|
| 165 | # find the output file based on the test name and options flag |
|---|
| 166 | exe_file = test.target_executable(); |
|---|
| 167 | out_file = test.target_output() |
|---|
| 168 | err_file = test.error_log() |
|---|
| 169 | cmp_file = test.expect() |
|---|
| 170 | in_file = test.input() |
|---|
| 171 | |
|---|
| 172 | # prepare the proper directories |
|---|
| 173 | test.prepare() |
|---|
| 174 | |
|---|
| 175 | # extra flags for cfa to pass through make. |
|---|
| 176 | cfa_flags = 'CFAFLAGS=--invariant' if settings.invariant else None |
|---|
| 177 | |
|---|
| 178 | # ---------- |
|---|
| 179 | # MAKE |
|---|
| 180 | # ---------- |
|---|
| 181 | # build, skipping to next test on error |
|---|
| 182 | with Timed() as comp_dur: |
|---|
| 183 | make_ret, _, _ = make(test.target(), flags=cfa_flags, output_file=subprocess.DEVNULL, error=out_file, error_file=err_file) |
|---|
| 184 | |
|---|
| 185 | # ---------- |
|---|
| 186 | # RUN |
|---|
| 187 | # ---------- |
|---|
| 188 | # run everything in a temp directory to make sure core file are handled properly |
|---|
| 189 | run_dur = None |
|---|
| 190 | with tempdir(): |
|---|
| 191 | # if the make command succeeds continue otherwise skip to diff |
|---|
| 192 | if success(make_ret): |
|---|
| 193 | with Timed() as run_dur: |
|---|
| 194 | if settings.dry_run or is_exe(exe_file): |
|---|
| 195 | # run test |
|---|
| 196 | retcode, _, _ = sh(exe_file, output_file=out_file, input_file=in_file, timeout=True, nice=True) |
|---|
| 197 | else : |
|---|
| 198 | # simply cat the result into the output |
|---|
| 199 | retcode = cat(exe_file, out_file) |
|---|
| 200 | else: |
|---|
| 201 | retcode = mv(err_file, out_file) |
|---|
| 202 | |
|---|
| 203 | if success(retcode): |
|---|
| 204 | if settings.generating : |
|---|
| 205 | # if we are only generating the output we still need to check that the test actually exists |
|---|
| 206 | if no_rule(out_file, test.target()) : |
|---|
| 207 | retcode = 1 |
|---|
| 208 | error = "\t\tNo make target for test %s!" % test.target() |
|---|
| 209 | rm(out_file) |
|---|
| 210 | else: |
|---|
| 211 | error = None |
|---|
| 212 | else : |
|---|
| 213 | # fetch return code and error from the diff command |
|---|
| 214 | retcode, error, _ = diff(cmp_file, out_file) |
|---|
| 215 | |
|---|
| 216 | else: |
|---|
| 217 | if os.stat(out_file).st_size < 1048576: |
|---|
| 218 | with open (out_file, "r", encoding='latin-1') as myfile: # use latin-1 so all chars mean something. |
|---|
| 219 | error = myfile.read() |
|---|
| 220 | else: |
|---|
| 221 | error = "Output log can't be read, file is bigger than 1MB, see {} for actual error\n".format(out_file) |
|---|
| 222 | |
|---|
| 223 | ret, info = core_info(exe_file) |
|---|
| 224 | error = error + info if error else info |
|---|
| 225 | |
|---|
| 226 | if settings.archive: |
|---|
| 227 | error = error + '\n' + core_archive(settings.archive, test.target(), exe_file) |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | # clean the executable |
|---|
| 232 | rm(exe_file) |
|---|
| 233 | |
|---|
| 234 | return retcode, error, [comp_dur.duration, run_dur.duration if run_dur else None] |
|---|
| 235 | |
|---|
| 236 | # run a single test and handle the errors, outputs, printing, exception handling, etc. |
|---|
| 237 | def run_test_worker(t) : |
|---|
| 238 | try : |
|---|
| 239 | # print formated name |
|---|
| 240 | name_txt = t.format_target(width=settings.output_width) + ' ' |
|---|
| 241 | |
|---|
| 242 | retcode, error, duration = run_single_test(t) |
|---|
| 243 | |
|---|
| 244 | # update output based on current action |
|---|
| 245 | result_key, result_txt = TestResult.toString( retcode, duration ) |
|---|
| 246 | |
|---|
| 247 | #print result with error if needed |
|---|
| 248 | text = '\t' + name_txt + result_txt |
|---|
| 249 | out = sys.stdout |
|---|
| 250 | if error : |
|---|
| 251 | text = text + '\n' + error |
|---|
| 252 | |
|---|
| 253 | return retcode == TestResult.SUCCESS, result_key, text |
|---|
| 254 | except KeyboardInterrupt: |
|---|
| 255 | return False, 'keybrd', "" |
|---|
| 256 | # except Exception as ex: |
|---|
| 257 | # print("Unexpected error in worker thread running {}: {}".format(t.target(), ex), file=sys.stderr) |
|---|
| 258 | # sys.stderr.flush() |
|---|
| 259 | # return False, "" |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | # run the given list of tests with the given parameters |
|---|
| 263 | def run_tests(tests, jobs) : |
|---|
| 264 | # clean the sandbox from previous commands |
|---|
| 265 | make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL) |
|---|
| 266 | |
|---|
| 267 | # create the executor for our jobs |
|---|
| 268 | pool = multiprocessing.Pool(jobs) |
|---|
| 269 | |
|---|
| 270 | failed = False |
|---|
| 271 | rescnts = { 'pass': 0, 'fail': 0, 'time': 0, 'keybrd': 0 } |
|---|
| 272 | other = 0 |
|---|
| 273 | |
|---|
| 274 | # for each test to run |
|---|
| 275 | try : |
|---|
| 276 | num = len(tests) |
|---|
| 277 | fancy = sys.stdout.isatty() |
|---|
| 278 | results = pool.imap_unordered( |
|---|
| 279 | run_test_worker, |
|---|
| 280 | tests, |
|---|
| 281 | chunksize = 1 |
|---|
| 282 | ) |
|---|
| 283 | |
|---|
| 284 | for i, (succ, code, txt) in enumerate(timed(results, timeout = settings.timeout.total), 1) : |
|---|
| 285 | if code in rescnts.keys(): |
|---|
| 286 | rescnts[code] += 1 |
|---|
| 287 | else: |
|---|
| 288 | other += 1 |
|---|
| 289 | |
|---|
| 290 | if not succ : |
|---|
| 291 | failed = True |
|---|
| 292 | |
|---|
| 293 | print(" " + txt) |
|---|
| 294 | |
|---|
| 295 | if(fancy and i != num): |
|---|
| 296 | print("%d/%d" % (i, num), end='\r') |
|---|
| 297 | sys.stdout.flush() |
|---|
| 298 | |
|---|
| 299 | except KeyboardInterrupt: |
|---|
| 300 | print("Tests interrupted by user", file=sys.stderr) |
|---|
| 301 | pool.terminate() |
|---|
| 302 | pool.join() |
|---|
| 303 | failed = True |
|---|
| 304 | except multiprocessing.TimeoutError: |
|---|
| 305 | print("ERROR: Test suite timed out", file=sys.stderr) |
|---|
| 306 | pool.terminate() |
|---|
| 307 | pool.join() |
|---|
| 308 | failed = True |
|---|
| 309 | killgroup() # needed to cleanly kill all children |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | # clean the workspace |
|---|
| 313 | make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL) |
|---|
| 314 | |
|---|
| 315 | print("{} passes, {} failures, {} timeouts, {} cancelled, {} other".format(rescnts['pass'], rescnts['fail'], rescnts['time'], rescnts['keybrd'], other)) |
|---|
| 316 | |
|---|
| 317 | return failed |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | ################################################################################ |
|---|
| 321 | # main loop |
|---|
| 322 | ################################################################################ |
|---|
| 323 | if __name__ == "__main__": |
|---|
| 324 | |
|---|
| 325 | # parse the command line arguments |
|---|
| 326 | options = parse_args() |
|---|
| 327 | |
|---|
| 328 | # init global settings |
|---|
| 329 | settings.init( options ) |
|---|
| 330 | |
|---|
| 331 | # -------------------------------------------------- |
|---|
| 332 | # list all the test for auto completion programs |
|---|
| 333 | # not pretty, single line, with the command line options |
|---|
| 334 | if options.list_comp : |
|---|
| 335 | # fetch the liest of all valid tests |
|---|
| 336 | tests = list_tests( None, None ) |
|---|
| 337 | |
|---|
| 338 | # print the possible options |
|---|
| 339 | print("-h --help --debug --dry-run --list --arch --all --regenerate-expected --archive-errors --install --timeout --global-timeout --timeout-with-gdb -j --jobs -I --include -E --exclude --continue ", end='') |
|---|
| 340 | print(" ".join(map(lambda t: "%s" % (t.target()), tests))) |
|---|
| 341 | |
|---|
| 342 | # done |
|---|
| 343 | sys.exit(0) |
|---|
| 344 | |
|---|
| 345 | # -------------------------------------------------- |
|---|
| 346 | # list all the test for auto completion programs |
|---|
| 347 | if options.list_dist : |
|---|
| 348 | # fetch the liest of all valid tests |
|---|
| 349 | tests = list_tests( None, None ) |
|---|
| 350 | |
|---|
| 351 | for t in tests: |
|---|
| 352 | print(os.path.relpath(t.expect(), settings.SRCDIR), end=' ') |
|---|
| 353 | print(os.path.relpath(t.input() , settings.SRCDIR), end=' ') |
|---|
| 354 | code, out, err = make_recon(t.target()) |
|---|
| 355 | |
|---|
| 356 | if code != 0: |
|---|
| 357 | print('ERROR: recond failed for test {}: {} \'{}\''.format(t.target(), code, err), file=sys.stderr) |
|---|
| 358 | sys.exit(1) |
|---|
| 359 | |
|---|
| 360 | print(' '.join(re.findall('([^\s]+\.cfa)', out)), end=' ') |
|---|
| 361 | |
|---|
| 362 | print('') |
|---|
| 363 | |
|---|
| 364 | # done |
|---|
| 365 | sys.exit(0) |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | # -------------------------------------------------- |
|---|
| 369 | # list all the tests for users, in a pretty format |
|---|
| 370 | if options.list : |
|---|
| 371 | # fetch the liest of all valid tests |
|---|
| 372 | tests = list_tests( options.include, options.exclude ) |
|---|
| 373 | |
|---|
| 374 | # print the available tests |
|---|
| 375 | fancy_print("\n".join(map(lambda t: t.toString(), tests))) |
|---|
| 376 | |
|---|
| 377 | # done |
|---|
| 378 | sys.exit(0) |
|---|
| 379 | |
|---|
| 380 | # fetch the liest of all valid tests |
|---|
| 381 | all_tests = list_tests( options.include, options.exclude ) |
|---|
| 382 | |
|---|
| 383 | # if user wants all tests than no other treatement of the test list is required |
|---|
| 384 | if options.all or options.include : |
|---|
| 385 | tests = all_tests |
|---|
| 386 | |
|---|
| 387 | #otherwise we need to validate that the test list that was entered is valid |
|---|
| 388 | else : |
|---|
| 389 | tests = valid_tests( options ) |
|---|
| 390 | |
|---|
| 391 | # make sure we have at least some test to run |
|---|
| 392 | if not tests : |
|---|
| 393 | print('ERROR: No valid test to run', file=sys.stderr) |
|---|
| 394 | sys.exit(1) |
|---|
| 395 | |
|---|
| 396 | # prep invariants |
|---|
| 397 | settings.prep_output(tests) |
|---|
| 398 | failed = 0 |
|---|
| 399 | |
|---|
| 400 | # check if the expected files aren't empty |
|---|
| 401 | if not options.regenerate_expected: |
|---|
| 402 | for t in tests: |
|---|
| 403 | if is_empty(t.expect()): |
|---|
| 404 | print('WARNING: test "{}" has empty .expect file'.format(t.target()), file=sys.stderr) |
|---|
| 405 | |
|---|
| 406 | options.jobs = job_count( options ) |
|---|
| 407 | |
|---|
| 408 | # for each build configurations, run the test |
|---|
| 409 | with Timed() as total_dur: |
|---|
| 410 | for arch, debug, install in itertools.product(settings.all_arch, settings.all_debug, settings.all_install): |
|---|
| 411 | settings.arch = arch |
|---|
| 412 | settings.debug = debug |
|---|
| 413 | settings.install = install |
|---|
| 414 | |
|---|
| 415 | # filter out the tests for a different architecture |
|---|
| 416 | # tests are the same across debug/install |
|---|
| 417 | local_tests = settings.arch.filter( tests ) |
|---|
| 418 | |
|---|
| 419 | # check the build configuration works |
|---|
| 420 | settings.validate() |
|---|
| 421 | jobs = min(options.jobs, len(local_tests)) |
|---|
| 422 | |
|---|
| 423 | # print configuration |
|---|
| 424 | print('%s %i tests on %i cores (%s - %s)' % ( |
|---|
| 425 | 'Regenerating' if settings.generating else 'Running', |
|---|
| 426 | len(local_tests), |
|---|
| 427 | jobs, |
|---|
| 428 | settings.arch.string, |
|---|
| 429 | settings.debug.string |
|---|
| 430 | )) |
|---|
| 431 | if not local_tests : |
|---|
| 432 | print('WARNING: No tests for this configuration') |
|---|
| 433 | continue |
|---|
| 434 | |
|---|
| 435 | # otherwise run all tests and make sure to return the correct error code |
|---|
| 436 | failed = run_tests(local_tests, jobs) |
|---|
| 437 | if failed: |
|---|
| 438 | if not settings.continue_: |
|---|
| 439 | break |
|---|
| 440 | |
|---|
| 441 | print('Tests took %s' % fmtDur( total_dur.duration )) |
|---|
| 442 | sys.exit( failed ) |
|---|
