Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 1 | """ |
| 2 | LLDB module which provides the abstract base class of lldb test case. |
| 3 | |
| 4 | The concrete subclass can override lldbtest.TesBase in order to inherit the |
| 5 | common behavior for unitest.TestCase.setUp/tearDown implemented in this file. |
| 6 | |
| 7 | The subclass should override the attribute mydir in order for the python runtime |
| 8 | to locate the individual test cases when running as part of a large test suite |
| 9 | or 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 |
| 12 | entire test suite. Users who want to run a test case on its own can specify the |
| 13 | LLDB_TEST and PYTHONPATH environment variables, for example: |
| 14 | |
| 15 | $ export LLDB_TEST=$PWD |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 16 | $ export PYTHONPATH=/Volumes/data/lldb/svn/trunk/build/Debug/LLDB.framework/Resources/Python:$LLDB_TEST:$LLDB_TEST/plugins |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 17 | $ echo $LLDB_TEST |
| 18 | /Volumes/data/lldb/svn/trunk/test |
| 19 | $ echo $PYTHONPATH |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 20 | /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 Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 21 | $ python function_types/TestFunctionTypes.py |
| 22 | . |
| 23 | ---------------------------------------------------------------------- |
| 24 | Ran 1 test in 0.363s |
| 25 | |
| 26 | OK |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 27 | $ LLDB_COMMAND_TRACE=YES python array_types/TestArrayTypes.py |
Johnny Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 28 | |
| 29 | ... |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 30 | |
| 31 | runCmd: breakpoint set -f main.c -l 42 |
| 32 | output: Breakpoint created: 1: file ='main.c', line = 42, locations = 1 |
| 33 | |
| 34 | runCmd: run |
| 35 | output: Launching '/Volumes/data/lldb/svn/trunk/test/array_types/a.out' (x86_64) |
| 36 | |
Johnny Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 37 | ... |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 38 | |
Johnny Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 39 | runCmd: frame variable strings |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 40 | output: (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 Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 47 | runCmd: frame variable char_16 |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 48 | output: (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 Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 67 | runCmd: frame variable ushort_matrix |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 68 | output: (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 Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 81 | runCmd: frame variable long_6 |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 82 | output: (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 | ---------------------------------------------------------------------- |
| 93 | Ran 1 test in 0.349s |
| 94 | |
| 95 | OK |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 96 | $ |
| 97 | """ |
| 98 | |
Johnny Chen | 93ae604 | 2010-09-21 22:34:45 +0000 | [diff] [blame] | 99 | import os, sys, traceback |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 100 | import re |
Johnny Chen | a1cc883 | 2010-08-30 21:35:00 +0000 | [diff] [blame] | 101 | from subprocess import * |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 102 | import StringIO |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 103 | import time |
Johnny Chen | 1acaf63 | 2010-08-30 23:08:52 +0000 | [diff] [blame] | 104 | import types |
Johnny Chen | 75e28f9 | 2010-08-05 23:42:46 +0000 | [diff] [blame] | 105 | import unittest2 |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 106 | import lldb |
| 107 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 108 | # 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 Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 112 | if "LLDB_COMMAND_TRACE" in os.environ and os.environ["LLDB_COMMAND_TRACE"]=="YES": |
| 113 | traceAlways = True |
| 114 | else: |
| 115 | traceAlways = False |
| 116 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 117 | # By default, doCleanup is True. |
| 118 | if "LLDB_DO_CLEANUP" in os.environ and os.environ["LLDB_DO_CLEANUP"]=="NO": |
| 119 | doCleanup = False |
| 120 | else: |
| 121 | doCleanup = True |
| 122 | |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 123 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 124 | # |
| 125 | # Some commonly used assert messages. |
| 126 | # |
| 127 | |
Johnny Chen | ee975b8 | 2010-09-17 22:45:27 +0000 | [diff] [blame] | 128 | COMMAND_FAILED_AS_EXPECTED = "Command has failed as expected" |
| 129 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 130 | CURRENT_EXECUTABLE_SET = "Current executable set successfully" |
| 131 | |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 132 | PROCESS_IS_VALID = "Process is valid" |
| 133 | |
| 134 | PROCESS_KILLED = "Process is killed successfully" |
| 135 | |
Johnny Chen | 1bb9f9a | 2010-08-27 23:47:36 +0000 | [diff] [blame] | 136 | RUN_SUCCEEDED = "Process is launched successfully" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 137 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 138 | RUN_COMPLETED = "Process exited successfully" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 139 | |
Johnny Chen | 5349ee2 | 2010-10-05 19:27:32 +0000 | [diff] [blame] | 140 | BACKTRACE_DISPLAYED_CORRECTLY = "Backtrace displayed correctly" |
| 141 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 142 | BREAKPOINT_CREATED = "Breakpoint created successfully" |
| 143 | |
Johnny Chen | 9b92c6e | 2010-08-17 21:33:31 +0000 | [diff] [blame] | 144 | BREAKPOINT_PENDING_CREATED = "Pending breakpoint created successfully" |
| 145 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 146 | BREAKPOINT_HIT_ONCE = "Breakpoint resolved with hit cout = 1" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 147 | |
Johnny Chen | 72afa8d | 2010-09-30 17:06:24 +0000 | [diff] [blame] | 148 | BREAKPOINT_HIT_TWICE = "Breakpoint resolved with hit cout = 2" |
| 149 | |
Johnny Chen | c55dace | 2010-10-15 18:07:09 +0000 | [diff] [blame^] | 150 | BREAKPOINT_HIT_THRICE = "Breakpoint resolved with hit cout = 3" |
| 151 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 152 | STEP_OUT_SUCCEEDED = "Thread step-out succeeded" |
| 153 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 154 | STOPPED_DUE_TO_BREAKPOINT = "Process state is stopped due to breakpoint" |
| 155 | |
Johnny Chen | d7a4eb0 | 2010-10-14 01:22:03 +0000 | [diff] [blame] | 156 | STOPPED_DUE_TO_SIGNAL = "Process state is stopped due to signal" |
| 157 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 158 | STOPPED_DUE_TO_STEP_IN = "Process state is stopped due to step in" |
| 159 | |
Johnny Chen | 4917e10 | 2010-08-24 22:07:56 +0000 | [diff] [blame] | 160 | DATA_TYPES_DISPLAYED_CORRECTLY = "Data type(s) displayed correctly" |
| 161 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 162 | VALID_BREAKPOINT = "Got a valid breakpoint" |
| 163 | |
Johnny Chen | 1bb9f9a | 2010-08-27 23:47:36 +0000 | [diff] [blame] | 164 | VALID_FILESPEC = "Got a valid filespec" |
| 165 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 166 | VALID_PROCESS = "Got a valid process" |
| 167 | |
| 168 | VALID_TARGET = "Got a valid target" |
| 169 | |
Johnny Chen | 22b95b2 | 2010-08-25 19:00:04 +0000 | [diff] [blame] | 170 | VARIABLES_DISPLAYED_CORRECTLY = "Variable(s) displayed correctly" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 171 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 172 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 173 | # |
| 174 | # And a generic "Command '%s' returns successfully" message generator. |
| 175 | # |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 176 | def CMD_MSG(str, exe): |
| 177 | if exe: |
| 178 | return "Command '%s' returns successfully" % str |
| 179 | else: |
| 180 | return "'%s' compares successfully" % str |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 181 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 182 | # |
Johnny Chen | f4ce288 | 2010-08-26 21:49:29 +0000 | [diff] [blame] | 183 | # Returns an env variable array from the os.environ map object. |
| 184 | # |
| 185 | def EnvArray(): |
| 186 | return map(lambda k,v: k+"="+v, os.environ.keys(), os.environ.values()) |
| 187 | |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 188 | # From 2.7's subprocess.check_output() convenience function. |
| 189 | def system(*popenargs, **kwargs): |
| 190 | r"""Run command with arguments and return its output as a byte string. |
| 191 | |
| 192 | If the exit code was non-zero it raises a CalledProcessError. The |
| 193 | CalledProcessError object will have the return code in the returncode |
| 194 | attribute and output in the output attribute. |
| 195 | |
| 196 | The arguments are the same as for the Popen constructor. Example: |
| 197 | |
| 198 | >>> check_output(["ls", "-l", "/dev/null"]) |
| 199 | 'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n' |
| 200 | |
| 201 | The stdout argument is not allowed as it is used internally. |
| 202 | To capture standard error in the result, use stderr=STDOUT. |
| 203 | |
| 204 | >>> check_output(["/bin/sh", "-c", |
| 205 | ... "ls -l non_existent_file ; exit 0"], |
| 206 | ... stderr=STDOUT) |
| 207 | 'ls: non_existent_file: No such file or directory\n' |
| 208 | """ |
| 209 | if 'stdout' in kwargs: |
| 210 | raise ValueError('stdout argument not allowed, it will be overridden.') |
| 211 | process = Popen(stdout=PIPE, *popenargs, **kwargs) |
Johnny Chen | fde69bc | 2010-09-14 22:01:40 +0000 | [diff] [blame] | 212 | output, error = process.communicate() |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 213 | retcode = process.poll() |
| 214 | |
| 215 | if traceAlways: |
| 216 | if isinstance(popenargs, types.StringTypes): |
| 217 | args = [popenargs] |
| 218 | else: |
| 219 | args = list(popenargs) |
| 220 | print >> sys.stderr |
| 221 | print >> sys.stderr, "os command:", args |
Johnny Chen | 493cad4 | 2010-09-14 22:39:02 +0000 | [diff] [blame] | 222 | print >> sys.stderr, "stdout:", output |
| 223 | print >> sys.stderr, "stderr:", error |
| 224 | print >> sys.stderr, "retcode:", retcode |
Johnny Chen | fde69bc | 2010-09-14 22:01:40 +0000 | [diff] [blame] | 225 | print >> sys.stderr |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 226 | |
| 227 | if retcode: |
| 228 | cmd = kwargs.get("args") |
| 229 | if cmd is None: |
| 230 | cmd = popenargs[0] |
Johnny Chen | 517c705 | 2010-09-16 18:26:06 +0000 | [diff] [blame] | 231 | raise CalledProcessError(retcode, cmd) |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 232 | return output |
| 233 | |
Johnny Chen | 1490600 | 2010-10-11 23:52:19 +0000 | [diff] [blame] | 234 | def line_number(filename, string_to_match): |
| 235 | """Helper function to return the line number of the first matched string.""" |
| 236 | with open(filename, 'r') as f: |
| 237 | for i, line in enumerate(f): |
| 238 | if line.find(string_to_match) != -1: |
| 239 | # Found our match. |
Johnny Chen | 0659e34 | 2010-10-12 00:09:25 +0000 | [diff] [blame] | 240 | return i+1 |
Johnny Chen | 1490600 | 2010-10-11 23:52:19 +0000 | [diff] [blame] | 241 | return -1 |
| 242 | |
Johnny Chen | 5349ee2 | 2010-10-05 19:27:32 +0000 | [diff] [blame] | 243 | def pointer_size(): |
| 244 | """Return the pointer size of the host system.""" |
| 245 | import ctypes |
| 246 | a_pointer = ctypes.c_void_p(0xffff) |
| 247 | return 8 * ctypes.sizeof(a_pointer) |
| 248 | |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 249 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 250 | class recording(StringIO.StringIO): |
| 251 | """ |
| 252 | A nice little context manager for recording the debugger interactions into |
| 253 | our session object. If trace flag is ON, it also emits the interactions |
| 254 | into the stderr. |
| 255 | """ |
| 256 | def __init__(self, test, trace): |
| 257 | """Create a StringIO instance; record session, stderr, and trace.""" |
| 258 | StringIO.StringIO.__init__(self) |
| 259 | self.session = test.session |
| 260 | self.stderr = test.old_stderr |
| 261 | self.trace = trace |
| 262 | |
| 263 | def __enter__(self): |
| 264 | """ |
| 265 | Context management protocol on entry to the body of the with statement. |
| 266 | Just return the StringIO object. |
| 267 | """ |
| 268 | return self |
| 269 | |
| 270 | def __exit__(self, type, value, tb): |
| 271 | """ |
| 272 | Context management protocol on exit from the body of the with statement. |
| 273 | If trace is ON, it emits the recordings into stderr. Always add the |
| 274 | recordings to our session object. And close the StringIO object, too. |
| 275 | """ |
| 276 | if self.trace: |
| 277 | print >> self.stderr, self.getvalue() |
| 278 | print >> self.session, self.getvalue() |
| 279 | self.close() |
| 280 | |
Johnny Chen | 75e28f9 | 2010-08-05 23:42:46 +0000 | [diff] [blame] | 281 | class TestBase(unittest2.TestCase): |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 282 | """This LLDB abstract base class is meant to be subclassed.""" |
| 283 | |
Johnny Chen | 4199819 | 2010-10-01 22:59:49 +0000 | [diff] [blame] | 284 | @classmethod |
| 285 | def skipLongRunningTest(cls): |
| 286 | """ |
| 287 | By default, we skip long running test case. |
| 288 | This can be overridden by passing '-l' to the test driver (dotest.py). |
| 289 | """ |
| 290 | if "LLDB_SKIP_LONG_RUNNING_TEST" in os.environ and "NO" == os.environ["LLDB_SKIP_LONG_RUNNING_TEST"]: |
| 291 | return False |
| 292 | else: |
| 293 | return True |
| 294 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 295 | # The concrete subclass should override this attribute. |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 296 | mydir = None |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 297 | |
Johnny Chen | ffde4fc | 2010-08-16 21:28:10 +0000 | [diff] [blame] | 298 | # State pertaining to the inferior process, if any. |
Johnny Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 299 | # This reflects inferior process started through the command interface with |
| 300 | # either the lldb "run" or "process launch" command. |
| 301 | # See also self.runCmd(). |
Johnny Chen | ffde4fc | 2010-08-16 21:28:10 +0000 | [diff] [blame] | 302 | runStarted = False |
| 303 | |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 304 | # Maximum allowed attempts when launching the inferior process. |
| 305 | # Can be overridden by the LLDB_MAX_LAUNCH_COUNT environment variable. |
| 306 | maxLaunchCount = 3; |
| 307 | |
| 308 | # Time to wait before the next launching attempt in second(s). |
| 309 | # Can be overridden by the LLDB_TIME_WAIT environment variable. |
| 310 | timeWait = 1.0; |
| 311 | |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 312 | # Keep track of the old current working directory. |
| 313 | oldcwd = None |
Johnny Chen | 88f8304 | 2010-08-05 21:23:45 +0000 | [diff] [blame] | 314 | |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 315 | @classmethod |
| 316 | def setUpClass(cls): |
Johnny Chen | 4199819 | 2010-10-01 22:59:49 +0000 | [diff] [blame] | 317 | """ |
| 318 | Python unittest framework class setup fixture. |
| 319 | Do current directory manipulation. |
| 320 | """ |
| 321 | |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 322 | # Fail fast if 'mydir' attribute is not overridden. |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 323 | if not cls.mydir or len(cls.mydir) == 0: |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 324 | raise Exception("Subclasses must override the 'mydir' attribute.") |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 325 | # Save old working directory. |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 326 | cls.oldcwd = os.getcwd() |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 327 | |
| 328 | # Change current working directory if ${LLDB_TEST} is defined. |
| 329 | # See also dotest.py which sets up ${LLDB_TEST}. |
| 330 | if ("LLDB_TEST" in os.environ): |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 331 | if traceAlways: |
Johnny Chen | 72afa8d | 2010-09-30 17:06:24 +0000 | [diff] [blame] | 332 | print >> sys.stderr, "Change dir to:", os.path.join(os.environ["LLDB_TEST"], cls.mydir) |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 333 | os.chdir(os.path.join(os.environ["LLDB_TEST"], cls.mydir)) |
| 334 | |
| 335 | @classmethod |
| 336 | def tearDownClass(cls): |
Johnny Chen | 4199819 | 2010-10-01 22:59:49 +0000 | [diff] [blame] | 337 | """ |
| 338 | Python unittest framework class teardown fixture. |
| 339 | Do class-wide cleanup. |
| 340 | """ |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 341 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 342 | if doCleanup: |
| 343 | # First, let's do the platform-specific cleanup. |
| 344 | module = __import__(sys.platform) |
| 345 | if not module.cleanup(): |
| 346 | raise Exception("Don't know how to do cleanup") |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 347 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 348 | # Subclass might have specific cleanup function defined. |
| 349 | if getattr(cls, "classCleanup", None): |
| 350 | if traceAlways: |
| 351 | print >> sys.stderr, "Call class-specific cleanup function for class:", cls |
| 352 | try: |
| 353 | cls.classCleanup() |
| 354 | except: |
| 355 | exc_type, exc_value, exc_tb = sys.exc_info() |
| 356 | traceback.print_exception(exc_type, exc_value, exc_tb) |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 357 | |
| 358 | # Restore old working directory. |
| 359 | if traceAlways: |
Johnny Chen | 72afa8d | 2010-09-30 17:06:24 +0000 | [diff] [blame] | 360 | print >> sys.stderr, "Restore dir to:", cls.oldcwd |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 361 | os.chdir(cls.oldcwd) |
| 362 | |
| 363 | def setUp(self): |
| 364 | #import traceback |
| 365 | #traceback.print_stack() |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 366 | |
Johnny Chen | e47649c | 2010-10-07 02:04:14 +0000 | [diff] [blame] | 367 | if ("LLDB_WAIT_BETWEEN_TEST_CASES" in os.environ and |
| 368 | os.environ["LLDB_WAIT_BETWEEN_TEST_CASES"] == 'YES'): |
| 369 | time.sleep(0.5) |
| 370 | |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 371 | if "LLDB_MAX_LAUNCH_COUNT" in os.environ: |
| 372 | self.maxLaunchCount = int(os.environ["LLDB_MAX_LAUNCH_COUNT"]) |
| 373 | |
| 374 | if "LLDB_TIME_WAIT" in os.environ: |
| 375 | self.timeWait = float(os.environ["LLDB_TIME_WAIT"]) |
| 376 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 377 | # Create the debugger instance if necessary. |
| 378 | try: |
| 379 | self.dbg = lldb.DBG |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 380 | except AttributeError: |
| 381 | self.dbg = lldb.SBDebugger.Create() |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 382 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 383 | if not self.dbg.IsValid(): |
| 384 | raise Exception('Invalid debugger instance') |
| 385 | |
| 386 | # We want our debugger to be synchronous. |
| 387 | self.dbg.SetAsync(False) |
| 388 | |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 389 | # There is no process associated with the debugger as yet. |
Johnny Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 390 | # See also self.tearDown() where it checks whether self.process has a |
| 391 | # valid reference and calls self.process.Kill() to kill the process. |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 392 | self.process = None |
| 393 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 394 | # Retrieve the associated command interpreter instance. |
| 395 | self.ci = self.dbg.GetCommandInterpreter() |
| 396 | if not self.ci: |
| 397 | raise Exception('Could not get the command interpreter') |
| 398 | |
| 399 | # And the result object. |
| 400 | self.res = lldb.SBCommandReturnObject() |
| 401 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 402 | # These are for customized teardown cleanup. |
| 403 | self.dict = None |
| 404 | self.doTearDownCleanup = False |
| 405 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 406 | # Create a string buffer to record the session info. |
| 407 | self.session = StringIO.StringIO() |
| 408 | |
| 409 | # Substitute self.session as the sys.stderr and restore it at the end of |
| 410 | # the test during tearDown(). If trace is ON, we dump the session info |
| 411 | # into the real stderr as well. The session info will be dumped into a |
| 412 | # test case specific file if a failure is encountered. |
| 413 | self.old_stderr = sys.stderr |
| 414 | sys.stderr = self.session |
| 415 | |
Johnny Chen | 314a145 | 2010-10-15 16:22:10 +0000 | [diff] [blame] | 416 | # Optimistically set self.__failed__ to False initially. If the test |
| 417 | # failed, the session info (self.session) is then dumped into a session |
| 418 | # specific file for diagnosis. |
Johnny Chen | 595c9d7 | 2010-10-15 02:28:13 +0000 | [diff] [blame] | 419 | self.__failed__ = False |
| 420 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 421 | def setTearDownCleanup(self, dictionary=None): |
| 422 | self.dict = dictionary |
| 423 | self.doTearDownCleanup = True |
| 424 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 425 | def markFailure(self): |
| 426 | """Callback invoked when we (the test case instance) failed.""" |
Johnny Chen | 595c9d7 | 2010-10-15 02:28:13 +0000 | [diff] [blame] | 427 | self.__failed__ = True |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 428 | with recording(self, False) as sbuf: |
Johnny Chen | 314a145 | 2010-10-15 16:22:10 +0000 | [diff] [blame] | 429 | # False because there's no need to write "FAIL" to the stderr twice. |
| 430 | # Once by the Python unittest framework, and a second time by us. |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 431 | print >> sbuf, "FAIL" |
| 432 | |
| 433 | def dumpSessionInfo(self): |
| 434 | """ |
| 435 | Dump the debugger interactions leading to a test failure. This allows |
| 436 | for more convenient postmortem analysis. |
| 437 | """ |
| 438 | for test, err in lldb.test_result.failures: |
| 439 | if test is self: |
| 440 | print >> self.session, err |
| 441 | |
| 442 | fname = os.path.join(os.environ["LLDB_TEST"], ".session-" + self.id()) |
| 443 | with open(fname, "w") as f: |
| 444 | print >> f, self.session.getvalue() |
| 445 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 446 | def tearDown(self): |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 447 | #import traceback |
| 448 | #traceback.print_stack() |
| 449 | |
| 450 | # Terminate the current process being debugged, if any. |
Johnny Chen | ffde4fc | 2010-08-16 21:28:10 +0000 | [diff] [blame] | 451 | if self.runStarted: |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 452 | self.runCmd("process kill", PROCESS_KILLED, check=False) |
| 453 | elif self.process and self.process.IsValid(): |
Johnny Chen | e47649c | 2010-10-07 02:04:14 +0000 | [diff] [blame] | 454 | rc = self.invoke(self.process, "Kill") |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 455 | self.assertTrue(rc.Success(), PROCESS_KILLED) |
Johnny Chen | e47649c | 2010-10-07 02:04:14 +0000 | [diff] [blame] | 456 | del self.process |
Johnny Chen | ffde4fc | 2010-08-16 21:28:10 +0000 | [diff] [blame] | 457 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 458 | del self.dbg |
| 459 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 460 | # Perform registered teardown cleanup. |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 461 | if doCleanup and self.doTearDownCleanup: |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 462 | module = __import__(sys.platform) |
| 463 | if not module.cleanup(dictionary=self.dict): |
| 464 | raise Exception("Don't know how to do cleanup") |
| 465 | |
Johnny Chen | 595c9d7 | 2010-10-15 02:28:13 +0000 | [diff] [blame] | 466 | # See also LLDBTestResult (dotest.py) which is a singlton class derived |
| 467 | # from TextTestResult and overwrites addFailure() method to allow us to |
| 468 | # to check the failure status here. |
| 469 | if self.__failed__: |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 470 | self.dumpSessionInfo() |
| 471 | |
| 472 | # Restore the sys.stderr to what it was before. |
| 473 | sys.stderr = self.old_stderr |
| 474 | |
Johnny Chen | 21f3341 | 2010-09-01 00:15:19 +0000 | [diff] [blame] | 475 | def runCmd(self, cmd, msg=None, check=True, trace=False, setCookie=True): |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 476 | """ |
| 477 | Ask the command interpreter to handle the command and then check its |
| 478 | return status. |
| 479 | """ |
| 480 | # Fail fast if 'cmd' is not meaningful. |
| 481 | if not cmd or len(cmd) == 0: |
| 482 | raise Exception("Bad 'cmd' parameter encountered") |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 483 | |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 484 | trace = (True if traceAlways else trace) |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 485 | |
Johnny Chen | 21f3341 | 2010-09-01 00:15:19 +0000 | [diff] [blame] | 486 | running = (cmd.startswith("run") or cmd.startswith("process launch")) |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 487 | |
Johnny Chen | 21f3341 | 2010-09-01 00:15:19 +0000 | [diff] [blame] | 488 | for i in range(self.maxLaunchCount if running else 1): |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 489 | self.ci.HandleCommand(cmd, self.res) |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 490 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 491 | with recording(self, trace) as sbuf: |
| 492 | print >> sbuf, "runCmd:", cmd |
Johnny Chen | 7c565c8 | 2010-10-15 16:13:00 +0000 | [diff] [blame] | 493 | if not check: |
| 494 | print >> sbuf, "checking of return status not required" |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 495 | if self.res.Succeeded(): |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 496 | print >> sbuf, "output:", self.res.GetOutput() |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 497 | else: |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 498 | print >> sbuf, "runCmd failed!" |
| 499 | print >> sbuf, self.res.GetError() |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 500 | |
Johnny Chen | c5b15db | 2010-09-03 22:35:47 +0000 | [diff] [blame] | 501 | if running: |
| 502 | # For process launch, wait some time before possible next try. |
| 503 | time.sleep(self.timeWait) |
| 504 | |
Johnny Chen | 029acae | 2010-08-20 21:03:09 +0000 | [diff] [blame] | 505 | if self.res.Succeeded(): |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 506 | break |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 507 | elif running: |
| 508 | with recording(self, True) as sbuf: |
| 509 | print >> sbuf, "Command '" + cmd + "' failed!" |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 510 | |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 511 | # Modify runStarted only if "run" or "process launch" was encountered. |
| 512 | if running: |
| 513 | self.runStarted = running and setCookie |
Johnny Chen | 21f3341 | 2010-09-01 00:15:19 +0000 | [diff] [blame] | 514 | |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 515 | if check: |
| 516 | self.assertTrue(self.res.Succeeded(), |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 517 | msg if msg else CMD_MSG(cmd, True)) |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 518 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 519 | def expect(self, str, msg=None, patterns=None, startstr=None, substrs=None, trace=False, error=False, matching=True, exe=True): |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 520 | """ |
| 521 | Similar to runCmd; with additional expect style output matching ability. |
| 522 | |
| 523 | Ask the command interpreter to handle the command and then check its |
| 524 | return status. The 'msg' parameter specifies an informational assert |
| 525 | message. We expect the output from running the command to start with |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 526 | 'startstr', matches the substrings contained in 'substrs', and regexp |
| 527 | matches the patterns contained in 'patterns'. |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 528 | |
| 529 | If the keyword argument error is set to True, it signifies that the API |
| 530 | client is expecting the command to fail. In this case, the error stream |
Johnny Chen | ee975b8 | 2010-09-17 22:45:27 +0000 | [diff] [blame] | 531 | from running the command is retrieved and compared against the golden |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 532 | input, instead. |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 533 | |
| 534 | If the keyword argument matching is set to False, it signifies that the API |
| 535 | client is expecting the output of the command not to match the golden |
| 536 | input. |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 537 | |
| 538 | Finally, the required argument 'str' represents the lldb command to be |
| 539 | sent to the command interpreter. In case the keyword argument 'exe' is |
| 540 | set to False, the 'str' is treated as a string to be matched/not-matched |
| 541 | against the golden input. |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 542 | """ |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 543 | trace = (True if traceAlways else trace) |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 544 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 545 | if exe: |
| 546 | # First run the command. If we are expecting error, set check=False. |
| 547 | self.runCmd(str, trace = (True if trace else False), check = not error) |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 548 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 549 | # Then compare the output against expected strings. |
| 550 | output = self.res.GetError() if error else self.res.GetOutput() |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 551 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 552 | # If error is True, the API client expects the command to fail! |
| 553 | if error: |
| 554 | self.assertFalse(self.res.Succeeded(), |
| 555 | "Command '" + str + "' is expected to fail!") |
| 556 | else: |
| 557 | # No execution required, just compare str against the golden input. |
| 558 | output = str |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 559 | with recording(self, trace) as sbuf: |
| 560 | print >> sbuf, "looking at:", output |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 561 | |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 562 | # The heading says either "Expecting" or "Not expecting". |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 563 | heading = "Expecting" if matching else "Not expecting" |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 564 | |
| 565 | # Start from the startstr, if specified. |
| 566 | # If there's no startstr, set the initial state appropriately. |
| 567 | matched = output.startswith(startstr) if startstr else (True if matching else False) |
Johnny Chen | ead35c8 | 2010-08-20 18:25:15 +0000 | [diff] [blame] | 568 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 569 | if startstr: |
| 570 | with recording(self, trace) as sbuf: |
| 571 | print >> sbuf, "%s start string: %s" % (heading, startstr) |
| 572 | print >> sbuf, "Matched" if matched else "Not matched" |
Johnny Chen | ead35c8 | 2010-08-20 18:25:15 +0000 | [diff] [blame] | 573 | |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 574 | # Look for sub strings, if specified. |
| 575 | keepgoing = matched if matching else not matched |
| 576 | if substrs and keepgoing: |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 577 | for str in substrs: |
Johnny Chen | 091bb1d | 2010-09-23 23:35:28 +0000 | [diff] [blame] | 578 | matched = output.find(str) != -1 |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 579 | with recording(self, trace) as sbuf: |
| 580 | print >> sbuf, "%s sub string: %s" % (heading, str) |
| 581 | print >> sbuf, "Matched" if matched else "Not matched" |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 582 | keepgoing = matched if matching else not matched |
| 583 | if not keepgoing: |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 584 | break |
| 585 | |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 586 | # Search for regular expression patterns, if specified. |
| 587 | keepgoing = matched if matching else not matched |
| 588 | if patterns and keepgoing: |
| 589 | for pattern in patterns: |
| 590 | # Match Objects always have a boolean value of True. |
| 591 | matched = bool(re.search(pattern, output)) |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 592 | with recording(self, trace) as sbuf: |
| 593 | print >> sbuf, "%s pattern: %s" % (heading, pattern) |
| 594 | print >> sbuf, "Matched" if matched else "Not matched" |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 595 | keepgoing = matched if matching else not matched |
| 596 | if not keepgoing: |
| 597 | break |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 598 | |
| 599 | self.assertTrue(matched if matching else not matched, |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 600 | msg if msg else CMD_MSG(str, exe)) |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 601 | |
Johnny Chen | a8b3cdd | 2010-08-25 22:52:45 +0000 | [diff] [blame] | 602 | def invoke(self, obj, name, trace=False): |
Johnny Chen | d8473bc | 2010-08-25 22:56:10 +0000 | [diff] [blame] | 603 | """Use reflection to call a method dynamically with no argument.""" |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 604 | trace = (True if traceAlways else trace) |
Johnny Chen | a8b3cdd | 2010-08-25 22:52:45 +0000 | [diff] [blame] | 605 | |
| 606 | method = getattr(obj, name) |
| 607 | import inspect |
| 608 | self.assertTrue(inspect.ismethod(method), |
| 609 | name + "is a method name of object: " + str(obj)) |
| 610 | result = method() |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 611 | with recording(self, trace) as sbuf: |
| 612 | print >> sbuf, str(method) + ":", result |
Johnny Chen | a8b3cdd | 2010-08-25 22:52:45 +0000 | [diff] [blame] | 613 | return result |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 614 | |
Johnny Chen | c202b49 | 2010-09-01 22:08:51 +0000 | [diff] [blame] | 615 | def breakAfterLaunch(self, process, func, trace=False): |
| 616 | """ |
| 617 | Perform some dancees after LaunchProcess() to break at func name. |
| 618 | |
| 619 | Return True if we can successfully break at the func name in due time. |
| 620 | """ |
| 621 | trace = (True if traceAlways else trace) |
| 622 | |
| 623 | count = 0 |
| 624 | while True: |
| 625 | # The stop reason of the thread should be breakpoint. |
| 626 | thread = process.GetThreadAtIndex(0) |
| 627 | SR = thread.GetStopReason() |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 628 | with recording(self, trace) as sbuf: |
| 629 | print >> sbuf, "StopReason =", StopReasonString(SR) |
Johnny Chen | c202b49 | 2010-09-01 22:08:51 +0000 | [diff] [blame] | 630 | |
| 631 | if SR == StopReasonEnum("Breakpoint"): |
| 632 | frame = thread.GetFrameAtIndex(0) |
| 633 | name = frame.GetFunction().GetName() |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 634 | with recording(self, trace) as sbuf: |
| 635 | print >> sbuf, "function =", name |
Johnny Chen | c202b49 | 2010-09-01 22:08:51 +0000 | [diff] [blame] | 636 | if (name == func): |
| 637 | # We got what we want; now break out of the loop. |
| 638 | return True |
| 639 | |
| 640 | # The inferior is in a transient state; continue the process. |
| 641 | time.sleep(1.0) |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 642 | with recording(self, trace) as sbuf: |
| 643 | print >> sbuf, "Continuing the process:", process |
Johnny Chen | c202b49 | 2010-09-01 22:08:51 +0000 | [diff] [blame] | 644 | process.Continue() |
| 645 | |
| 646 | count = count + 1 |
Johnny Chen | c181067 | 2010-09-15 00:00:54 +0000 | [diff] [blame] | 647 | if count == 15: |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 648 | with recording(self, trace) as sbuf: |
| 649 | print >> sbuf, "Reached 15 iterations, giving up..." |
Johnny Chen | c202b49 | 2010-09-01 22:08:51 +0000 | [diff] [blame] | 650 | # Enough iterations already, break out of the loop. |
| 651 | return False |
| 652 | |
| 653 | # End of while loop. |
| 654 | |
| 655 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 656 | def buildDefault(self, architecture=None, compiler=None, dictionary=None): |
Johnny Chen | ff4e1d8 | 2010-09-03 23:49:16 +0000 | [diff] [blame] | 657 | """Platform specific way to build the default binaries.""" |
| 658 | module = __import__(sys.platform) |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 659 | if not module.buildDefault(architecture, compiler, dictionary): |
Johnny Chen | ff4e1d8 | 2010-09-03 23:49:16 +0000 | [diff] [blame] | 660 | raise Exception("Don't know how to build default binary") |
| 661 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 662 | def buildDsym(self, architecture=None, compiler=None, dictionary=None): |
Johnny Chen | eef7a86 | 2010-08-30 22:26:48 +0000 | [diff] [blame] | 663 | """Platform specific way to build binaries with dsym info.""" |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 664 | module = __import__(sys.platform) |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 665 | if not module.buildDsym(architecture, compiler, dictionary): |
Johnny Chen | eef7a86 | 2010-08-30 22:26:48 +0000 | [diff] [blame] | 666 | raise Exception("Don't know how to build binary with dsym") |
| 667 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 668 | def buildDwarf(self, architecture=None, compiler=None, dictionary=None): |
Johnny Chen | eef7a86 | 2010-08-30 22:26:48 +0000 | [diff] [blame] | 669 | """Platform specific way to build binaries with dwarf maps.""" |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 670 | module = __import__(sys.platform) |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 671 | if not module.buildDwarf(architecture, compiler, dictionary): |
Johnny Chen | eef7a86 | 2010-08-30 22:26:48 +0000 | [diff] [blame] | 672 | raise Exception("Don't know how to build binary with dwarf") |
| 673 | |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 674 | def DebugSBValue(self, frame, val): |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 675 | """Debug print a SBValue object, if traceAlways is True.""" |
| 676 | if not traceAlways: |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 677 | return |
| 678 | |
| 679 | err = sys.stderr |
| 680 | err.write(val.GetName() + ":\n") |
| 681 | err.write('\t' + "TypeName -> " + val.GetTypeName() + '\n') |
| 682 | err.write('\t' + "ByteSize -> " + str(val.GetByteSize()) + '\n') |
| 683 | err.write('\t' + "NumChildren -> " + str(val.GetNumChildren()) + '\n') |
| 684 | err.write('\t' + "Value -> " + str(val.GetValue(frame)) + '\n') |
| 685 | err.write('\t' + "Summary -> " + str(val.GetSummary(frame)) + '\n') |
| 686 | err.write('\t' + "IsPtrType -> " + str(val.TypeIsPtrType()) + '\n') |
| 687 | err.write('\t' + "Location -> " + val.GetLocation(frame) + '\n') |
| 688 | |