source: src/tests/test.py @ be65cca

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

Concurrent tests no longer run when threading is disable

  • Property mode set to 100755
File size: 11.3 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 subprocess import Popen, PIPE, STDOUT
9
10import argparse
11import os
12import re
13import stat
14import sys
15
16################################################################################
17#               help functions
18################################################################################
19
20# Test class that defines what a test is
21class Test:
22    def __init__(self, name, path):
23        self.name, self.path = name, path
24
25# parses the Makefile to find the machine type (32-bit / 64-bit)
26def getMachineType():
27        sh('echo "int main() { return 0; }" > .dummy.c')
28        sh("make .dummy", print2stdout=False)
29        _, out = sh("file .dummy", print2stdout=False)
30        sh("rm -f .dummy.c > /dev/null 2>&1")
31        sh("rm -f .dummy > /dev/null 2>&1")
32        return re.search("ELF\s([0-9]+)-bit", out).group(1)
33
34def listTestsFolder(folder) :
35        path = ('./.expect/%s' % folder) if folder else './expect'
36
37        # tests directly in the .expect folder will always be processed
38        return map(lambda fname: Test(fname, '%s/%s' % (path, fname)),
39                [splitext(f)[0] for f in listdir( path )
40                if not f.startswith('.') and f.endswith('.txt')
41                ])
42
43# reads the directory ./.expect and indentifies the tests
44def listTests( concurrent ):
45        machineType = getMachineType()
46
47        # tests directly in the .expect folder will always be processed
48        generic_list = listTestsFolder( "." )
49
50        # tests in the machineType folder will be ran only for the corresponding compiler
51        typed_list = listTestsFolder( machineType )
52
53        # tests in the concurrent folder will be ran only if concurrency is enabled
54        concurrent_list = listTestsFolder( "concurrent" ) if concurrent else []
55
56        # append both lists to get
57        return generic_list + typed_list + concurrent_list;
58
59# helper functions to run terminal commands
60def sh(cmd, dry_run = False, print2stdout = True):
61        if dry_run :    # if this is a dry_run, only print the commands that would be ran
62                print("cmd: %s" % cmd)
63                return 0, None
64        else :                  # otherwise create a pipe and run the desired command
65                proc = Popen(cmd, stdout=None if print2stdout else PIPE, stderr=STDOUT, shell=True)
66                out, err = proc.communicate()
67                return proc.returncode, out
68
69# helper function to replace patterns in a file
70def file_replace(fname, pat, s_after):
71    # first, see if the pattern is even in the file.
72    with open(fname) as f:
73        if not any(re.search(pat, line) for line in f):
74            return # pattern does not occur in file so we are done.
75
76    # pattern is in the file, so perform replace operation.
77    with open(fname) as f:
78        out_fname = fname + ".tmp"
79        out = open(out_fname, "w")
80        for line in f:
81            out.write(re.sub(pat, s_after, line))
82        out.close()
83        os.rename(out_fname, fname)
84
85# tests output may differ depending on the depth of the makefile
86def fix_MakeLevel(file) :
87        if environ.get('MAKELEVEL') :
88                file_replace(file, "make\[%i\]" % int(environ.get('MAKELEVEL')), 'make' )
89
90# helper function to check if a files contains only a spacific string
91def fileContainsOnly(file, text) :
92        with open(file) as f:
93                ff = f.read().strip()
94                result = ff == text.strip()
95
96                return result;
97
98# check whether or not a file is executable
99def fileIsExecutable(file) :
100        try :
101                fileinfo = os.stat(file)
102                return bool(fileinfo.st_mode & stat.S_IXUSR)
103        except Exception as inst:
104                print(type(inst))    # the exception instance
105                print(inst.args)     # arguments stored in .args
106                print(inst)
107                return False
108
109################################################################################
110#               running test functions
111################################################################################
112def run_single_test(test, generate, dry_run, debug):
113
114        # find the output file based on the test name and options flag
115        out_file = (".out/%s.log" % test.name) if not generate else (".expect/%s.txt" % test.path)
116
117        # remove any outputs from the previous tests to prevent side effects
118        sh("rm -f %s" % out_file, dry_run)
119        sh("rm -f %s > /dev/null 2>&1" % test.name, dry_run)
120
121        options = "-debug" if debug else "-nodebug";
122
123        # build, skipping to next test on error
124        make_ret, _ = sh("""%s EXTRA_FLAGS="-quiet %s" %s 2> %s 1> /dev/null""" % (make_cmd, options, test.name, out_file), dry_run)
125
126        # if the make command succeds continue otherwise skip to diff
127        if make_ret == 0 :
128                # fetch optional input
129                stdinput = "< .in/%s.txt" % test.name if isfile(".in/%s.txt" % test.path) else ""
130
131                if fileIsExecutable(test.name) :
132                        # run test
133                        sh("./%s %s > %s 2>&1" % (test.name, stdinput, out_file), dry_run)
134                else :
135                        # simply cat the result into the output
136                        sh("cat %s > %s" % (test.name, out_file), dry_run)
137
138        retcode = 0
139        error = None
140
141        # fix output to prevent make depth to cause issues
142        fix_MakeLevel(out_file)
143
144        if generate :
145                # if we are ounly generating the output we still need to check that the test actually exists
146                if not dry_run and fileContainsOnly(out_file, "make: *** No rule to make target `%s'.  Stop." % test.name) :
147                        retcode = 1;
148                        error = "\t\tNo make target for test %s!" % test.name
149                        sh("rm %s" % out_file, False)
150
151        else :
152                # diff the output of the files
153                diff_cmd = ("diff --old-group-format='\t\tmissing lines :\n"
154                                        "%%<' \\\n"
155                                        "--new-group-format='\t\tnew lines :\n"
156                                        "%%>' \\\n"
157                                        "--unchanged-group-format='%%=' \\"
158                                        "--changed-group-format='\t\texpected :\n"
159                                        "%%<\n"
160                                        "\t\tgot :\n"
161                                        "%%>' \\\n"
162                                        "--new-line-format='\t\t%%dn\t%%L' \\\n"
163                                        "--old-line-format='\t\t%%dn\t%%L' \\\n"
164                                        "--unchanged-line-format='' \\\n"
165                                        ".expect/%s.txt .out/%s.log")
166
167                # fetch return code and error from the diff command
168                retcode, error = sh(diff_cmd % (test.path, test.name), dry_run, False)
169
170        # clean the executable
171        sh("rm -f %s > /dev/null 2>&1" % test.name, dry_run)
172
173        return retcode, error
174
175def run_test_instance(t, generate, dry_run, debug) :
176        try :
177                # print formated name
178                name_txt = "%20s  " % t.name
179
180                #run the test instance and collect the result
181                test_failed, error = run_single_test(t, generate, dry_run, debug)
182
183                # update output based on current action
184                if generate :
185                        failed_txt = "ERROR"
186                        success_txt = "Done"
187                else :
188                        failed_txt = "FAILED"
189                        success_txt = "PASSED"
190
191                #print result with error if needed
192                text = name_txt + (failed_txt if test_failed else success_txt)
193                out = sys.stdout
194                if error :
195                        text = text + "\n" + error
196                        out = sys.stderr
197
198                print(text, file = out);
199                sys.stdout.flush()
200                sys.stderr.flush()
201                return test_failed
202
203        except KeyboardInterrupt:
204                test_failed = True
205
206
207# run the given list of tests with the given parameters
208def run_tests(tests, generate, dry_run, jobs, debug) :
209        # clean the sandbox from previous commands
210        sh("%s clean > /dev/null 2>&1" % make_cmd, dry_run)
211
212        #make sure the required folder are present
213        sh('mkdir -p .out .expect', dry_run)
214
215        if generate :
216                print( "Regenerate tests for: " )
217
218        # for each test to run
219        pool = Pool(jobs)
220        try :
221                results = pool.map_async(partial(run_test_instance, generate=generate, dry_run=dry_run, debug=debug), tests ).get(9999)
222        except KeyboardInterrupt:
223                pool.terminate()
224                print("Tests interrupted by user")
225                sys.exit(1)
226
227        #clean the workspace
228        sh("%s clean > /dev/null 2>&1" % make_cmd, dry_run)
229
230        for failed in results:
231                if failed :
232                        return 1
233
234        return 0
235
236def yes_no(string):
237        if string == "yes" :
238                return True
239        if string == "no" :
240                return False
241        raise argparse.ArgumentTypeError(msg)
242        return False
243
244
245################################################################################
246#               main loop
247################################################################################
248# create a parser with the arguments for the tests script
249parser = argparse.ArgumentParser(description='Script which runs cforall tests')
250parser.add_argument('--debug', help='Run all tests in debug or release', type=yes_no, default='no')
251parser.add_argument('--concurrent', help='Run concurrent tests', type=yes_no, default='no')
252parser.add_argument('--dry-run', help='Don\'t run the tests, only output the commands', action='store_true')
253parser.add_argument('--list', help='List all test available', action='store_true')
254parser.add_argument('--all', help='Run all test available', action='store_true')
255parser.add_argument('--regenerate-expected', help='Regenerate the .expect by running the specified tets, can be used with --all option', action='store_true')
256parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously', type=int, default='8')
257parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run')
258
259# parse the command line arguments
260options = parser.parse_args()
261
262# script must have at least some tests to run
263if (len(options.tests) > 0  and     options.all and not options.list) \
264or (len(options.tests) == 0 and not options.all and not options.list) :
265        print('ERROR: must have option \'--all\' or non-empty test list', file=sys.stderr)
266        parser.print_help()
267        sys.exit(1)
268
269print( options.concurrent )
270
271# fetch the liest of all valid tests
272allTests = listTests( options.concurrent )
273
274# if user wants all tests than no other treatement of the test list is required
275if options.all or options.list :
276        tests = allTests
277
278else :
279        #otherwise we need to validate that the test list that was entered is valid
280        tests = []
281
282        # if we are regenerating the tests we need to find the information of the
283        # already existing tests and create new info for the new tests
284        if options.regenerate_expected :
285                for testname in options.tests :
286                        if testname.endswith(".c") or testname.endswith(".cc") or testname.endswith(".cpp") :
287                                print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr)
288                        else :
289                                found = [test for test in allTests if test.name == testname]
290                                tests.append( found[0] if len(found) == 1 else Test(testname, testname) )
291
292        else :
293                # otherwise we only need to validate that all tests are present in the complete list
294                for testname in options.tests:
295                        test = [t for t in allTests if t.name == testname]
296
297                        if len(test) != 0 :
298                                tests.append( test[0] )
299                        else :
300                                print('ERROR: No expected file for test %s, ignoring it' % testname, file=sys.stderr)
301
302        # make sure we have at least some test to run
303        if len(tests) == 0 :
304                print('ERROR: No valid test to run', file=sys.stderr)
305                sys.exit(1)
306
307# sort the test alphabetically for convenience
308tests.sort(key=lambda t: t.name)
309
310# check if the user already passed in a number of jobs for multi-threading
311make_flags = environ.get('MAKEFLAGS')
312make_jobs_fds = re.search("--jobserver-fds=\s*([0-9]+),([0-9]+)", make_flags) if make_flags else None
313if make_jobs_fds :
314        tokens = os.read(int(make_jobs_fds.group(1)), 1024)
315        options.jobs = len(tokens)
316        os.write(int(make_jobs_fds.group(2)), tokens)
317
318# make sure we have a valid number of jobs that corresponds to user input
319if options.jobs <= 0 :
320        print('ERROR: Invalid number of jobs', file=sys.stderr)
321        sys.exit(1)
322
323print('Running (%s) on %i cores' % ("debug" if options.debug else "no debug", options.jobs))
324make_cmd = "make" if make_flags else ("make -j%i" % options.jobs)
325
326# users may want to simply list the tests
327if options.list :
328        print("\n".join(map(lambda t: "%s (%s)" % (t.name, t.path), tests)))
329
330else :
331        # otherwise run all tests and make sure to return the correct error code
332        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.