source: src/tests/test.py @ 0e7b95c

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

Tests now run with concurrency by default

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