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