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