[945047e] | 1 | #!/usr/bin/python |
---|
[efc15918] | 2 | from __future__ import print_function |
---|
| 3 | |
---|
[c07d724] | 4 | from pybin.tools import * |
---|
[0ad0c55] | 5 | from pybin.test_run import * |
---|
[bacc36c] | 6 | from pybin import settings |
---|
[efc15918] | 7 | |
---|
| 8 | import argparse |
---|
[122cac7] | 9 | import re |
---|
[efc15918] | 10 | import sys |
---|
[ca54499] | 11 | import time |
---|
[efc15918] | 12 | |
---|
| 13 | ################################################################################ |
---|
| 14 | # help functions |
---|
| 15 | ################################################################################ |
---|
[f1231f2] | 16 | |
---|
[209383b] | 17 | def findTests(): |
---|
[0ad0c55] | 18 | expected = [] |
---|
[f1231f2] | 19 | |
---|
[f3b9efc] | 20 | def matchTest(path): |
---|
[6044200] | 21 | match = re.search("^%s\/([\w\/\-_]*).expect\/([\w\-_]+)(\.[\w\-_]+)?\.txt$" % settings.SRCDIR, path) |
---|
[bacc36c] | 22 | if match : |
---|
| 23 | test = Test() |
---|
| 24 | test.name = match.group(2) |
---|
| 25 | test.path = match.group(1) |
---|
| 26 | test.arch = match.group(3)[1:] if match.group(3) else None |
---|
[f3b9efc] | 27 | if settings.arch.match(test.arch): |
---|
| 28 | expected.append(test) |
---|
[f803a75] | 29 | |
---|
[f3b9efc] | 30 | pathWalk( matchTest ) |
---|
[c07d724] | 31 | |
---|
[0ad0c55] | 32 | return expected |
---|
[efc15918] | 33 | |
---|
[be65cca] | 34 | # reads the directory ./.expect and indentifies the tests |
---|
[0ad0c55] | 35 | def listTests( includes, excludes ): |
---|
[be65cca] | 36 | # tests directly in the .expect folder will always be processed |
---|
[209383b] | 37 | test_list = findTests() |
---|
[be65cca] | 38 | |
---|
[0ad0c55] | 39 | # if we have a limited number of includes, filter by them |
---|
| 40 | if includes: |
---|
| 41 | test_list = [x for x in test_list if |
---|
[a85e44c] | 42 | x.target().startswith( tuple(includes) ) |
---|
[0ad0c55] | 43 | ] |
---|
[be65cca] | 44 | |
---|
[0ad0c55] | 45 | # # if we have a folders to excludes, filter by them |
---|
| 46 | if excludes: |
---|
| 47 | test_list = [x for x in test_list if not |
---|
[a85e44c] | 48 | x.target().startswith( tuple(excludes) ) |
---|
[0ad0c55] | 49 | ] |
---|
[f1231f2] | 50 | |
---|
[0ad0c55] | 51 | return test_list |
---|
[efc15918] | 52 | |
---|
[c07d724] | 53 | # from the found tests, filter all the valid tests/desired tests |
---|
| 54 | def validTests( options ): |
---|
| 55 | tests = [] |
---|
| 56 | |
---|
| 57 | # if we are regenerating the tests we need to find the information of the |
---|
| 58 | # already existing tests and create new info for the new tests |
---|
| 59 | if options.regenerate_expected : |
---|
| 60 | for testname in options.tests : |
---|
[16a63a78] | 61 | testname = canonicalPath( testname ) |
---|
[bacc36c] | 62 | if Test.valid_name(testname): |
---|
[a95c117] | 63 | found = [test for test in allTests if canonicalPath( test.target() ) == testname] |
---|
[bacc36c] | 64 | tests.append( found[0] if len(found) == 1 else Test.from_target(testname) ) |
---|
[c07d724] | 65 | else : |
---|
[bacc36c] | 66 | print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr) |
---|
[c07d724] | 67 | |
---|
| 68 | else : |
---|
| 69 | # otherwise we only need to validate that all tests are present in the complete list |
---|
| 70 | for testname in options.tests: |
---|
[bacc36c] | 71 | test = [t for t in allTests if pathCmp( t.target(), testname )] |
---|
[c07d724] | 72 | |
---|
[bacc36c] | 73 | if test : |
---|
[c07d724] | 74 | tests.append( test[0] ) |
---|
| 75 | else : |
---|
| 76 | print('ERROR: No expected file for test %s, ignoring it' % testname, file=sys.stderr) |
---|
| 77 | |
---|
| 78 | return tests |
---|
| 79 | |
---|
| 80 | # parses the option |
---|
| 81 | def getOptions(): |
---|
| 82 | # create a parser with the arguments for the tests script |
---|
| 83 | parser = argparse.ArgumentParser(description='Script which runs cforall tests') |
---|
[28582b2] | 84 | parser.add_argument('--debug', help='Run all tests in debug or release', type=yes_no, default='yes') |
---|
[a5121bf] | 85 | parser.add_argument('--install', help='Run all tests based on installed binaries or tree binaries', type=yes_no, default='no') |
---|
[bacc36c] | 86 | parser.add_argument('--arch', help='Test for specific architecture', type=str, default='') |
---|
[afe8882] | 87 | parser.add_argument('--timeout', help='Maximum duration in seconds after a single test is considered to have timed out', type=int, default=60) |
---|
| 88 | 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) |
---|
[c07d724] | 89 | parser.add_argument('--dry-run', help='Don\'t run the tests, only output the commands', action='store_true') |
---|
| 90 | parser.add_argument('--list', help='List all test available', action='store_true') |
---|
| 91 | parser.add_argument('--all', help='Run all test available', action='store_true') |
---|
| 92 | parser.add_argument('--regenerate-expected', help='Regenerate the .expect by running the specified tets, can be used with --all option', action='store_true') |
---|
[d142ec5] | 93 | parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously', type=int) |
---|
[c07d724] | 94 | parser.add_argument('--list-comp', help='List all valide arguments', action='store_true') |
---|
[0ad0c55] | 95 | parser.add_argument('-I','--include', help='Directory of test to include, can be used multiple time, All if omitted', action='append') |
---|
| 96 | parser.add_argument('-E','--exclude', help='Directory of test to exclude, can be used multiple time, None if omitted', action='append') |
---|
[c07d724] | 97 | parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run') |
---|
| 98 | |
---|
[575a6e5] | 99 | try: |
---|
| 100 | options = parser.parse_args() |
---|
| 101 | except: |
---|
| 102 | print('ERROR: invalid arguments', file=sys.stderr) |
---|
| 103 | parser.print_help(sys.stderr) |
---|
| 104 | sys.exit(1) |
---|
[c07d724] | 105 | |
---|
| 106 | # script must have at least some tests to run or be listing |
---|
| 107 | listing = options.list or options.list_comp |
---|
| 108 | all_tests = options.all |
---|
| 109 | some_tests = len(options.tests) > 0 |
---|
[0ad0c55] | 110 | some_dirs = len(options.include) > 0 if options.include else 0 |
---|
[c07d724] | 111 | |
---|
| 112 | # check that exactly one of the booleans is set to true |
---|
[0ad0c55] | 113 | if not sum( (listing, all_tests, some_tests, some_dirs) ) > 0 : |
---|
| 114 | print('ERROR: must have option \'--all\', \'--list\', \'--include\', \'-I\' or non-empty test list', file=sys.stderr) |
---|
[c07d724] | 115 | parser.print_help() |
---|
| 116 | sys.exit(1) |
---|
| 117 | |
---|
| 118 | return options |
---|
| 119 | |
---|
[efc15918] | 120 | ################################################################################ |
---|
| 121 | # running test functions |
---|
| 122 | ################################################################################ |
---|
[f85bc15] | 123 | # fix the absolute paths in the output |
---|
| 124 | def fixoutput( fname ): |
---|
| 125 | if not is_ascii(fname): |
---|
| 126 | return |
---|
| 127 | |
---|
| 128 | file_replace(fname, "%s/" % settings.SRCDIR, "") |
---|
| 129 | |
---|
| 130 | |
---|
[c07d724] | 131 | # logic to run a single test and return the result (No handling of printing or other test framework logic) |
---|
[209383b] | 132 | def run_single_test(test): |
---|
[3c1d702] | 133 | |
---|
[c07d724] | 134 | # find the output file based on the test name and options flag |
---|
[f85bc15] | 135 | exe_file = test.target_executable(); |
---|
[bacc36c] | 136 | out_file = test.target_output() |
---|
| 137 | err_file = test.error_log() |
---|
| 138 | cmp_file = test.expect() |
---|
| 139 | in_file = test.input() |
---|
[0ad0c55] | 140 | |
---|
| 141 | # prepare the proper directories |
---|
[bacc36c] | 142 | test.prepare() |
---|
[efc15918] | 143 | |
---|
[c07d724] | 144 | # build, skipping to next test on error |
---|
[ca54499] | 145 | before = time.time() |
---|
[bacc36c] | 146 | make_ret, _ = make( test.target(), |
---|
| 147 | redirects = "2> %s 1> /dev/null" % out_file, |
---|
| 148 | error_file = err_file |
---|
| 149 | ) |
---|
[ca54499] | 150 | after = time.time() |
---|
| 151 | |
---|
| 152 | comp_dur = after - before |
---|
| 153 | |
---|
| 154 | run_dur = None |
---|
[efc15918] | 155 | |
---|
[c07d724] | 156 | # if the make command succeds continue otherwise skip to diff |
---|
[bacc36c] | 157 | if make_ret == 0 or settings.dry_run: |
---|
[ca54499] | 158 | before = time.time() |
---|
[f85bc15] | 159 | if settings.dry_run or fileIsExecutable(exe_file) : |
---|
[c07d724] | 160 | # run test |
---|
[afe8882] | 161 | retcode, _ = sh("timeout %d %s > %s 2>&1" % (settings.timeout.single, exe_file, out_file), input = in_file) |
---|
[9fcb5e4] | 162 | else : |
---|
[c07d724] | 163 | # simply cat the result into the output |
---|
[f85bc15] | 164 | retcode, _ = sh("cat %s > %s" % (exe_file, out_file)) |
---|
[ca54499] | 165 | |
---|
| 166 | after = time.time() |
---|
| 167 | run_dur = after - before |
---|
[0ad0c55] | 168 | else: |
---|
[f3b9efc] | 169 | retcode, _ = sh("mv %s %s" % (err_file, out_file)) |
---|
[122cac7] | 170 | |
---|
[0ad0c55] | 171 | |
---|
[c2d5e28] | 172 | if retcode == 0: |
---|
[f7d3215] | 173 | # fixoutput(out_file) |
---|
[bacc36c] | 174 | if settings.generating : |
---|
[c2d5e28] | 175 | # if we are ounly generating the output we still need to check that the test actually exists |
---|
[bacc36c] | 176 | if not settings.dry_run and fileContainsOnly(out_file, "make: *** No rule to make target `%s'. Stop." % test.target()) : |
---|
[c2d5e28] | 177 | retcode = 1; |
---|
[0ad0c55] | 178 | error = "\t\tNo make target for test %s!" % test.target() |
---|
[c2d5e28] | 179 | sh("rm %s" % out_file, False) |
---|
[f3b9efc] | 180 | else: |
---|
| 181 | error = None |
---|
[c2d5e28] | 182 | else : |
---|
| 183 | # fetch return code and error from the diff command |
---|
[bacc36c] | 184 | retcode, error = diff(cmp_file, out_file) |
---|
[ac032b5] | 185 | |
---|
| 186 | else: |
---|
| 187 | with open (out_file, "r") as myfile: |
---|
| 188 | error = myfile.read() |
---|
| 189 | |
---|
[b5f9829] | 190 | |
---|
[c07d724] | 191 | # clean the executable |
---|
[bacc36c] | 192 | sh("rm -f %s > /dev/null 2>&1" % test.target()) |
---|
[efc15918] | 193 | |
---|
[ca54499] | 194 | return retcode, error, [comp_dur, run_dur] |
---|
[efc15918] | 195 | |
---|
[c07d724] | 196 | # run a single test and handle the errors, outputs, printing, exception handling, etc. |
---|
[209383b] | 197 | def run_test_worker(t) : |
---|
[ced2e989] | 198 | |
---|
[bacc36c] | 199 | with SignalHandling(): |
---|
| 200 | # print formated name |
---|
| 201 | name_txt = "%20s " % t.name |
---|
[ced2e989] | 202 | |
---|
[ca54499] | 203 | retcode, error, duration = run_single_test(t) |
---|
[0a1a680] | 204 | |
---|
[bacc36c] | 205 | # update output based on current action |
---|
[ca54499] | 206 | result_txt = TestResult.toString( retcode, duration ) |
---|
[bacc36c] | 207 | |
---|
| 208 | #print result with error if needed |
---|
| 209 | text = name_txt + result_txt |
---|
| 210 | out = sys.stdout |
---|
| 211 | if error : |
---|
| 212 | text = text + "\n" + error |
---|
| 213 | out = sys.stderr |
---|
| 214 | |
---|
| 215 | print(text, file = out) |
---|
| 216 | sys.stdout.flush() |
---|
| 217 | sys.stderr.flush() |
---|
[9fcb5e4] | 218 | |
---|
[c2d5e28] | 219 | return retcode != TestResult.SUCCESS |
---|
[ced2e989] | 220 | |
---|
[911348cd] | 221 | # run the given list of tests with the given parameters |
---|
[209383b] | 222 | def run_tests(tests, jobs) : |
---|
[911348cd] | 223 | # clean the sandbox from previous commands |
---|
[bacc36c] | 224 | make('clean', redirects = '> /dev/null 2>&1') |
---|
[efc15918] | 225 | |
---|
[c07d724] | 226 | # create the executor for our jobs and handle the signal properly |
---|
[bacc36c] | 227 | pool = setupPool(jobs) |
---|
[c07d724] | 228 | |
---|
| 229 | # for each test to run |
---|
[ced2e989] | 230 | try : |
---|
[bacc36c] | 231 | results = pool.map_async( |
---|
[209383b] | 232 | run_test_worker, |
---|
[bacc36c] | 233 | tests, |
---|
| 234 | chunksize = 1 |
---|
[afe8882] | 235 | ).get(settings.timeout.total) |
---|
[ced2e989] | 236 | except KeyboardInterrupt: |
---|
| 237 | pool.terminate() |
---|
| 238 | print("Tests interrupted by user") |
---|
| 239 | sys.exit(1) |
---|
[efc15918] | 240 | |
---|
[c07d724] | 241 | # clean the workspace |
---|
[bacc36c] | 242 | make('clean', redirects = '> /dev/null 2>&1') |
---|
[efc15918] | 243 | |
---|
[ced2e989] | 244 | for failed in results: |
---|
| 245 | if failed : |
---|
| 246 | return 1 |
---|
| 247 | |
---|
| 248 | return 0 |
---|
[efc15918] | 249 | |
---|
[6a1bdfd] | 250 | |
---|
[efc15918] | 251 | ################################################################################ |
---|
| 252 | # main loop |
---|
| 253 | ################################################################################ |
---|
[c07d724] | 254 | if __name__ == "__main__": |
---|
[f803a75] | 255 | |
---|
[c07d724] | 256 | # parse the command line arguments |
---|
| 257 | options = getOptions() |
---|
[f1231f2] | 258 | |
---|
[bacc36c] | 259 | # init global settings |
---|
| 260 | settings.init( options ) |
---|
| 261 | |
---|
[c07d724] | 262 | # fetch the liest of all valid tests |
---|
[0ad0c55] | 263 | allTests = listTests( options.include, options.exclude ) |
---|
[f1231f2] | 264 | |
---|
[c07d724] | 265 | # if user wants all tests than no other treatement of the test list is required |
---|
[0ad0c55] | 266 | if options.all or options.list or options.list_comp or options.include : |
---|
[c07d724] | 267 | tests = allTests |
---|
[0534c3c] | 268 | |
---|
[f3b9efc] | 269 | #otherwise we need to validate that the test list that was entered is valid |
---|
[c07d724] | 270 | else : |
---|
| 271 | tests = validTests( options ) |
---|
[0534c3c] | 272 | |
---|
[dd226e3] | 273 | # make sure we have at least some test to run |
---|
| 274 | if not tests : |
---|
| 275 | print('ERROR: No valid test to run', file=sys.stderr) |
---|
| 276 | sys.exit(1) |
---|
| 277 | |
---|
| 278 | |
---|
[c07d724] | 279 | # sort the test alphabetically for convenience |
---|
[f3b9efc] | 280 | tests.sort(key=lambda t: (t.arch if t.arch else '') + t.target()) |
---|
[f1231f2] | 281 | |
---|
[c07d724] | 282 | # users may want to simply list the tests |
---|
| 283 | if options.list_comp : |
---|
[afe8882] | 284 | print("-h --help --debug --dry-run --list --arch --all --regenerate-expected --install --timeout --global-timeout -j --jobs ", end='') |
---|
[0ad0c55] | 285 | print(" ".join(map(lambda t: "%s" % (t.target()), tests))) |
---|
[911348cd] | 286 | |
---|
[c07d724] | 287 | elif options.list : |
---|
[f3b9efc] | 288 | print("Listing for %s:%s"% (settings.arch.string, settings.debug.string)) |
---|
[ed45af6] | 289 | fancy_print("\n".join(map(lambda t: "%s" % (t.toString()), tests))) |
---|
[911348cd] | 290 | |
---|
[b98c913] | 291 | else : |
---|
[28582b2] | 292 | # check the build configuration works |
---|
| 293 | settings.validate() |
---|
| 294 | |
---|
[bacc36c] | 295 | options.jobs, forceJobs = jobCount( options, tests ) |
---|
| 296 | settings.updateMakeCmd(forceJobs, options.jobs) |
---|
[b98c913] | 297 | |
---|
[bacc36c] | 298 | print('%s (%s:%s) on %i cores' % ( |
---|
| 299 | 'Regenerate tests' if settings.generating else 'Running', |
---|
[f3b9efc] | 300 | settings.arch.string, |
---|
| 301 | settings.debug.string, |
---|
[bacc36c] | 302 | options.jobs |
---|
| 303 | )) |
---|
[efc15918] | 304 | |
---|
[c07d724] | 305 | # otherwise run all tests and make sure to return the correct error code |
---|
[209383b] | 306 | sys.exit( run_tests(tests, options.jobs) ) |
---|