source: src/tests/test.py @ 6e206cb

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 6e206cb was 6e206cb, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

tests run with chunksize = 1 to take advantage of cores

  • Property mode set to 100755
File size: 10.8 KB
Line 
1#!/usr/bin/python
2from __future__ import print_function
3
4from functools import partial
5from multiprocessing import Pool
6from os import listdir, environ
7from os.path import isfile, join, splitext
8from pybin.tools import *
9
10import argparse
11import multiprocessing
12import os
13import re
14import signal
15import sys
16
17################################################################################
18#               help functions
19################################################################################
20
21# Test class that defines what a test is
22class Test:
23    def __init__(self, name, path):
24        self.name, self.path = name, path
25
26class TestResult:
27        SUCCESS = 0
28        FAILURE = 1
29        TIMEOUT = 124
30
31# parses the Makefile to find the machine type (32-bit / 64-bit)
32def getMachineType():
33        sh('echo "void ?{}(int*a,int b){}int main(){return 0;}" > .dummy.c')
34        ret, out = sh("make .dummy -s", print2stdout=True)
35
36        if ret != 0:
37                print("Failed to identify architecture:")
38                print(out)
39                print("Stopping")
40                rm( (".dummy.c",".dummy") )
41                sys.exit(1)
42
43        _, out = sh("file .dummy", print2stdout=False)
44        rm( (".dummy.c",".dummy") )
45
46        return re.search("ELF\s([0-9]+)-bit", out).group(1)
47
48def listTestsFolder(folder) :
49        path = ('./.expect/%s/' % folder) if folder else './.expect/'
50        subpath = "%s/" % folder if folder else ""
51
52        # tests directly in the .expect folder will always be processed
53        return map(lambda fname: Test(fname, subpath + fname),
54                [splitext(f)[0] for f in listdir( path )
55                if not f.startswith('.') and f.endswith('.txt')
56                ])
57
58# reads the directory ./.expect and indentifies the tests
59def listTests( concurrent ):
60        machineType = getMachineType()
61
62        # tests directly in the .expect folder will always be processed
63        generic_list = listTestsFolder( "" )
64
65        # tests in the machineType folder will be ran only for the corresponding compiler
66        typed_list = listTestsFolder( machineType )
67
68        # tests in the concurrent folder will be ran only if concurrency is enabled
69        concurrent_list = listTestsFolder( "concurrent" ) if concurrent else []
70
71        # append both lists to get
72        return generic_list + typed_list + concurrent_list;
73
74# from the found tests, filter all the valid tests/desired tests
75def validTests( options ):
76        tests = []
77
78        # if we are regenerating the tests we need to find the information of the
79        # already existing tests and create new info for the new tests
80        if options.regenerate_expected :
81                for testname in options.tests :
82                        if testname.endswith( (".c", ".cc", ".cpp") ):
83                                print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr)
84                        else :
85                                found = [test for test in allTests if test.name == testname]
86                                tests.append( found[0] if len(found) == 1 else Test(testname, testname) )
87
88        else :
89                # otherwise we only need to validate that all tests are present in the complete list
90                for testname in options.tests:
91                        test = [t for t in allTests if t.name == testname]
92
93                        if len(test) != 0 :
94                                tests.append( test[0] )
95                        else :
96                                print('ERROR: No expected file for test %s, ignoring it' % testname, file=sys.stderr)
97
98        # make sure we have at least some test to run
99        if len(tests) == 0 :
100                print('ERROR: No valid test to run', file=sys.stderr)
101                sys.exit(1)
102
103        return tests
104
105# parses the option
106def getOptions():
107        # create a parser with the arguments for the tests script
108        parser = argparse.ArgumentParser(description='Script which runs cforall tests')
109        parser.add_argument('--debug', help='Run all tests in debug or release', type=yes_no, default='no')
110        parser.add_argument('--concurrent', help='Run concurrent tests', type=yes_no, default='yes')
111        parser.add_argument('--dry-run', help='Don\'t run the tests, only output the commands', action='store_true')
112        parser.add_argument('--list', help='List all test available', action='store_true')
113        parser.add_argument('--all', help='Run all test available', action='store_true')
114        parser.add_argument('--regenerate-expected', help='Regenerate the .expect by running the specified tets, can be used with --all option', action='store_true')
115        parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously', type=int, default='8')
116        parser.add_argument('--list-comp', help='List all valide arguments', action='store_true')
117        parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run')
118
119        options =  parser.parse_args()
120
121        # script must have at least some tests to run or be listing
122        listing    = options.list or options.list_comp
123        all_tests  = options.all
124        some_tests = len(options.tests) > 0
125
126        # check that exactly one of the booleans is set to true
127        if not sum( (listing, all_tests, some_tests) ) == 1 :
128                print('ERROR: must have option \'--all\', \'--list\' or non-empty test list', file=sys.stderr)
129                parser.print_help()
130                sys.exit(1)
131
132        return options
133
134def jobCount( options ):
135        # check if the user already passed in a number of jobs for multi-threading
136        make_flags = environ.get('MAKEFLAGS')
137        make_jobs_fds = re.search("--jobserver-(auth|fds)=\s*([0-9]+),([0-9]+)", make_flags) if make_flags else None
138        if make_jobs_fds :
139                tokens = os.read(int(make_jobs_fds.group(2)), 1024)
140                options.jobs = len(tokens)
141                os.write(int(make_jobs_fds.group(3)), tokens)
142        else :
143                options.jobs = multiprocessing.cpu_count()
144
145        # make sure we have a valid number of jobs that corresponds to user input
146        if options.jobs <= 0 :
147                print('ERROR: Invalid number of jobs', file=sys.stderr)
148                sys.exit(1)
149
150        return min( options.jobs, len(tests) ), True if make_flags else False
151
152################################################################################
153#               running test functions
154################################################################################
155# logic to run a single test and return the result (No handling of printing or other test framework logic)
156def run_single_test(test, generate, dry_run, debug):
157
158        # find the output file based on the test name and options flag
159        out_file = (".out/%s.log" % test.name) if not generate else (".expect/%s.txt" % test.path)
160        err_file = ".err/%s.log" % test.name
161
162        # remove any outputs from the previous tests to prevent side effects
163        rm( (out_file, test.name), dry_run )
164
165        options = "-debug" if debug else "-nodebug"
166
167        # build, skipping to next test on error
168        make_ret, _ = sh("""%s test=yes EXTRA_FLAGS="%s" %s 2> %s 1> /dev/null""" % (make_cmd, options, test.name, out_file), dry_run)
169
170        retcode = 0
171        error = None
172
173        # if the make command succeds continue otherwise skip to diff
174        if make_ret == 0 :
175                # fetch optional input
176                stdinput = "< .in/%s.txt" % test.name if isfile(".in/%s.txt" % test.path) else ""
177
178                if fileIsExecutable(test.name) :
179                        # run test
180                        retcode, _ = sh("timeout 60 ./%s %s > %s 2>&1" % (test.name, stdinput, out_file), dry_run)
181                else :
182                        # simply cat the result into the output
183                        sh("cat %s > %s" % (test.name, out_file), dry_run)
184
185        else :
186                # command failed save the log to less temporary file
187                sh("mv %s %s" % (err_file, out_file), dry_run)
188
189        if retcode == 0:
190                if generate :
191                        # if we are ounly generating the output we still need to check that the test actually exists
192                        if not dry_run and fileContainsOnly(out_file, "make: *** No rule to make target `%s'.  Stop." % test.name) :
193                                retcode = 1;
194                                error = "\t\tNo make target for test %s!" % test.name
195                                sh("rm %s" % out_file, False)
196                else :
197                        # fetch return code and error from the diff command
198                        retcode, error = diff(".expect/%s.txt" % test.path, ".out/%s.log" % test.name, dry_run)
199        # clean the executable
200        sh("rm -f %s > /dev/null 2>&1" % test.name, dry_run)
201
202        return retcode, error
203
204# run a single test and handle the errors, outputs, printing, exception handling, etc.
205def run_test_worker(t, generate, dry_run, debug) :
206
207        signal.signal(signal.SIGINT, signal.SIG_DFL)
208        # print formated name
209        name_txt = "%20s  " % t.name
210
211        retcode, error = run_single_test(t, generate, dry_run, debug)
212
213        # update output based on current action
214        if generate :
215                if   retcode == TestResult.SUCCESS:     result_txt = "Done"
216                elif retcode == TestResult.TIMEOUT:     result_txt = "TIMEOUT"
217                else :                                          result_txt = "ERROR"
218        else :
219                if   retcode == TestResult.SUCCESS:     result_txt = "PASSED"
220                elif retcode == TestResult.TIMEOUT:     result_txt = "TIMEOUT"
221                else :                                          result_txt = "FAILED"
222
223        #print result with error if needed
224        text = name_txt + result_txt
225        out = sys.stdout
226        if error :
227                text = text + "\n" + error
228                out = sys.stderr
229
230        print(text, file = out)
231        sys.stdout.flush()
232        sys.stderr.flush()
233        signal.signal(signal.SIGINT, signal.SIG_IGN)
234
235        return retcode != TestResult.SUCCESS
236
237# run the given list of tests with the given parameters
238def run_tests(tests, generate, dry_run, jobs, debug) :
239        # clean the sandbox from previous commands
240        sh("%s clean > /dev/null 2>&1" % make_cmd, dry_run)
241
242        # make sure the required folder are present
243        sh('mkdir -p .out .expect .err', dry_run)
244
245        if generate :
246                print( "Regenerate tests for: " )
247
248        # create the executor for our jobs and handle the signal properly
249        original_sigint_handler = signal.signal(signal.SIGINT, signal.SIG_IGN)
250        pool = Pool(jobs)
251        signal.signal(signal.SIGINT, original_sigint_handler)
252
253        # for each test to run
254        try :
255                results = pool.map_async(partial(run_test_worker, generate=generate, dry_run=dry_run, debug=debug), tests, chunksize = 1 ).get(3600)
256        except KeyboardInterrupt:
257                pool.terminate()
258                print("Tests interrupted by user")
259                sys.exit(1)
260
261        # clean the workspace
262        sh("%s clean > /dev/null 2>&1" % make_cmd, dry_run)
263
264        for failed in results:
265                if failed :
266                        return 1
267
268        return 0
269
270
271################################################################################
272#               main loop
273################################################################################
274if __name__ == "__main__":
275        #always run from same folder
276        chdir()
277
278        # parse the command line arguments
279        options = getOptions()
280
281        # fetch the liest of all valid tests
282        allTests = listTests( options.concurrent )
283
284        # if user wants all tests than no other treatement of the test list is required
285        if options.all or options.list or options.list_comp :
286                tests = allTests
287
288        else :
289                #otherwise we need to validate that the test list that was entered is valid
290                tests = validTests( options )
291
292        # sort the test alphabetically for convenience
293        tests.sort(key=lambda t: t.name)
294
295        # users may want to simply list the tests
296        if options.list_comp :
297                print("-h --help --debug --concurrent --dry-run --list --all --regenerate-expected -j --jobs ", end='')
298                print(" ".join(map(lambda t: "%s" % (t.name), tests)))
299
300        elif options.list :
301                print("\n".join(map(lambda t: "%s (%s)" % (t.name, t.path), tests)))
302
303        else :
304                options.jobs, forceJobs = jobCount( options )
305
306                print('Running (%s) on %i cores' % ("debug" if options.debug else "no debug", options.jobs))
307                make_cmd = "make" if forceJobs else ("make -j%i" % options.jobs)
308
309                # otherwise run all tests and make sure to return the correct error code
310                sys.exit( run_tests(tests, options.regenerate_expected, options.dry_run, options.jobs, options.debug) )
Note: See TracBrowser for help on using the repository browser.