5 # runtest.py - wrapper script for running SCons tests
7 # This script mainly exists to set PYTHONPATH to the right list of
8 # directories to test the SCons modules.
10 # By default, it directly uses the modules in the local tree:
11 # ./src/ (source files we ship) and ./QMTest/ (other modules we don't).
13 # HOWEVER, now that SCons has Repository support, we don't have
14 # Aegis copy all of the files into the local tree. So if you're
15 # using Aegis and want to run tests by hand using this script, you
16 # must "aecp ." the entire source tree into your local directory
17 # structure. When you're done with your change, you can then
18 # "aecpu -unch ." to un-copy any files that you haven't changed.
20 # When any -p option is specified, this script assumes it's in a
21 # directory in which a build has been performed, and sets PYTHONPATH
22 # so that it *only* references the modules that have unpacked from
23 # the specified built package, to test whether the packages are good.
27 # -a Run all tests; does a virtual 'find' for
28 # all SCons tests under the current directory.
30 # --aegis Print test results to an output file (specified
31 # by the -o option) in the format expected by
32 # aetest(5). This is intended for use in the
33 # batch_test_command field in the Aegis project
36 # -d Debug. Runs the script under the Python
37 # debugger (pdb.py) so you don't have to
38 # muck with PYTHONPATH yourself.
40 # -f file Only execute the tests listed in the specified
43 # -h Print the help and exit.
45 # -l List available tests and exit.
47 # -n No execute, just print command lines.
49 # -o file Print test results to the specified file.
50 # The --aegis and --xml options specify the
53 # -P Python Use the specified Python interpreter.
55 # -p package Test against the specified package.
57 # --passed In the final summary, also report which tests
58 # passed. The default is to only report tests
59 # which failed or returned NO RESULT.
61 # -q Quiet. By default, runtest.py prints the
62 # command line it will execute before
63 # executing it. This suppresses that print.
65 # --sp The Aegis search path.
67 # --spe The Aegis executable search path.
69 # -t Print the execution time of each test.
71 # -X The scons "script" is an executable; don't
74 # -x scons The scons script to use for tests.
76 # --xml Print test results to an output file (specified
77 # by the -o option) in an SCons-specific XML format.
78 # This is (will be) used for reporting results back
79 # to a central SCons test monitoring infrastructure.
81 # (Note: There used to be a -v option that specified the SCons
82 # version to be tested, when we were installing in a version-specific
83 # library directory. If we ever resurrect that as the default, then
84 # you can find the appropriate code in the 0.04 version of this script,
85 # rather than reinventing that wheel.)
98 if not hasattr(os, 'WEXITSTATUS'):
99 os.WEXITSTATUS = lambda x: x
105 builddir = os.path.join(cwd, 'build')
112 print_passed_summary = None
124 Usage: runtest.py [OPTIONS] [TEST ...]
126 -a, --all Run all tests.
127 --aegis Print results in Aegis format.
128 -b BASE, --baseline BASE Run test scripts against baseline BASE.
129 --builddir DIR Directory in which packages were built.
130 -d, --debug Run test scripts under the Python debugger.
131 -f FILE, --file FILE Run tests in specified FILE.
132 -h, --help Print this message and exit.
133 -l, --list List available tests and exit.
134 -n, --no-exec No execute, just print command lines.
135 --noqmtest Execute tests directly, not using QMTest.
136 -o FILE, --output FILE Print test results to FILE.
137 -P Python Use the specified Python interpreter.
138 -p PACKAGE, --package PACKAGE
139 Test against the specified PACKAGE:
141 local-tar-gz .tar.gz standalone package
142 local-zip .zip standalone package
144 src-tar-gz .tar.gz source package
145 src-zip .zip source package
146 tar-gz .tar.gz distribution
147 zip .zip distribution
148 --passed Summarize which tests passed.
149 --qmtest Run using the QMTest harness.
150 -q, --quiet Don't print the test being executed.
151 --sp PATH The Aegis search path.
152 --spe PATH The Aegis executable search path.
153 -t, --time Print test execution time.
154 -v version Specify the SCons version.
155 --verbose=LEVEL Set verbose level: 1 = print executed commands,
156 2 = print commands and non-zero output,
157 3 = print commands and all output.
158 -X Test script is executable, don't feed to Python.
159 -x SCRIPT, --exec SCRIPT Test SCRIPT.
160 --xml Print results in SCons XML format.
163 opts, args = getopt.getopt(sys.argv[1:], "ab:df:hlno:P:p:qv:Xx:t",
164 ['all', 'aegis', 'baseline=', 'builddir=',
165 'debug', 'file=', 'help',
166 'list', 'no-exec', 'noqmtest', 'output=',
167 'package=', 'passed', 'python=', 'qmtest',
168 'quiet', 'sp=', 'spe=', 'time',
173 if o in ['-a', '--all']:
175 elif o in ['-b', '--baseline']:
177 elif o in ['--builddir']:
179 if not os.path.isabs(builddir):
180 builddir = os.path.normpath(os.path.join(cwd, builddir))
181 elif o in ['-d', '--debug']:
183 pdb = os.path.join(dir, 'pdb.py')
184 if os.path.exists(pdb):
187 elif o in ['-f', '--file']:
188 if not os.path.isabs(a):
189 a = os.path.join(cwd, a)
191 elif o in ['-h', '--help']:
194 elif o in ['-l', '--list']:
196 elif o in ['-n', '--no-exec']:
198 elif o in ['--noqmtest']:
200 elif o in ['-o', '--output']:
201 if a != '-' and not os.path.isabs(a):
202 a = os.path.join(cwd, a)
204 elif o in ['-p', '--package']:
206 elif o in ['--passed']:
207 print_passed_summary = 1
208 elif o in ['-P', '--python']:
210 elif o in ['--qmtest']:
211 if sys.platform == 'win32':
212 # typically in c:/PythonXX/Scripts
216 elif o in ['-q', '--quiet']:
219 sp = string.split(a, os.pathsep)
221 spe = string.split(a, os.pathsep)
222 elif o in ['-t', '--time']:
224 elif o in ['--verbose']:
225 os.environ['TESTCMD_VERBOSE'] = a
226 elif o in ['-v', '--version']:
230 elif o in ['-x', '--exec']:
232 elif o in ['--aegis', '--xml']:
235 if not args and not all and not testlistfile:
236 sys.stderr.write("""\
237 runtest.py: No tests were specified.
238 List one or more tests on the command line, use the
239 -f option to specify a file containing a list of tests,
240 or use the -a option to find and run all tests.
245 if sys.platform in ('win32', 'cygwin'):
248 pathext = [''] + string.split(os.environ['PATHEXT'], os.pathsep)
249 for dir in string.split(os.environ['PATH'], os.pathsep):
250 f = os.path.join(dir, file)
253 if os.path.isfile(fext):
260 for dir in string.split(os.environ['PATH'], os.pathsep):
261 f = os.path.join(dir, file)
262 if os.path.isfile(f):
267 if stat.S_IMODE(st[stat.ST_MODE]) & 0111:
271 # See if --qmtest or --noqmtest specified
276 # Old code for using QMTest by default if it's installed.
277 # We now default to not using QMTest unless explicitly asked for.
278 #for q in ['qmtest', 'qmtest.py']:
281 # # The name was found on $PATH; just execute the found name so
282 # # we don't have to worry about paths containing white space.
286 # msg = ('Warning: found neither qmtest nor qmtest.py on $PATH;\n' +
287 # '\tassuming --noqmtest option.\n')
288 # sys.stderr.write(msg)
291 aegis = whereis('aegis')
293 if format == '--aegis' and aegis:
294 change = os.popen("aesub '$c' 2>/dev/null", "r").read()
297 paths = os.popen("aesub '$sp' 2>/dev/null", "r").read()[:-1]
298 sp = string.split(paths, os.pathsep)
300 spe = os.popen("aesub '$spe' 2>/dev/null", "r").read()[:-1]
301 spe = string.split(spe, os.pathsep)
314 _ws = re.compile('\s')
319 s = string.replace(s, '\\', '\\\\')
322 # Set up lowest-common-denominator spawning of a process on both Windows
323 # and non-Windows systems that works all the way back to Python 1.5.2.
326 except AttributeError:
327 def spawn_it(command_args):
330 os.execv(command_args[0], command_args)
332 pid, status = os.waitpid(pid, 0)
335 def spawn_it(command_args):
336 command = command_args[0]
337 command_args = map(escape, command_args)
338 return os.spawnv(os.P_WAIT, command, command_args)
341 def __init__(self, path, spe=None):
343 self.abspath = os.path.abspath(path)
346 f = os.path.join(dir, path)
347 if os.path.isfile(f):
352 class SystemExecutor(Base):
354 s = spawn_it(self.command_args)
357 sys.stdout.write("Unexpected exit status %d\n" % s)
365 except AttributeError:
366 class PopenExecutor(Base):
368 (tochild, fromchild, childerr) = os.popen3(self.command_str)
370 self.stderr = childerr.read()
371 self.stdout = fromchild.read()
373 self.status = childerr.close()
377 self.status = self.status >> 8
379 class PopenExecutor(Base):
381 p = popen2.Popen3(self.command_str, 1)
383 self.stdout = p.fromchild.read()
384 self.stderr = p.childerr.read()
385 self.status = p.wait()
386 self.status = self.status >> 8
388 class PopenExecutor(Base):
390 p = subprocess.Popen(self.command_str,
391 stdout=subprocess.PIPE,
392 stderr=subprocess.PIPE,
394 self.stdout = p.stdout.read()
395 self.stderr = p.stderr.read()
396 self.status = p.wait()
398 class Aegis(SystemExecutor):
400 f.write('test_result = [\n')
402 f.write(' { file_name = "%s";\n' % self.path)
403 f.write(' exit_status = %d; },\n' % self.status)
407 class XML(PopenExecutor):
409 f.write(' <results>\n')
412 f.write(' <file_name>%s</file_name>\n' % self.path)
413 f.write(' <command_line>%s</command_line>\n' % self.command_str)
414 f.write(' <exit_status>%s</exit_status>\n' % self.status)
415 f.write(' <stdout>%s</stdout>\n' % self.stdout)
416 f.write(' <stderr>%s</stderr>\n' % self.stderr)
417 f.write(' <time>%.1f</time>\n' % self.test_time)
418 f.write(' </test>\n')
420 f.write(' <time>%.1f</time>\n' % self.total_time)
421 f.write(' </results>\n')
424 None : SystemExecutor,
429 Test = format_class[format]
435 'local-tar-gz' : None,
444 # The hard-coded "python2.1" here is the library directory
445 # name on Debian systems, not an executable, so it's all right.
447 'deb' : os.path.join('python2.1', 'site-packages')
450 if not dir.has_key(package):
451 sys.stderr.write("Unknown package '%s'\n" % package)
454 test_dir = os.path.join(builddir, 'test-%s' % package)
456 if dir[package] is None:
457 scons_script_dir = test_dir
458 globs = glob.glob(os.path.join(test_dir, 'scons-local-*'))
460 sys.stderr.write("No `scons-local-*' dir in `%s'\n" % test_dir)
463 pythonpath_dir = globs[len(globs)-1]
464 elif sys.platform == 'win32':
465 scons_script_dir = os.path.join(test_dir, dir[package], 'Scripts')
466 scons_lib_dir = os.path.join(test_dir, dir[package])
467 pythonpath_dir = scons_lib_dir
469 scons_script_dir = os.path.join(test_dir, dir[package], 'bin')
470 l = lib.get(package, 'scons')
471 scons_lib_dir = os.path.join(test_dir, dir[package], 'lib', l)
472 pythonpath_dir = scons_lib_dir
474 scons_runtest_dir = builddir
480 # XXX: Logic like the following will be necessary once
481 # we fix runtest.py to run tests within an Aegis change
482 # without symlinks back to the baseline(s).
487 # d = os.path.join(dir, 'src', 'script')
488 # f = os.path.join(d, 'scons.py')
489 # if os.path.isfile(f):
492 # spe = map(lambda x: os.path.join(x, 'src', 'engine'), spe)
493 # ld = string.join(spe, os.pathsep)
495 if not baseline or baseline == '.':
497 elif baseline == '-':
498 # Tentative code for fetching information directly from the
499 # QMTest context file.
502 #import qm.test.context
504 #context = qm.test.context.Context()
505 #context.Read('context')
508 svn_info = os.popen("svn info 2>&1", "r").read()
509 match = re.search('URL: (.*)', svn_info)
513 sys.stderr.write('runtest.py: could not find a URL:\n')
514 sys.stderr.write(svn_info)
517 base = tempfile.mkdtemp(prefix='runtest-tmp-')
519 command = 'cd %s && svn co -q %s' % (base, url)
521 base = os.path.join(base, os.path.split(url)[1])
529 scons_runtest_dir = base
531 scons_script_dir = sd or os.path.join(base, 'src', 'script')
533 scons_lib_dir = ld or os.path.join(base, 'src', 'engine')
535 pythonpath_dir = scons_lib_dir
538 # Let the version of SCons that the -x option pointed to find
540 os.environ['SCONS'] = scons
542 # Because SCons is really aggressive about finding its modules,
543 # it sometimes finds SCons modules elsewhere on the system.
544 # This forces SCons to use the modules that are being tested.
545 os.environ['SCONS_LIB_DIR'] = scons_lib_dir
548 os.environ['SCONS_EXEC'] = '1'
550 os.environ['SCONS_RUNTEST_DIR'] = scons_runtest_dir
551 os.environ['SCONS_SCRIPT_DIR'] = scons_script_dir
552 os.environ['SCONS_CWD'] = cwd
554 os.environ['SCONS_VERSION'] = version
556 old_pythonpath = os.environ.get('PYTHONPATH')
558 # FIXME: the following is necessary to pull in half of the testing
559 # harness from $srcdir/etc. Those modules should be transfered
560 # to QMTest/ once we completely cut over to using that as
561 # the harness, in which case this manipulation of PYTHONPATH
562 # should be able to go away.
563 pythonpaths = [ pythonpath_dir ]
566 if format == '--aegis':
567 q = os.path.join(dir, 'build', 'QMTest')
569 q = os.path.join(dir, 'QMTest')
570 pythonpaths.append(q)
572 os.environ['SCONS_SOURCE_PATH_EXECUTABLE'] = string.join(spe, os.pathsep)
574 os.environ['PYTHONPATH'] = string.join(pythonpaths, os.pathsep)
577 os.environ['PYTHONPATH'] = os.environ['PYTHONPATH'] + \
583 def find_Tests_py(tdict, dirname, names):
584 for n in filter(lambda n: n[-8:] == "Tests.py", names):
585 tdict[os.path.join(dirname, n)] = 1
587 def find_py(tdict, dirname, names):
588 tests = filter(lambda n: n[-3:] == ".py", names)
590 excludes = open(os.path.join(dirname,".exclude_tests")).readlines()
591 except (OSError, IOError):
594 for exclude in excludes:
595 exclude = string.split(exclude, '#' , 1)[0]
596 exclude = string.strip(exclude)
597 if not exclude: continue
598 tests = filter(lambda n, ex = exclude: n != ex, tests)
600 tdict[os.path.join(dirname, n)] = 1
606 tests.extend(glob.glob(a))
609 x = os.path.join(dir, a)
616 for path in glob.glob(a):
617 if os.path.isdir(path):
619 if path[:3] == 'src':
620 os.path.walk(path, find_Tests_py, tdict)
621 elif path[:4] == 'test':
622 os.path.walk(path, find_py, tdict)
629 tests = open(testlistfile, 'r').readlines()
630 tests = filter(lambda x: x[0] != '#', tests)
631 tests = map(lambda x: x[:-1], tests)
632 elif all and not qmtest:
633 # Find all of the SCons functional tests in the local directory
634 # tree. This is anything under the 'src' subdirectory that ends
635 # with 'Tests.py', or any Python script (*.py) under the 'test'
638 # Note that there are some tests under 'src' that *begin* with
639 # 'test_', but they're packaging and installation tests, not
640 # functional tests, so we don't execute them by default. (They can
641 # still be executed by hand, though, and are routinely executed
642 # by the Aegis packaging build to make sure that we're building
645 os.path.walk('src', find_Tests_py, tdict)
646 os.path.walk('test', find_py, tdict)
647 if format == '--aegis' and aegis:
648 cmd = "aegis -list -unf pf 2>/dev/null"
649 for line in os.popen(cmd, "r").readlines():
650 a = string.split(line)
651 if a[0] == "test" and not tdict.has_key(a[-1]):
652 tdict[a[-1]] = Test(a[-1], spe)
653 cmd = "aegis -list -unf cf 2>/dev/null"
654 for line in os.popen(cmd, "r").readlines():
655 a = string.split(line)
659 elif not tdict.has_key(a[-1]):
660 tdict[a[-1]] = Test(a[-1], spe)
667 aegis_result_stream = 'scons_tdb.AegisBaselineStream'
668 qmr_file = 'baseline.qmr'
670 aegis_result_stream = 'scons_tdb.AegisChangeStream'
671 qmr_file = 'results.qmr'
674 aegis_result_stream = aegis_result_stream + "(print_time='1')"
676 qmtest_args = [ qmtest, ]
678 if format == '--aegis':
680 if not os.path.isdir(dir):
682 qmtest_args.extend(['-D', dir])
686 '--output %s' % qmr_file,
688 '--result-stream="%s"' % aegis_result_stream,
692 qmtest_args.append('--context python="%s"' % python)
695 if format == '--xml':
696 rsclass = 'scons_tdb.SConsXMLResultStream'
698 rsclass = 'scons_tdb.AegisBatchStream'
699 qof = "r'" + outputfile + "'"
700 rs = '--result-stream="%s(filename=%s)"' % (rsclass, qof)
701 qmtest_args.append(rs)
703 if format == '--aegis':
704 tests = map(lambda x: string.replace(x, cwd+os.sep, ''), tests)
706 os.environ['SCONS'] = os.path.join(cwd, 'src', 'script', 'scons.py')
708 cmd = string.join(qmtest_args + tests, ' ')
710 sys.stdout.write(cmd + '\n')
714 status = os.WEXITSTATUS(os.system(cmd))
718 # os.chdir(scons_script_dir)
722 tests = map(Test, tests)
725 def __init__(self, file):
727 def write(self, arg):
730 def __getattr__(self, attr):
731 return getattr(self.file, attr)
733 sys.stdout = Unbuffered(sys.stdout)
734 sys.stderr = Unbuffered(sys.stderr)
738 sys.stdout.write(t.path + "\n")
743 if os.name == 'java':
744 python = os.path.join(sys.prefix, 'jython')
746 python = sys.executable
748 # time.clock() is the suggested interface for doing benchmarking timings,
749 # but time.time() does a better job on Linux systems, so let that be
750 # the non-Windows default.
752 if sys.platform == 'win32':
753 time_func = time.clock
755 time_func = time.time
758 print_time_func = lambda fmt, time: sys.stdout.write(fmt % time)
760 print_time_func = lambda fmt, time: None
762 total_start_time = time_func()
764 command_args = ['-tt']
766 command_args.append(debug)
767 command_args.append(t.path)
768 t.command_args = [python] + command_args
769 t.command_str = string.join([escape(python)] + command_args, " ")
771 sys.stdout.write(t.command_str + "\n")
772 test_start_time = time_func()
775 t.test_time = time_func() - test_start_time
776 print_time_func("Test execution time: %.1f seconds\n", t.test_time)
778 tests[0].total_time = time_func() - total_start_time
779 print_time_func("Total execution time for all tests: %.1f seconds\n", tests[0].total_time)
781 passed = filter(lambda t: t.status == 0, tests)
782 fail = filter(lambda t: t.status == 1, tests)
783 no_result = filter(lambda t: t.status == 2, tests)
785 if len(tests) != 1 and execute_tests:
786 if passed and print_passed_summary:
788 sys.stdout.write("\nPassed the following test:\n")
790 sys.stdout.write("\nPassed the following %d tests:\n" % len(passed))
791 paths = map(lambda x: x.path, passed)
792 sys.stdout.write("\t" + string.join(paths, "\n\t") + "\n")
795 sys.stdout.write("\nFailed the following test:\n")
797 sys.stdout.write("\nFailed the following %d tests:\n" % len(fail))
798 paths = map(lambda x: x.path, fail)
799 sys.stdout.write("\t" + string.join(paths, "\n\t") + "\n")
801 if len(no_result) == 1:
802 sys.stdout.write("\nNO RESULT from the following test:\n")
804 sys.stdout.write("\nNO RESULT from the following %d tests:\n" % len(no_result))
805 paths = map(lambda x: x.path, no_result)
806 sys.stdout.write("\t" + string.join(paths, "\n\t") + "\n")
809 if outputfile == '-':
812 f = open(outputfile, 'w')
814 #f.write("test_result = [\n")
819 if outputfile != '-':
822 if format == '--aegis':
833 # indent-tabs-mode:nil
835 # vim: set expandtab tabstop=4 shiftwidth=4: