source: tests/test.py @ bee653c

arm-ehcleanup-dtorsjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-expr
Last change on this file since bee653c was f806b61, checked in by tdelisle <tdelisle@…>, 3 years ago

Tests are now run in temporary directory

  • Property mode set to 100755
File size: 10.1 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('-j', '--jobs', help='Number of tests to run simultaneously', type=int)
94        parser.add_argument('--list-comp', help='List all valide arguments', action='store_true')
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')
97        parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run')
98
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)
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
110        some_dirs  = len(options.include) > 0 if options.include else 0
111
112        # check that exactly one of the booleans is set to true
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)
115                parser.print_help()
116                sys.exit(1)
117
118        return options
119
120################################################################################
121#               running test functions
122################################################################################
123def success(val):
124        return val == 0 or settings.dry_run
125
126def no_rule(file, target):
127        return not settings.dry_run and file_contains_only(file, "make: *** No rule to make target `%s'.  Stop." % target)
128
129# logic to run a single test and return the result (No handling of printing or other test framework logic)
130def run_single_test(test):
131
132        # find the output file based on the test name and options flag
133        exe_file = test.target_executable();
134        out_file = test.target_output()
135        err_file = test.error_log()
136        cmp_file = test.expect()
137        in_file  = test.input()
138
139        # prepare the proper directories
140        test.prepare()
141
142        # build, skipping to next test on error
143        with Timed() as comp_dur:
144                make_ret, _ = make( test.target(), output=subprocess.DEVNULL, error=out_file, error_file = err_file )
145
146        run_dur = None
147        # run everything in a temp directory to make sure core file are handled properly
148        with tempdir():
149                # if the make command succeds continue otherwise skip to diff
150                if success(make_ret):
151                        with Timed() as run_dur:
152                                if settings.dry_run or is_exe(exe_file):
153                                        # run test
154                                        retcode, _ = sh(exe_file, output=out_file, input=in_file, timeout=True)
155                                else :
156                                        # simply cat the result into the output
157                                        retcode = cat(exe_file, out_file)
158                else:
159                        retcode = mv(err_file, out_file)
160
161                if success(retcode):
162                        if settings.generating :
163                                # if we are ounly generating the output we still need to check that the test actually exists
164                                if no_rule(out_file, test.target()) :
165                                        retcode = 1
166                                        error = "\t\tNo make target for test %s!" % test.target()
167                                        rm(out_file)
168                                else:
169                                        error = None
170                        else :
171                                # fetch return code and error from the diff command
172                                retcode, error = diff(cmp_file, out_file)
173
174                else:
175                        with open (out_file, "r") as myfile:
176                                error = myfile.read()
177
178                        ret, info = core_info(exe_file)
179                        error = error + info if error else info
180
181
182
183        # clean the executable
184        rm(exe_file)
185
186        return retcode, error, [comp_dur.duration, run_dur.duration if run_dur else None]
187
188# run a single test and handle the errors, outputs, printing, exception handling, etc.
189def run_test_worker(t) :
190        try :
191                # print formated name
192                name_txt = '{0:{width}}  '.format(t.target(), width=settings.output_width)
193
194                retcode, error, duration = run_single_test(t)
195
196                # update output based on current action
197                result_txt = TestResult.toString( retcode, duration )
198
199                #print result with error if needed
200                text = '\t' + name_txt + result_txt
201                out = sys.stdout
202                if error :
203                        text = text + '\n' + error
204                        out = sys.stderr
205
206                print(text, file = out)
207                sys.stdout.flush()
208                sys.stderr.flush()
209
210                return retcode != TestResult.SUCCESS
211        except KeyboardInterrupt:
212                False
213
214# run the given list of tests with the given parameters
215def run_tests(tests, jobs) :
216        # clean the sandbox from previous commands
217        make('clean', output=subprocess.DEVNULL, error=subprocess.DEVNULL)
218
219        # create the executor for our jobs and handle the signal properly
220        pool = multiprocessing.Pool(jobs)
221
222        # for each test to run
223        try :
224                results = pool.map_async(
225                        run_test_worker,
226                        tests,
227                        chunksize = 1
228                ).get(settings.timeout.total)
229        except KeyboardInterrupt:
230                pool.terminate()
231                print("Tests interrupted by user")
232                sys.exit(1)
233
234        # clean the workspace
235        make('clean', output=subprocess.DEVNULL, error=subprocess.DEVNULL)
236
237        for failed in results:
238                if failed :
239                        return 1
240
241        return 0
242
243
244################################################################################
245#               main loop
246################################################################################
247if __name__ == "__main__":
248
249        # parse the command line arguments
250        options = parse_args()
251
252        # init global settings
253        settings.init( options )
254
255        # fetch the liest of all valid tests
256        all_tests = list_tests( options.include, options.exclude )
257
258
259        # if user wants all tests than no other treatement of the test list is required
260        if options.all or options.list or options.list_comp or options.include :
261                tests = all_tests
262
263        #otherwise we need to validate that the test list that was entered is valid
264        else :
265                tests = valid_tests( options )
266
267        # make sure we have at least some test to run
268        if not tests :
269                print('ERROR: No valid test to run', file=sys.stderr)
270                sys.exit(1)
271
272
273        # sort the test alphabetically for convenience
274        tests.sort(key=lambda t: (t.arch if t.arch else '') + t.target())
275
276        # users may want to simply list the tests
277        if options.list_comp :
278                print("-h --help --debug --dry-run --list --arch --all --regenerate-expected --install --timeout --global-timeout -j --jobs ", end='')
279                print(" ".join(map(lambda t: "%s" % (t.target()), tests)))
280
281        elif options.list :
282                print("Listing for %s:%s"% (settings.arch.string, settings.debug.string))
283                fancy_print("\n".join(map(lambda t: t.toString(), tests)))
284
285        else :
286                # check the build configuration works
287                settings.prep_output(tests)
288                settings.validate()
289
290                options.jobs, forceJobs = job_count( options, tests )
291                settings.update_make_cmd(forceJobs, options.jobs)
292
293                print('%s %i tests on %i cores (%s:%s)' % (
294                        'Regenerating' if settings.generating else 'Running',
295                        len(tests),
296                        options.jobs,
297                        settings.arch.string,
298                        settings.debug.string
299                ))
300
301                # otherwise run all tests and make sure to return the correct error code
302                sys.exit( run_tests(tests, options.jobs) )
Note: See TracBrowser for help on using the repository browser.