source: tests/test.py @ 99581ee

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since 99581ee was 99581ee, checked in by Thierry Delisle <tdelisle@…>, 13 months ago

Tests now support the --ast flag, Makefile still doesn't

  • Property mode set to 100755
File size: 14.2 KB
Line 
1#!/usr/bin/python3
2
3from pybin.tools import *
4from pybin.test_run import *
5from pybin import settings
6
7import argparse
8import itertools
9import re
10import sys
11import tempfile
12import time
13
14import os
15import psutil
16import signal
17
18################################################################################
19#               help functions
20################################################################################
21
22def find_tests():
23        expected = []
24
25        def match_test(path):
26                match = re.search("^%s\/([\w\/\-_]*).expect\/([\w\-_]+)(\.[\w\-_]+)?\.txt$" % settings.SRCDIR, path)
27                if match :
28                        test = Test()
29                        test.name = match.group(2)
30                        test.path = match.group(1)
31                        test.arch = match.group(3)[1:] if match.group(3) else None
32                        expected.append(test)
33
34        path_walk( match_test )
35
36        return expected
37
38# reads the directory ./.expect and indentifies the tests
39def list_tests( includes, excludes ):
40        # tests directly in the .expect folder will always be processed
41        test_list = find_tests()
42
43        # if we have a limited number of includes, filter by them
44        if includes:
45                test_list = [x for x in test_list if
46                        x.target().startswith( tuple(includes) )
47                ]
48
49        # # if we have a folders to excludes, filter by them
50        if excludes:
51                test_list = [x for x in test_list if not
52                        x.target().startswith( tuple(excludes) )
53                ]
54
55        # sort the test alphabetically for convenience
56        test_list.sort(key=lambda t: ('~' if t.arch else '') + t.target() + (t.arch if t.arch else ''))
57
58        return test_list
59
60# from the found tests, filter all the valid tests/desired tests
61def valid_tests( options ):
62        tests = []
63
64        # if we are regenerating the tests we need to find the information of the
65        # already existing tests and create new info for the new tests
66        if options.regenerate_expected :
67                for testname in options.tests :
68                        testname = canonical_path( testname )
69                        # first check if this is a valid name to regenerate
70                        if Test.valid_name(testname):
71                                # this is a valid name, let's check if it already exists
72                                found = [test for test in all_tests if canonical_path( test.target() ) == testname]
73                                if not found:
74                                        # it's a new name, create it according to the name and specified architecture
75                                        if options.arch:
76                                                # user specified one or multiple architectures, assume the tests will have architecture specific results
77                                                tests.extend( [Test.new_target(testname, arch) for arch in settings.all_arch] )
78                                        else:
79                                                # user didn't specify an architecture, just create a cross platform test
80                                                tests.append( Test.new_target( testname, None ) )
81                                elif len(found) == 1 and not found[0].arch:
82                                        # we found a single test, the user better be wanting to create a cross platform test
83                                        if options.arch:
84                                                print('ERROR: "%s", test has no specified architecture but --arch was specified, ignoring it' % testname, file=sys.stderr)
85                                        else:
86                                                tests.append( found[0] )
87                                else:
88                                        # this test is already cross platform, just add a test for each platform the user asked
89                                        tests.extend( [Test.new_target(testname, arch) for arch in settings.all_arch] )
90
91                                        # print a warning if it users didn't ask for a specific architecture
92                                        if not options.arch:
93                                                print('WARNING: "%s", test has architecture specific expected files but --arch was not specified, regenerating only for current host' % testname, file=sys.stderr)
94
95                        else :
96                                print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr)
97
98        else :
99                # otherwise we only need to validate that all tests are present in the complete list
100                for testname in options.tests:
101                        test = [t for t in all_tests if path_cmp( t.target(), testname )]
102
103                        if test :
104                                tests.extend( test )
105                        else :
106                                print('ERROR: No expected file for test %s, ignoring it' % testname, file=sys.stderr)
107
108        return tests
109
110# parses the option
111def parse_args():
112        # create a parser with the arguments for the tests script
113        parser = argparse.ArgumentParser(description='Script which runs cforall tests')
114        parser.add_argument('--ast', help='Test for specific ast', type=comma_separated(str), default=None)
115        parser.add_argument('--arch', help='Test for specific architecture', type=comma_separated(str), default=None)
116        parser.add_argument('--debug', help='Run all tests in debug or release', type=comma_separated(yes_no), default='yes')
117        parser.add_argument('--install', help='Run all tests based on installed binaries or tree binaries', type=comma_separated(yes_no), default='no')
118        parser.add_argument('--continue', help='When multiple specifications are passed (debug/install/arch), sets whether or not to continue if the last specification failed', type=yes_no, default='yes', dest='continue_')
119        parser.add_argument('--timeout', help='Maximum duration in seconds after a single test is considered to have timed out', type=int, default=120)
120        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)
121        parser.add_argument('--timeout-with-gdb', help='Instead of killing the command when it times out, orphan it and print process id to allow gdb to attach', type=yes_no, default="no")
122        parser.add_argument('--dry-run', help='Don\'t run the tests, only output the commands', action='store_true')
123        parser.add_argument('--list', help='List all test available', action='store_true')
124        parser.add_argument('--all', help='Run all test available', action='store_true')
125        parser.add_argument('--regenerate-expected', help='Regenerate the .expect by running the specified tets, can be used with --all option', action='store_true')
126        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='')
127        parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously', type=int)
128        parser.add_argument('--list-comp', help='List all valide arguments', action='store_true')
129        parser.add_argument('-I','--include', help='Directory of test to include, can be used multiple time, All  if omitted', action='append')
130        parser.add_argument('-E','--exclude', help='Directory of test to exclude, can be used multiple time, None if omitted', action='append')
131        parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run')
132
133        try:
134                options =  parser.parse_args()
135        except:
136                print('ERROR: invalid arguments', file=sys.stderr)
137                parser.print_help(sys.stderr)
138                sys.exit(1)
139
140        # script must have at least some tests to run or be listing
141        listing    = options.list or options.list_comp
142        all_tests  = options.all
143        some_tests = len(options.tests) > 0
144        some_dirs  = len(options.include) > 0 if options.include else 0
145
146        # check that exactly one of the booleans is set to true
147        if not sum( (listing, all_tests, some_tests, some_dirs) ) > 0 :
148                print('''ERROR: must have option '--all', '--list', '--include', '-I' or non-empty test list''', file=sys.stderr)
149                parser.print_help()
150                sys.exit(1)
151
152        return options
153
154################################################################################
155#               running test functions
156################################################################################
157def success(val):
158        return val == 0 or settings.dry_run
159
160def no_rule(file, target):
161        return not settings.dry_run and file_contains_only(file, "make: *** No rule to make target `%s'.  Stop." % target)
162
163# logic to run a single test and return the result (No handling of printing or other test framework logic)
164def run_single_test(test):
165
166        # find the output file based on the test name and options flag
167        exe_file = test.target_executable();
168        out_file = test.target_output()
169        err_file = test.error_log()
170        cmp_file = test.expect()
171        in_file  = test.input()
172
173        # prepare the proper directories
174        test.prepare()
175
176        # ----------
177        # MAKE
178        # ----------
179        # build, skipping to next test on error
180        with Timed() as comp_dur:
181                make_ret, _ = make( test.target(), output_file=subprocess.DEVNULL, error=out_file, error_file = err_file )
182
183        # ----------
184        # RUN
185        # ----------
186        # run everything in a temp directory to make sure core file are handled properly
187        run_dur = None
188        with tempdir():
189                # if the make command succeeds continue otherwise skip to diff
190                if success(make_ret):
191                        with Timed() as run_dur:
192                                if settings.dry_run or is_exe(exe_file):
193                                        # run test
194                                        retcode, _ = sh(exe_file, output_file=out_file, input_file=in_file, timeout=True)
195                                else :
196                                        # simply cat the result into the output
197                                        retcode = cat(exe_file, out_file)
198                else:
199                        retcode = mv(err_file, out_file)
200
201                if success(retcode):
202                        if settings.generating :
203                                # if we are only generating the output we still need to check that the test actually exists
204                                if no_rule(out_file, test.target()) :
205                                        retcode = 1
206                                        error = "\t\tNo make target for test %s!" % test.target()
207                                        rm(out_file)
208                                else:
209                                        error = None
210                        else :
211                                # fetch return code and error from the diff command
212                                retcode, error = diff(cmp_file, out_file)
213
214                else:
215                        if os.stat(out_file).st_size < 1048576:
216                                with open (out_file, "r", encoding='latin-1') as myfile:  # use latin-1 so all chars mean something.
217                                        error = myfile.read()
218                        else:
219                                error = "Output log can't be read, file is bigger than 1MB, see {} for actual error\n".format(out_file)
220
221                        ret, info = core_info(exe_file)
222                        error = error + info if error else info
223
224                        if settings.archive:
225                                error = error + '\n' + core_archive(settings.archive, test.target(), exe_file)
226
227
228
229        # clean the executable
230        rm(exe_file)
231
232        return retcode, error, [comp_dur.duration, run_dur.duration if run_dur else None]
233
234# run a single test and handle the errors, outputs, printing, exception handling, etc.
235def run_test_worker(t) :
236        try :
237                # print formated name
238                name_txt = '{0:{width}}  '.format(t.target(), width=settings.output_width)
239
240                retcode, error, duration = run_single_test(t)
241
242                # update output based on current action
243                result_txt = TestResult.toString( retcode, duration )
244
245                #print result with error if needed
246                text = '\t' + name_txt + result_txt
247                out = sys.stdout
248                if error :
249                        text = text + '\n' + error
250
251                return retcode == TestResult.SUCCESS, text
252        except KeyboardInterrupt:
253                return False, ""
254        except Exception as ex:
255                print("Unexpected error in worker thread running {}: {}".format(t.target(), ex), file=sys.stderr)
256                sys.stderr.flush()
257                return False, ""
258
259
260# run the given list of tests with the given parameters
261def run_tests(tests, jobs) :
262        # clean the sandbox from previous commands
263        make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL)
264
265        # create the executor for our jobs
266        pool = multiprocessing.Pool(jobs)
267
268        failed = False
269
270        # for each test to run
271        try :
272                num = len(tests)
273                fancy = sys.stdout.isatty()
274                results = pool.imap_unordered(
275                        run_test_worker,
276                        tests,
277                        chunksize = 1
278                )
279
280                for i, (succ, txt) in enumerate(timed(results, timeout = settings.timeout.total), 1) :
281                        if not succ :
282                                failed = True
283
284                        print("       " + txt)
285
286                        if(fancy and i != num):
287                                print("%d/%d" % (i, num), end='\r')
288                                sys.stdout.flush()
289
290        except KeyboardInterrupt:
291                print("Tests interrupted by user", file=sys.stderr)
292                pool.terminate()
293                pool.join()
294                failed = True
295        except multiprocessing.TimeoutError:
296                print("ERROR: Test suite timed out", file=sys.stderr)
297                pool.terminate()
298                pool.join()
299                failed = True
300                killgroup() # needed to cleanly kill all children
301
302
303        # clean the workspace
304        make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL)
305
306        return failed
307
308
309################################################################################
310#               main loop
311################################################################################
312if __name__ == "__main__":
313
314        # parse the command line arguments
315        options = parse_args()
316
317        # init global settings
318        settings.init( options )
319
320        # users may want to simply list the tests
321        if options.list_comp :
322                # fetch the liest of all valid tests
323                tests = list_tests( None, None )
324
325                # print the possible options
326                print("-h --help --debug --dry-run --list --arch --all --regenerate-expected --archive-errors --install --timeout --global-timeout --timeout-with-gdb -j --jobs -I --include -E --exclude --continue ", end='')
327                print(" ".join(map(lambda t: "%s" % (t.target()), tests)))
328
329        elif options.list :
330                # fetch the liest of all valid tests
331                tests = list_tests( options.include, options.exclude )
332
333                # print the available tests
334                fancy_print("\n".join(map(lambda t: t.toString(), tests)))
335
336        else :
337                # fetch the liest of all valid tests
338                all_tests = list_tests( options.include, options.exclude )
339
340                # if user wants all tests than no other treatement of the test list is required
341                if options.all or options.include :
342                        tests = all_tests
343
344                #otherwise we need to validate that the test list that was entered is valid
345                else :
346                        tests = valid_tests( options )
347
348                # make sure we have at least some test to run
349                if not tests :
350                        print('ERROR: No valid test to run', file=sys.stderr)
351                        sys.exit(1)
352
353                # prep invariants
354                settings.prep_output(tests)
355                failed = 0
356
357                # check if the expected files aren't empty
358                if not options.regenerate_expected:
359                        for t in tests:
360                                if is_empty(t.expect()):
361                                        print('WARNING: test "{}" has empty .expect file'.format(t.target()), file=sys.stderr)
362
363                # for each build configurations, run the test
364                with Timed() as total_dur:
365                        for ast, arch, debug, install in itertools.product(settings.all_ast, settings.all_arch, settings.all_debug, settings.all_install):
366                                settings.ast     = ast
367                                settings.arch    = arch
368                                settings.debug   = debug
369                                settings.install = install
370
371                                # filter out the tests for a different architecture
372                                # tests are the same across debug/install
373                                local_tests = settings.arch.filter( tests )
374                                options.jobs, forceJobs = job_count( options, local_tests )
375                                settings.update_make_cmd(forceJobs, options.jobs)
376
377                                # check the build configuration works
378                                settings.validate()
379
380                                # print configuration
381                                print('%s %i tests on %i cores (%s:%s - %s)' % (
382                                        'Regenerating' if settings.generating else 'Running',
383                                        len(local_tests),
384                                        options.jobs,
385                                        settings.arch.string,
386                                        settings.debug.string,
387                                        settings.ast.string
388                                ))
389
390                                # otherwise run all tests and make sure to return the correct error code
391                                failed = run_tests(local_tests, options.jobs)
392                                if failed:
393                                        result = 1
394                                        if not settings.continue_:
395                                                break
396
397                print('Tests took %s' % fmtDur( total_dur.duration ))
398                sys.exit( failed )
Note: See TracBrowser for help on using the repository browser.