blob: 21a6e5305cadf7c890c4c234338687b28338459a [file] [log] [blame]
This README file describes the files and directories related to the Python test
suite under the current 'test' directory.
Provides the test driver for the test suite. To invoke it, cd to the 'test'
directory and issue the './' command or './ -v' for more
verbose output. ' -h' prints out the help messge.
A specific naming pattern is followed by the .py script under the 'test'
directory in order to be recognized by '' test driver as a module
which implements a test case, namely, Test*.py.
Some example usages:
1. ./ -v . 2> ~/Developer/Log/lldbtest.log0
This runs the test suite and directs the run log to a file.
2. LLDB_LOG=/tmp/lldb.log GDB_REMOTE_LOG=/tmp/gdb-remote.log ./ -v . 2> ~/Developer/Log/lldbtest.log
This runs the test suite, with logging turned on for the lldb as well as
the process.gdb-remote channels and directs the run log to a file.
Provides an abstract base class of lldb test case named 'TestVase', which in
turn inherits from Python's unittest.TestCase. The concrete subclass can
override lldbtest.TestBase in order to inherit the common behavior for
unittest.TestCase.setUp/tearDown implemented in this file.
To provide a test case, the concrete subclass provides methods whose names
start with the letters test. For more details about the Python's unittest
framework, go to
./command_source/ provides a simple example of test case
which overrides lldbtest.TestBase to exercise the lldb's 'command source'
command. The subclass should override the attribute 'mydir' in order for the
runtime to locate the individual test cases when running as part of a large
test suite or when running each test case as a separate Python invocation.
The doc string provides more details about the setup required for running a
test case on its own. To run the whole test suite, '' is all you
need to do.
o subdirectories of 'test'
Most of them predate the introduction of the python test suite and contain
example C/C++/ObjC source files which get compiled into executables which are
to be exercised by the debugger.
For such subdirectory which has an associated Test*.py file, it was added as
part of the Python-based test suite to test lldb functionality.
Some of the subdirectories, for example, the 'help' subdirectory, do not have
C/C++/ObjC source files; they were created to house the Python test case which
does not involve lldb reading in an executable file at all.
o make directory
Contains Makefile.rules, which can be utilized by test cases to write Makefile
based rules to build binaries for the inferiors.
By default, the built executable name is a.out, which can be overwritten by
specifying your EXE make variable, via the Makefile under the specfic test
directory or via supplying a Python dictionary to the build method in your
Python test script. An example of the latter can be found in
test/lang/objc/radar-9691614/, where:
def test_method_ret_BOOL_with_dsym(self):
"""Test that objective-c method returning BOOL works correctly."""
d = {'EXE': self.exe_name}
def test_method_ret_BOOL_with_dwarf(self):
"""Test that objective-c method returning BOOL works correctly."""
d = {'EXE': self.exe_name}
def setUp(self):
# Call super's setUp().
# We'll use the test method name as the exe_name.
self.exe_name = self.testMethodName
# Find the line number to break inside main().
self.main_source = "main.m"
self.line = line_number(self.main_source, '// Set breakpoint here.')
The exe names for the two test methods are equal to the test method names and
are therefore guaranteed different.
o plugins directory
Contains platform specific plugin to build binaries with dsym/dwarf debugging
info. Other platform specific functionalities may be added in the future.
o unittest2 directory
Many new features were added to unittest in Python 2.7, including test
discovery. unittest2 allows you to use these features with earlier versions of
It currently has unittest2 0.5.1 from
Version 0.5.1 of unittest2 has feature parity with unittest in Python 2.7
final. If you want to ensure that your tests run identically under unittest2
and unittest in Python 2.7 you should use unittest2 0.5.1.
Later versions of unittest2 include changes in unittest made in Python 3.2 and
onwards after the release of Python 2.7.
In case you wonder, there is also a '' perl script file. It was
created to visit each Python test case under the specified directory and
invoke Python's builtin unittest.main() on each test case.
It does not take advantage of the test runner and test suite functionality
provided by Python's unitest framework. Its existence is because we want a
different way of running the whole test suite. As lldb and the Python test
suite become more reliable, we don't expect to be using '' anymore.
Note: has been moved to the attic directory.
o Profiling runs
I used the following command line thingy to do the profiling on a SnowLeopard
$ DOTEST_PROFILE=YES DOTEST_SCRIPT_DIR=/Volumes/data/lldb/svn/trunk/test /System/Library/Frameworks/Python.framework/Versions/Current/lib/python2.6/ -o my.profile ./ -v -w 2> ~/Developer/Log/lldbtest.log
After that, I used the module to browse the statistics:
$ python /System/Library/Frameworks/Python.framework/Versions/Current/lib/python2.6/ my.profile