blob: f2a51edda4e071d126cff8915f9cdde4f6e6a1e5 [file] [log] [blame]
Johnny Chena1affab2010-07-03 03:41:59 +00001"""
2LLDB module which provides the abstract base class of lldb test case.
3
4The concrete subclass can override lldbtest.TesBase in order to inherit the
5common behavior for unitest.TestCase.setUp/tearDown implemented in this file.
6
7The subclass should override the attribute mydir in order for the python runtime
8to locate the individual test cases when running as part of a large test suite
9or when running each test case as a separate python invocation.
10
11./dotest.py provides a test driver which sets up the environment to run the
12entire test suite. Users who want to run a test case on its own can specify the
13LLDB_TEST and PYTHONPATH environment variables, for example:
14
15$ export LLDB_TEST=$PWD
Johnny Chen9de4ede2010-08-31 17:42:54 +000016$ export PYTHONPATH=/Volumes/data/lldb/svn/trunk/build/Debug/LLDB.framework/Resources/Python:$LLDB_TEST:$LLDB_TEST/plugins
Johnny Chena1affab2010-07-03 03:41:59 +000017$ echo $LLDB_TEST
18/Volumes/data/lldb/svn/trunk/test
19$ echo $PYTHONPATH
Johnny Chen9de4ede2010-08-31 17:42:54 +000020/Volumes/data/lldb/svn/trunk/build/Debug/LLDB.framework/Resources/Python:/Volumes/data/lldb/svn/trunk/test:/Volumes/data/lldb/svn/trunk/test/plugins
Johnny Chena1affab2010-07-03 03:41:59 +000021$ python function_types/TestFunctionTypes.py
22.
23----------------------------------------------------------------------
24Ran 1 test in 0.363s
25
26OK
Johnny Chend0c24b22010-08-23 17:10:44 +000027$ LLDB_COMMAND_TRACE=YES python array_types/TestArrayTypes.py
Johnny Chen59ea45f2010-09-02 22:25:47 +000028
29...
Johnny Chend0c24b22010-08-23 17:10:44 +000030
31runCmd: breakpoint set -f main.c -l 42
32output: Breakpoint created: 1: file ='main.c', line = 42, locations = 1
33
34runCmd: run
35output: Launching '/Volumes/data/lldb/svn/trunk/test/array_types/a.out' (x86_64)
36
Johnny Chen59ea45f2010-09-02 22:25:47 +000037...
Johnny Chend0c24b22010-08-23 17:10:44 +000038
Johnny Chen59ea45f2010-09-02 22:25:47 +000039runCmd: frame variable strings
Johnny Chend0c24b22010-08-23 17:10:44 +000040output: (char *[4]) strings = {
41 (char *) strings[0] = 0x0000000100000f0c "Hello",
42 (char *) strings[1] = 0x0000000100000f12 "Hola",
43 (char *) strings[2] = 0x0000000100000f17 "Bonjour",
44 (char *) strings[3] = 0x0000000100000f1f "Guten Tag"
45}
46
Johnny Chen59ea45f2010-09-02 22:25:47 +000047runCmd: frame variable char_16
Johnny Chend0c24b22010-08-23 17:10:44 +000048output: (char [16]) char_16 = {
49 (char) char_16[0] = 'H',
50 (char) char_16[1] = 'e',
51 (char) char_16[2] = 'l',
52 (char) char_16[3] = 'l',
53 (char) char_16[4] = 'o',
54 (char) char_16[5] = ' ',
55 (char) char_16[6] = 'W',
56 (char) char_16[7] = 'o',
57 (char) char_16[8] = 'r',
58 (char) char_16[9] = 'l',
59 (char) char_16[10] = 'd',
60 (char) char_16[11] = '\n',
61 (char) char_16[12] = '\0',
62 (char) char_16[13] = '\0',
63 (char) char_16[14] = '\0',
64 (char) char_16[15] = '\0'
65}
66
Johnny Chen59ea45f2010-09-02 22:25:47 +000067runCmd: frame variable ushort_matrix
Johnny Chend0c24b22010-08-23 17:10:44 +000068output: (unsigned short [2][3]) ushort_matrix = {
69 (unsigned short [3]) ushort_matrix[0] = {
70 (unsigned short) ushort_matrix[0][0] = 0x0001,
71 (unsigned short) ushort_matrix[0][1] = 0x0002,
72 (unsigned short) ushort_matrix[0][2] = 0x0003
73 },
74 (unsigned short [3]) ushort_matrix[1] = {
75 (unsigned short) ushort_matrix[1][0] = 0x000b,
76 (unsigned short) ushort_matrix[1][1] = 0x0016,
77 (unsigned short) ushort_matrix[1][2] = 0x0021
78 }
79}
80
Johnny Chen59ea45f2010-09-02 22:25:47 +000081runCmd: frame variable long_6
Johnny Chend0c24b22010-08-23 17:10:44 +000082output: (long [6]) long_6 = {
83 (long) long_6[0] = 1,
84 (long) long_6[1] = 2,
85 (long) long_6[2] = 3,
86 (long) long_6[3] = 4,
87 (long) long_6[4] = 5,
88 (long) long_6[5] = 6
89}
90
91.
92----------------------------------------------------------------------
93Ran 1 test in 0.349s
94
95OK
Johnny Chena1affab2010-07-03 03:41:59 +000096$
97"""
98
Johnny Chen93ae6042010-09-21 22:34:45 +000099import os, sys, traceback
Johnny Chen2d899752010-09-21 21:08:53 +0000100import re
Johnny Chena1cc8832010-08-30 21:35:00 +0000101from subprocess import *
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000102import StringIO
Johnny Chen65572482010-08-25 18:49:48 +0000103import time
Johnny Chen1acaf632010-08-30 23:08:52 +0000104import types
Johnny Chen75e28f92010-08-05 23:42:46 +0000105import unittest2
Johnny Chena1affab2010-07-03 03:41:59 +0000106import lldb
107
Johnny Chen548aefd2010-10-11 22:25:46 +0000108# See also dotest.parseOptionsAndInitTestdirs(), where the environment variables
109# LLDB_COMMAND_TRACE and LLDB_NO_CLEANUP are set from '-t' and '-r dir' options.
110
111# By default, traceAlways is False.
Johnny Chen9de4ede2010-08-31 17:42:54 +0000112if "LLDB_COMMAND_TRACE" in os.environ and os.environ["LLDB_COMMAND_TRACE"]=="YES":
113 traceAlways = True
114else:
115 traceAlways = False
116
Johnny Chen548aefd2010-10-11 22:25:46 +0000117# By default, doCleanup is True.
118if "LLDB_DO_CLEANUP" in os.environ and os.environ["LLDB_DO_CLEANUP"]=="NO":
119 doCleanup = False
120else:
121 doCleanup = True
122
Johnny Chen9de4ede2010-08-31 17:42:54 +0000123
Johnny Chen96f08d52010-08-09 22:01:17 +0000124#
125# Some commonly used assert messages.
126#
127
Johnny Chenee975b82010-09-17 22:45:27 +0000128COMMAND_FAILED_AS_EXPECTED = "Command has failed as expected"
129
Johnny Chen96f08d52010-08-09 22:01:17 +0000130CURRENT_EXECUTABLE_SET = "Current executable set successfully"
131
Johnny Chen72a14342010-09-02 21:23:12 +0000132PROCESS_IS_VALID = "Process is valid"
133
134PROCESS_KILLED = "Process is killed successfully"
135
Johnny Chen1bb9f9a2010-08-27 23:47:36 +0000136RUN_SUCCEEDED = "Process is launched successfully"
Johnny Chen96f08d52010-08-09 22:01:17 +0000137
Johnny Chend85dae52010-08-09 23:44:24 +0000138RUN_COMPLETED = "Process exited successfully"
Johnny Chen96f08d52010-08-09 22:01:17 +0000139
Johnny Chen5349ee22010-10-05 19:27:32 +0000140BACKTRACE_DISPLAYED_CORRECTLY = "Backtrace displayed correctly"
141
Johnny Chend85dae52010-08-09 23:44:24 +0000142BREAKPOINT_CREATED = "Breakpoint created successfully"
143
Johnny Chen9b92c6e2010-08-17 21:33:31 +0000144BREAKPOINT_PENDING_CREATED = "Pending breakpoint created successfully"
145
Johnny Chend85dae52010-08-09 23:44:24 +0000146BREAKPOINT_HIT_ONCE = "Breakpoint resolved with hit cout = 1"
Johnny Chen96f08d52010-08-09 22:01:17 +0000147
Johnny Chen72afa8d2010-09-30 17:06:24 +0000148BREAKPOINT_HIT_TWICE = "Breakpoint resolved with hit cout = 2"
149
Johnny Chenc55dace2010-10-15 18:07:09 +0000150BREAKPOINT_HIT_THRICE = "Breakpoint resolved with hit cout = 3"
151
Johnny Chen0b3ee552010-09-22 23:00:20 +0000152STEP_OUT_SUCCEEDED = "Thread step-out succeeded"
153
Johnny Chen96f08d52010-08-09 22:01:17 +0000154STOPPED_DUE_TO_BREAKPOINT = "Process state is stopped due to breakpoint"
155
Johnny Chenf6bdb192010-10-20 18:38:48 +0000156STOPPED_DUE_TO_BREAKPOINT_CONDITION = "Stopped due to breakpoint condition"
157
Johnny Chend7a4eb02010-10-14 01:22:03 +0000158STOPPED_DUE_TO_SIGNAL = "Process state is stopped due to signal"
159
Johnny Chen96f08d52010-08-09 22:01:17 +0000160STOPPED_DUE_TO_STEP_IN = "Process state is stopped due to step in"
161
Johnny Chen4917e102010-08-24 22:07:56 +0000162DATA_TYPES_DISPLAYED_CORRECTLY = "Data type(s) displayed correctly"
163
Johnny Chenb4d1fff2010-08-26 20:04:17 +0000164VALID_BREAKPOINT = "Got a valid breakpoint"
165
Johnny Chen0601a292010-10-22 18:10:25 +0000166VALID_BREAKPOINT_LOCATION = "Got a valid breakpoint location"
167
Johnny Chen1bb9f9a2010-08-27 23:47:36 +0000168VALID_FILESPEC = "Got a valid filespec"
169
Johnny Chenb4d1fff2010-08-26 20:04:17 +0000170VALID_PROCESS = "Got a valid process"
171
172VALID_TARGET = "Got a valid target"
173
Johnny Chen22b95b22010-08-25 19:00:04 +0000174VARIABLES_DISPLAYED_CORRECTLY = "Variable(s) displayed correctly"
Johnny Chen96f08d52010-08-09 22:01:17 +0000175
Johnny Chenb4d1fff2010-08-26 20:04:17 +0000176
Johnny Chend85dae52010-08-09 23:44:24 +0000177#
178# And a generic "Command '%s' returns successfully" message generator.
179#
Johnny Chen8e06de92010-09-21 23:33:30 +0000180def CMD_MSG(str, exe):
181 if exe:
182 return "Command '%s' returns successfully" % str
183 else:
184 return "'%s' compares successfully" % str
Johnny Chend85dae52010-08-09 23:44:24 +0000185
Johnny Chenb4d1fff2010-08-26 20:04:17 +0000186#
Johnny Chendb9cbe92010-10-19 19:11:38 +0000187# And a generic "Value of setting '%s' is correct" message generator.
188#
189def SETTING_MSG(setting):
190 return "Value of setting '%s' is correct" % setting
191
192#
Johnny Chenf4ce2882010-08-26 21:49:29 +0000193# Returns an env variable array from the os.environ map object.
194#
195def EnvArray():
196 return map(lambda k,v: k+"="+v, os.environ.keys(), os.environ.values())
197
Johnny Chen14906002010-10-11 23:52:19 +0000198def line_number(filename, string_to_match):
199 """Helper function to return the line number of the first matched string."""
200 with open(filename, 'r') as f:
201 for i, line in enumerate(f):
202 if line.find(string_to_match) != -1:
203 # Found our match.
Johnny Chen0659e342010-10-12 00:09:25 +0000204 return i+1
Johnny Chen14906002010-10-11 23:52:19 +0000205 return -1
206
Johnny Chen5349ee22010-10-05 19:27:32 +0000207def pointer_size():
208 """Return the pointer size of the host system."""
209 import ctypes
210 a_pointer = ctypes.c_void_p(0xffff)
211 return 8 * ctypes.sizeof(a_pointer)
212
Johnny Chen9c10c182010-08-27 00:15:48 +0000213
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000214class recording(StringIO.StringIO):
215 """
216 A nice little context manager for recording the debugger interactions into
217 our session object. If trace flag is ON, it also emits the interactions
218 into the stderr.
219 """
220 def __init__(self, test, trace):
Johnny Chen1b7d6292010-10-15 23:55:05 +0000221 """Create a StringIO instance; record the session obj and trace flag."""
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000222 StringIO.StringIO.__init__(self)
Johnny Chen1b7d6292010-10-15 23:55:05 +0000223 self.session = test.session if test else None
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000224 self.trace = trace
225
226 def __enter__(self):
227 """
228 Context management protocol on entry to the body of the with statement.
229 Just return the StringIO object.
230 """
231 return self
232
233 def __exit__(self, type, value, tb):
234 """
235 Context management protocol on exit from the body of the with statement.
236 If trace is ON, it emits the recordings into stderr. Always add the
237 recordings to our session object. And close the StringIO object, too.
238 """
239 if self.trace:
Johnny Chen1b7d6292010-10-15 23:55:05 +0000240 print >> sys.stderr, self.getvalue()
241 if self.session:
242 print >> self.session, self.getvalue()
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000243 self.close()
244
Johnny Chen1b7d6292010-10-15 23:55:05 +0000245# From 2.7's subprocess.check_output() convenience function.
246def system(*popenargs, **kwargs):
247 r"""Run command with arguments and return its output as a byte string.
248
249 If the exit code was non-zero it raises a CalledProcessError. The
250 CalledProcessError object will have the return code in the returncode
251 attribute and output in the output attribute.
252
253 The arguments are the same as for the Popen constructor. Example:
254
255 >>> check_output(["ls", "-l", "/dev/null"])
256 'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
257
258 The stdout argument is not allowed as it is used internally.
259 To capture standard error in the result, use stderr=STDOUT.
260
261 >>> check_output(["/bin/sh", "-c",
262 ... "ls -l non_existent_file ; exit 0"],
263 ... stderr=STDOUT)
264 'ls: non_existent_file: No such file or directory\n'
265 """
266
267 # Assign the sender object to variable 'test' and remove it from kwargs.
268 test = kwargs.pop('sender', None)
269
270 if 'stdout' in kwargs:
271 raise ValueError('stdout argument not allowed, it will be overridden.')
272 process = Popen(stdout=PIPE, *popenargs, **kwargs)
273 output, error = process.communicate()
274 retcode = process.poll()
275
276 with recording(test, traceAlways) as sbuf:
277 if isinstance(popenargs, types.StringTypes):
278 args = [popenargs]
279 else:
280 args = list(popenargs)
281 print >> sbuf
282 print >> sbuf, "os command:", args
283 print >> sbuf, "stdout:", output
284 print >> sbuf, "stderr:", error
285 print >> sbuf, "retcode:", retcode
286 print >> sbuf
287
288 if retcode:
289 cmd = kwargs.get("args")
290 if cmd is None:
291 cmd = popenargs[0]
292 raise CalledProcessError(retcode, cmd)
293 return output
294
Johnny Chen75e28f92010-08-05 23:42:46 +0000295class TestBase(unittest2.TestCase):
Johnny Chena1affab2010-07-03 03:41:59 +0000296 """This LLDB abstract base class is meant to be subclassed."""
297
Johnny Chen41998192010-10-01 22:59:49 +0000298 @classmethod
299 def skipLongRunningTest(cls):
300 """
301 By default, we skip long running test case.
302 This can be overridden by passing '-l' to the test driver (dotest.py).
303 """
304 if "LLDB_SKIP_LONG_RUNNING_TEST" in os.environ and "NO" == os.environ["LLDB_SKIP_LONG_RUNNING_TEST"]:
305 return False
306 else:
307 return True
308
Johnny Chena1affab2010-07-03 03:41:59 +0000309 # The concrete subclass should override this attribute.
Johnny Chenf8c723b2010-07-03 20:41:42 +0000310 mydir = None
Johnny Chena1affab2010-07-03 03:41:59 +0000311
Johnny Chenffde4fc2010-08-16 21:28:10 +0000312 # State pertaining to the inferior process, if any.
Johnny Chen59ea45f2010-09-02 22:25:47 +0000313 # This reflects inferior process started through the command interface with
314 # either the lldb "run" or "process launch" command.
315 # See also self.runCmd().
Johnny Chenffde4fc2010-08-16 21:28:10 +0000316 runStarted = False
317
Johnny Chen65572482010-08-25 18:49:48 +0000318 # Maximum allowed attempts when launching the inferior process.
319 # Can be overridden by the LLDB_MAX_LAUNCH_COUNT environment variable.
320 maxLaunchCount = 3;
321
322 # Time to wait before the next launching attempt in second(s).
Johnny Chend2965212010-10-19 16:00:42 +0000323 # Can be overridden by the LLDB_TIME_WAIT_NEXT_LAUNCH environment variable.
Johnny Chen65572482010-08-25 18:49:48 +0000324 timeWait = 1.0;
325
Johnny Chend3521cc2010-09-16 01:53:04 +0000326 # Keep track of the old current working directory.
327 oldcwd = None
Johnny Chen88f83042010-08-05 21:23:45 +0000328
Johnny Chend3521cc2010-09-16 01:53:04 +0000329 @classmethod
330 def setUpClass(cls):
Johnny Chen41998192010-10-01 22:59:49 +0000331 """
332 Python unittest framework class setup fixture.
333 Do current directory manipulation.
334 """
335
Johnny Chenf8c723b2010-07-03 20:41:42 +0000336 # Fail fast if 'mydir' attribute is not overridden.
Johnny Chend3521cc2010-09-16 01:53:04 +0000337 if not cls.mydir or len(cls.mydir) == 0:
Johnny Chenf8c723b2010-07-03 20:41:42 +0000338 raise Exception("Subclasses must override the 'mydir' attribute.")
Johnny Chena1affab2010-07-03 03:41:59 +0000339 # Save old working directory.
Johnny Chend3521cc2010-09-16 01:53:04 +0000340 cls.oldcwd = os.getcwd()
Johnny Chena1affab2010-07-03 03:41:59 +0000341
342 # Change current working directory if ${LLDB_TEST} is defined.
343 # See also dotest.py which sets up ${LLDB_TEST}.
344 if ("LLDB_TEST" in os.environ):
Johnny Chend3521cc2010-09-16 01:53:04 +0000345 if traceAlways:
Johnny Chen72afa8d2010-09-30 17:06:24 +0000346 print >> sys.stderr, "Change dir to:", os.path.join(os.environ["LLDB_TEST"], cls.mydir)
Johnny Chend3521cc2010-09-16 01:53:04 +0000347 os.chdir(os.path.join(os.environ["LLDB_TEST"], cls.mydir))
348
349 @classmethod
350 def tearDownClass(cls):
Johnny Chen41998192010-10-01 22:59:49 +0000351 """
352 Python unittest framework class teardown fixture.
353 Do class-wide cleanup.
354 """
Johnny Chend3521cc2010-09-16 01:53:04 +0000355
Johnny Chen548aefd2010-10-11 22:25:46 +0000356 if doCleanup:
357 # First, let's do the platform-specific cleanup.
358 module = __import__(sys.platform)
359 if not module.cleanup():
360 raise Exception("Don't know how to do cleanup")
Johnny Chend3521cc2010-09-16 01:53:04 +0000361
Johnny Chen548aefd2010-10-11 22:25:46 +0000362 # Subclass might have specific cleanup function defined.
363 if getattr(cls, "classCleanup", None):
364 if traceAlways:
365 print >> sys.stderr, "Call class-specific cleanup function for class:", cls
366 try:
367 cls.classCleanup()
368 except:
369 exc_type, exc_value, exc_tb = sys.exc_info()
370 traceback.print_exception(exc_type, exc_value, exc_tb)
Johnny Chend3521cc2010-09-16 01:53:04 +0000371
372 # Restore old working directory.
373 if traceAlways:
Johnny Chen72afa8d2010-09-30 17:06:24 +0000374 print >> sys.stderr, "Restore dir to:", cls.oldcwd
Johnny Chend3521cc2010-09-16 01:53:04 +0000375 os.chdir(cls.oldcwd)
376
377 def setUp(self):
378 #import traceback
379 #traceback.print_stack()
Johnny Chena1affab2010-07-03 03:41:59 +0000380
Johnny Chene47649c2010-10-07 02:04:14 +0000381 if ("LLDB_WAIT_BETWEEN_TEST_CASES" in os.environ and
382 os.environ["LLDB_WAIT_BETWEEN_TEST_CASES"] == 'YES'):
383 time.sleep(0.5)
384
Johnny Chen65572482010-08-25 18:49:48 +0000385 if "LLDB_MAX_LAUNCH_COUNT" in os.environ:
386 self.maxLaunchCount = int(os.environ["LLDB_MAX_LAUNCH_COUNT"])
387
Johnny Chend2965212010-10-19 16:00:42 +0000388 if "LLDB_TIME_WAIT_NEXT_LAUNCH" in os.environ:
389 self.timeWait = float(os.environ["LLDB_TIME_WAIT_NEXT_LAUNCH"])
Johnny Chen65572482010-08-25 18:49:48 +0000390
Johnny Chena1affab2010-07-03 03:41:59 +0000391 # Create the debugger instance if necessary.
392 try:
393 self.dbg = lldb.DBG
Johnny Chena1affab2010-07-03 03:41:59 +0000394 except AttributeError:
395 self.dbg = lldb.SBDebugger.Create()
Johnny Chenf8c723b2010-07-03 20:41:42 +0000396
Johnny Chena1affab2010-07-03 03:41:59 +0000397 if not self.dbg.IsValid():
398 raise Exception('Invalid debugger instance')
399
400 # We want our debugger to be synchronous.
401 self.dbg.SetAsync(False)
402
Johnny Chen72a14342010-09-02 21:23:12 +0000403 # There is no process associated with the debugger as yet.
Johnny Chen59ea45f2010-09-02 22:25:47 +0000404 # See also self.tearDown() where it checks whether self.process has a
405 # valid reference and calls self.process.Kill() to kill the process.
Johnny Chen72a14342010-09-02 21:23:12 +0000406 self.process = None
407
Johnny Chena1affab2010-07-03 03:41:59 +0000408 # Retrieve the associated command interpreter instance.
409 self.ci = self.dbg.GetCommandInterpreter()
410 if not self.ci:
411 raise Exception('Could not get the command interpreter')
412
413 # And the result object.
414 self.res = lldb.SBCommandReturnObject()
415
Johnny Chen0b3ee552010-09-22 23:00:20 +0000416 # These are for customized teardown cleanup.
417 self.dict = None
418 self.doTearDownCleanup = False
419
Johnny Chen1b7d6292010-10-15 23:55:05 +0000420 # Create a string buffer to record the session info, to be dumped into a
421 # test case specific file if test failure is encountered.
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000422 self.session = StringIO.StringIO()
423
Johnny Chence681462010-10-19 00:25:01 +0000424 # Optimistically set self.__errored__ and self.__failed__ to False
425 # initially. If the test errored/failed, the session info
426 # (self.session) is then dumped into a session specific file for
427 # diagnosis.
428 self.__errored__ = False
Johnny Chen595c9d72010-10-15 02:28:13 +0000429 self.__failed__ = False
430
Johnny Chen705737b2010-10-19 23:40:13 +0000431 # See addTearDownHook(self, hook) which allows the client to add a hook
432 # function to be run during tearDown() time.
433 self.hooks = []
434
Johnny Chence681462010-10-19 00:25:01 +0000435 def markError(self):
436 """Callback invoked when we (the test case instance) errored."""
437 self.__errored__ = True
438 with recording(self, False) as sbuf:
439 # False because there's no need to write "ERROR" to the stderr twice.
440 # Once by the Python unittest framework, and a second time by us.
441 print >> sbuf, "ERROR"
442
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000443 def markFailure(self):
444 """Callback invoked when we (the test case instance) failed."""
Johnny Chen595c9d72010-10-15 02:28:13 +0000445 self.__failed__ = True
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000446 with recording(self, False) as sbuf:
Johnny Chen314a1452010-10-15 16:22:10 +0000447 # False because there's no need to write "FAIL" to the stderr twice.
448 # Once by the Python unittest framework, and a second time by us.
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000449 print >> sbuf, "FAIL"
450
451 def dumpSessionInfo(self):
452 """
Johnny Chence681462010-10-19 00:25:01 +0000453 Dump the debugger interactions leading to a test error/failure. This
454 allows for more convenient postmortem analysis.
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000455 """
Johnny Chence681462010-10-19 00:25:01 +0000456 for test, err in lldb.test_result.errors:
457 if test is self:
458 print >> self.session, err
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000459 for test, err in lldb.test_result.failures:
460 if test is self:
461 print >> self.session, err
462
Johnny Chence681462010-10-19 00:25:01 +0000463 dname = os.path.join(os.environ["LLDB_TEST"],
Johnny Chen125fc2b2010-10-21 16:55:35 +0000464 os.environ["LLDB_SESSION_DIRNAME"])
Johnny Chence681462010-10-19 00:25:01 +0000465 if not os.path.isdir(dname):
466 os.mkdir(dname)
467 fname = os.path.join(dname, "%s.log" % self.id())
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000468 with open(fname, "w") as f:
Johnny Chen125fc2b2010-10-21 16:55:35 +0000469 import datetime
470 print >> f, "Session info generated @", datetime.datetime.now().ctime()
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000471 print >> f, self.session.getvalue()
472
Johnny Cheneb4f7a82010-10-19 22:45:25 +0000473 def setTearDownCleanup(self, dictionary=None):
474 """Register a cleanup action at tearDown() time with a dictinary"""
475 self.dict = dictionary
476 self.doTearDownCleanup = True
477
Johnny Chen705737b2010-10-19 23:40:13 +0000478 def addTearDownHook(self, hook):
479 """
480 Add a function to be run during tearDown() time.
481
482 Hooks are executed in a first come first serve manner.
483 """
Johnny Chen73a87102010-10-20 18:12:58 +0000484 if callable(hook):
485 with recording(self, traceAlways) as sbuf:
486 import inspect
487 print >> sbuf, "Adding tearDown hook:", inspect.getsource(hook)
488 self.hooks.append(hook)
Johnny Chen705737b2010-10-19 23:40:13 +0000489
Johnny Chena1affab2010-07-03 03:41:59 +0000490 def tearDown(self):
Johnny Chen72a14342010-09-02 21:23:12 +0000491 #import traceback
492 #traceback.print_stack()
493
Johnny Chen705737b2010-10-19 23:40:13 +0000494 # Check and run any hook functions.
495 for hook in self.hooks:
Johnny Chen73a87102010-10-20 18:12:58 +0000496 with recording(self, traceAlways) as sbuf:
497 import inspect
498 print >> sbuf, "Executing tearDown hook:", inspect.getsource(hook)
Johnny Chen705737b2010-10-19 23:40:13 +0000499 hook()
500
Johnny Chen72a14342010-09-02 21:23:12 +0000501 # Terminate the current process being debugged, if any.
Johnny Chenffde4fc2010-08-16 21:28:10 +0000502 if self.runStarted:
Johnny Chen72a14342010-09-02 21:23:12 +0000503 self.runCmd("process kill", PROCESS_KILLED, check=False)
504 elif self.process and self.process.IsValid():
Johnny Chene47649c2010-10-07 02:04:14 +0000505 rc = self.invoke(self.process, "Kill")
Johnny Chen72a14342010-09-02 21:23:12 +0000506 self.assertTrue(rc.Success(), PROCESS_KILLED)
Johnny Chene47649c2010-10-07 02:04:14 +0000507 del self.process
Johnny Chenffde4fc2010-08-16 21:28:10 +0000508
Johnny Chena1affab2010-07-03 03:41:59 +0000509 del self.dbg
Johnny Chen705737b2010-10-19 23:40:13 +0000510 del self.hooks
Johnny Chena1affab2010-07-03 03:41:59 +0000511
Johnny Chen0b3ee552010-09-22 23:00:20 +0000512 # Perform registered teardown cleanup.
Johnny Chen548aefd2010-10-11 22:25:46 +0000513 if doCleanup and self.doTearDownCleanup:
Johnny Chen0b3ee552010-09-22 23:00:20 +0000514 module = __import__(sys.platform)
Johnny Chen5486d072010-10-16 00:08:49 +0000515 if not module.cleanup(self, dictionary=self.dict):
Johnny Chen0b3ee552010-09-22 23:00:20 +0000516 raise Exception("Don't know how to do cleanup")
517
Johnny Chen595c9d72010-10-15 02:28:13 +0000518 # See also LLDBTestResult (dotest.py) which is a singlton class derived
Johnny Chence681462010-10-19 00:25:01 +0000519 # from TextTestResult and overwrites addError()/addFailure() methods to
520 # allow us to to check the error/failure status here.
521 if self.__errored__ or self.__failed__:
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000522 self.dumpSessionInfo()
523
Johnny Chen21f33412010-09-01 00:15:19 +0000524 def runCmd(self, cmd, msg=None, check=True, trace=False, setCookie=True):
Johnny Chen8df95eb2010-08-19 23:26:59 +0000525 """
526 Ask the command interpreter to handle the command and then check its
527 return status.
528 """
529 # Fail fast if 'cmd' is not meaningful.
530 if not cmd or len(cmd) == 0:
531 raise Exception("Bad 'cmd' parameter encountered")
Johnny Chen4f995f02010-08-20 17:57:32 +0000532
Johnny Chen9de4ede2010-08-31 17:42:54 +0000533 trace = (True if traceAlways else trace)
Johnny Chend0c24b22010-08-23 17:10:44 +0000534
Johnny Chen21f33412010-09-01 00:15:19 +0000535 running = (cmd.startswith("run") or cmd.startswith("process launch"))
Johnny Chen4f995f02010-08-20 17:57:32 +0000536
Johnny Chen21f33412010-09-01 00:15:19 +0000537 for i in range(self.maxLaunchCount if running else 1):
Johnny Chen65572482010-08-25 18:49:48 +0000538 self.ci.HandleCommand(cmd, self.res)
Johnny Chen4f995f02010-08-20 17:57:32 +0000539
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000540 with recording(self, trace) as sbuf:
541 print >> sbuf, "runCmd:", cmd
Johnny Chen7c565c82010-10-15 16:13:00 +0000542 if not check:
Johnny Chen31cf8e22010-10-15 18:52:22 +0000543 print >> sbuf, "check of return status not required"
Johnny Chen65572482010-08-25 18:49:48 +0000544 if self.res.Succeeded():
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000545 print >> sbuf, "output:", self.res.GetOutput()
Johnny Chen65572482010-08-25 18:49:48 +0000546 else:
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000547 print >> sbuf, "runCmd failed!"
548 print >> sbuf, self.res.GetError()
Johnny Chen4f995f02010-08-20 17:57:32 +0000549
Johnny Chenc5b15db2010-09-03 22:35:47 +0000550 if running:
551 # For process launch, wait some time before possible next try.
552 time.sleep(self.timeWait)
553
Johnny Chen029acae2010-08-20 21:03:09 +0000554 if self.res.Succeeded():
Johnny Chen65572482010-08-25 18:49:48 +0000555 break
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000556 elif running:
557 with recording(self, True) as sbuf:
558 print >> sbuf, "Command '" + cmd + "' failed!"
Johnny Chen4f995f02010-08-20 17:57:32 +0000559
Johnny Chen72a14342010-09-02 21:23:12 +0000560 # Modify runStarted only if "run" or "process launch" was encountered.
561 if running:
562 self.runStarted = running and setCookie
Johnny Chen21f33412010-09-01 00:15:19 +0000563
Johnny Chen8df95eb2010-08-19 23:26:59 +0000564 if check:
565 self.assertTrue(self.res.Succeeded(),
Johnny Chen8e06de92010-09-21 23:33:30 +0000566 msg if msg else CMD_MSG(cmd, True))
Johnny Chen8df95eb2010-08-19 23:26:59 +0000567
Johnny Chen8e06de92010-09-21 23:33:30 +0000568 def expect(self, str, msg=None, patterns=None, startstr=None, substrs=None, trace=False, error=False, matching=True, exe=True):
Johnny Chen8df95eb2010-08-19 23:26:59 +0000569 """
570 Similar to runCmd; with additional expect style output matching ability.
571
572 Ask the command interpreter to handle the command and then check its
573 return status. The 'msg' parameter specifies an informational assert
574 message. We expect the output from running the command to start with
Johnny Chen2d899752010-09-21 21:08:53 +0000575 'startstr', matches the substrings contained in 'substrs', and regexp
576 matches the patterns contained in 'patterns'.
Johnny Chen9792f8e2010-09-17 22:28:51 +0000577
578 If the keyword argument error is set to True, it signifies that the API
579 client is expecting the command to fail. In this case, the error stream
Johnny Chenee975b82010-09-17 22:45:27 +0000580 from running the command is retrieved and compared against the golden
Johnny Chen9792f8e2010-09-17 22:28:51 +0000581 input, instead.
Johnny Chen2d899752010-09-21 21:08:53 +0000582
583 If the keyword argument matching is set to False, it signifies that the API
584 client is expecting the output of the command not to match the golden
585 input.
Johnny Chen8e06de92010-09-21 23:33:30 +0000586
587 Finally, the required argument 'str' represents the lldb command to be
588 sent to the command interpreter. In case the keyword argument 'exe' is
589 set to False, the 'str' is treated as a string to be matched/not-matched
590 against the golden input.
Johnny Chen8df95eb2010-08-19 23:26:59 +0000591 """
Johnny Chen9de4ede2010-08-31 17:42:54 +0000592 trace = (True if traceAlways else trace)
Johnny Chend0c24b22010-08-23 17:10:44 +0000593
Johnny Chen8e06de92010-09-21 23:33:30 +0000594 if exe:
595 # First run the command. If we are expecting error, set check=False.
596 self.runCmd(str, trace = (True if trace else False), check = not error)
Johnny Chen8df95eb2010-08-19 23:26:59 +0000597
Johnny Chen8e06de92010-09-21 23:33:30 +0000598 # Then compare the output against expected strings.
599 output = self.res.GetError() if error else self.res.GetOutput()
Johnny Chen9792f8e2010-09-17 22:28:51 +0000600
Johnny Chen8e06de92010-09-21 23:33:30 +0000601 # If error is True, the API client expects the command to fail!
602 if error:
603 self.assertFalse(self.res.Succeeded(),
604 "Command '" + str + "' is expected to fail!")
605 else:
606 # No execution required, just compare str against the golden input.
607 output = str
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000608 with recording(self, trace) as sbuf:
609 print >> sbuf, "looking at:", output
Johnny Chen9792f8e2010-09-17 22:28:51 +0000610
Johnny Chen2d899752010-09-21 21:08:53 +0000611 # The heading says either "Expecting" or "Not expecting".
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000612 heading = "Expecting" if matching else "Not expecting"
Johnny Chen2d899752010-09-21 21:08:53 +0000613
614 # Start from the startstr, if specified.
615 # If there's no startstr, set the initial state appropriately.
616 matched = output.startswith(startstr) if startstr else (True if matching else False)
Johnny Chenead35c82010-08-20 18:25:15 +0000617
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000618 if startstr:
619 with recording(self, trace) as sbuf:
620 print >> sbuf, "%s start string: %s" % (heading, startstr)
621 print >> sbuf, "Matched" if matched else "Not matched"
Johnny Chenead35c82010-08-20 18:25:15 +0000622
Johnny Chen2d899752010-09-21 21:08:53 +0000623 # Look for sub strings, if specified.
624 keepgoing = matched if matching else not matched
625 if substrs and keepgoing:
Johnny Chen8df95eb2010-08-19 23:26:59 +0000626 for str in substrs:
Johnny Chen091bb1d2010-09-23 23:35:28 +0000627 matched = output.find(str) != -1
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000628 with recording(self, trace) as sbuf:
629 print >> sbuf, "%s sub string: %s" % (heading, str)
630 print >> sbuf, "Matched" if matched else "Not matched"
Johnny Chen2d899752010-09-21 21:08:53 +0000631 keepgoing = matched if matching else not matched
632 if not keepgoing:
Johnny Chen8df95eb2010-08-19 23:26:59 +0000633 break
634
Johnny Chen2d899752010-09-21 21:08:53 +0000635 # Search for regular expression patterns, if specified.
636 keepgoing = matched if matching else not matched
637 if patterns and keepgoing:
638 for pattern in patterns:
639 # Match Objects always have a boolean value of True.
640 matched = bool(re.search(pattern, output))
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000641 with recording(self, trace) as sbuf:
642 print >> sbuf, "%s pattern: %s" % (heading, pattern)
643 print >> sbuf, "Matched" if matched else "Not matched"
Johnny Chen2d899752010-09-21 21:08:53 +0000644 keepgoing = matched if matching else not matched
645 if not keepgoing:
646 break
Johnny Chen2d899752010-09-21 21:08:53 +0000647
648 self.assertTrue(matched if matching else not matched,
Johnny Chen8e06de92010-09-21 23:33:30 +0000649 msg if msg else CMD_MSG(str, exe))
Johnny Chen8df95eb2010-08-19 23:26:59 +0000650
Johnny Chena8b3cdd2010-08-25 22:52:45 +0000651 def invoke(self, obj, name, trace=False):
Johnny Chend8473bc2010-08-25 22:56:10 +0000652 """Use reflection to call a method dynamically with no argument."""
Johnny Chen9de4ede2010-08-31 17:42:54 +0000653 trace = (True if traceAlways else trace)
Johnny Chena8b3cdd2010-08-25 22:52:45 +0000654
655 method = getattr(obj, name)
656 import inspect
657 self.assertTrue(inspect.ismethod(method),
658 name + "is a method name of object: " + str(obj))
659 result = method()
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000660 with recording(self, trace) as sbuf:
661 print >> sbuf, str(method) + ":", result
Johnny Chena8b3cdd2010-08-25 22:52:45 +0000662 return result
Johnny Chen9c10c182010-08-27 00:15:48 +0000663
Johnny Chenc202b492010-09-01 22:08:51 +0000664 def breakAfterLaunch(self, process, func, trace=False):
665 """
666 Perform some dancees after LaunchProcess() to break at func name.
667
668 Return True if we can successfully break at the func name in due time.
669 """
670 trace = (True if traceAlways else trace)
671
672 count = 0
673 while True:
674 # The stop reason of the thread should be breakpoint.
675 thread = process.GetThreadAtIndex(0)
676 SR = thread.GetStopReason()
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000677 with recording(self, trace) as sbuf:
678 print >> sbuf, "StopReason =", StopReasonString(SR)
Johnny Chenc202b492010-09-01 22:08:51 +0000679
680 if SR == StopReasonEnum("Breakpoint"):
681 frame = thread.GetFrameAtIndex(0)
682 name = frame.GetFunction().GetName()
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000683 with recording(self, trace) as sbuf:
684 print >> sbuf, "function =", name
Johnny Chenc202b492010-09-01 22:08:51 +0000685 if (name == func):
686 # We got what we want; now break out of the loop.
687 return True
688
689 # The inferior is in a transient state; continue the process.
690 time.sleep(1.0)
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000691 with recording(self, trace) as sbuf:
692 print >> sbuf, "Continuing the process:", process
Johnny Chenc202b492010-09-01 22:08:51 +0000693 process.Continue()
694
695 count = count + 1
Johnny Chenc1810672010-09-15 00:00:54 +0000696 if count == 15:
Johnny Chen84a6d6f2010-10-15 01:18:29 +0000697 with recording(self, trace) as sbuf:
698 print >> sbuf, "Reached 15 iterations, giving up..."
Johnny Chenc202b492010-09-01 22:08:51 +0000699 # Enough iterations already, break out of the loop.
700 return False
701
702 # End of while loop.
703
704
Johnny Chen0b3ee552010-09-22 23:00:20 +0000705 def buildDefault(self, architecture=None, compiler=None, dictionary=None):
Johnny Chenff4e1d82010-09-03 23:49:16 +0000706 """Platform specific way to build the default binaries."""
707 module = __import__(sys.platform)
Johnny Chen1b7d6292010-10-15 23:55:05 +0000708 if not module.buildDefault(self, architecture, compiler, dictionary):
Johnny Chenff4e1d82010-09-03 23:49:16 +0000709 raise Exception("Don't know how to build default binary")
710
Johnny Chen0b3ee552010-09-22 23:00:20 +0000711 def buildDsym(self, architecture=None, compiler=None, dictionary=None):
Johnny Cheneef7a862010-08-30 22:26:48 +0000712 """Platform specific way to build binaries with dsym info."""
Johnny Chen9de4ede2010-08-31 17:42:54 +0000713 module = __import__(sys.platform)
Johnny Chen1b7d6292010-10-15 23:55:05 +0000714 if not module.buildDsym(self, architecture, compiler, dictionary):
Johnny Cheneef7a862010-08-30 22:26:48 +0000715 raise Exception("Don't know how to build binary with dsym")
716
Johnny Chen0b3ee552010-09-22 23:00:20 +0000717 def buildDwarf(self, architecture=None, compiler=None, dictionary=None):
Johnny Cheneef7a862010-08-30 22:26:48 +0000718 """Platform specific way to build binaries with dwarf maps."""
Johnny Chen9de4ede2010-08-31 17:42:54 +0000719 module = __import__(sys.platform)
Johnny Chen1b7d6292010-10-15 23:55:05 +0000720 if not module.buildDwarf(self, architecture, compiler, dictionary):
Johnny Cheneef7a862010-08-30 22:26:48 +0000721 raise Exception("Don't know how to build binary with dwarf")
722
Johnny Chen9c10c182010-08-27 00:15:48 +0000723 def DebugSBValue(self, frame, val):
Johnny Chen9de4ede2010-08-31 17:42:54 +0000724 """Debug print a SBValue object, if traceAlways is True."""
725 if not traceAlways:
Johnny Chen9c10c182010-08-27 00:15:48 +0000726 return
727
728 err = sys.stderr
729 err.write(val.GetName() + ":\n")
730 err.write('\t' + "TypeName -> " + val.GetTypeName() + '\n')
731 err.write('\t' + "ByteSize -> " + str(val.GetByteSize()) + '\n')
732 err.write('\t' + "NumChildren -> " + str(val.GetNumChildren()) + '\n')
733 err.write('\t' + "Value -> " + str(val.GetValue(frame)) + '\n')
734 err.write('\t' + "Summary -> " + str(val.GetSummary(frame)) + '\n')
735 err.write('\t' + "IsPtrType -> " + str(val.TypeIsPtrType()) + '\n')
736 err.write('\t' + "Location -> " + val.GetLocation(frame) + '\n')
737