source: tests/test.py @ 8364209

arm-ehjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-expr
Last change on this file since 8364209 was 8364209, checked in by Thierry Delisle <tdelisle@…>, 2 years ago

Tests now send SIGABRT instead and SIGTERM when a test takes too long

  • Property mode set to 100755
File size: 10.9 KB
Line 
1#!/usr/bin/python3
2
3from pybin.tools import *
4from pybin.test_run import *
5from pybin import settings
6
7import argparse
8import re
9import sys
10import tempfile
11import time
12
13################################################################################
14#               help functions
15################################################################################
16
17def find_tests():
18        expected = []
19
20        def match_test(path):
21                match = re.search("^%s\/([\w\/\-_]*).expect\/([\w\-_]+)(\.[\w\-_]+)?\.txt$" % settings.SRCDIR, path)
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
27                        if settings.arch.match(test.arch):
28                                expected.append(test)
29
30        path_walk( match_test )
31
32        return expected
33
34# reads the directory ./.expect and indentifies the tests
35def list_tests( includes, excludes ):
36        # tests directly in the .expect folder will always be processed
37        test_list = find_tests()
38
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
42                        x.target().startswith( tuple(includes) )
43                ]
44
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
48                        x.target().startswith( tuple(excludes) )
49                ]
50
51        return test_list
52
53# from the found tests, filter all the valid tests/desired tests
54def valid_tests( 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 :
61                        testname = canonical_path( testname )
62                        if Test.valid_name(testname):
63                                found = [test for test in all_tests if canonical_path( test.target() ) == testname]
64                                tests.append( found[0] if len(found) == 1 else Test.from_target(testname) )
65                        else :
66                                print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr)
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:
71                        test = [t for t in all_tests if path_cmp( t.target(), testname )]
72
73                        if test :
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
81def parse_args():
82        # create a parser with the arguments for the tests script
83        parser = argparse.ArgumentParser(description='Script which runs cforall tests')
84        parser.add_argument('--debug', help='Run all tests in debug or release', type=yes_no, default='yes')
85        parser.add_argument('--install', help='Run all tests based on installed binaries or tree binaries', type=yes_no, default='no')
86        parser.add_argument('--arch', help='Test for specific architecture', type=str, default='')
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)
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')
93        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='')
94        parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously', type=int)
95        parser.add_argument('--list-comp', help='List all valide arguments', action='store_true')
96        parser.add_argument('-I','--include', help='Directory of test to include, can be used multiple time, All  if omitted', action='append')
97        parser.add_argument('-E','--exclude', help='Directory of test to exclude, can be used multiple time, None if omitted', action='append')
98        parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run')
99
100        try:
101                options =  parser.parse_args()
102        except:
103                print('ERROR: invalid arguments', file=sys.stderr)
104                parser.print_help(sys.stderr)
105                sys.exit(1)
106
107        # script must have at least some tests to run or be listing
108        listing    = options.list or options.list_comp
109        all_tests  = options.all
110        some_tests = len(options.tests) > 0
111        some_dirs  = len(options.include) > 0 if options.include else 0
112
113        # check that exactly one of the booleans is set to true
114        if not sum( (listing, all_tests, some_tests, some_dirs) ) > 0 :
115                print('''ERROR: must have option '--all', '--list', '--include', '-I' or non-empty test list''', file=sys.stderr)
116                parser.print_help()
117                sys.exit(1)
118
119        return options
120
121################################################################################
122#               running test functions
123################################################################################
124def success(val):
125        return val == 0 or settings.dry_run
126
127def no_rule(file, target):
128        return not settings.dry_run and file_contains_only(file, "make: *** No rule to make target `%s'.  Stop." % target)
129
130# logic to run a single test and return the result (No handling of printing or other test framework logic)
131def run_single_test(test):
132
133        # find the output file based on the test name and options flag
134        exe_file = test.target_executable();
135        out_file = test.target_output()
136        err_file = test.error_log()
137        cmp_file = test.expect()
138        in_file  = test.input()
139
140        # prepare the proper directories
141        test.prepare()
142
143        # build, skipping to next test on error
144        with Timed() as comp_dur:
145                make_ret, _ = make( test.target(), output_file=subprocess.DEVNULL, error=out_file, error_file = err_file )
146
147        run_dur = None
148        # run everything in a temp directory to make sure core file are handled properly
149        with tempdir():
150                # if the make command succeds continue otherwise skip to diff
151                if success(make_ret):
152                        with Timed() as run_dur:
153                                if settings.dry_run or is_exe(exe_file):
154                                        # run test
155                                        retcode, _ = sh(exe_file, output_file=out_file, input_file=in_file, timeout=True)
156                                else :
157                                        # simply cat the result into the output
158                                        retcode = cat(exe_file, out_file)
159                else:
160                        retcode = mv(err_file, out_file)
161
162                if success(retcode):
163                        if settings.generating :
164                                # if we are ounly generating the output we still need to check that the test actually exists
165                                if no_rule(out_file, test.target()) :
166                                        retcode = 1
167                                        error = "\t\tNo make target for test %s!" % test.target()
168                                        rm(out_file)
169                                else:
170                                        error = None
171                        else :
172                                # fetch return code and error from the diff command
173                                retcode, error = diff(cmp_file, out_file)
174
175                else:
176                        with open (out_file, "r") as myfile:
177                                error = myfile.read()
178
179                        ret, info = core_info(exe_file)
180                        error = error + info if error else info
181
182                        if settings.archive:
183                                error = error + '\n' + core_archive(settings.archive, test.target(), exe_file)
184
185
186
187        # clean the executable
188        rm(exe_file)
189
190        return retcode, error, [comp_dur.duration, run_dur.duration if run_dur else None]
191
192# run a single test and handle the errors, outputs, printing, exception handling, etc.
193def run_test_worker(t) :
194        try :
195                # print formated name
196                name_txt = '{0:{width}}  '.format(t.target(), width=settings.output_width)
197
198                retcode, error, duration = run_single_test(t)
199
200                # update output based on current action
201                result_txt = TestResult.toString( retcode, duration )
202
203                #print result with error if needed
204                text = '\t' + name_txt + result_txt
205                out = sys.stdout
206                if error :
207                        text = text + '\n' + error
208
209                return retcode == TestResult.SUCCESS, text
210        except KeyboardInterrupt:
211                return False, ""
212        except Exception as ex:
213                print("Unexpected error in worker thread: %s" % ex, file=sys.stderr)
214                sys.stderr.flush()
215                return False, ""
216
217
218# run the given list of tests with the given parameters
219def run_tests(tests, jobs) :
220        # clean the sandbox from previous commands
221        make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL)
222
223        # create the executor for our jobs and handle the signal properly
224        pool = multiprocessing.Pool(jobs)
225
226        failed = False
227
228        # for each test to run
229        try :
230                num = len(tests)
231                fancy = sys.stdout.isatty()
232                results = pool.imap_unordered(
233                        run_test_worker,
234                        tests,
235                        chunksize = 1
236                )
237
238                for i, (succ, txt) in enumerate(timed(results, timeout = settings.timeout.total), 1) :
239                        if not succ :
240                                failed = True
241
242                        print("       " + txt)
243
244                        if(fancy and i != num):
245                                print("%d/%d" % (i, num), end='\r')
246                                sys.stdout.flush()
247
248        except KeyboardInterrupt:
249                print("Tests interrupted by user", file=sys.stderr)
250                pool.terminate()
251                pool.join()
252                failed = True
253        except multiprocessing.TimeoutError:
254                print("ERROR: Test suite timed out", file=sys.stderr)
255                pool.terminate()
256                pool.join()
257                failed = True
258                killgroup() # needed to cleanly kill all children
259
260
261        # clean the workspace
262        make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL)
263
264        return 1 if failed else 0
265
266
267################################################################################
268#               main loop
269################################################################################
270if __name__ == "__main__":
271
272        # parse the command line arguments
273        options = parse_args()
274
275        # init global settings
276        settings.init( options )
277
278        # fetch the liest of all valid tests
279        all_tests = list_tests( options.include, options.exclude )
280
281
282        # if user wants all tests than no other treatement of the test list is required
283        if options.all or options.list or options.list_comp or options.include :
284                tests = all_tests
285
286        #otherwise we need to validate that the test list that was entered is valid
287        else :
288                tests = valid_tests( options )
289
290        # make sure we have at least some test to run
291        if not tests :
292                print('ERROR: No valid test to run', file=sys.stderr)
293                sys.exit(1)
294
295
296        # sort the test alphabetically for convenience
297        tests.sort(key=lambda t: (t.arch if t.arch else '') + t.target())
298
299        # users may want to simply list the tests
300        if options.list_comp :
301                print("-h --help --debug --dry-run --list --arch --all --regenerate-expected --archive-errors --install --timeout --global-timeout -j --jobs ", end='')
302                print(" ".join(map(lambda t: "%s" % (t.target()), tests)))
303
304        elif options.list :
305                print("Listing for %s:%s"% (settings.arch.string, settings.debug.string))
306                fancy_print("\n".join(map(lambda t: t.toString(), tests)))
307
308        else :
309                # check the build configuration works
310                settings.prep_output(tests)
311                settings.validate()
312
313                options.jobs, forceJobs = job_count( options, tests )
314                settings.update_make_cmd(forceJobs, options.jobs)
315
316                print('%s %i tests on %i cores (%s:%s)' % (
317                        'Regenerating' if settings.generating else 'Running',
318                        len(tests),
319                        options.jobs,
320                        settings.arch.string,
321                        settings.debug.string
322                ))
323
324                # otherwise run all tests and make sure to return the correct error code
325                sys.exit( run_tests(tests, options.jobs) )
Note: See TracBrowser for help on using the repository browser.