Context Navigation

source: tests/test.py @ 9139540

ADTarm-ehast-experimentalenumforall-pointer-decayjacob/cs343-translationnew-ast-unique-exprpthread-emulationqualifiedEnum

Last change on this file since 9139540 was ad4832f1, checked in by Thierry Delisle <tdelisle@…>, 4 years ago
Fix check in regenerate expected for inconsistent settings.
Property mode set to `100755`
File size: 15.1 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: