"""
A simple testing framework for lldb using python's unit testing framework.
Tests for lldb are written as python scripts which take advantage of the script
bridging provided by LLDB.framework to interact with lldb core.
A specific naming pattern is followed by the .py script to be recognized as
a module which implements a test scenario, namely, Test*.py.
To specify the directories where "Test*.py" python test scripts are located,
you need to pass in a list of directory names. By default, the current
working directory is searched if nothing is specified on the command line.
Type:
./dotest.py -h
for available options.
"""
import atexit
import commands
import os
import platform
import progress
import signal
import subprocess
import sys
import textwrap
import time
import inspect
import unittest2
if sys.version_info >= (2, 7):
argparse = __import__('argparse')
else:
argparse = __import__('argparse_compat')
def parse_args(parser):
""" Returns an argument object. LLDB_TEST_ARGUMENTS environment variable can
be used to pass additional arguments if a compatible (>=2.7) argparse
library is available.
"""
if sys.version_info >= (2, 7):
args = ArgParseNamespace()
if ('LLDB_TEST_ARGUMENTS' in os.environ):
print "Arguments passed through environment: '%s'" % os.environ['LLDB_TEST_ARGUMENTS']
args = parser.parse_args([sys.argv[0]].__add__(os.environ['LLDB_TEST_ARGUMENTS'].split()),namespace=args)
return parser.parse_args(namespace=args)
else:
return parser.parse_args()
def is_exe(fpath):
"""Returns true if fpath is an executable."""
return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
def which(program):
"""Returns the full path to a program; None otherwise."""
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program):
return program
else:
for path in os.environ["PATH"].split(os.pathsep):
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
return None
class _WritelnDecorator(object):
"""Used to decorate file-like objects with a handy 'writeln' method"""
def __init__(self,stream):
self.stream = stream
def __getattr__(self, attr):
if attr in ('stream', '__getstate__'):
raise AttributeError(attr)
return getattr(self.stream,attr)
def writeln(self, arg=None):
if arg:
self.write(arg)
self.write('\n')
validCategories = {
'dataformatters':'Tests related to the type command and the data formatters subsystem',
'expression':'Tests related to the expression parser',
'objc':'Tests related to the Objective-C programming language support',
'pyapi':'Tests related to the Python API',
'basic_process': 'Basic process execution sniff tests.',
'cmdline' : 'Tests related to the LLDB command-line interface',
'dyntype' : 'Tests related to dynamic type support'
}
suite = unittest2.TestSuite()
dont_do_python_api_test = False
just_do_python_api_test = False
just_do_benchmarks_test = False
dont_do_dsym_test = "linux" in sys.platform or "freebsd" in sys.platform
dont_do_dwarf_test = False
blacklist = None
blacklistConfig = {}
categoriesList = None
useCategories = False
skipCategories = []
failuresPerCategory = {}
lldbFrameworkPath = None
lldbExecutablePath = None
configFile = None
count = 1
config = {}
pre_flight = None
post_flight = None
lldbtest_remote_sandbox = None
lldbtest_remote_shell_template = None
archs = None compilers = None
cflags_extras = ''
dumpSysPath = False
bmExecutable = None
bmBreakpointSpec = None
bmIterationCount = -1
excluded = set(['.svn', '.git'])
failfast = False
filters = []
runHooks = []
fs4all = True
ignore = False
skip_build_and_cleanup = False
skip_long_running_test = True
noHeaders = False
parsable = False
regexp = None
rdir = None
sdir_name = None
sdir_has_content = False
svn_info = ''
svn_silent = True
verbose = 1
progress_bar = False
testdirs = [ sys.path[0] ]
separator = '-' * 70
failed = False
lldb_platform_name = None
lldb_platform_url = None
lldb_platform_working_dir = None
def usage(parser):
parser.print_help()
if verbose > 0:
print """
Examples:
This is an example of using the -f option to pinpoint to a specfic test class
and test method to be run:
$ ./dotest.py -f ClassTypesTestCase.test_with_dsym_and_run_command
----------------------------------------------------------------------
Collected 1 test
test_with_dsym_and_run_command (TestClassTypes.ClassTypesTestCase)
Test 'frame variable this' when stopped on a class constructor. ... ok
----------------------------------------------------------------------
Ran 1 test in 1.396s
OK
And this is an example of using the -p option to run a single file (the filename
matches the pattern 'ObjC' and it happens to be 'TestObjCMethods.py'):
$ ./dotest.py -v -p ObjC
----------------------------------------------------------------------
Collected 4 tests
test_break_with_dsym (TestObjCMethods.FoundationTestCase)
Test setting objc breakpoints using '_regexp-break' and 'breakpoint set'. ... ok
test_break_with_dwarf (TestObjCMethods.FoundationTestCase)
Test setting objc breakpoints using '_regexp-break' and 'breakpoint set'. ... ok
test_data_type_and_expr_with_dsym (TestObjCMethods.FoundationTestCase)
Lookup objective-c data types and evaluate expressions. ... ok
test_data_type_and_expr_with_dwarf (TestObjCMethods.FoundationTestCase)
Lookup objective-c data types and evaluate expressions. ... ok
----------------------------------------------------------------------
Ran 4 tests in 16.661s
OK
Running of this script also sets up the LLDB_TEST environment variable so that
individual test cases can locate their supporting files correctly. The script
tries to set up Python's search paths for modules by looking at the build tree
relative to this script. See also the '-i' option in the following example.
Finally, this is an example of using the lldb.py module distributed/installed by
Xcode4 to run against the tests under the 'forward' directory, and with the '-w'
option to add some delay between two tests. It uses ARCH=x86_64 to specify that
as the architecture and CC=clang to specify the compiler used for the test run:
$ PYTHONPATH=/Xcode4/Library/PrivateFrameworks/LLDB.framework/Versions/A/Resources/Python ARCH=x86_64 CC=clang ./dotest.py -v -w -i forward
Session logs for test failures/errors will go into directory '2010-11-11-13_56_16'
----------------------------------------------------------------------
Collected 2 tests
test_with_dsym_and_run_command (TestForwardDeclaration.ForwardDeclarationTestCase)
Display *bar_ptr when stopped on a function with forward declaration of struct bar. ... ok
test_with_dwarf_and_run_command (TestForwardDeclaration.ForwardDeclarationTestCase)
Display *bar_ptr when stopped on a function with forward declaration of struct bar. ... ok
----------------------------------------------------------------------
Ran 2 tests in 5.659s
OK
The 'Session ...' verbiage is recently introduced (see also the '-s' option) to
notify the directory containing the session logs for test failures or errors.
In case there is any test failure/error, a similar message is appended at the
end of the stderr output for your convenience.
Environment variables related to loggings:
o LLDB_LOG: if defined, specifies the log file pathname for the 'lldb' subsystem
with a default option of 'event process' if LLDB_LOG_OPTION is not defined.
o GDB_REMOTE_LOG: if defined, specifies the log file pathname for the
'process.gdb-remote' subsystem with a default option of 'packets' if
GDB_REMOTE_LOG_OPTION is not defined.
"""
sys.exit(0)
def unique_string_match(yourentry,list):
candidate = None
for item in list:
if item.startswith(yourentry):
if candidate:
return None
candidate = item
return candidate
class ArgParseNamespace(object):
pass
def validate_categories(categories):
"""For each category in categories, ensure that it's a valid category (or a prefix thereof).
If a category is invalid, print a message and quit.
If all categories are valid, return the list of categories. Prefixes are expanded in the
returned list.
"""
global validCategories
result = []
for category in categories:
origCategory = category
if category not in validCategories:
category = unique_string_match(category, validCategories)
if (category not in validCategories) or category == None:
print "fatal error: category '" + origCategory + "' is not a valid category"
print "if you have added a new category, please edit dotest.py, adding your new category to validCategories"
print "else, please specify one or more of the following: " + str(validCategories.keys())
sys.exit(1)
result.append(category)
return result
def setCrashInfoHook_Mac(text):
import crashinfo
crashinfo.setCrashReporterDescription(text)
def setCrashInfoHook_NonMac(text):
pass
setCrashInfoHook = None
def deleteCrashInfoDylib(dylib_path):
try:
os.remove(dylib_path)
finally:
pass
def setupCrashInfoHook():
global setCrashInfoHook
setCrashInfoHook = setCrashInfoHook_NonMac if platform.system() == "Darwin":
test_dir = os.environ['LLDB_TEST']
if not test_dir or not os.path.exists(test_dir):
return
dylib_src = os.path.join(test_dir,"crashinfo.c")
dylib_dst = os.path.join(test_dir,"crashinfo.so")
cmd = "xcrun clang %s -o %s -framework Python -Xlinker -dylib -iframework /System/Library/Frameworks/ -Xlinker -F /System/Library/Frameworks/" % (dylib_src,dylib_dst)
if subprocess.call(cmd,shell=True) == 0 and os.path.exists(dylib_dst):
setCrashInfoHook = setCrashInfoHook_Mac
atexit.register(deleteCrashInfoDylib,dylib_dst)
else:
pass
def parseOptionsAndInitTestdirs():
"""Initialize the list of directories containing our unittest scripts.
'-h/--help as the first option prints out usage info and exit the program.
"""
global dont_do_python_api_test
global just_do_python_api_test
global just_do_benchmarks_test
global dont_do_dsym_test
global dont_do_dwarf_test
global blacklist
global blacklistConfig
global categoriesList
global validCategories
global useCategories
global skipCategories
global lldbFrameworkPath
global lldbExecutablePath
global configFile
global archs
global compilers
global count
global dumpSysPath
global bmExecutable
global bmBreakpointSpec
global bmIterationCount
global failfast
global filters
global fs4all
global ignore
global progress_bar
global runHooks
global skip_build_and_cleanup
global skip_long_running_test
global noHeaders
global parsable
global regexp
global rdir
global sdir_name
global svn_silent
global verbose
global testdirs
global lldb_platform_name
global lldb_platform_url
global lldb_platform_working_dir
global setCrashInfoHook
do_help = False
parser = argparse.ArgumentParser(description='description', prefix_chars='+-', add_help=False)
group = None
X = lambda optstr, helpstr, **kwargs: group.add_argument(optstr, help=helpstr, action='store_true', **kwargs)
group = parser.add_argument_group('Help')
group.add_argument('-h', '--help', dest='h', action='store_true', help="Print this help message and exit. Add '-v' for more detailed help.")
group = parser.add_argument_group('Toolchain options')
group.add_argument('-A', '--arch', metavar='arch', action='append', dest='archs', help=textwrap.dedent('''Specify the architecture(s) to test. This option can be specified more than once'''))
group.add_argument('-C', '--compiler', metavar='compiler', dest='compilers', action='append', help=textwrap.dedent('''Specify the compiler(s) used to build the inferior executables. The compiler path can be an executable basename or a full path to a compiler executable. This option can be specified multiple times.'''))
group.add_argument('-E', metavar='extra-flags', help=textwrap.dedent('''Specify the extra flags to be passed to the toolchain when building the inferior programs to be debugged
suggestions: do not lump the "-A arch1 -A arch2" together such that the -E option applies to only one of the architectures'''))
X('-D', 'Dump the Python sys.path variable')
group = parser.add_argument_group('Test filtering options')
group.add_argument('-N', choices=['dwarf', 'dsym'], help="Don't do test cases marked with the @dsym decorator by passing 'dsym' as the option arg, or don't do test cases marked with the @dwarf decorator by passing 'dwarf' as the option arg")
X('-a', "Don't do lldb Python API tests")
X('+a', "Just do lldb Python API tests. Do not specify along with '+a'", dest='plus_a')
X('+b', 'Just do benchmark tests', dest='plus_b')
group.add_argument('-b', metavar='blacklist', help='Read a blacklist file specified after this option')
group.add_argument('-f', metavar='filterspec', action='append', help='Specify a filter, which consists of the test class name, a dot, followed by the test method, to only admit such test into the test suite') X('-g', 'If specified, the filterspec by -f is not exclusive, i.e., if a test module does not match the filterspec (testclass.testmethod), the whole module is still admitted to the test suite')
X('-l', "Don't skip long running tests")
group.add_argument('-p', metavar='pattern', help='Specify a regexp filename pattern for inclusion in the test suite')
group.add_argument('-X', metavar='directory', help="Exclude a directory from consideration for test discovery. -X types => if 'types' appear in the pathname components of a potential testfile, it will be ignored")
group.add_argument('-G', '--category', metavar='category', action='append', dest='categoriesList', help=textwrap.dedent('''Specify categories of test cases of interest. Can be specified more than once.'''))
group.add_argument('--skip-category', metavar='category', action='append', dest='skipCategories', help=textwrap.dedent('''Specify categories of test cases to skip. Takes precedence over -G. Can be specified more than once.'''))
group = parser.add_argument_group('Configuration options')
group.add_argument('-c', metavar='config-file', help='Read a config file specified after this option') group.add_argument('--framework', metavar='framework-path', help='The path to LLDB.framework')
group.add_argument('--executable', metavar='executable-path', help='The path to the lldb executable')
group.add_argument('--libcxx', metavar='directory', help='The path to custom libc++ library')
group.add_argument('-e', metavar='benchmark-exe', help='Specify the full path of an executable used for benchmark purposes (see also: -x)')
group.add_argument('-k', metavar='command', action='append', help="Specify a runhook, which is an lldb command to be executed by the debugger; The option can occur multiple times. The commands are executed one after the other to bring the debugger to a desired state, so that, for example, further benchmarking can be done")
group.add_argument('-R', metavar='dir', help='Specify a directory to relocate the tests and their intermediate files to. BE WARNED THAT the directory, if exists, will be deleted before running this test driver. No cleanup of intermediate test files is performed in this case')
group.add_argument('-r', metavar='dir', help="Similar to '-R', except that the directory must not exist before running this test driver")
group.add_argument('-s', metavar='name', help='Specify the name of the dir created to store the session files of tests with errored or failed status. If not specified, the test driver uses the timestamp as the session dir name')
group.add_argument('-x', metavar='breakpoint-spec', help='Specify the breakpoint specification for the benchmark executable')
group.add_argument('-y', type=int, metavar='count', help="Specify the iteration count used to collect our benchmarks. An example is the number of times to do 'thread step-over' to measure stepping speed.")
group.add_argument('-#', type=int, metavar='sharp', dest='sharp', help='Repeat the test suite for a specified number of times')
group = parser.add_argument_group('Remote platform options')
group.add_argument('--platform-name', dest='lldb_platform_name', metavar='platform-name', help='The name of a remote platform to use')
group.add_argument('--platform-url', dest='lldb_platform_url', metavar='platform-url', help='A LLDB platform URL to use when connecting to a remote platform to run the test suite')
group.add_argument('--platform-working-dir', dest='lldb_platform_working_dir', metavar='platform-working-dir', help='The directory to use on the remote platform.')
group = parser.add_argument_group('Runtime behaviour options')
X('-d', 'Suspend the process after launch to wait indefinitely for a debugger to attach')
X('-F', 'Fail fast. Stop the test suite on the first error/failure')
X('-i', "Ignore (don't bailout) if 'lldb.py' module cannot be located in the build tree relative to this script; use PYTHONPATH to locate the module")
X('-n', "Don't print the headers like build dir, lldb version, and svn info at all")
X('-P', "Use the graphic progress bar.")
X('-q', "Don't print extra output from this script.")
X('-S', "Skip the build and cleanup while running the test. Use this option with care as you would need to build the inferior(s) by hand and build the executable(s) with the correct name(s). This can be used with '-# n' to stress test certain test cases for n number of times")
X('-t', 'Turn on tracing of lldb command and other detailed test executions')
group.add_argument('-u', dest='unset_env_varnames', metavar='variable', action='append', help='Specify an environment variable to unset before running the test cases. e.g., -u DYLD_INSERT_LIBRARIES -u MallocScribble')
X('-v', 'Do verbose mode of unittest framework (print out each test case invocation)')
X('-w', 'Insert some wait time (currently 0.5 sec) between consecutive test cases')
X('-T', 'Obtain and dump svn information for this checkout of LLDB (off by default)')
del X
group = parser.add_argument_group('Test directories')
group.add_argument('args', metavar='test-dir', nargs='*', help='Specify a list of directory names to search for test modules named after Test*.py (test discovery). If empty, search from the current working directory instead.')
args = parse_args(parser)
platform_system = platform.system()
platform_machine = platform.machine()
if args.unset_env_varnames:
for env_var in args.unset_env_varnames:
if env_var in os.environ:
del os.environ[env_var]
if args.v and not args.q:
print sys.argv
if args.h:
do_help = True
if args.compilers:
compilers = args.compilers
else:
compilers = ['clang']
if args.archs:
archs = args.archs
for arch in archs:
if arch.startswith('arm') and platform_system == 'Darwin':
os.environ['SDKROOT'] = commands.getoutput('xcodebuild -version -sdk iphoneos.internal Path')
else:
if (platform_system == 'Darwin' or (platform_system == 'Linux' and compilers == ['clang'])) and platform_machine == 'x86_64':
archs = ['x86_64', 'i386']
else:
archs = [platform_machine]
if args.categoriesList:
categoriesList = set(validate_categories(args.categoriesList))
useCategories = True
else:
categoriesList = []
if args.skipCategories:
skipCategories = validate_categories(args.skipCategories)
if args.D:
dumpSysPath = True
if args.E:
cflags_extras = args.E
os.environ['CFLAGS_EXTRAS'] = cflags_extras
if args.N == 'dwarf':
dont_do_dwarf_test = True
elif args.N == 'dsym':
dont_do_dsym_test = True
if args.a:
dont_do_python_api_test = True
if args.plus_a:
if dont_do_python_api_test:
print "Warning: -a and +a can't both be specified! Using only -a"
else:
just_do_python_api_test = True
if args.plus_b:
just_do_benchmarks_test = True
if args.b:
if args.b.startswith('-'):
usage(parser)
blacklistFile = args.b
if not os.path.isfile(blacklistFile):
print 'Blacklist file:', blacklistFile, 'does not exist!'
usage(parser)
execfile(blacklistFile, globals(), blacklistConfig)
blacklist = blacklistConfig.get('blacklist')
if args.c:
if args.c.startswith('-'):
usage(parser)
configFile = args.c
if not os.path.isfile(configFile):
print 'Config file:', configFile, 'does not exist!'
usage(parser)
if args.d:
sys.stdout.write("Suspending the process %d to wait for debugger to attach...\n" % os.getpid())
sys.stdout.flush()
os.kill(os.getpid(), signal.SIGSTOP)
if args.e:
if args.e.startswith('-'):
usage(parser)
bmExecutable = args.e
if not is_exe(bmExecutable):
usage(parser)
if args.F:
failfast = True
if args.f:
if any([x.startswith('-') for x in args.f]):
usage(parser)
filters.extend(args.f)
if args.g:
fs4all = False
if args.i:
ignore = True
if args.k:
runHooks.extend(args.k)
if args.l:
skip_long_running_test = False
if args.framework:
lldbFrameworkPath = args.framework
if args.executable:
lldbExecutablePath = args.executable
if args.libcxx:
os.environ["LIBCXX_PATH"] = args.libcxx
if args.n:
noHeaders = True
if args.p:
if args.p.startswith('-'):
usage(parser)
regexp = args.p
if args.q:
noHeaders = True
parsable = True
if args.P and not args.v:
progress_bar = True
verbose = 0
if args.R:
if args.R.startswith('-'):
usage(parser)
rdir = os.path.abspath(args.R)
if os.path.exists(rdir):
import shutil
print 'Removing tree:', rdir
shutil.rmtree(rdir)
if args.r:
if args.r.startswith('-'):
usage(parser)
rdir = os.path.abspath(args.r)
if os.path.exists(rdir):
print 'Relocated directory:', rdir, 'must not exist!'
usage(parser)
if args.S:
skip_build_and_cleanup = True
if args.s:
if args.s.startswith('-'):
usage(parser)
sdir_name = args.s
if args.t:
os.environ['LLDB_COMMAND_TRACE'] = 'YES'
if args.T:
svn_silent = False
if args.v:
verbose = 2
if args.w:
os.environ['LLDB_WAIT_BETWEEN_TEST_CASES'] = 'YES'
if args.X:
if args.X.startswith('-'):
usage(parser)
excluded.add(args.X)
if args.x:
if args.x.startswith('-'):
usage(parser)
bmBreakpointSpec = args.x
if args.y:
bmIterationCount = args.y
if args.sharp:
count = args.sharp
if do_help == True:
usage(parser)
if dont_do_python_api_test and just_do_python_api_test:
usage(parser)
if args.lldb_platform_name:
lldb_platform_name = args.lldb_platform_name
if args.lldb_platform_url:
lldb_platform_url = args.lldb_platform_url
if args.lldb_platform_working_dir:
lldb_platform_working_dir = args.lldb_platform_working_dir
if len(args.args) > 0:
testdirs = map(os.path.abspath, args.args)
if rdir:
from shutil import copytree, ignore_patterns
tmpdirs = []
orig_testdirs = testdirs[:]
for srcdir in testdirs:
if ("test" + os.sep) in srcdir:
to_split_on = "test" + os.sep
else:
to_split_on = "test"
dstdir = os.path.join(rdir, srcdir.split(to_split_on)[1])
dstdir = dstdir.rstrip(os.sep)
copytree(srcdir, dstdir, ignore=ignore_patterns('*.pyc', '.svn'))
tmpdirs.append(dstdir)
testdirs = tmpdirs
os.environ["LLDB_DO_CLEANUP"] = 'NO'
if len(testdirs) != 1 or os.path.basename(orig_testdirs[0]) != 'test':
scriptdir = os.path.dirname(__file__)
copytree(os.path.join(scriptdir, 'make'), os.path.join(rdir, 'make'),
ignore=ignore_patterns('.svn'))
global config, pre_flight, post_flight, lldbtest_remote_sandbox, lldbtest_remote_shell_template
if configFile:
execfile(configFile, globals(), config)
if "pre_flight" in config:
pre_flight = config["pre_flight"]
if not callable(pre_flight):
print "fatal error: pre_flight is not callable, exiting."
sys.exit(1)
if "post_flight" in config:
post_flight = config["post_flight"]
if not callable(post_flight):
print "fatal error: post_flight is not callable, exiting."
sys.exit(1)
if "lldbtest_remote_sandbox" in config:
lldbtest_remote_sandbox = config["lldbtest_remote_sandbox"]
if "lldbtest_remote_shell_template" in config:
lldbtest_remote_shell_template = config["lldbtest_remote_shell_template"]
def setupSysPath():
"""
Add LLDB.framework/Resources/Python to the search paths for modules.
As a side effect, we also discover the 'lldb' executable and export it here.
"""
global rdir
global testdirs
global dumpSysPath
global noHeaders
global svn_info
global svn_silent
global lldbFrameworkPath
global lldbExecutablePath
if ("DOTEST_PROFILE" in os.environ or "DOTEST_PDB" in os.environ) and "DOTEST_SCRIPT_DIR" in os.environ:
scriptPath = os.environ["DOTEST_SCRIPT_DIR"]
else:
scriptPath = sys.path[0]
if not scriptPath.endswith('test'):
print "This script expects to reside in lldb's test directory."
sys.exit(-1)
if rdir:
if len(testdirs) == 1 and os.path.basename(testdirs[0]) == 'test':
os.environ["LLDB_TEST"] = os.path.join(rdir, 'test')
else:
os.environ["LLDB_TEST"] = rdir
else:
os.environ["LLDB_TEST"] = scriptPath
os.environ["LLDB_SRC"] = os.path.join(sys.path[0], os.pardir)
pluginPath = os.path.join(scriptPath, 'plugins')
pexpectPath = os.path.join(scriptPath, 'pexpect-2.4')
sys.path.append(scriptPath)
sys.path.append(pluginPath)
sys.path.append(pexpectPath)
base = os.path.abspath(os.path.join(scriptPath, os.pardir))
xcode3_build_dir = ['build']
xcode4_build_dir = ['build', 'lldb', 'Build', 'Products']
dbg = ['Debug']
dbc = ['DebugClang']
rel = ['Release']
bai = ['BuildAndIntegration']
python_resource_dir = ['LLDB.framework', 'Resources', 'Python']
lldbExec = None
if lldbExecutablePath:
if is_exe(lldbExecutablePath):
lldbExec = lldbExecutablePath
lldbHere = lldbExec
else:
print lldbExecutablePath + " is not an executable"
sys.exit(-1)
else:
if "LLDB_EXEC" in os.environ and is_exe(os.environ["LLDB_EXEC"]):
lldbExec = os.environ["LLDB_EXEC"]
else:
lldbExec = None
executable = ['lldb']
dbgExec = os.path.join(base, *(xcode3_build_dir + dbg + executable))
dbgExec2 = os.path.join(base, *(xcode4_build_dir + dbg + executable))
dbcExec = os.path.join(base, *(xcode3_build_dir + dbc + executable))
dbcExec2 = os.path.join(base, *(xcode4_build_dir + dbc + executable))
relExec = os.path.join(base, *(xcode3_build_dir + rel + executable))
relExec2 = os.path.join(base, *(xcode4_build_dir + rel + executable))
baiExec = os.path.join(base, *(xcode3_build_dir + bai + executable))
baiExec2 = os.path.join(base, *(xcode4_build_dir + bai + executable))
lldbHere = None
if is_exe(dbgExec):
lldbHere = dbgExec
elif is_exe(dbgExec2):
lldbHere = dbgExec2
elif is_exe(dbcExec):
lldbHere = dbcExec
elif is_exe(dbcExec2):
lldbHere = dbcExec2
elif is_exe(relExec):
lldbHere = relExec
elif is_exe(relExec2):
lldbHere = relExec2
elif is_exe(baiExec):
lldbHere = baiExec
elif is_exe(baiExec2):
lldbHere = baiExec2
elif lldbExec:
lldbHere = lldbExec
if not lldbExec:
lldbExec = which('lldb')
if lldbHere and not lldbExec:
lldbExec = lldbHere
if lldbExec and not lldbHere:
lldbHere = lldbExec
if lldbHere:
os.environ["LLDB_HERE"] = lldbHere
os.environ["LLDB_LIB_DIR"] = os.path.split(lldbHere)[0]
if not noHeaders:
print "LLDB library dir:", os.environ["LLDB_LIB_DIR"]
os.system('%s -v' % lldbHere)
if not lldbExec:
print "The 'lldb' executable cannot be located. Some of the tests may not be run as a result."
else:
os.environ["LLDB_EXEC"] = lldbExec
if not svn_silent and not parsable:
if os.path.isdir(os.path.join(base, '.svn')) and which("svn") is not None:
pipe = subprocess.Popen([which("svn"), "info", base], stdout = subprocess.PIPE)
svn_info = pipe.stdout.read()
elif os.path.isdir(os.path.join(base, '.git')) and which("git") is not None:
pipe = subprocess.Popen([which("git"), "svn", "info", base], stdout = subprocess.PIPE)
svn_info = pipe.stdout.read()
if not noHeaders:
print svn_info
global ignore
lldbPath = None
if lldbFrameworkPath:
candidatePath = os.path.join(lldbFrameworkPath, 'Resources', 'Python')
if os.path.isfile(os.path.join(candidatePath, 'lldb/__init__.py')):
lldbPath = candidatePath
if not lldbPath:
print 'Resources/Python/lldb/__init__.py was not found in ' + lldbFrameworkPath
sys.exit(-1)
else:
if ignore:
return
init_in_python_dir = 'lldb/__init__.py'
import pexpect
lldb_dash_p_result = None
if lldbHere:
lldb_dash_p_result = pexpect.run("%s -P"%(lldbHere))
elif lldbExec:
lldb_dash_p_result = pexpect.run("%s -P"%(lldbExec))
if lldb_dash_p_result and not lldb_dash_p_result.startswith(("<", "lldb: invalid option:")):
lines = lldb_dash_p_result.splitlines()
if len(lines) == 1 and os.path.isfile(os.path.join(lines[0], init_in_python_dir)):
lldbPath = lines[0]
if "linux" in sys.platform:
os.environ['LLDB_LIB_DIR'] = os.path.join(lldbPath, '..', '..')
if not lldbPath:
dbgPath = os.path.join(base, *(xcode3_build_dir + dbg + python_resource_dir))
dbgPath2 = os.path.join(base, *(xcode4_build_dir + dbg + python_resource_dir))
dbcPath = os.path.join(base, *(xcode3_build_dir + dbc + python_resource_dir))
dbcPath2 = os.path.join(base, *(xcode4_build_dir + dbc + python_resource_dir))
relPath = os.path.join(base, *(xcode3_build_dir + rel + python_resource_dir))
relPath2 = os.path.join(base, *(xcode4_build_dir + rel + python_resource_dir))
baiPath = os.path.join(base, *(xcode3_build_dir + bai + python_resource_dir))
baiPath2 = os.path.join(base, *(xcode4_build_dir + bai + python_resource_dir))
if os.path.isfile(os.path.join(dbgPath, init_in_python_dir)):
lldbPath = dbgPath
elif os.path.isfile(os.path.join(dbgPath2, init_in_python_dir)):
lldbPath = dbgPath2
elif os.path.isfile(os.path.join(dbcPath, init_in_python_dir)):
lldbPath = dbcPath
elif os.path.isfile(os.path.join(dbcPath2, init_in_python_dir)):
lldbPath = dbcPath2
elif os.path.isfile(os.path.join(relPath, init_in_python_dir)):
lldbPath = relPath
elif os.path.isfile(os.path.join(relPath2, init_in_python_dir)):
lldbPath = relPath2
elif os.path.isfile(os.path.join(baiPath, init_in_python_dir)):
lldbPath = baiPath
elif os.path.isfile(os.path.join(baiPath2, init_in_python_dir)):
lldbPath = baiPath2
if not lldbPath:
print 'This script requires lldb.py to be in either ' + dbgPath + ',',
print relPath + ', or ' + baiPath
sys.exit(-1)
(before, frameWithVersion, after) = lldbPath.rpartition("LLDB.framework/Versions/A")
if frameWithVersion != "" :
lldbPath = before + "LLDB.framework" + after
lldbPath = os.path.abspath(lldbPath)
os.environ["LLDB_FRAMEWORK"] = os.path.dirname(os.path.dirname(lldbPath))
sys.path[1:1] = [lldbPath]
if dumpSysPath:
print "sys.path:", sys.path
def visit(prefix, dir, names):
"""Visitor function for os.path.walk(path, visit, arg)."""
global suite
global regexp
global filters
global fs4all
global excluded
if set(dir.split(os.sep)).intersection(excluded):
return
for name in names:
if os.path.isdir(os.path.join(dir, name)):
continue
if '.py' == os.path.splitext(name)[1] and name.startswith(prefix):
if regexp:
import re
if re.search(regexp, name):
pass
else:
continue
if not sys.path.count(dir):
sys.path.insert(0, dir)
base = os.path.splitext(name)[0]
filterspec = None
for filterspec in filters:
filtered = True
module = __import__(base)
parts = filterspec.split('.')
obj = module
for part in parts:
try:
parent, obj = obj, getattr(obj, part)
except AttributeError:
filtered = False
break
if filtered:
suite.addTests(
unittest2.defaultTestLoader.loadTestsFromName(filterspec, module))
continue
if filters and fs4all and not filtered:
continue
if not filterspec or not filtered:
suite.addTests(unittest2.defaultTestLoader.loadTestsFromName(base))
def lldbLoggings():
"""Check and do lldb loggings if necessary."""
ci = lldb.DBG.GetCommandInterpreter()
res = lldb.SBCommandReturnObject()
if ("LLDB_LOG" in os.environ):
open(os.environ["LLDB_LOG"], 'w').close()
if ("LLDB_LOG_OPTION" in os.environ):
lldb_log_option = os.environ["LLDB_LOG_OPTION"]
else:
lldb_log_option = "event process expr state api"
ci.HandleCommand(
"log enable -n -f " + os.environ["LLDB_LOG"] + " lldb " + lldb_log_option,
res)
if not res.Succeeded():
raise Exception('log enable failed (check LLDB_LOG env variable)')
if ("LLDB_LINUX_LOG" in os.environ):
open(os.environ["LLDB_LINUX_LOG"], 'w').close()
if ("LLDB_LINUX_LOG_OPTION" in os.environ):
lldb_log_option = os.environ["LLDB_LINUX_LOG_OPTION"]
else:
lldb_log_option = "event process expr state api"
ci.HandleCommand(
"log enable -n -f " + os.environ["LLDB_LINUX_LOG"] + " linux " + lldb_log_option,
res)
if not res.Succeeded():
raise Exception('log enable failed (check LLDB_LINUX_LOG env variable)')
if ("GDB_REMOTE_LOG" in os.environ):
if ("GDB_REMOTE_LOG_OPTION" in os.environ):
gdb_remote_log_option = os.environ["GDB_REMOTE_LOG_OPTION"]
else:
gdb_remote_log_option = "packets process"
ci.HandleCommand(
"log enable -n -f " + os.environ["GDB_REMOTE_LOG"] + " gdb-remote "
+ gdb_remote_log_option,
res)
if not res.Succeeded():
raise Exception('log enable failed (check GDB_REMOTE_LOG env variable)')
def getMyCommandLine():
ps = subprocess.Popen([which('ps'), '-o', "command=CMD", str(os.getpid())], stdout=subprocess.PIPE).communicate()[0]
lines = ps.split('\n')
cmd_line = lines[1]
return cmd_line
def checkDsymForUUIDIsNotOn():
cmd = ["defaults", "read", "com.apple.DebugSymbols"]
pipe = subprocess.Popen(cmd, stdout = subprocess.PIPE, stderr = subprocess.STDOUT)
cmd_output = pipe.stdout.read()
if cmd_output and "DBGFileMappedPaths = " in cmd_output:
print "%s =>" % ' '.join(cmd)
print cmd_output
print "Disable automatic lookup and caching of dSYMs before running the test suite!"
print "Exiting..."
sys.exit(0)
if sys.platform.startswith("darwin"):
checkDsymForUUIDIsNotOn()
parseOptionsAndInitTestdirs()
setupSysPath()
setupCrashInfoHook()
if not skip_long_running_test:
os.environ["LLDB_SKIP_LONG_RUNNING_TEST"] = "NO"
for testdir in testdirs:
os.path.walk(testdir, visit, 'Test')
import lldb, atexit
atexit.register(lambda: lldb.SBDebugger.Terminate())
lldb.DBG = lldb.SBDebugger.Create()
if lldb_platform_name:
print "Setting up remote platform '%s'" % (lldb_platform_name)
lldb.remote_platform = lldb.SBPlatform(lldb_platform_name)
if not lldb.remote_platform.IsValid():
print "error: unable to create the LLDB platform named '%s'." % (lldb_platform_name)
sys.exit(1)
if lldb_platform_url:
print "Connecting to remote platform '%s' at '%s'..." % (lldb_platform_name, lldb_platform_url)
platform_connect_options = lldb.SBPlatformConnectOptions(lldb_platform_url);
err = lldb.remote_platform.ConnectRemote(platform_connect_options)
if err.Success():
print "Connected."
else:
print "error: failed to connect to remote platform using URL '%s': %s" % (lldb_platform_url, err)
sys.exit(1)
if lldb_platform_working_dir:
print "Setting remote platform working directory to '%s'..." % (lldb_platform_working_dir)
lldb.remote_platform.SetWorkingDirectory(lldb_platform_working_dir)
lldb.remote_platform_working_dir = lldb_platform_working_dir
lldb.DBG.SetSelectedPlatform(lldb.remote_platform)
else:
lldb.remote_platform = None
lldb.remote_platform_working_dir = None
lldb.blacklist = blacklist
lldb.pre_flight = pre_flight
lldb.post_flight = post_flight
def getsource_if_available(obj):
"""
Return the text of the source code for an object if available. Otherwise,
a print representation is returned.
"""
import inspect
try:
return inspect.getsource(obj)
except:
return repr(obj)
if not noHeaders:
print "lldb.pre_flight:", getsource_if_available(lldb.pre_flight)
print "lldb.post_flight:", getsource_if_available(lldb.post_flight)
if lldb.pre_flight or lldb.post_flight:
lldb.test_remote = True
else:
lldb.test_remote = False
lldb.lldbtest_remote_sandbox = lldbtest_remote_sandbox
lldb.lldbtest_remote_sandboxed_executable = None
lldb.lldbtest_remote_shell_template = lldbtest_remote_shell_template
lldb.dont_do_python_api_test = dont_do_python_api_test
lldb.just_do_python_api_test = just_do_python_api_test
lldb.just_do_benchmarks_test = just_do_benchmarks_test
lldb.dont_do_dsym_test = dont_do_dsym_test
lldb.dont_do_dwarf_test = dont_do_dwarf_test
lldb.skip_build_and_cleanup = skip_build_and_cleanup
lldb.bmExecutable = bmExecutable
lldb.bmBreakpointSpec = bmBreakpointSpec
lldb.bmIterationCount = bmIterationCount
lldb.runHooks = runHooks
lldbLoggings()
unittest2.signals.installHandler()
import datetime
timestamp_started = datetime.datetime.now().strftime("%Y-%m-%d-%H_%M_%S")
if not sdir_name:
sdir_name = timestamp_started
os.environ["LLDB_SESSION_DIRNAME"] = os.path.join(os.getcwd(), sdir_name)
if not noHeaders:
sys.stderr.write("\nSession logs for test failures/errors/unexpected successes"
" will go into directory '%s'\n" % sdir_name)
sys.stderr.write("Command invoked: %s\n" % getMyCommandLine())
if not os.path.isdir(sdir_name):
os.mkdir(sdir_name)
where_to_save_session = os.getcwd()
fname = os.path.join(sdir_name, "TestStarted")
with open(fname, "w") as f:
print >> f, "Test started at: %s\n" % timestamp_started
print >> f, svn_info
print >> f, "Command invoked: %s\n" % getMyCommandLine()
iterArchs = False
iterCompilers = False
if not archs and "archs" in config:
archs = config["archs"]
if isinstance(archs, list) and len(archs) >= 1:
iterArchs = True
if not compilers and "compilers" in config:
compilers = config["compilers"]
for i in range(len(compilers)):
c = compilers[i]
if which(c):
continue
else:
if sys.platform.startswith("darwin"):
pipe = subprocess.Popen(['xcrun', '-find', c], stdout = subprocess.PIPE, stderr = subprocess.STDOUT)
cmd_output = pipe.stdout.read()
if cmd_output:
if "not found" in cmd_output:
print "dropping %s from the compilers used" % c
compilers.remove(i)
else:
compilers[i] = cmd_output.split('\n')[0]
print "'xcrun -find %s' returning %s" % (c, compilers[i])
if not parsable:
print "compilers=%s" % str(compilers)
if not compilers or len(compilers) == 0:
print "No eligible compiler found, exiting."
sys.exit(1)
if isinstance(compilers, list) and len(compilers) >= 1:
iterCompilers = True
if rdir:
old_sys_path = sys.path[:]
if iterArchs or iterCompilers:
old_stderr = sys.stderr
old_stdout = sys.stdout
new_stderr = None
new_stdout = None
for ia in range(len(archs) if iterArchs else 1):
archConfig = ""
if iterArchs:
os.environ["ARCH"] = archs[ia]
archConfig = "arch=%s" % archs[ia]
for ic in range(len(compilers) if iterCompilers else 1):
if iterCompilers:
os.environ["CC"] = compilers[ic]
configString = "%s compiler=%s" % (archConfig, compilers[ic])
else:
configString = archConfig
if iterArchs or iterCompilers:
from string import maketrans
tbl = maketrans(' ', '-')
configPostfix = configString.translate(tbl)
if old_stderr.name != '<stderr>' and config.get('split_stderr'):
if new_stderr:
new_stderr.close()
new_stderr = open("%s.%s" % (old_stderr.name, configPostfix), "w")
sys.stderr = new_stderr
if old_stdout.name != '<stdout>' and config.get('split_stdout'):
if new_stdout:
new_stdout.close()
new_stdout = open("%s.%s" % (old_stdout.name, configPostfix), "w")
sys.stdout = new_stdout
if rdir:
from shutil import copytree, rmtree, ignore_patterns
newrdir = "%s.%s" % (rdir, configPostfix)
if os.path.exists(newrdir):
rmtree(newrdir)
copytree(rdir, newrdir, ignore=ignore_patterns('*.pyc', '*.o', '*.d'))
if len(testdirs) == 1 and os.path.basename(testdirs[0]) == 'test':
os.environ["LLDB_TEST"] = os.path.join(newrdir, 'test')
else:
os.environ["LLDB_TEST"] = newrdir
sys.path = [x.replace(rdir, newrdir, 1) for x in old_sys_path]
if not parsable:
sys.stderr.write("\nConfiguration: " + configString + "\n")
if not parsable:
sys.stderr.write(separator + "\n")
sys.stderr.write("Collected %d test%s\n\n"
% (suite.countTestCases(),
suite.countTestCases() != 1 and "s" or ""))
class LLDBTestResult(unittest2.TextTestResult):
"""
Enforce a singleton pattern to allow introspection of test progress.
Overwrite addError(), addFailure(), and addExpectedFailure() methods
to enable each test instance to track its failure/error status. It
is used in the LLDB test framework to emit detailed trace messages
to a log file for easier human inspection of test failres/errors.
"""
__singleton__ = None
__ignore_singleton__ = False
@staticmethod
def getTerminalSize():
import os
env = os.environ
def ioctl_GWINSZ(fd):
try:
import fcntl, termios, struct, os
cr = struct.unpack('hh', fcntl.ioctl(fd, termios.TIOCGWINSZ,
'1234'))
except:
return
return cr
cr = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2)
if not cr:
try:
fd = os.open(os.ctermid(), os.O_RDONLY)
cr = ioctl_GWINSZ(fd)
os.close(fd)
except:
pass
if not cr:
cr = (env.get('LINES', 25), env.get('COLUMNS', 80))
return int(cr[1]), int(cr[0])
def __init__(self, *args):
if not LLDBTestResult.__ignore_singleton__ and LLDBTestResult.__singleton__:
raise Exception("LLDBTestResult instantiated more than once")
super(LLDBTestResult, self).__init__(*args)
LLDBTestResult.__singleton__ = self
lldb.test_result = self
global suite
counterWidth = len(str(suite.countTestCases()))
self.fmt = "%" + str(counterWidth) + "d: "
self.indentation = ' ' * (counterWidth + 2)
self.counter = 0
(width, height) = LLDBTestResult.getTerminalSize()
self.progressbar = None
global progress_bar
if width > 10 and not parsable and progress_bar:
try:
self.progressbar = progress.ProgressWithEvents(stdout=self.stream,start=0,end=suite.countTestCases(),width=width-10)
except:
self.progressbar = None
def _config_string(self, test):
compiler = getattr(test, "getCompiler", None)
arch = getattr(test, "getArchitecture", None)
return "%s-%s" % (compiler() if compiler else "", arch() if arch else "")
def _exc_info_to_string(self, err, test):
"""Overrides superclass TestResult's method in order to append
our test config info string to the exception info string."""
if hasattr(test, "getArchitecture") and hasattr(test, "getCompiler"):
return '%sConfig=%s-%s' % (super(LLDBTestResult, self)._exc_info_to_string(err, test),
test.getArchitecture(),
test.getCompiler())
else:
return super(LLDBTestResult, self)._exc_info_to_string(err, test)
def getDescription(self, test):
doc_first_line = test.shortDescription()
if self.descriptions and doc_first_line:
return '\n'.join((str(test), self.indentation + doc_first_line))
else:
return str(test)
def getCategoriesForTest(self,test):
if hasattr(test,"_testMethodName"):
test_method = getattr(test,"_testMethodName")
test_method = getattr(test,test_method)
else:
test_method = None
if test_method != None and hasattr(test_method,"getCategories"):
test_categories = test_method.getCategories(test)
elif hasattr(test,"getCategories"):
test_categories = test.getCategories()
elif inspect.ismethod(test) and test.__self__ != None and hasattr(test.__self__,"getCategories"):
test_categories = test.__self__.getCategories()
else:
test_categories = []
if test_categories == None:
test_categories = []
return test_categories
def shouldSkipBecauseOfCategories(self,test):
global useCategories
import inspect
if useCategories:
global categoriesList
test_categories = self.getCategoriesForTest(test)
if len(test_categories) == 0 or len(categoriesList & set(test_categories)) == 0:
return True
global skipCategories
for category in skipCategories:
if category in self.getCategoriesForTest(test):
return True
return False
def hardMarkAsSkipped(self,test):
getattr(test, test._testMethodName).__func__.__unittest_skip__ = True
getattr(test, test._testMethodName).__func__.__unittest_skip_why__ = "test case does not fall in any category of interest for this run"
test.__class__.__unittest_skip__ = True
test.__class__.__unittest_skip_why__ = "test case does not fall in any category of interest for this run"
def startTest(self, test):
if self.shouldSkipBecauseOfCategories(test):
self.hardMarkAsSkipped(test)
global setCrashInfoHook
setCrashInfoHook("%s at %s" % (str(test),inspect.getfile(test.__class__)))
self.counter += 1
test.test_number = self.counter
if self.showAll:
self.stream.write(self.fmt % self.counter)
super(LLDBTestResult, self).startTest(test)
def addSuccess(self, test):
global parsable
super(LLDBTestResult, self).addSuccess(test)
if parsable:
self.stream.write("PASS: LLDB (%s) :: %s\n" % (self._config_string(test), str(test)))
def addError(self, test, err):
global sdir_has_content
global parsable
sdir_has_content = True
super(LLDBTestResult, self).addError(test, err)
method = getattr(test, "markError", None)
if method:
method()
if parsable:
self.stream.write("FAIL: LLDB (%s) :: %s\n" % (self._config_string(test), str(test)))
def addFailure(self, test, err):
global sdir_has_content
global failuresPerCategory
global parsable
sdir_has_content = True
super(LLDBTestResult, self).addFailure(test, err)
method = getattr(test, "markFailure", None)
if method:
method()
if parsable:
self.stream.write("FAIL: LLDB (%s) :: %s\n" % (self._config_string(test), str(test)))
if useCategories:
test_categories = self.getCategoriesForTest(test)
for category in test_categories:
if category in failuresPerCategory:
failuresPerCategory[category] = failuresPerCategory[category] + 1
else:
failuresPerCategory[category] = 1
def addExpectedFailure(self, test, err, bugnumber):
global sdir_has_content
global parsable
sdir_has_content = True
super(LLDBTestResult, self).addExpectedFailure(test, err, bugnumber)
method = getattr(test, "markExpectedFailure", None)
if method:
method(err, bugnumber)
if parsable:
self.stream.write("XFAIL: LLDB (%s) :: %s\n" % (self._config_string(test), str(test)))
def addSkip(self, test, reason):
global sdir_has_content
global parsable
sdir_has_content = True
super(LLDBTestResult, self).addSkip(test, reason)
method = getattr(test, "markSkippedTest", None)
if method:
method()
if parsable:
self.stream.write("UNSUPPORTED: LLDB (%s) :: %s (%s) \n" % (self._config_string(test), str(test), reason))
def addUnexpectedSuccess(self, test, bugnumber):
global sdir_has_content
global parsable
sdir_has_content = True
super(LLDBTestResult, self).addUnexpectedSuccess(test, bugnumber)
method = getattr(test, "markUnexpectedSuccess", None)
if method:
method(bugnumber)
if parsable:
self.stream.write("XPASS: LLDB (%s) :: %s\n" % (self._config_string(test), str(test)))
if parsable:
v = 0
elif progress_bar:
v = 1
else:
v = verbose
if count == 1:
result = unittest2.TextTestRunner(stream=sys.stderr,
verbosity=v,
failfast=failfast,
resultclass=LLDBTestResult).run(suite)
else:
LLDBTestResult.__ignore_singleton__ = True
for i in range(count):
result = unittest2.TextTestRunner(stream=sys.stderr,
verbosity=v,
failfast=failfast,
resultclass=LLDBTestResult).run(suite)
failed = failed or not result.wasSuccessful()
if sdir_has_content and not parsable:
sys.stderr.write("Session logs for test failures/errors/unexpected successes"
" can be found in directory '%s'\n" % sdir_name)
if useCategories and len(failuresPerCategory) > 0:
sys.stderr.write("Failures per category:\n")
for category in failuresPerCategory:
sys.stderr.write("%s - %d\n" % (category,failuresPerCategory[category]))
os.chdir(where_to_save_session)
fname = os.path.join(sdir_name, "TestFinished")
with open(fname, "w") as f:
print >> f, "Test finished at: %s\n" % datetime.datetime.now().strftime("%Y-%m-%d-%H_%M_%S")
if ("LLDB_TESTSUITE_FORCE_FINISH" in os.environ):
print "Terminating Test suite..."
subprocess.Popen(["/bin/sh", "-c", "kill %s; exit 0" % (os.getpid())])
sys.exit(failed)