source: src/tests/test.py @ 066d77a

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since 066d77a was 850fda6, checked in by Thierry Delisle <tdelisle@…>, 8 years ago

tests now properly use GNU jobserver pipes to count available make jobs

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