source: tests/test.py

Last change on this file was e85a72b8, checked in by Peter A. Buhr <pabuhr@…>, 6 months ago

change valide (French) to valid (English)

  • Property mode set to 100755
File size: 15.6 KB
Line 
1#!/usr/bin/python3
2
3from pybin.tools import *
4from pybin.test_run import *
5from pybin import settings
6
7import argparse
8import itertools
9import re
10import sys
11import tempfile
12import time
13
14import os
15import signal
16
17################################################################################
18#               help functions
19################################################################################
20
21def find_tests():
22        expected = []
23
24        def match_test(path):
25                match = re.search("^%s\/([\w\/\-_]*).expect\/([\w\-_\+]+)(\.[\w\-_]+)?\.txt$" % settings.SRCDIR, path)
26                if match :
27                        test = Test()
28                        test.name = match.group(2)
29                        test.path = match.group(1)
30                        test.arch = match.group(3)[1:] if match.group(3) else None
31
32                        expected.append(test)
33
34        path_walk( match_test )
35
36        return expected
37
38# reads the directory ./.expect and indentifies the tests
39def list_tests( includes, excludes ):
40        # tests directly in the .expect folder will always be processed
41        test_list = find_tests()
42
43        # if we have a limited number of includes, filter by them
44        if includes:
45                test_list = [x for x in test_list if
46                        x.target().startswith( tuple(includes) )
47                ]
48
49        # # if we have a folders to excludes, filter by them
50        if excludes:
51                test_list = [x for x in test_list if not
52                        x.target().startswith( tuple(excludes) )
53                ]
54
55        # sort the test alphabetically for convenience
56        test_list.sort(key=lambda t: ('~' if t.arch else '') + t.target() + (t.arch if t.arch else ''))
57
58        return test_list
59
60# from the found tests, filter all the valid tests/desired tests
61def valid_tests( options ):
62        tests = []
63
64        # if we are regenerating the tests we need to find the information of the
65        # already existing tests and create new info for the new tests
66        if options.regenerate_expected :
67                for testname in options.tests :
68                        testname = os.path.normpath( os.path.join(settings.SRCDIR, testname) )
69
70                        # first check if this is a valid name to regenerate
71                        if Test.valid_name(testname):
72                                # this is a valid name, let's check if it already exists
73                                found = [test for test in all_tests if canonical_path( test.target() ) == testname]
74                                setup = settings.all_arch if options.arch else [None]
75                                if not found:
76                                        # it's a new name, create it according to the name and specified architecture
77                                        tests.extend( [Test.new_target(testname, arch) for arch in setup] )
78                                elif len(found) == 1 and not found[0].arch:
79                                        # we found a single test, the user better be wanting to create a cross platform test
80                                        if options.arch:
81                                                print('ERROR: "%s", test has no specified architecture but --arch was specified, ignoring it' % testname, file=sys.stderr)
82                                        else:
83                                                tests.append( found[0] )
84                                else:
85                                        # this test is already cross platform, just add a test for each platform the user asked
86                                        tests.extend( [Test.new_target(testname, arch) for arch in setup] )
87
88                                        # print a warning if it users didn't ask for a specific architecture
89                                        found_arch = [f.arch for f in found if f.arch]
90                                        if found_arch and not options.arch:
91                                                print('WARNING: "%s", test has architecture specific expected files but --arch was not specified, regenerating only for current host' % testname, file=sys.stderr)
92
93                        else :
94                                print('ERROR: "%s", tests are not allowed to end with a C/C++/CFA extension, ignoring it' % testname, file=sys.stderr)
95
96        else :
97                # otherwise we only need to validate that all tests are present in the complete list
98                for testname in options.tests:
99                        test = [t for t in all_tests if path_cmp( t.target(), testname )]
100
101                        if test :
102                                tests.extend( test )
103                        else :
104                                print('ERROR: No expected file for test %s, ignoring it' % testname, file=sys.stderr)
105
106        return tests
107
108# parses the option
109def parse_args():
110        # create a parser with the arguments for the tests script
111        parser = argparse.ArgumentParser(description='Script which runs cforall tests')
112        parser.add_argument('--arch', help='Test for specific architecture', type=comma_separated(str), default=None)
113        parser.add_argument('--debug', help='Run all tests in debug or release', type=comma_separated(yes_no), default='yes')
114        parser.add_argument('--install', help='Run all tests based on installed binaries or tree binaries', type=comma_separated(yes_no), default='no')
115        parser.add_argument('--continue', help='When multiple specifications are passed (debug/install/arch), sets whether or not to continue if the last specification failed', type=yes_no, default='yes', dest='continue_')
116        parser.add_argument('--no-invariant', help='Tell the compiler not to check invariants.', action='store_false', dest='invariant')
117        parser.add_argument('--invariant', help='Tell the compiler to check invariants.', action='store_const', const=True)
118        parser.add_argument('--timeout', help='Maximum duration in seconds after a single test is considered to have timed out', type=int, default=240)
119        parser.add_argument('--global-timeout', help='Maximum cumulative duration in seconds after the ALL tests are considered to have timed out', type=int, default=7200)
120        parser.add_argument('--timeout-with-gdb', help='Instead of killing the command when it times out, orphan it and print process id to allow gdb to attach', type=yes_no, default="no")
121        parser.add_argument('--dry-run', help='Don\'t run the tests, only output the commands', action='store_true')
122        parser.add_argument('--list', help='List all test available', action='store_true')
123        parser.add_argument('--all', help='Run all test available', action='store_true')
124        parser.add_argument('--regenerate-expected', help='Regenerate the .expect by running the specified tets, can be used with --all option', action='store_true')
125        parser.add_argument('--archive-errors', help='If called with a valid path, on test crashes the test script will copy the core dump and the executable to the specified path.', type=str, default='')
126        parser.add_argument('-j', '--jobs', help='Number of tests to run simultaneously, 0 (default) for unlimited', nargs='?', const=0, type=int)
127        parser.add_argument('--list-comp', help='List all valid arguments', action='store_true')
128        parser.add_argument('--list-dist', help='List all tests for distribution', action='store_true')
129        parser.add_argument('-I','--include', help='Directory of test to include, can be used multiple time, All  if omitted', action='append')
130        parser.add_argument('-E','--exclude', help='Directory of test to exclude, can be used multiple time, None if omitted', action='append')
131        parser.add_argument('tests', metavar='test', type=str, nargs='*', help='a list of tests to run')
132
133        try:
134                options =  parser.parse_args()
135        except:
136                print('ERROR: invalid arguments', file=sys.stderr)
137                parser.print_help(sys.stderr)
138                sys.exit(1)
139
140        # script must have at least some tests to run or be listing
141        listing    = options.list or options.list_comp or options.list_dist
142        all_tests  = options.all
143        some_tests = len(options.tests) > 0
144        some_dirs  = len(options.include) > 0 if options.include else 0
145
146        # check that exactly one of the booleans is set to true
147        if not sum( (listing, all_tests, some_tests, some_dirs) ) > 0 :
148                print('''ERROR: must have option '--all', '--list', '--include', '-I' or non-empty test list''', file=sys.stderr)
149                parser.print_help()
150                sys.exit(1)
151
152        return options
153
154################################################################################
155#               running test functions
156################################################################################
157def success(val):
158        return val == 0 or settings.dry_run
159
160def no_rule(file, target):
161        return not settings.dry_run and file_contains_only(file, "make: *** No rule to make target `%s'.  Stop." % target)
162
163# logic to run a single test and return the result (No handling of printing or other test framework logic)
164def run_single_test(test):
165
166        # find the output file based on the test name and options flag
167        exe_file = test.target_executable();
168        out_file = test.target_output()
169        err_file = test.error_log()
170        cmp_file = test.expect()
171        in_file  = test.input()
172
173        # prepare the proper directories
174        test.prepare()
175
176        # extra flags for cfa to pass through make.
177        cfa_flags = 'CFAFLAGS=--invariant' if settings.invariant else None
178
179        # ----------
180        # MAKE
181        # ----------
182        # build, skipping to next test on error
183        with Timed() as comp_dur:
184                make_ret, _, _ = make(test.target(), flags=cfa_flags, output_file=subprocess.DEVNULL, error=out_file, error_file=err_file)
185
186        # ----------
187        # RUN
188        # ----------
189        # run everything in a temp directory to make sure core file are handled properly
190        run_dur = None
191        with tempdir():
192                # if the make command succeeds continue otherwise skip to diff
193                if success(make_ret):
194                        with Timed() as run_dur:
195                                if settings.dry_run or is_exe(exe_file):
196                                        # run test
197                                        retcode, _, _ = sh(exe_file, output_file=out_file, input_file=in_file, timeout=True, nice=True)
198                                else :
199                                        # simply cat the result into the output
200                                        retcode = cat(exe_file, out_file)
201                else:
202                        retcode = mv(err_file, out_file)
203
204                if success(retcode):
205                        if settings.generating :
206                                # if we are only generating the output we still need to check that the test actually exists
207                                if no_rule(out_file, test.target()) :
208                                        retcode = 1
209                                        error = "\t\tNo make target for test %s!" % test.target()
210                                        rm(out_file)
211                                else:
212                                        error = None
213                        else :
214                                # fetch return code and error from the diff command
215                                retcode, error, _ = diff(cmp_file, out_file)
216
217                else:
218                        if os.stat(out_file).st_size < 1048576:
219                                with open (out_file, "r", encoding='latin-1') as myfile:  # use latin-1 so all chars mean something.
220                                        error = myfile.read()
221                        else:
222                                error = "Output log can't be read, file is bigger than 1MB, see {} for actual error\n".format(out_file)
223
224                        ret, info = core_info(exe_file)
225                        error = error + info if error else info
226
227                        if settings.archive:
228                                error = error + '\n' + core_archive(settings.archive, test.target(), exe_file)
229
230
231
232        # clean the executable
233        rm(exe_file)
234
235        return retcode, error, [comp_dur.duration, run_dur.duration if run_dur else None]
236
237# run a single test and handle the errors, outputs, printing, exception handling, etc.
238def run_test_worker(t) :
239        try :
240                # print formated name
241                name_txt = t.format_target(width=settings.output_width) + '  '
242
243                retcode, error, duration = run_single_test(t)
244
245                # update output based on current action
246                result_key, result_txt = TestResult.toString( retcode, duration )
247
248                #print result with error if needed
249                text = '\t' + name_txt + result_txt
250                out = sys.stdout
251                if error :
252                        text = text + '\n' + error
253
254                return retcode == TestResult.SUCCESS, result_key, text
255        except KeyboardInterrupt:
256                return False, 'keybrd', ""
257        # except Exception as ex:
258        #       print("Unexpected error in worker thread running {}: {}".format(t.target(), ex), file=sys.stderr)
259        #       sys.stderr.flush()
260        #       return False, ""
261
262
263# run the given list of tests with the given parameters
264def run_tests(tests, jobs) :
265        # clean the sandbox from previous commands
266        make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL)
267
268        # create the executor for our jobs
269        pool = multiprocessing.Pool(jobs)
270
271        failed = False
272        rescnts = {     'pass': 0, 'fail': 0, 'time': 0, 'keybrd': 0 }
273        other = 0
274
275        # for each test to run
276        try :
277                num = len(tests)
278                fancy = sys.stdout.isatty()
279                results = pool.imap_unordered(
280                        run_test_worker,
281                        tests,
282                        chunksize = 1
283                )
284
285                for i, (succ, code, txt) in enumerate(timed(results, timeout = settings.timeout.total), 1) :
286                        if code in rescnts.keys():
287                                rescnts[code] += 1
288                        else:
289                                other += 1
290
291                        if not succ :
292                                failed = True
293
294                        print("       " + txt)
295
296                        if(fancy and i != num):
297                                print("%d/%d" % (i, num), end='\r')
298                                sys.stdout.flush()
299
300        except KeyboardInterrupt:
301                print("Tests interrupted by user", file=sys.stderr)
302                pool.terminate()
303                pool.join()
304                failed = True
305        except multiprocessing.TimeoutError:
306                print("ERROR: Test suite timed out", file=sys.stderr)
307                pool.terminate()
308                pool.join()
309                failed = True
310                killgroup() # needed to cleanly kill all children
311
312
313        # clean the workspace
314        make('clean', output_file=subprocess.DEVNULL, error=subprocess.DEVNULL)
315
316        print("{} passes, {} failures, {} timeouts, {} cancelled, {} other".format(rescnts['pass'], rescnts['fail'], rescnts['time'], rescnts['keybrd'], other))
317
318        return failed
319
320
321################################################################################
322#               main loop
323################################################################################
324if __name__ == "__main__":
325
326        # parse the command line arguments
327        options = parse_args()
328
329        # init global settings
330        settings.init( options )
331
332        # --------------------------------------------------
333        # list all the test for auto completion programs
334        # not pretty, single line, with the command line options
335        if options.list_comp :
336                # fetch the liest of all valid tests
337                tests = list_tests( None, None )
338
339                # print the possible options
340                print("-h --help --debug --dry-run --list --arch --all --regenerate-expected --archive-errors --install --timeout --global-timeout --timeout-with-gdb -j --jobs -I --include -E --exclude --continue ", end='')
341                print(" ".join(map(lambda t: "%s" % (t.target()), tests)))
342
343                # done
344                sys.exit(0)
345
346        # --------------------------------------------------
347        # list all the test for auto completion programs
348        if options.list_dist :
349                # fetch the liest of all valid tests
350                tests = list_tests( None, None )
351
352                for t in tests:
353                        print(os.path.relpath(t.expect(), settings.SRCDIR), end=' ')
354                        print(os.path.relpath(t.input() , settings.SRCDIR), end=' ')
355                        code, out, err = make_recon(t.target())
356
357                        if code != 0:
358                                print('ERROR: recond failed for test {}: {} \'{}\''.format(t.target(), code, err), file=sys.stderr)
359                                sys.exit(1)
360
361                        print(' '.join(re.findall('([^\s]+\.cfa)', out)), end=' ')
362
363                print('')
364
365                # done
366                sys.exit(0)
367
368
369        # --------------------------------------------------
370        # list all the tests for users, in a pretty format
371        if options.list :
372                # fetch the liest of all valid tests
373                tests = list_tests( options.include, options.exclude )
374
375                # print the available tests
376                fancy_print("\n".join(map(lambda t: t.toString(), tests)))
377
378                # done
379                sys.exit(0)
380
381        # fetch the liest of all valid tests
382        all_tests = list_tests( options.include, options.exclude )
383
384        # if user wants all tests than no other treatement of the test list is required
385        if options.all or options.include :
386                tests = all_tests
387
388        #otherwise we need to validate that the test list that was entered is valid
389        else :
390                tests = valid_tests( options )
391
392        # make sure we have at least some test to run
393        if not tests :
394                print('ERROR: No valid test to run', file=sys.stderr)
395                sys.exit(1)
396
397        # prep invariants
398        settings.prep_output(tests)
399        failed = 0
400
401        # check if the expected files aren't empty
402        if not options.regenerate_expected:
403                for t in tests:
404                        if is_empty(t.expect()):
405                                print('WARNING: test "{}" has empty .expect file'.format(t.target()), file=sys.stderr)
406
407        options.jobs = job_count( options )
408
409        # for each build configurations, run the test
410        with Timed() as total_dur:
411                for arch, debug, install in itertools.product(settings.all_arch, settings.all_debug, settings.all_install):
412                        settings.arch    = arch
413                        settings.debug   = debug
414                        settings.install = install
415
416                        # filter out the tests for a different architecture
417                        # tests are the same across debug/install
418                        local_tests = settings.arch.filter( tests )
419
420                        # check the build configuration works
421                        settings.validate()
422                        jobs = min(options.jobs, len(local_tests))
423
424                        # print configuration
425                        print('%s %i tests on %i cores (%s - %s)' % (
426                                'Regenerating' if settings.generating else 'Running',
427                                len(local_tests),
428                                jobs,
429                                settings.arch.string,
430                                settings.debug.string
431                        ))
432                        if not local_tests :
433                                print('WARNING: No tests for this configuration')
434                                continue
435
436                        # otherwise run all tests and make sure to return the correct error code
437                        failed = run_tests(local_tests, jobs)
438                        if failed:
439                                if not settings.continue_:
440                                        break
441
442        print('Tests took %s' % fmtDur( total_dur.duration ))
443        sys.exit( failed )
Note: See TracBrowser for help on using the repository browser.