source: src/tests/test.py @ bacc36c

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since bacc36c was bacc36c, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

Major test cleanup by modularizing further into pybin

  • Property mode set to 100755
File size: 9.2 KB
Line 
1#!/usr/bin/python
2from __future__ import print_function
3
4from pybin.tools import *
5from pybin.test_run import *
6from pybin import settings
7
8import argparse
9import functools
10import re
11import sys
12
13################################################################################
14#               help functions
15################################################################################
16
17def list_expected():
18        expected = []
19
20        def findTest(path):
21                match = re.search("(\.[\w\/\-_]*)\/.expect\/([\w\-_]+)(\.[\w\-_]+)?\.txt", 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                        expected.append(test)
28
29        pathWalk( findTest )
30
31        return expected
32
33# reads the directory ./.expect and indentifies the tests
34def 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 = list_expected()
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.path.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.path.startswith( tuple(excludes) )
51                ]
52
53        return test_list
54
55# from the found tests, filter all the valid tests/desired tests
56def 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                        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) )
66                        else :
67                                print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr)
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:
72                        test = [t for t in allTests if pathCmp( t.target(), testname )]
73
74                        if test :
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
80        if tests :
81                print('ERROR: No valid test to run', file=sys.stderr)
82                sys.exit(1)
83
84        return tests
85
86# parses the option
87def 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')
91        parser.add_argument('--arch', help='Test for specific architecture', type=str, default='')
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')
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')
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
108        some_dirs  = len(options.include) > 0 if options.include else 0
109
110        # check that exactly one of the booleans is set to true
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)
113                parser.print_help()
114                sys.exit(1)
115
116        return options
117
118################################################################################
119#               running test functions
120################################################################################
121# logic to run a single test and return the result (No handling of printing or other test framework logic)
122def run_single_test(test, debug):
123
124        # find the output file based on the test name and options flag
125        out_file = test.target_output()
126        err_file = test.error_log()
127        cmp_file = test.expect()
128        in_file  = test.input()
129
130        # prepare the proper directories
131        test.prepare()
132
133        # remove any outputs from the previous tests to prevent side effects
134        rm( (out_file, err_file, test.target()) )
135
136        options = "-debug" if debug else "-nodebug"
137
138        # build, skipping to next test on error
139        make_ret, _ = make( test.target(),
140                flags      = """DEBUG_FLAGS="%s" """ % options,
141                redirects  = "2> %s 1> /dev/null" % out_file,
142                error_file = err_file
143        )
144
145        retcode = 0
146        error = None
147
148        # if the make command succeds continue otherwise skip to diff
149        if make_ret == 0 or settings.dry_run:
150                if settings.dry_run or fileIsExecutable(test.target()) :
151                        # run test
152                        retcode, _ = sh("timeout 60 %s > %s 2>&1" % (test.target(), out_file), input = in_file)
153                else :
154                        # simply cat the result into the output
155                        sh("cat %s > %s" % (test.target(), out_file))
156        else:
157                sh("mv %s %s" % (err_file, out_file))
158
159
160        if retcode == 0:
161                if settings.generating :
162                        # if we are ounly generating the output we still need to check that the test actually exists
163                        if not settings.dry_run and fileContainsOnly(out_file, "make: *** No rule to make target `%s'.  Stop." % test.target()) :
164                                retcode = 1;
165                                error = "\t\tNo make target for test %s!" % test.target()
166                                sh("rm %s" % out_file, False)
167                else :
168                        # fetch return code and error from the diff command
169                        retcode, error = diff(cmp_file, out_file)
170
171        else:
172                with open (out_file, "r") as myfile:
173                        error = myfile.read()
174
175
176        # clean the executable
177        sh("rm -f %s > /dev/null 2>&1" % test.target())
178
179        return retcode, error
180
181# run a single test and handle the errors, outputs, printing, exception handling, etc.
182def run_test_worker(t, debug) :
183
184        with SignalHandling():
185                # print formated name
186                name_txt = "%20s  " % t.name
187
188                retcode, error = run_single_test(t, debug)
189
190                # update output based on current action
191                result_txt = TestResult.toString( retcode )
192
193                #print result with error if needed
194                text = name_txt + result_txt
195                out = sys.stdout
196                if error :
197                        text = text + "\n" + error
198                        out = sys.stderr
199
200                print(text, file = out)
201                sys.stdout.flush()
202                sys.stderr.flush()
203
204        return retcode != TestResult.SUCCESS
205
206# run the given list of tests with the given parameters
207def run_tests(tests, jobs, debug) :
208        # clean the sandbox from previous commands
209        make('clean', redirects = '> /dev/null 2>&1')
210
211        # create the executor for our jobs and handle the signal properly
212        pool = setupPool(jobs)
213
214        # for each test to run
215        try :
216                results = pool.map_async(
217                        functools.partial(run_test_worker, debug=debug),
218                        tests,
219                        chunksize = 1
220                ).get(7200)
221        except KeyboardInterrupt:
222                pool.terminate()
223                print("Tests interrupted by user")
224                sys.exit(1)
225
226        # clean the workspace
227        make('clean', redirects = '> /dev/null 2>&1')
228
229        for failed in results:
230                if failed :
231                        return 1
232
233        return 0
234
235
236################################################################################
237#               main loop
238################################################################################
239if __name__ == "__main__":
240        #always run from same folder
241        chdir()
242
243        # parse the command line arguments
244        options = getOptions()
245
246        # init global settings
247        settings.init( options )
248
249        # fetch the liest of all valid tests
250        allTests = listTests( options.include, options.exclude )
251
252        # if user wants all tests than no other treatement of the test list is required
253        if options.all or options.list or options.list_comp or options.include :
254                tests = allTests
255
256        else :
257                #otherwise we need to validate that the test list that was entered is valid
258                tests = validTests( options )
259
260        # sort the test alphabetically for convenience
261        tests.sort(key=lambda t: t.target())
262
263        # users may want to simply list the tests
264        if options.list_comp :
265                print("-h --help --debug --dry-run --list --all --regenerate-expected -j --jobs ", end='')
266                print(" ".join(map(lambda t: "%s" % (t.target()), tests)))
267
268        elif options.list :
269                print("Listing for %s:%s"% (settings.arch.toString(), "debug" if options.debug else "no debug"))
270                print("\n".join(map(lambda t: "%s" % (t.toString()), tests)))
271
272        else :
273                options.jobs, forceJobs = jobCount( options, tests )
274                settings.updateMakeCmd(forceJobs, options.jobs)
275
276                print('%s (%s:%s) on %i cores' % (
277                        'Regenerate tests' if settings.generating else 'Running',
278                        settings.arch.toString(),
279                        "debug" if options.debug else "no debug",
280                        options.jobs
281                ))
282
283                # otherwise run all tests and make sure to return the correct error code
284                sys.exit( run_tests(tests, options.jobs, options.debug) )
Note: See TracBrowser for help on using the repository browser.