source: src/tests/test.py @ 00303d50

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

Fixed attributes test and added more error handling for machine type

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