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 |
Johnny Chen | e39170b | 2012-05-16 20:41:28 +0000 | [diff] [blame] | 12 | entire of part of the test suite . Example: |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 13 | |
Johnny Chen | e39170b | 2012-05-16 20:41:28 +0000 | [diff] [blame] | 14 | # Exercises the test suite in the types directory.... |
| 15 | /Volumes/data/lldb/svn/ToT/test $ ./dotest.py -A x86_64 types |
Johnny Chen | 59ea45f | 2010-09-02 22:25:47 +0000 | [diff] [blame] | 16 | ... |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 17 | |
Johnny Chen | e39170b | 2012-05-16 20:41:28 +0000 | [diff] [blame] | 18 | Session logs for test failures/errors/unexpected successes will go into directory '2012-05-16-13_35_42' |
| 19 | Command invoked: python ./dotest.py -A x86_64 types |
| 20 | compilers=['clang'] |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 21 | |
Johnny Chen | e39170b | 2012-05-16 20:41:28 +0000 | [diff] [blame] | 22 | Configuration: arch=x86_64 compiler=clang |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 23 | ---------------------------------------------------------------------- |
Johnny Chen | e39170b | 2012-05-16 20:41:28 +0000 | [diff] [blame] | 24 | Collected 72 tests |
| 25 | |
| 26 | ........................................................................ |
| 27 | ---------------------------------------------------------------------- |
| 28 | Ran 72 tests in 135.468s |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 29 | |
| 30 | OK |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 31 | $ |
| 32 | """ |
| 33 | |
Johnny Chen | 93ae604 | 2010-09-21 22:34:45 +0000 | [diff] [blame] | 34 | import os, sys, traceback |
Enrico Granata | 0fd6c8d | 2012-10-24 18:14:21 +0000 | [diff] [blame] | 35 | import os.path |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 36 | import re |
Johnny Chen | a1cc883 | 2010-08-30 21:35:00 +0000 | [diff] [blame] | 37 | from subprocess import * |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 38 | import StringIO |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 39 | import time |
Johnny Chen | 1acaf63 | 2010-08-30 23:08:52 +0000 | [diff] [blame] | 40 | import types |
Johnny Chen | 75e28f9 | 2010-08-05 23:42:46 +0000 | [diff] [blame] | 41 | import unittest2 |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 42 | import lldb |
| 43 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 44 | # See also dotest.parseOptionsAndInitTestdirs(), where the environment variables |
Johnny Chen | 24af296 | 2011-01-19 18:18:47 +0000 | [diff] [blame] | 45 | # LLDB_COMMAND_TRACE and LLDB_DO_CLEANUP are set from '-t' and '-r dir' options. |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 46 | |
| 47 | # By default, traceAlways is False. |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 48 | if "LLDB_COMMAND_TRACE" in os.environ and os.environ["LLDB_COMMAND_TRACE"]=="YES": |
| 49 | traceAlways = True |
| 50 | else: |
| 51 | traceAlways = False |
| 52 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 53 | # By default, doCleanup is True. |
| 54 | if "LLDB_DO_CLEANUP" in os.environ and os.environ["LLDB_DO_CLEANUP"]=="NO": |
| 55 | doCleanup = False |
| 56 | else: |
| 57 | doCleanup = True |
| 58 | |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 59 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 60 | # |
| 61 | # Some commonly used assert messages. |
| 62 | # |
| 63 | |
Johnny Chen | ee975b8 | 2010-09-17 22:45:27 +0000 | [diff] [blame] | 64 | COMMAND_FAILED_AS_EXPECTED = "Command has failed as expected" |
| 65 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 66 | CURRENT_EXECUTABLE_SET = "Current executable set successfully" |
| 67 | |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 68 | PROCESS_IS_VALID = "Process is valid" |
| 69 | |
| 70 | PROCESS_KILLED = "Process is killed successfully" |
| 71 | |
Johnny Chen | 0ace30f | 2010-12-23 01:12:19 +0000 | [diff] [blame] | 72 | PROCESS_EXITED = "Process exited successfully" |
| 73 | |
| 74 | PROCESS_STOPPED = "Process status should be stopped" |
| 75 | |
Johnny Chen | 1bb9f9a | 2010-08-27 23:47:36 +0000 | [diff] [blame] | 76 | RUN_SUCCEEDED = "Process is launched successfully" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 77 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 78 | RUN_COMPLETED = "Process exited successfully" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 79 | |
Johnny Chen | 5349ee2 | 2010-10-05 19:27:32 +0000 | [diff] [blame] | 80 | BACKTRACE_DISPLAYED_CORRECTLY = "Backtrace displayed correctly" |
| 81 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 82 | BREAKPOINT_CREATED = "Breakpoint created successfully" |
| 83 | |
Johnny Chen | 1ad9e99 | 2010-12-04 00:07:24 +0000 | [diff] [blame] | 84 | BREAKPOINT_STATE_CORRECT = "Breakpoint state is correct" |
| 85 | |
Johnny Chen | 9b92c6e | 2010-08-17 21:33:31 +0000 | [diff] [blame] | 86 | BREAKPOINT_PENDING_CREATED = "Pending breakpoint created successfully" |
| 87 | |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 88 | BREAKPOINT_HIT_ONCE = "Breakpoint resolved with hit cout = 1" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 89 | |
Johnny Chen | 72afa8d | 2010-09-30 17:06:24 +0000 | [diff] [blame] | 90 | BREAKPOINT_HIT_TWICE = "Breakpoint resolved with hit cout = 2" |
| 91 | |
Johnny Chen | c55dace | 2010-10-15 18:07:09 +0000 | [diff] [blame] | 92 | BREAKPOINT_HIT_THRICE = "Breakpoint resolved with hit cout = 3" |
| 93 | |
Greg Clayton | b2c1a41 | 2012-10-24 18:24:14 +0000 | [diff] [blame^] | 94 | MISSING_EXPECTED_REGISTERS = "At least one expected register is unavailable." |
| 95 | |
Johnny Chen | c0dbdc0 | 2011-06-27 20:05:23 +0000 | [diff] [blame] | 96 | OBJECT_PRINTED_CORRECTLY = "Object printed correctly" |
| 97 | |
Johnny Chen | 6f7abb0 | 2010-12-09 18:22:12 +0000 | [diff] [blame] | 98 | SOURCE_DISPLAYED_CORRECTLY = "Source code displayed correctly" |
| 99 | |
Johnny Chen | 0b3ee55 | 2010-09-22 23:00:20 +0000 | [diff] [blame] | 100 | STEP_OUT_SUCCEEDED = "Thread step-out succeeded" |
| 101 | |
Johnny Chen | 33cd0c3 | 2011-04-15 16:44:48 +0000 | [diff] [blame] | 102 | STOPPED_DUE_TO_EXC_BAD_ACCESS = "Process should be stopped due to bad access exception" |
| 103 | |
Johnny Chen | e8587d0 | 2010-11-10 23:46:38 +0000 | [diff] [blame] | 104 | STOPPED_DUE_TO_BREAKPOINT = "Process should be stopped due to breakpoint" |
Johnny Chen | c82ac76 | 2010-11-10 20:20:06 +0000 | [diff] [blame] | 105 | |
Johnny Chen | e8587d0 | 2010-11-10 23:46:38 +0000 | [diff] [blame] | 106 | STOPPED_DUE_TO_BREAKPOINT_WITH_STOP_REASON_AS = "%s, %s" % ( |
| 107 | STOPPED_DUE_TO_BREAKPOINT, "instead, the actual stop reason is: '%s'") |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 108 | |
Johnny Chen | f6bdb19 | 2010-10-20 18:38:48 +0000 | [diff] [blame] | 109 | STOPPED_DUE_TO_BREAKPOINT_CONDITION = "Stopped due to breakpoint condition" |
| 110 | |
Johnny Chen | 7a4512b | 2010-12-13 21:49:58 +0000 | [diff] [blame] | 111 | STOPPED_DUE_TO_BREAKPOINT_IGNORE_COUNT = "Stopped due to breakpoint and ignore count" |
| 112 | |
Johnny Chen | d7a4eb0 | 2010-10-14 01:22:03 +0000 | [diff] [blame] | 113 | STOPPED_DUE_TO_SIGNAL = "Process state is stopped due to signal" |
| 114 | |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 115 | STOPPED_DUE_TO_STEP_IN = "Process state is stopped due to step in" |
| 116 | |
Johnny Chen | 58c66e2 | 2011-09-15 21:09:59 +0000 | [diff] [blame] | 117 | STOPPED_DUE_TO_WATCHPOINT = "Process should be stopped due to watchpoint" |
| 118 | |
Johnny Chen | 4917e10 | 2010-08-24 22:07:56 +0000 | [diff] [blame] | 119 | DATA_TYPES_DISPLAYED_CORRECTLY = "Data type(s) displayed correctly" |
| 120 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 121 | VALID_BREAKPOINT = "Got a valid breakpoint" |
| 122 | |
Johnny Chen | 0601a29 | 2010-10-22 18:10:25 +0000 | [diff] [blame] | 123 | VALID_BREAKPOINT_LOCATION = "Got a valid breakpoint location" |
| 124 | |
Johnny Chen | ac91027 | 2011-05-06 23:26:12 +0000 | [diff] [blame] | 125 | VALID_COMMAND_INTERPRETER = "Got a valid command interpreter" |
| 126 | |
Johnny Chen | 1bb9f9a | 2010-08-27 23:47:36 +0000 | [diff] [blame] | 127 | VALID_FILESPEC = "Got a valid filespec" |
| 128 | |
Johnny Chen | 8fd886c | 2010-12-08 01:25:21 +0000 | [diff] [blame] | 129 | VALID_MODULE = "Got a valid module" |
| 130 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 131 | VALID_PROCESS = "Got a valid process" |
| 132 | |
Johnny Chen | 8fd886c | 2010-12-08 01:25:21 +0000 | [diff] [blame] | 133 | VALID_SYMBOL = "Got a valid symbol" |
| 134 | |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 135 | VALID_TARGET = "Got a valid target" |
| 136 | |
Johnny Chen | 2ef5eae | 2012-02-03 20:43:00 +0000 | [diff] [blame] | 137 | VALID_TYPE = "Got a valid type" |
| 138 | |
Johnny Chen | 5503d46 | 2011-07-15 22:28:10 +0000 | [diff] [blame] | 139 | VALID_VARIABLE = "Got a valid variable" |
| 140 | |
Johnny Chen | 22b95b2 | 2010-08-25 19:00:04 +0000 | [diff] [blame] | 141 | VARIABLES_DISPLAYED_CORRECTLY = "Variable(s) displayed correctly" |
Johnny Chen | 96f08d5 | 2010-08-09 22:01:17 +0000 | [diff] [blame] | 142 | |
Johnny Chen | 58c66e2 | 2011-09-15 21:09:59 +0000 | [diff] [blame] | 143 | WATCHPOINT_CREATED = "Watchpoint created successfully" |
Johnny Chen | b4d1fff | 2010-08-26 20:04:17 +0000 | [diff] [blame] | 144 | |
Johnny Chen | 05efcf78 | 2010-11-09 18:42:22 +0000 | [diff] [blame] | 145 | def CMD_MSG(str): |
Johnny Chen | 006b595 | 2011-05-31 22:16:51 +0000 | [diff] [blame] | 146 | '''A generic "Command '%s' returns successfully" message generator.''' |
Johnny Chen | 05efcf78 | 2010-11-09 18:42:22 +0000 | [diff] [blame] | 147 | return "Command '%s' returns successfully" % str |
| 148 | |
Johnny Chen | dbe2c82 | 2012-03-15 19:10:00 +0000 | [diff] [blame] | 149 | def COMPLETION_MSG(str_before, str_after): |
Johnny Chen | fbcad68 | 2012-01-20 23:02:51 +0000 | [diff] [blame] | 150 | '''A generic message generator for the completion mechanism.''' |
| 151 | return "'%s' successfully completes to '%s'" % (str_before, str_after) |
| 152 | |
Johnny Chen | 05efcf78 | 2010-11-09 18:42:22 +0000 | [diff] [blame] | 153 | def EXP_MSG(str, exe): |
Johnny Chen | 006b595 | 2011-05-31 22:16:51 +0000 | [diff] [blame] | 154 | '''A generic "'%s' returns expected result" message generator if exe. |
| 155 | Otherwise, it generates "'%s' matches expected result" message.''' |
Johnny Chen | 05efcf78 | 2010-11-09 18:42:22 +0000 | [diff] [blame] | 156 | return "'%s' %s expected result" % (str, 'returns' if exe else 'matches') |
Johnny Chen | d85dae5 | 2010-08-09 23:44:24 +0000 | [diff] [blame] | 157 | |
Johnny Chen | db9cbe9 | 2010-10-19 19:11:38 +0000 | [diff] [blame] | 158 | def SETTING_MSG(setting): |
Johnny Chen | 006b595 | 2011-05-31 22:16:51 +0000 | [diff] [blame] | 159 | '''A generic "Value of setting '%s' is correct" message generator.''' |
Johnny Chen | db9cbe9 | 2010-10-19 19:11:38 +0000 | [diff] [blame] | 160 | return "Value of setting '%s' is correct" % setting |
| 161 | |
Johnny Chen | f4ce288 | 2010-08-26 21:49:29 +0000 | [diff] [blame] | 162 | def EnvArray(): |
Johnny Chen | 006b595 | 2011-05-31 22:16:51 +0000 | [diff] [blame] | 163 | """Returns an env variable array from the os.environ map object.""" |
Johnny Chen | f4ce288 | 2010-08-26 21:49:29 +0000 | [diff] [blame] | 164 | return map(lambda k,v: k+"="+v, os.environ.keys(), os.environ.values()) |
| 165 | |
Johnny Chen | 1490600 | 2010-10-11 23:52:19 +0000 | [diff] [blame] | 166 | def line_number(filename, string_to_match): |
| 167 | """Helper function to return the line number of the first matched string.""" |
| 168 | with open(filename, 'r') as f: |
| 169 | for i, line in enumerate(f): |
| 170 | if line.find(string_to_match) != -1: |
| 171 | # Found our match. |
Johnny Chen | 0659e34 | 2010-10-12 00:09:25 +0000 | [diff] [blame] | 172 | return i+1 |
Johnny Chen | 33cd0c3 | 2011-04-15 16:44:48 +0000 | [diff] [blame] | 173 | raise Exception("Unable to find '%s' within file %s" % (string_to_match, filename)) |
Johnny Chen | 1490600 | 2010-10-11 23:52:19 +0000 | [diff] [blame] | 174 | |
Johnny Chen | 5349ee2 | 2010-10-05 19:27:32 +0000 | [diff] [blame] | 175 | def pointer_size(): |
| 176 | """Return the pointer size of the host system.""" |
| 177 | import ctypes |
| 178 | a_pointer = ctypes.c_void_p(0xffff) |
| 179 | return 8 * ctypes.sizeof(a_pointer) |
| 180 | |
Johnny Chen | 7be5d35 | 2012-02-09 02:01:59 +0000 | [diff] [blame] | 181 | def is_exe(fpath): |
| 182 | """Returns true if fpath is an executable.""" |
| 183 | return os.path.isfile(fpath) and os.access(fpath, os.X_OK) |
| 184 | |
| 185 | def which(program): |
| 186 | """Returns the full path to a program; None otherwise.""" |
| 187 | fpath, fname = os.path.split(program) |
| 188 | if fpath: |
| 189 | if is_exe(program): |
| 190 | return program |
| 191 | else: |
| 192 | for path in os.environ["PATH"].split(os.pathsep): |
| 193 | exe_file = os.path.join(path, program) |
| 194 | if is_exe(exe_file): |
| 195 | return exe_file |
| 196 | return None |
| 197 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 198 | class recording(StringIO.StringIO): |
| 199 | """ |
| 200 | A nice little context manager for recording the debugger interactions into |
| 201 | our session object. If trace flag is ON, it also emits the interactions |
| 202 | into the stderr. |
| 203 | """ |
| 204 | def __init__(self, test, trace): |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 205 | """Create a StringIO instance; record the session obj and trace flag.""" |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 206 | StringIO.StringIO.__init__(self) |
Johnny Chen | 770683d | 2011-08-16 22:06:17 +0000 | [diff] [blame] | 207 | # The test might not have undergone the 'setUp(self)' phase yet, so that |
| 208 | # the attribute 'session' might not even exist yet. |
Johnny Chen | 8339f98 | 2011-08-16 17:06:45 +0000 | [diff] [blame] | 209 | self.session = getattr(test, "session", None) if test else None |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 210 | self.trace = trace |
| 211 | |
| 212 | def __enter__(self): |
| 213 | """ |
| 214 | Context management protocol on entry to the body of the with statement. |
| 215 | Just return the StringIO object. |
| 216 | """ |
| 217 | return self |
| 218 | |
| 219 | def __exit__(self, type, value, tb): |
| 220 | """ |
| 221 | Context management protocol on exit from the body of the with statement. |
| 222 | If trace is ON, it emits the recordings into stderr. Always add the |
| 223 | recordings to our session object. And close the StringIO object, too. |
| 224 | """ |
| 225 | if self.trace: |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 226 | print >> sys.stderr, self.getvalue() |
| 227 | if self.session: |
| 228 | print >> self.session, self.getvalue() |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 229 | self.close() |
| 230 | |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 231 | # From 2.7's subprocess.check_output() convenience function. |
Johnny Chen | 0bfa859 | 2011-03-23 20:28:59 +0000 | [diff] [blame] | 232 | # Return a tuple (stdoutdata, stderrdata). |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 233 | def system(*popenargs, **kwargs): |
Johnny Chen | 22ca65d | 2011-11-16 22:44:28 +0000 | [diff] [blame] | 234 | r"""Run an os command with arguments and return its output as a byte string. |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 235 | |
| 236 | If the exit code was non-zero it raises a CalledProcessError. The |
| 237 | CalledProcessError object will have the return code in the returncode |
| 238 | attribute and output in the output attribute. |
| 239 | |
| 240 | The arguments are the same as for the Popen constructor. Example: |
| 241 | |
| 242 | >>> check_output(["ls", "-l", "/dev/null"]) |
| 243 | 'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n' |
| 244 | |
| 245 | The stdout argument is not allowed as it is used internally. |
| 246 | To capture standard error in the result, use stderr=STDOUT. |
| 247 | |
| 248 | >>> check_output(["/bin/sh", "-c", |
| 249 | ... "ls -l non_existent_file ; exit 0"], |
| 250 | ... stderr=STDOUT) |
| 251 | 'ls: non_existent_file: No such file or directory\n' |
| 252 | """ |
| 253 | |
| 254 | # Assign the sender object to variable 'test' and remove it from kwargs. |
| 255 | test = kwargs.pop('sender', None) |
| 256 | |
| 257 | if 'stdout' in kwargs: |
| 258 | raise ValueError('stdout argument not allowed, it will be overridden.') |
Johnny Chen | 0bfa859 | 2011-03-23 20:28:59 +0000 | [diff] [blame] | 259 | process = Popen(stdout=PIPE, stderr=PIPE, *popenargs, **kwargs) |
Johnny Chen | 30b30cb | 2011-11-16 22:41:53 +0000 | [diff] [blame] | 260 | pid = process.pid |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 261 | output, error = process.communicate() |
| 262 | retcode = process.poll() |
| 263 | |
| 264 | with recording(test, traceAlways) as sbuf: |
| 265 | if isinstance(popenargs, types.StringTypes): |
| 266 | args = [popenargs] |
| 267 | else: |
| 268 | args = list(popenargs) |
| 269 | print >> sbuf |
| 270 | print >> sbuf, "os command:", args |
Johnny Chen | 30b30cb | 2011-11-16 22:41:53 +0000 | [diff] [blame] | 271 | print >> sbuf, "with pid:", pid |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 272 | print >> sbuf, "stdout:", output |
| 273 | print >> sbuf, "stderr:", error |
| 274 | print >> sbuf, "retcode:", retcode |
| 275 | print >> sbuf |
| 276 | |
| 277 | if retcode: |
| 278 | cmd = kwargs.get("args") |
| 279 | if cmd is None: |
| 280 | cmd = popenargs[0] |
| 281 | raise CalledProcessError(retcode, cmd) |
Johnny Chen | 0bfa859 | 2011-03-23 20:28:59 +0000 | [diff] [blame] | 282 | return (output, error) |
Johnny Chen | 1b7d629 | 2010-10-15 23:55:05 +0000 | [diff] [blame] | 283 | |
Johnny Chen | 2986764 | 2010-11-01 20:35:01 +0000 | [diff] [blame] | 284 | def getsource_if_available(obj): |
| 285 | """ |
| 286 | Return the text of the source code for an object if available. Otherwise, |
| 287 | a print representation is returned. |
| 288 | """ |
| 289 | import inspect |
| 290 | try: |
| 291 | return inspect.getsource(obj) |
| 292 | except: |
| 293 | return repr(obj) |
| 294 | |
Peter Collingbourne | 39bd536 | 2011-06-20 19:06:20 +0000 | [diff] [blame] | 295 | def builder_module(): |
| 296 | return __import__("builder_" + sys.platform) |
| 297 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 298 | # |
| 299 | # Decorators for categorizing test cases. |
| 300 | # |
| 301 | |
| 302 | from functools import wraps |
| 303 | def python_api_test(func): |
| 304 | """Decorate the item as a Python API only test.""" |
| 305 | if isinstance(func, type) and issubclass(func, unittest2.TestCase): |
| 306 | raise Exception("@python_api_test can only be used to decorate a test method") |
| 307 | @wraps(func) |
| 308 | def wrapper(self, *args, **kwargs): |
| 309 | try: |
| 310 | if lldb.dont_do_python_api_test: |
| 311 | self.skipTest("python api tests") |
| 312 | except AttributeError: |
| 313 | pass |
| 314 | return func(self, *args, **kwargs) |
| 315 | |
| 316 | # Mark this function as such to separate them from lldb command line tests. |
| 317 | wrapper.__python_api_test__ = True |
| 318 | return wrapper |
| 319 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 320 | def benchmarks_test(func): |
| 321 | """Decorate the item as a benchmarks test.""" |
| 322 | if isinstance(func, type) and issubclass(func, unittest2.TestCase): |
| 323 | raise Exception("@benchmarks_test can only be used to decorate a test method") |
| 324 | @wraps(func) |
| 325 | def wrapper(self, *args, **kwargs): |
| 326 | try: |
| 327 | if not lldb.just_do_benchmarks_test: |
| 328 | self.skipTest("benchmarks tests") |
| 329 | except AttributeError: |
| 330 | pass |
| 331 | return func(self, *args, **kwargs) |
| 332 | |
| 333 | # Mark this function as such to separate them from the regular tests. |
| 334 | wrapper.__benchmarks_test__ = True |
| 335 | return wrapper |
| 336 | |
Johnny Chen | a3ed7d8 | 2012-04-06 00:56:05 +0000 | [diff] [blame] | 337 | def dsym_test(func): |
| 338 | """Decorate the item as a dsym test.""" |
| 339 | if isinstance(func, type) and issubclass(func, unittest2.TestCase): |
| 340 | raise Exception("@dsym_test can only be used to decorate a test method") |
| 341 | @wraps(func) |
| 342 | def wrapper(self, *args, **kwargs): |
| 343 | try: |
| 344 | if lldb.dont_do_dsym_test: |
| 345 | self.skipTest("dsym tests") |
| 346 | except AttributeError: |
| 347 | pass |
| 348 | return func(self, *args, **kwargs) |
| 349 | |
| 350 | # Mark this function as such to separate them from the regular tests. |
| 351 | wrapper.__dsym_test__ = True |
| 352 | return wrapper |
| 353 | |
| 354 | def dwarf_test(func): |
| 355 | """Decorate the item as a dwarf test.""" |
| 356 | if isinstance(func, type) and issubclass(func, unittest2.TestCase): |
| 357 | raise Exception("@dwarf_test can only be used to decorate a test method") |
| 358 | @wraps(func) |
| 359 | def wrapper(self, *args, **kwargs): |
| 360 | try: |
| 361 | if lldb.dont_do_dwarf_test: |
| 362 | self.skipTest("dwarf tests") |
| 363 | except AttributeError: |
| 364 | pass |
| 365 | return func(self, *args, **kwargs) |
| 366 | |
| 367 | # Mark this function as such to separate them from the regular tests. |
| 368 | wrapper.__dwarf_test__ = True |
| 369 | return wrapper |
| 370 | |
Johnny Chen | 65040cb | 2011-08-19 00:54:27 +0000 | [diff] [blame] | 371 | def expectedFailureClang(func): |
| 372 | """Decorate the item as a Clang only expectedFailure.""" |
| 373 | if isinstance(func, type) and issubclass(func, unittest2.TestCase): |
| 374 | raise Exception("@expectedFailureClang can only be used to decorate a test method") |
| 375 | @wraps(func) |
| 376 | def wrapper(*args, **kwargs): |
| 377 | from unittest2 import case |
| 378 | self = args[0] |
| 379 | compiler = self.getCompiler() |
| 380 | try: |
| 381 | func(*args, **kwargs) |
Johnny Chen | 7c9136b | 2011-08-19 01:17:09 +0000 | [diff] [blame] | 382 | except Exception: |
Johnny Chen | 65040cb | 2011-08-19 00:54:27 +0000 | [diff] [blame] | 383 | if "clang" in compiler: |
| 384 | raise case._ExpectedFailure(sys.exc_info()) |
| 385 | else: |
Johnny Chen | 7c9136b | 2011-08-19 01:17:09 +0000 | [diff] [blame] | 386 | raise |
Johnny Chen | 65040cb | 2011-08-19 00:54:27 +0000 | [diff] [blame] | 387 | |
| 388 | if "clang" in compiler: |
| 389 | raise case._UnexpectedSuccess |
| 390 | return wrapper |
| 391 | |
Johnny Chen | 869e296 | 2011-12-22 21:14:31 +0000 | [diff] [blame] | 392 | def expectedFailurei386(func): |
| 393 | """Decorate the item as an i386 only expectedFailure.""" |
| 394 | if isinstance(func, type) and issubclass(func, unittest2.TestCase): |
| 395 | raise Exception("@expectedFailurei386 can only be used to decorate a test method") |
| 396 | @wraps(func) |
| 397 | def wrapper(*args, **kwargs): |
| 398 | from unittest2 import case |
| 399 | self = args[0] |
| 400 | arch = self.getArchitecture() |
| 401 | try: |
| 402 | func(*args, **kwargs) |
| 403 | except Exception: |
| 404 | if "i386" in arch: |
| 405 | raise case._ExpectedFailure(sys.exc_info()) |
| 406 | else: |
| 407 | raise |
| 408 | |
| 409 | if "i386" in arch: |
| 410 | raise case._UnexpectedSuccess |
| 411 | return wrapper |
| 412 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 413 | class Base(unittest2.TestCase): |
Johnny Chen | 607b7a1 | 2010-10-22 23:15:46 +0000 | [diff] [blame] | 414 | """ |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 415 | Abstract base for performing lldb (see TestBase) or other generic tests (see |
| 416 | BenchBase for one example). lldbtest.Base works with the test driver to |
| 417 | accomplish things. |
| 418 | |
Johnny Chen | 607b7a1 | 2010-10-22 23:15:46 +0000 | [diff] [blame] | 419 | """ |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 420 | # The concrete subclass should override this attribute. |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 421 | mydir = None |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 422 | |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 423 | # Keep track of the old current working directory. |
| 424 | oldcwd = None |
Johnny Chen | 88f8304 | 2010-08-05 21:23:45 +0000 | [diff] [blame] | 425 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 426 | def TraceOn(self): |
| 427 | """Returns True if we are in trace mode (tracing detailed test execution).""" |
| 428 | return traceAlways |
| 429 | |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 430 | @classmethod |
| 431 | def setUpClass(cls): |
Johnny Chen | 4199819 | 2010-10-01 22:59:49 +0000 | [diff] [blame] | 432 | """ |
| 433 | Python unittest framework class setup fixture. |
| 434 | Do current directory manipulation. |
| 435 | """ |
| 436 | |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 437 | # Fail fast if 'mydir' attribute is not overridden. |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 438 | if not cls.mydir or len(cls.mydir) == 0: |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 439 | raise Exception("Subclasses must override the 'mydir' attribute.") |
Enrico Granata | 0fd6c8d | 2012-10-24 18:14:21 +0000 | [diff] [blame] | 440 | |
| 441 | # Fail fast if 'mydir' is not an existing directory |
| 442 | if not os.path.exists(cls.mydir) or not os.path.isdir(cls.mydir): |
| 443 | raise Exception("Subclasses must define 'mydir' to be an existing directory.") |
| 444 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 445 | # Save old working directory. |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 446 | cls.oldcwd = os.getcwd() |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 447 | |
| 448 | # Change current working directory if ${LLDB_TEST} is defined. |
| 449 | # See also dotest.py which sets up ${LLDB_TEST}. |
| 450 | if ("LLDB_TEST" in os.environ): |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 451 | if traceAlways: |
Johnny Chen | 72afa8d | 2010-09-30 17:06:24 +0000 | [diff] [blame] | 452 | 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] | 453 | os.chdir(os.path.join(os.environ["LLDB_TEST"], cls.mydir)) |
| 454 | |
| 455 | @classmethod |
| 456 | def tearDownClass(cls): |
Johnny Chen | 4199819 | 2010-10-01 22:59:49 +0000 | [diff] [blame] | 457 | """ |
| 458 | Python unittest framework class teardown fixture. |
| 459 | Do class-wide cleanup. |
| 460 | """ |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 461 | |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 462 | if doCleanup and not lldb.skip_build_and_cleanup: |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 463 | # First, let's do the platform-specific cleanup. |
Peter Collingbourne | 39bd536 | 2011-06-20 19:06:20 +0000 | [diff] [blame] | 464 | module = builder_module() |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 465 | if not module.cleanup(): |
| 466 | raise Exception("Don't know how to do cleanup") |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 467 | |
Johnny Chen | 548aefd | 2010-10-11 22:25:46 +0000 | [diff] [blame] | 468 | # Subclass might have specific cleanup function defined. |
| 469 | if getattr(cls, "classCleanup", None): |
| 470 | if traceAlways: |
| 471 | print >> sys.stderr, "Call class-specific cleanup function for class:", cls |
| 472 | try: |
| 473 | cls.classCleanup() |
| 474 | except: |
| 475 | exc_type, exc_value, exc_tb = sys.exc_info() |
| 476 | traceback.print_exception(exc_type, exc_value, exc_tb) |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 477 | |
| 478 | # Restore old working directory. |
| 479 | if traceAlways: |
Johnny Chen | 72afa8d | 2010-09-30 17:06:24 +0000 | [diff] [blame] | 480 | print >> sys.stderr, "Restore dir to:", cls.oldcwd |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 481 | os.chdir(cls.oldcwd) |
| 482 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 483 | @classmethod |
| 484 | def skipLongRunningTest(cls): |
| 485 | """ |
| 486 | By default, we skip long running test case. |
| 487 | This can be overridden by passing '-l' to the test driver (dotest.py). |
| 488 | """ |
| 489 | if "LLDB_SKIP_LONG_RUNNING_TEST" in os.environ and "NO" == os.environ["LLDB_SKIP_LONG_RUNNING_TEST"]: |
| 490 | return False |
| 491 | else: |
| 492 | return True |
Johnny Chen | 9a9fcf6 | 2011-06-21 00:53:00 +0000 | [diff] [blame] | 493 | |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 494 | def setUp(self): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 495 | """Fixture for unittest test case setup. |
| 496 | |
| 497 | It works with the test driver to conditionally skip tests and does other |
| 498 | initializations.""" |
Johnny Chen | d3521cc | 2010-09-16 01:53:04 +0000 | [diff] [blame] | 499 | #import traceback |
| 500 | #traceback.print_stack() |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 501 | |
Johnny Chen | 113388f | 2011-08-02 22:54:37 +0000 | [diff] [blame] | 502 | if "LLDB_EXEC" in os.environ: |
| 503 | self.lldbExec = os.environ["LLDB_EXEC"] |
Johnny Chen | 6033bed | 2011-08-26 00:00:01 +0000 | [diff] [blame] | 504 | else: |
| 505 | self.lldbExec = None |
| 506 | if "LLDB_HERE" in os.environ: |
| 507 | self.lldbHere = os.environ["LLDB_HERE"] |
| 508 | else: |
| 509 | self.lldbHere = None |
Johnny Chen | 7d7f447 | 2011-10-07 19:21:09 +0000 | [diff] [blame] | 510 | # If we spawn an lldb process for test (via pexpect), do not load the |
| 511 | # init file unless told otherwise. |
| 512 | if "NO_LLDBINIT" in os.environ and "NO" == os.environ["NO_LLDBINIT"]: |
| 513 | self.lldbOption = "" |
| 514 | else: |
| 515 | self.lldbOption = "--no-lldbinit" |
Johnny Chen | 113388f | 2011-08-02 22:54:37 +0000 | [diff] [blame] | 516 | |
Johnny Chen | 71cb797 | 2011-08-01 21:13:26 +0000 | [diff] [blame] | 517 | # Assign the test method name to self.testMethodName. |
| 518 | # |
| 519 | # For an example of the use of this attribute, look at test/types dir. |
| 520 | # There are a bunch of test cases under test/types and we don't want the |
| 521 | # module cacheing subsystem to be confused with executable name "a.out" |
| 522 | # used for all the test cases. |
| 523 | self.testMethodName = self._testMethodName |
| 524 | |
Johnny Chen | 3ebdacc | 2010-12-10 18:52:10 +0000 | [diff] [blame] | 525 | # Python API only test is decorated with @python_api_test, |
| 526 | # which also sets the "__python_api_test__" attribute of the |
| 527 | # function object to True. |
Johnny Chen | d8c1dd3 | 2011-05-31 23:21:42 +0000 | [diff] [blame] | 528 | try: |
| 529 | if lldb.just_do_python_api_test: |
| 530 | testMethod = getattr(self, self._testMethodName) |
| 531 | if getattr(testMethod, "__python_api_test__", False): |
| 532 | pass |
| 533 | else: |
Johnny Chen | 82ccf40 | 2011-07-30 01:39:58 +0000 | [diff] [blame] | 534 | self.skipTest("non python api test") |
| 535 | except AttributeError: |
| 536 | pass |
| 537 | |
| 538 | # Benchmarks test is decorated with @benchmarks_test, |
| 539 | # which also sets the "__benchmarks_test__" attribute of the |
| 540 | # function object to True. |
| 541 | try: |
| 542 | if lldb.just_do_benchmarks_test: |
| 543 | testMethod = getattr(self, self._testMethodName) |
| 544 | if getattr(testMethod, "__benchmarks_test__", False): |
| 545 | pass |
| 546 | else: |
| 547 | self.skipTest("non benchmarks test") |
Johnny Chen | d8c1dd3 | 2011-05-31 23:21:42 +0000 | [diff] [blame] | 548 | except AttributeError: |
| 549 | pass |
Johnny Chen | 3ebdacc | 2010-12-10 18:52:10 +0000 | [diff] [blame] | 550 | |
Johnny Chen | 71cb797 | 2011-08-01 21:13:26 +0000 | [diff] [blame] | 551 | # This is for the case of directly spawning 'lldb'/'gdb' and interacting |
| 552 | # with it using pexpect. |
| 553 | self.child = None |
| 554 | self.child_prompt = "(lldb) " |
| 555 | # If the child is interacting with the embedded script interpreter, |
| 556 | # there are two exits required during tear down, first to quit the |
| 557 | # embedded script interpreter and second to quit the lldb command |
| 558 | # interpreter. |
| 559 | self.child_in_script_interpreter = False |
| 560 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 561 | # These are for customized teardown cleanup. |
| 562 | self.dict = None |
| 563 | self.doTearDownCleanup = False |
| 564 | # And in rare cases where there are multiple teardown cleanups. |
| 565 | self.dicts = [] |
| 566 | self.doTearDownCleanups = False |
| 567 | |
| 568 | # Create a string buffer to record the session info, to be dumped into a |
| 569 | # test case specific file if test failure is encountered. |
| 570 | self.session = StringIO.StringIO() |
| 571 | |
| 572 | # Optimistically set __errored__, __failed__, __expected__ to False |
| 573 | # initially. If the test errored/failed, the session info |
| 574 | # (self.session) is then dumped into a session specific file for |
| 575 | # diagnosis. |
| 576 | self.__errored__ = False |
| 577 | self.__failed__ = False |
| 578 | self.__expected__ = False |
| 579 | # We are also interested in unexpected success. |
| 580 | self.__unexpected__ = False |
Johnny Chen | cd1df5a | 2011-08-16 00:48:58 +0000 | [diff] [blame] | 581 | # And skipped tests. |
| 582 | self.__skipped__ = False |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 583 | |
| 584 | # See addTearDownHook(self, hook) which allows the client to add a hook |
| 585 | # function to be run during tearDown() time. |
| 586 | self.hooks = [] |
| 587 | |
| 588 | # See HideStdout(self). |
| 589 | self.sys_stdout_hidden = False |
| 590 | |
Johnny Chen | 644ad08 | 2011-10-19 16:48:07 +0000 | [diff] [blame] | 591 | def runHooks(self, child=None, child_prompt=None, use_cmd_api=False): |
Johnny Chen | 5f3c567 | 2011-10-19 01:06:21 +0000 | [diff] [blame] | 592 | """Perform the run hooks to bring lldb debugger to the desired state. |
| 593 | |
Johnny Chen | 644ad08 | 2011-10-19 16:48:07 +0000 | [diff] [blame] | 594 | By default, expect a pexpect spawned child and child prompt to be |
| 595 | supplied (use_cmd_api=False). If use_cmd_api is true, ignore the child |
| 596 | and child prompt and use self.runCmd() to run the hooks one by one. |
| 597 | |
Johnny Chen | 5f3c567 | 2011-10-19 01:06:21 +0000 | [diff] [blame] | 598 | Note that child is a process spawned by pexpect.spawn(). If not, your |
| 599 | test case is mostly likely going to fail. |
| 600 | |
| 601 | See also dotest.py where lldb.runHooks are processed/populated. |
| 602 | """ |
| 603 | if not lldb.runHooks: |
| 604 | self.skipTest("No runhooks specified for lldb, skip the test") |
Johnny Chen | 644ad08 | 2011-10-19 16:48:07 +0000 | [diff] [blame] | 605 | if use_cmd_api: |
| 606 | for hook in lldb.runhooks: |
| 607 | self.runCmd(hook) |
| 608 | else: |
| 609 | if not child or not child_prompt: |
| 610 | self.fail("Both child and child_prompt need to be defined.") |
| 611 | for hook in lldb.runHooks: |
| 612 | child.sendline(hook) |
| 613 | child.expect_exact(child_prompt) |
Johnny Chen | 5f3c567 | 2011-10-19 01:06:21 +0000 | [diff] [blame] | 614 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 615 | def HideStdout(self): |
| 616 | """Hide output to stdout from the user. |
| 617 | |
| 618 | During test execution, there might be cases where we don't want to show the |
| 619 | standard output to the user. For example, |
| 620 | |
| 621 | self.runCmd(r'''sc print "\n\n\tHello!\n"''') |
| 622 | |
| 623 | tests whether command abbreviation for 'script' works or not. There is no |
| 624 | need to show the 'Hello' output to the user as long as the 'script' command |
| 625 | succeeds and we are not in TraceOn() mode (see the '-t' option). |
| 626 | |
| 627 | In this case, the test method calls self.HideStdout(self) to redirect the |
| 628 | sys.stdout to a null device, and restores the sys.stdout upon teardown. |
| 629 | |
| 630 | Note that you should only call this method at most once during a test case |
| 631 | execution. Any subsequent call has no effect at all.""" |
| 632 | if self.sys_stdout_hidden: |
| 633 | return |
| 634 | |
| 635 | self.sys_stdout_hidden = True |
| 636 | old_stdout = sys.stdout |
| 637 | sys.stdout = open(os.devnull, 'w') |
| 638 | def restore_stdout(): |
| 639 | sys.stdout = old_stdout |
| 640 | self.addTearDownHook(restore_stdout) |
| 641 | |
| 642 | # ======================================================================= |
| 643 | # Methods for customized teardown cleanups as well as execution of hooks. |
| 644 | # ======================================================================= |
| 645 | |
| 646 | def setTearDownCleanup(self, dictionary=None): |
| 647 | """Register a cleanup action at tearDown() time with a dictinary""" |
| 648 | self.dict = dictionary |
| 649 | self.doTearDownCleanup = True |
| 650 | |
| 651 | def addTearDownCleanup(self, dictionary): |
| 652 | """Add a cleanup action at tearDown() time with a dictinary""" |
| 653 | self.dicts.append(dictionary) |
| 654 | self.doTearDownCleanups = True |
| 655 | |
| 656 | def addTearDownHook(self, hook): |
| 657 | """ |
| 658 | Add a function to be run during tearDown() time. |
| 659 | |
| 660 | Hooks are executed in a first come first serve manner. |
| 661 | """ |
| 662 | if callable(hook): |
| 663 | with recording(self, traceAlways) as sbuf: |
| 664 | print >> sbuf, "Adding tearDown hook:", getsource_if_available(hook) |
| 665 | self.hooks.append(hook) |
| 666 | |
| 667 | def tearDown(self): |
| 668 | """Fixture for unittest test case teardown.""" |
| 669 | #import traceback |
| 670 | #traceback.print_stack() |
| 671 | |
Johnny Chen | 71cb797 | 2011-08-01 21:13:26 +0000 | [diff] [blame] | 672 | # This is for the case of directly spawning 'lldb' and interacting with it |
| 673 | # using pexpect. |
| 674 | import pexpect |
| 675 | if self.child and self.child.isalive(): |
| 676 | with recording(self, traceAlways) as sbuf: |
| 677 | print >> sbuf, "tearing down the child process...." |
| 678 | if self.child_in_script_interpreter: |
| 679 | self.child.sendline('quit()') |
| 680 | self.child.expect_exact(self.child_prompt) |
| 681 | self.child.sendline('quit') |
| 682 | try: |
| 683 | self.child.expect(pexpect.EOF) |
| 684 | except: |
| 685 | pass |
Johnny Chen | f0ff42a | 2012-02-27 23:07:40 +0000 | [diff] [blame] | 686 | # Give it one final blow to make sure the child is terminated. |
| 687 | self.child.close() |
Johnny Chen | 71cb797 | 2011-08-01 21:13:26 +0000 | [diff] [blame] | 688 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 689 | # Check and run any hook functions. |
| 690 | for hook in reversed(self.hooks): |
| 691 | with recording(self, traceAlways) as sbuf: |
| 692 | print >> sbuf, "Executing tearDown hook:", getsource_if_available(hook) |
| 693 | hook() |
| 694 | |
| 695 | del self.hooks |
| 696 | |
| 697 | # Perform registered teardown cleanup. |
| 698 | if doCleanup and self.doTearDownCleanup: |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 699 | self.cleanup(dictionary=self.dict) |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 700 | |
| 701 | # In rare cases where there are multiple teardown cleanups added. |
| 702 | if doCleanup and self.doTearDownCleanups: |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 703 | if self.dicts: |
| 704 | for dict in reversed(self.dicts): |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 705 | self.cleanup(dictionary=dict) |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 706 | |
| 707 | # Decide whether to dump the session info. |
| 708 | self.dumpSessionInfo() |
| 709 | |
| 710 | # ========================================================= |
| 711 | # Various callbacks to allow introspection of test progress |
| 712 | # ========================================================= |
| 713 | |
| 714 | def markError(self): |
| 715 | """Callback invoked when an error (unexpected exception) errored.""" |
| 716 | self.__errored__ = True |
| 717 | with recording(self, False) as sbuf: |
| 718 | # False because there's no need to write "ERROR" to the stderr twice. |
| 719 | # Once by the Python unittest framework, and a second time by us. |
| 720 | print >> sbuf, "ERROR" |
| 721 | |
| 722 | def markFailure(self): |
| 723 | """Callback invoked when a failure (test assertion failure) occurred.""" |
| 724 | self.__failed__ = True |
| 725 | with recording(self, False) as sbuf: |
| 726 | # False because there's no need to write "FAIL" to the stderr twice. |
| 727 | # Once by the Python unittest framework, and a second time by us. |
| 728 | print >> sbuf, "FAIL" |
| 729 | |
| 730 | def markExpectedFailure(self): |
| 731 | """Callback invoked when an expected failure/error occurred.""" |
| 732 | self.__expected__ = True |
| 733 | with recording(self, False) as sbuf: |
| 734 | # False because there's no need to write "expected failure" to the |
| 735 | # stderr twice. |
| 736 | # Once by the Python unittest framework, and a second time by us. |
| 737 | print >> sbuf, "expected failure" |
| 738 | |
Johnny Chen | f5b8909 | 2011-08-15 23:09:08 +0000 | [diff] [blame] | 739 | def markSkippedTest(self): |
| 740 | """Callback invoked when a test is skipped.""" |
| 741 | self.__skipped__ = True |
| 742 | with recording(self, False) as sbuf: |
| 743 | # False because there's no need to write "skipped test" to the |
| 744 | # stderr twice. |
| 745 | # Once by the Python unittest framework, and a second time by us. |
| 746 | print >> sbuf, "skipped test" |
| 747 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 748 | def markUnexpectedSuccess(self): |
| 749 | """Callback invoked when an unexpected success occurred.""" |
| 750 | self.__unexpected__ = True |
| 751 | with recording(self, False) as sbuf: |
| 752 | # False because there's no need to write "unexpected success" to the |
| 753 | # stderr twice. |
| 754 | # Once by the Python unittest framework, and a second time by us. |
| 755 | print >> sbuf, "unexpected success" |
| 756 | |
| 757 | def dumpSessionInfo(self): |
| 758 | """ |
| 759 | Dump the debugger interactions leading to a test error/failure. This |
| 760 | allows for more convenient postmortem analysis. |
| 761 | |
| 762 | See also LLDBTestResult (dotest.py) which is a singlton class derived |
| 763 | from TextTestResult and overwrites addError, addFailure, and |
| 764 | addExpectedFailure methods to allow us to to mark the test instance as |
| 765 | such. |
| 766 | """ |
| 767 | |
| 768 | # We are here because self.tearDown() detected that this test instance |
| 769 | # either errored or failed. The lldb.test_result singleton contains |
| 770 | # two lists (erros and failures) which get populated by the unittest |
| 771 | # framework. Look over there for stack trace information. |
| 772 | # |
| 773 | # The lists contain 2-tuples of TestCase instances and strings holding |
| 774 | # formatted tracebacks. |
| 775 | # |
| 776 | # See http://docs.python.org/library/unittest.html#unittest.TestResult. |
| 777 | if self.__errored__: |
| 778 | pairs = lldb.test_result.errors |
| 779 | prefix = 'Error' |
| 780 | elif self.__failed__: |
| 781 | pairs = lldb.test_result.failures |
| 782 | prefix = 'Failure' |
| 783 | elif self.__expected__: |
| 784 | pairs = lldb.test_result.expectedFailures |
| 785 | prefix = 'ExpectedFailure' |
Johnny Chen | f5b8909 | 2011-08-15 23:09:08 +0000 | [diff] [blame] | 786 | elif self.__skipped__: |
| 787 | prefix = 'SkippedTest' |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 788 | elif self.__unexpected__: |
| 789 | prefix = "UnexpectedSuccess" |
| 790 | else: |
| 791 | # Simply return, there's no session info to dump! |
| 792 | return |
| 793 | |
Johnny Chen | f5b8909 | 2011-08-15 23:09:08 +0000 | [diff] [blame] | 794 | if not self.__unexpected__ and not self.__skipped__: |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 795 | for test, traceback in pairs: |
| 796 | if test is self: |
| 797 | print >> self.session, traceback |
| 798 | |
Johnny Chen | 6fd55f1 | 2011-08-11 00:16:28 +0000 | [diff] [blame] | 799 | testMethod = getattr(self, self._testMethodName) |
| 800 | if getattr(testMethod, "__benchmarks_test__", False): |
| 801 | benchmarks = True |
| 802 | else: |
| 803 | benchmarks = False |
| 804 | |
Johnny Chen | dfa0cdb | 2011-12-03 00:16:59 +0000 | [diff] [blame] | 805 | # This records the compiler version used for the test. |
| 806 | system([self.getCompiler(), "-v"], sender=self) |
| 807 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 808 | dname = os.path.join(os.environ["LLDB_TEST"], |
| 809 | os.environ["LLDB_SESSION_DIRNAME"]) |
| 810 | if not os.path.isdir(dname): |
| 811 | os.mkdir(dname) |
Sean Callanan | 783ac95 | 2012-10-16 18:22:04 +0000 | [diff] [blame] | 812 | fname = os.path.join(dname, "%s-%s-%s-%s.log" % (prefix, self.getArchitecture(), "_".join(self.getCompiler().split('/')), self.id())) |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 813 | with open(fname, "w") as f: |
| 814 | import datetime |
| 815 | print >> f, "Session info generated @", datetime.datetime.now().ctime() |
| 816 | print >> f, self.session.getvalue() |
| 817 | print >> f, "To rerun this test, issue the following command from the 'test' directory:\n" |
Johnny Chen | 6fd55f1 | 2011-08-11 00:16:28 +0000 | [diff] [blame] | 818 | print >> f, "./dotest.py %s -v %s -f %s.%s" % (self.getRunOptions(), |
| 819 | ('+b' if benchmarks else '-t'), |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 820 | self.__class__.__name__, |
| 821 | self._testMethodName) |
| 822 | |
| 823 | # ==================================================== |
| 824 | # Config. methods supported through a plugin interface |
| 825 | # (enables reading of the current test configuration) |
| 826 | # ==================================================== |
| 827 | |
| 828 | def getArchitecture(self): |
| 829 | """Returns the architecture in effect the test suite is running with.""" |
| 830 | module = builder_module() |
| 831 | return module.getArchitecture() |
| 832 | |
| 833 | def getCompiler(self): |
| 834 | """Returns the compiler in effect the test suite is running with.""" |
| 835 | module = builder_module() |
| 836 | return module.getCompiler() |
| 837 | |
| 838 | def getRunOptions(self): |
| 839 | """Command line option for -A and -C to run this test again, called from |
| 840 | self.dumpSessionInfo().""" |
| 841 | arch = self.getArchitecture() |
| 842 | comp = self.getCompiler() |
Johnny Chen | b7058c5 | 2011-08-24 19:48:51 +0000 | [diff] [blame] | 843 | if arch: |
| 844 | option_str = "-A " + arch |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 845 | else: |
Johnny Chen | b7058c5 | 2011-08-24 19:48:51 +0000 | [diff] [blame] | 846 | option_str = "" |
| 847 | if comp: |
Johnny Chen | e1219bf | 2012-03-16 20:44:00 +0000 | [diff] [blame] | 848 | option_str += " -C " + comp |
Johnny Chen | b7058c5 | 2011-08-24 19:48:51 +0000 | [diff] [blame] | 849 | return option_str |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 850 | |
| 851 | # ================================================== |
| 852 | # Build methods supported through a plugin interface |
| 853 | # ================================================== |
| 854 | |
Johnny Chen | cbf1591 | 2012-02-01 01:49:50 +0000 | [diff] [blame] | 855 | def buildDefault(self, architecture=None, compiler=None, dictionary=None, clean=True): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 856 | """Platform specific way to build the default binaries.""" |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 857 | if lldb.skip_build_and_cleanup: |
| 858 | return |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 859 | module = builder_module() |
Johnny Chen | cbf1591 | 2012-02-01 01:49:50 +0000 | [diff] [blame] | 860 | if not module.buildDefault(self, architecture, compiler, dictionary, clean): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 861 | raise Exception("Don't know how to build default binary") |
| 862 | |
Johnny Chen | cbf1591 | 2012-02-01 01:49:50 +0000 | [diff] [blame] | 863 | def buildDsym(self, architecture=None, compiler=None, dictionary=None, clean=True): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 864 | """Platform specific way to build binaries with dsym info.""" |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 865 | if lldb.skip_build_and_cleanup: |
| 866 | return |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 867 | module = builder_module() |
Johnny Chen | cbf1591 | 2012-02-01 01:49:50 +0000 | [diff] [blame] | 868 | if not module.buildDsym(self, architecture, compiler, dictionary, clean): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 869 | raise Exception("Don't know how to build binary with dsym") |
| 870 | |
Johnny Chen | cbf1591 | 2012-02-01 01:49:50 +0000 | [diff] [blame] | 871 | def buildDwarf(self, architecture=None, compiler=None, dictionary=None, clean=True): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 872 | """Platform specific way to build binaries with dwarf maps.""" |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 873 | if lldb.skip_build_and_cleanup: |
| 874 | return |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 875 | module = builder_module() |
Johnny Chen | cbf1591 | 2012-02-01 01:49:50 +0000 | [diff] [blame] | 876 | if not module.buildDwarf(self, architecture, compiler, dictionary, clean): |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 877 | raise Exception("Don't know how to build binary with dwarf") |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 878 | |
Johnny Chen | 7f9985a | 2011-08-12 20:19:22 +0000 | [diff] [blame] | 879 | def cleanup(self, dictionary=None): |
| 880 | """Platform specific way to do cleanup after build.""" |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 881 | if lldb.skip_build_and_cleanup: |
| 882 | return |
Johnny Chen | 7f9985a | 2011-08-12 20:19:22 +0000 | [diff] [blame] | 883 | module = builder_module() |
| 884 | if not module.cleanup(self, dictionary): |
Johnny Chen | 028d8eb | 2011-11-17 19:57:27 +0000 | [diff] [blame] | 885 | raise Exception("Don't know how to do cleanup with dictionary: "+dictionary) |
Johnny Chen | 7f9985a | 2011-08-12 20:19:22 +0000 | [diff] [blame] | 886 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 887 | |
| 888 | class TestBase(Base): |
| 889 | """ |
| 890 | This abstract base class is meant to be subclassed. It provides default |
| 891 | implementations for setUpClass(), tearDownClass(), setUp(), and tearDown(), |
| 892 | among other things. |
| 893 | |
| 894 | Important things for test class writers: |
| 895 | |
| 896 | - Overwrite the mydir class attribute, otherwise your test class won't |
| 897 | run. It specifies the relative directory to the top level 'test' so |
| 898 | the test harness can change to the correct working directory before |
| 899 | running your test. |
| 900 | |
| 901 | - The setUp method sets up things to facilitate subsequent interactions |
| 902 | with the debugger as part of the test. These include: |
| 903 | - populate the test method name |
| 904 | - create/get a debugger set with synchronous mode (self.dbg) |
| 905 | - get the command interpreter from with the debugger (self.ci) |
| 906 | - create a result object for use with the command interpreter |
| 907 | (self.res) |
| 908 | - plus other stuffs |
| 909 | |
| 910 | - The tearDown method tries to perform some necessary cleanup on behalf |
| 911 | of the test to return the debugger to a good state for the next test. |
| 912 | These include: |
| 913 | - execute any tearDown hooks registered by the test method with |
| 914 | TestBase.addTearDownHook(); examples can be found in |
| 915 | settings/TestSettings.py |
| 916 | - kill the inferior process associated with each target, if any, |
| 917 | and, then delete the target from the debugger's target list |
| 918 | - perform build cleanup before running the next test method in the |
| 919 | same test class; examples of registering for this service can be |
| 920 | found in types/TestIntegerTypes.py with the call: |
| 921 | - self.setTearDownCleanup(dictionary=d) |
| 922 | |
| 923 | - Similarly setUpClass and tearDownClass perform classwise setup and |
| 924 | teardown fixtures. The tearDownClass method invokes a default build |
| 925 | cleanup for the entire test class; also, subclasses can implement the |
| 926 | classmethod classCleanup(cls) to perform special class cleanup action. |
| 927 | |
| 928 | - The instance methods runCmd and expect are used heavily by existing |
| 929 | test cases to send a command to the command interpreter and to perform |
| 930 | string/pattern matching on the output of such command execution. The |
| 931 | expect method also provides a mode to peform string/pattern matching |
| 932 | without running a command. |
| 933 | |
| 934 | - The build methods buildDefault, buildDsym, and buildDwarf are used to |
| 935 | build the binaries used during a particular test scenario. A plugin |
| 936 | should be provided for the sys.platform running the test suite. The |
| 937 | Mac OS X implementation is located in plugins/darwin.py. |
| 938 | """ |
| 939 | |
| 940 | # Maximum allowed attempts when launching the inferior process. |
| 941 | # Can be overridden by the LLDB_MAX_LAUNCH_COUNT environment variable. |
| 942 | maxLaunchCount = 3; |
| 943 | |
| 944 | # Time to wait before the next launching attempt in second(s). |
| 945 | # Can be overridden by the LLDB_TIME_WAIT_NEXT_LAUNCH environment variable. |
| 946 | timeWaitNextLaunch = 1.0; |
| 947 | |
| 948 | def doDelay(self): |
| 949 | """See option -w of dotest.py.""" |
| 950 | if ("LLDB_WAIT_BETWEEN_TEST_CASES" in os.environ and |
| 951 | os.environ["LLDB_WAIT_BETWEEN_TEST_CASES"] == 'YES'): |
| 952 | waitTime = 1.0 |
| 953 | if "LLDB_TIME_WAIT_BETWEEN_TEST_CASES" in os.environ: |
| 954 | waitTime = float(os.environ["LLDB_TIME_WAIT_BETWEEN_TEST_CASES"]) |
| 955 | time.sleep(waitTime) |
| 956 | |
Enrico Granata | ac3a8e2 | 2012-09-21 19:10:53 +0000 | [diff] [blame] | 957 | # Returns the list of categories to which this test case belongs |
| 958 | # by default, look for a ".categories" file, and read its contents |
| 959 | # if no such file exists, traverse the hierarchy - we guarantee |
| 960 | # a .categories to exist at the top level directory so we do not end up |
| 961 | # looping endlessly - subclasses are free to define their own categories |
| 962 | # in whatever way makes sense to them |
| 963 | def getCategories(self): |
| 964 | import inspect |
| 965 | import os.path |
| 966 | folder = inspect.getfile(self.__class__) |
| 967 | folder = os.path.dirname(folder) |
| 968 | while folder != '/': |
| 969 | categories_file_name = os.path.join(folder,".categories") |
| 970 | if os.path.exists(categories_file_name): |
| 971 | categories_file = open(categories_file_name,'r') |
| 972 | categories = categories_file.readline() |
| 973 | categories_file.close() |
| 974 | categories = str.replace(categories,'\n','') |
| 975 | categories = str.replace(categories,'\r','') |
| 976 | return categories.split(',') |
| 977 | else: |
| 978 | folder = os.path.dirname(folder) |
| 979 | continue |
| 980 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 981 | def setUp(self): |
| 982 | #import traceback |
| 983 | #traceback.print_stack() |
| 984 | |
| 985 | # Works with the test driver to conditionally skip tests via decorators. |
| 986 | Base.setUp(self) |
| 987 | |
Johnny Chen | 366fb8c | 2011-08-01 18:46:13 +0000 | [diff] [blame] | 988 | try: |
| 989 | if lldb.blacklist: |
| 990 | className = self.__class__.__name__ |
| 991 | classAndMethodName = "%s.%s" % (className, self._testMethodName) |
| 992 | if className in lldb.blacklist: |
| 993 | self.skipTest(lldb.blacklist.get(className)) |
| 994 | elif classAndMethodName in lldb.blacklist: |
| 995 | self.skipTest(lldb.blacklist.get(classAndMethodName)) |
| 996 | except AttributeError: |
| 997 | pass |
| 998 | |
Johnny Chen | 9a9fcf6 | 2011-06-21 00:53:00 +0000 | [diff] [blame] | 999 | # Insert some delay between successive test cases if specified. |
| 1000 | self.doDelay() |
Johnny Chen | e47649c | 2010-10-07 02:04:14 +0000 | [diff] [blame] | 1001 | |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 1002 | if "LLDB_MAX_LAUNCH_COUNT" in os.environ: |
| 1003 | self.maxLaunchCount = int(os.environ["LLDB_MAX_LAUNCH_COUNT"]) |
| 1004 | |
Johnny Chen | d296521 | 2010-10-19 16:00:42 +0000 | [diff] [blame] | 1005 | if "LLDB_TIME_WAIT_NEXT_LAUNCH" in os.environ: |
Johnny Chen | 458a67e | 2010-11-29 20:20:34 +0000 | [diff] [blame] | 1006 | self.timeWaitNextLaunch = float(os.environ["LLDB_TIME_WAIT_NEXT_LAUNCH"]) |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 1007 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 1008 | # Create the debugger instance if necessary. |
| 1009 | try: |
| 1010 | self.dbg = lldb.DBG |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 1011 | except AttributeError: |
| 1012 | self.dbg = lldb.SBDebugger.Create() |
Johnny Chen | f8c723b | 2010-07-03 20:41:42 +0000 | [diff] [blame] | 1013 | |
Johnny Chen | 960ce12 | 2011-05-25 19:06:18 +0000 | [diff] [blame] | 1014 | if not self.dbg: |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 1015 | raise Exception('Invalid debugger instance') |
| 1016 | |
| 1017 | # We want our debugger to be synchronous. |
| 1018 | self.dbg.SetAsync(False) |
| 1019 | |
| 1020 | # Retrieve the associated command interpreter instance. |
| 1021 | self.ci = self.dbg.GetCommandInterpreter() |
| 1022 | if not self.ci: |
| 1023 | raise Exception('Could not get the command interpreter') |
| 1024 | |
| 1025 | # And the result object. |
| 1026 | self.res = lldb.SBCommandReturnObject() |
| 1027 | |
Johnny Chen | ac97a6b | 2012-04-16 18:55:15 +0000 | [diff] [blame] | 1028 | # Run global pre-flight code, if defined via the config file. |
| 1029 | if lldb.pre_flight: |
| 1030 | lldb.pre_flight(self) |
| 1031 | |
Enrico Granata | 251729e | 2012-10-24 01:23:57 +0000 | [diff] [blame] | 1032 | # utility methods that tests can use to access the current objects |
| 1033 | def target(self): |
| 1034 | if not self.dbg: |
| 1035 | raise Exception('Invalid debugger instance') |
| 1036 | return self.dbg.GetSelectedTarget() |
| 1037 | |
| 1038 | def process(self): |
| 1039 | if not self.dbg: |
| 1040 | raise Exception('Invalid debugger instance') |
| 1041 | return self.dbg.GetSelectedTarget().GetProcess() |
| 1042 | |
| 1043 | def thread(self): |
| 1044 | if not self.dbg: |
| 1045 | raise Exception('Invalid debugger instance') |
| 1046 | return self.dbg.GetSelectedTarget().GetProcess().GetSelectedThread() |
| 1047 | |
| 1048 | def frame(self): |
| 1049 | if not self.dbg: |
| 1050 | raise Exception('Invalid debugger instance') |
| 1051 | return self.dbg.GetSelectedTarget().GetProcess().GetSelectedThread().GetSelectedFrame() |
| 1052 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 1053 | def tearDown(self): |
Johnny Chen | 72a1434 | 2010-09-02 21:23:12 +0000 | [diff] [blame] | 1054 | #import traceback |
| 1055 | #traceback.print_stack() |
| 1056 | |
Johnny Chen | cbe5126 | 2011-08-01 19:50:58 +0000 | [diff] [blame] | 1057 | Base.tearDown(self) |
Johnny Chen | 705737b | 2010-10-19 23:40:13 +0000 | [diff] [blame] | 1058 | |
Johnny Chen | 409646d | 2011-06-15 21:24:24 +0000 | [diff] [blame] | 1059 | # Delete the target(s) from the debugger as a general cleanup step. |
| 1060 | # This includes terminating the process for each target, if any. |
| 1061 | # We'd like to reuse the debugger for our next test without incurring |
| 1062 | # the initialization overhead. |
| 1063 | targets = [] |
| 1064 | for target in self.dbg: |
| 1065 | if target: |
| 1066 | targets.append(target) |
| 1067 | process = target.GetProcess() |
| 1068 | if process: |
| 1069 | rc = self.invoke(process, "Kill") |
| 1070 | self.assertTrue(rc.Success(), PROCESS_KILLED) |
| 1071 | for target in targets: |
| 1072 | self.dbg.DeleteTarget(target) |
Johnny Chen | ffde4fc | 2010-08-16 21:28:10 +0000 | [diff] [blame] | 1073 | |
Johnny Chen | ac97a6b | 2012-04-16 18:55:15 +0000 | [diff] [blame] | 1074 | # Run global post-flight code, if defined via the config file. |
| 1075 | if lldb.post_flight: |
| 1076 | lldb.post_flight(self) |
| 1077 | |
Johnny Chen | a1affab | 2010-07-03 03:41:59 +0000 | [diff] [blame] | 1078 | del self.dbg |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1079 | |
Johnny Chen | 90c56e6 | 2011-09-30 21:48:35 +0000 | [diff] [blame] | 1080 | def switch_to_thread_with_stop_reason(self, stop_reason): |
| 1081 | """ |
| 1082 | Run the 'thread list' command, and select the thread with stop reason as |
| 1083 | 'stop_reason'. If no such thread exists, no select action is done. |
| 1084 | """ |
| 1085 | from lldbutil import stop_reason_to_str |
| 1086 | self.runCmd('thread list') |
| 1087 | output = self.res.GetOutput() |
| 1088 | thread_line_pattern = re.compile("^[ *] thread #([0-9]+):.*stop reason = %s" % |
| 1089 | stop_reason_to_str(stop_reason)) |
| 1090 | for line in output.splitlines(): |
| 1091 | matched = thread_line_pattern.match(line) |
| 1092 | if matched: |
| 1093 | self.runCmd('thread select %s' % matched.group(1)) |
| 1094 | |
Johnny Chen | ef6f476 | 2011-06-15 21:38:39 +0000 | [diff] [blame] | 1095 | def runCmd(self, cmd, msg=None, check=True, trace=False): |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1096 | """ |
| 1097 | Ask the command interpreter to handle the command and then check its |
| 1098 | return status. |
| 1099 | """ |
| 1100 | # Fail fast if 'cmd' is not meaningful. |
| 1101 | if not cmd or len(cmd) == 0: |
| 1102 | raise Exception("Bad 'cmd' parameter encountered") |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 1103 | |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 1104 | trace = (True if traceAlways else trace) |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 1105 | |
Johnny Chen | 21f3341 | 2010-09-01 00:15:19 +0000 | [diff] [blame] | 1106 | running = (cmd.startswith("run") or cmd.startswith("process launch")) |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 1107 | |
Johnny Chen | 21f3341 | 2010-09-01 00:15:19 +0000 | [diff] [blame] | 1108 | for i in range(self.maxLaunchCount if running else 1): |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 1109 | self.ci.HandleCommand(cmd, self.res) |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 1110 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1111 | with recording(self, trace) as sbuf: |
| 1112 | print >> sbuf, "runCmd:", cmd |
Johnny Chen | 7c565c8 | 2010-10-15 16:13:00 +0000 | [diff] [blame] | 1113 | if not check: |
Johnny Chen | 31cf8e2 | 2010-10-15 18:52:22 +0000 | [diff] [blame] | 1114 | print >> sbuf, "check of return status not required" |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 1115 | if self.res.Succeeded(): |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1116 | print >> sbuf, "output:", self.res.GetOutput() |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 1117 | else: |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1118 | print >> sbuf, "runCmd failed!" |
| 1119 | print >> sbuf, self.res.GetError() |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 1120 | |
Johnny Chen | 029acae | 2010-08-20 21:03:09 +0000 | [diff] [blame] | 1121 | if self.res.Succeeded(): |
Johnny Chen | 6557248 | 2010-08-25 18:49:48 +0000 | [diff] [blame] | 1122 | break |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1123 | elif running: |
Johnny Chen | dcb3722 | 2011-01-19 02:02:08 +0000 | [diff] [blame] | 1124 | # For process launch, wait some time before possible next try. |
| 1125 | time.sleep(self.timeWaitNextLaunch) |
Johnny Chen | 894eab4 | 2012-08-01 19:56:04 +0000 | [diff] [blame] | 1126 | with recording(self, trace) as sbuf: |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1127 | print >> sbuf, "Command '" + cmd + "' failed!" |
Johnny Chen | 4f995f0 | 2010-08-20 17:57:32 +0000 | [diff] [blame] | 1128 | |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1129 | if check: |
| 1130 | self.assertTrue(self.res.Succeeded(), |
Johnny Chen | 05efcf78 | 2010-11-09 18:42:22 +0000 | [diff] [blame] | 1131 | msg if msg else CMD_MSG(cmd)) |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1132 | |
Jim Ingham | 431d839 | 2012-09-22 00:05:11 +0000 | [diff] [blame] | 1133 | def match (self, str, patterns, msg=None, trace=False, error=False, matching=True, exe=True): |
| 1134 | """run command in str, and match the result against regexp in patterns returning the match object for the first matching pattern |
| 1135 | |
| 1136 | Otherwise, all the arguments have the same meanings as for the expect function""" |
| 1137 | |
| 1138 | trace = (True if traceAlways else trace) |
| 1139 | |
| 1140 | if exe: |
| 1141 | # First run the command. If we are expecting error, set check=False. |
| 1142 | # Pass the assert message along since it provides more semantic info. |
| 1143 | self.runCmd(str, msg=msg, trace = (True if trace else False), check = not error) |
| 1144 | |
| 1145 | # Then compare the output against expected strings. |
| 1146 | output = self.res.GetError() if error else self.res.GetOutput() |
| 1147 | |
| 1148 | # If error is True, the API client expects the command to fail! |
| 1149 | if error: |
| 1150 | self.assertFalse(self.res.Succeeded(), |
| 1151 | "Command '" + str + "' is expected to fail!") |
| 1152 | else: |
| 1153 | # No execution required, just compare str against the golden input. |
| 1154 | output = str |
| 1155 | with recording(self, trace) as sbuf: |
| 1156 | print >> sbuf, "looking at:", output |
| 1157 | |
| 1158 | # The heading says either "Expecting" or "Not expecting". |
| 1159 | heading = "Expecting" if matching else "Not expecting" |
| 1160 | |
| 1161 | for pattern in patterns: |
| 1162 | # Match Objects always have a boolean value of True. |
| 1163 | match_object = re.search(pattern, output) |
| 1164 | matched = bool(match_object) |
| 1165 | with recording(self, trace) as sbuf: |
| 1166 | print >> sbuf, "%s pattern: %s" % (heading, pattern) |
| 1167 | print >> sbuf, "Matched" if matched else "Not matched" |
| 1168 | if matched: |
| 1169 | break |
| 1170 | |
| 1171 | self.assertTrue(matched if matching else not matched, |
| 1172 | msg if msg else EXP_MSG(str, exe)) |
| 1173 | |
| 1174 | return match_object |
| 1175 | |
Johnny Chen | 90c56e6 | 2011-09-30 21:48:35 +0000 | [diff] [blame] | 1176 | def expect(self, str, msg=None, patterns=None, startstr=None, endstr=None, substrs=None, trace=False, error=False, matching=True, exe=True): |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1177 | """ |
| 1178 | Similar to runCmd; with additional expect style output matching ability. |
| 1179 | |
| 1180 | Ask the command interpreter to handle the command and then check its |
| 1181 | return status. The 'msg' parameter specifies an informational assert |
| 1182 | message. We expect the output from running the command to start with |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1183 | 'startstr', matches the substrings contained in 'substrs', and regexp |
| 1184 | matches the patterns contained in 'patterns'. |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 1185 | |
| 1186 | If the keyword argument error is set to True, it signifies that the API |
| 1187 | 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] | 1188 | from running the command is retrieved and compared against the golden |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 1189 | input, instead. |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1190 | |
| 1191 | If the keyword argument matching is set to False, it signifies that the API |
| 1192 | client is expecting the output of the command not to match the golden |
| 1193 | input. |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 1194 | |
| 1195 | Finally, the required argument 'str' represents the lldb command to be |
| 1196 | sent to the command interpreter. In case the keyword argument 'exe' is |
| 1197 | set to False, the 'str' is treated as a string to be matched/not-matched |
| 1198 | against the golden input. |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1199 | """ |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 1200 | trace = (True if traceAlways else trace) |
Johnny Chen | d0c24b2 | 2010-08-23 17:10:44 +0000 | [diff] [blame] | 1201 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 1202 | if exe: |
| 1203 | # First run the command. If we are expecting error, set check=False. |
Johnny Chen | 60881f6 | 2010-10-28 21:10:32 +0000 | [diff] [blame] | 1204 | # Pass the assert message along since it provides more semantic info. |
Johnny Chen | 05dd893 | 2010-10-28 18:24:22 +0000 | [diff] [blame] | 1205 | self.runCmd(str, msg=msg, trace = (True if trace else False), check = not error) |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1206 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 1207 | # Then compare the output against expected strings. |
| 1208 | output = self.res.GetError() if error else self.res.GetOutput() |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 1209 | |
Johnny Chen | 8e06de9 | 2010-09-21 23:33:30 +0000 | [diff] [blame] | 1210 | # If error is True, the API client expects the command to fail! |
| 1211 | if error: |
| 1212 | self.assertFalse(self.res.Succeeded(), |
| 1213 | "Command '" + str + "' is expected to fail!") |
| 1214 | else: |
| 1215 | # No execution required, just compare str against the golden input. |
Enrico Granata | 01458ca | 2012-10-23 00:09:02 +0000 | [diff] [blame] | 1216 | if isinstance(str,lldb.SBCommandReturnObject): |
| 1217 | output = str.GetOutput() |
| 1218 | else: |
| 1219 | output = str |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1220 | with recording(self, trace) as sbuf: |
| 1221 | print >> sbuf, "looking at:", output |
Johnny Chen | 9792f8e | 2010-09-17 22:28:51 +0000 | [diff] [blame] | 1222 | |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1223 | # The heading says either "Expecting" or "Not expecting". |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1224 | heading = "Expecting" if matching else "Not expecting" |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1225 | |
| 1226 | # Start from the startstr, if specified. |
| 1227 | # If there's no startstr, set the initial state appropriately. |
| 1228 | matched = output.startswith(startstr) if startstr else (True if matching else False) |
Johnny Chen | ead35c8 | 2010-08-20 18:25:15 +0000 | [diff] [blame] | 1229 | |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1230 | if startstr: |
| 1231 | with recording(self, trace) as sbuf: |
| 1232 | print >> sbuf, "%s start string: %s" % (heading, startstr) |
| 1233 | print >> sbuf, "Matched" if matched else "Not matched" |
Johnny Chen | ead35c8 | 2010-08-20 18:25:15 +0000 | [diff] [blame] | 1234 | |
Johnny Chen | 90c56e6 | 2011-09-30 21:48:35 +0000 | [diff] [blame] | 1235 | # Look for endstr, if specified. |
| 1236 | keepgoing = matched if matching else not matched |
| 1237 | if endstr: |
| 1238 | matched = output.endswith(endstr) |
| 1239 | with recording(self, trace) as sbuf: |
| 1240 | print >> sbuf, "%s end string: %s" % (heading, endstr) |
| 1241 | print >> sbuf, "Matched" if matched else "Not matched" |
| 1242 | |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1243 | # Look for sub strings, if specified. |
| 1244 | keepgoing = matched if matching else not matched |
| 1245 | if substrs and keepgoing: |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1246 | for str in substrs: |
Johnny Chen | 091bb1d | 2010-09-23 23:35:28 +0000 | [diff] [blame] | 1247 | matched = output.find(str) != -1 |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1248 | with recording(self, trace) as sbuf: |
| 1249 | print >> sbuf, "%s sub string: %s" % (heading, str) |
| 1250 | print >> sbuf, "Matched" if matched else "Not matched" |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1251 | keepgoing = matched if matching else not matched |
| 1252 | if not keepgoing: |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1253 | break |
| 1254 | |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1255 | # Search for regular expression patterns, if specified. |
| 1256 | keepgoing = matched if matching else not matched |
| 1257 | if patterns and keepgoing: |
| 1258 | for pattern in patterns: |
| 1259 | # Match Objects always have a boolean value of True. |
| 1260 | matched = bool(re.search(pattern, output)) |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1261 | with recording(self, trace) as sbuf: |
| 1262 | print >> sbuf, "%s pattern: %s" % (heading, pattern) |
| 1263 | print >> sbuf, "Matched" if matched else "Not matched" |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1264 | keepgoing = matched if matching else not matched |
| 1265 | if not keepgoing: |
| 1266 | break |
Johnny Chen | 2d89975 | 2010-09-21 21:08:53 +0000 | [diff] [blame] | 1267 | |
| 1268 | self.assertTrue(matched if matching else not matched, |
Johnny Chen | 05efcf78 | 2010-11-09 18:42:22 +0000 | [diff] [blame] | 1269 | msg if msg else EXP_MSG(str, exe)) |
Johnny Chen | 8df95eb | 2010-08-19 23:26:59 +0000 | [diff] [blame] | 1270 | |
Johnny Chen | a8b3cdd | 2010-08-25 22:52:45 +0000 | [diff] [blame] | 1271 | def invoke(self, obj, name, trace=False): |
Johnny Chen | d8473bc | 2010-08-25 22:56:10 +0000 | [diff] [blame] | 1272 | """Use reflection to call a method dynamically with no argument.""" |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 1273 | trace = (True if traceAlways else trace) |
Johnny Chen | a8b3cdd | 2010-08-25 22:52:45 +0000 | [diff] [blame] | 1274 | |
| 1275 | method = getattr(obj, name) |
| 1276 | import inspect |
| 1277 | self.assertTrue(inspect.ismethod(method), |
| 1278 | name + "is a method name of object: " + str(obj)) |
| 1279 | result = method() |
Johnny Chen | 84a6d6f | 2010-10-15 01:18:29 +0000 | [diff] [blame] | 1280 | with recording(self, trace) as sbuf: |
| 1281 | print >> sbuf, str(method) + ":", result |
Johnny Chen | a8b3cdd | 2010-08-25 22:52:45 +0000 | [diff] [blame] | 1282 | return result |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 1283 | |
Johnny Chen | b877031 | 2011-05-27 23:36:52 +0000 | [diff] [blame] | 1284 | # ================================================= |
| 1285 | # Misc. helper methods for debugging test execution |
| 1286 | # ================================================= |
| 1287 | |
Johnny Chen | 57cd6dd | 2011-07-11 19:15:11 +0000 | [diff] [blame] | 1288 | def DebugSBValue(self, val): |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 1289 | """Debug print a SBValue object, if traceAlways is True.""" |
Johnny Chen | 47342d5 | 2011-04-27 17:43:07 +0000 | [diff] [blame] | 1290 | from lldbutil import value_type_to_str |
Johnny Chen | 2c8d159 | 2010-11-03 21:37:58 +0000 | [diff] [blame] | 1291 | |
Johnny Chen | 9de4ede | 2010-08-31 17:42:54 +0000 | [diff] [blame] | 1292 | if not traceAlways: |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 1293 | return |
| 1294 | |
| 1295 | err = sys.stderr |
| 1296 | err.write(val.GetName() + ":\n") |
Johnny Chen | 90c56e6 | 2011-09-30 21:48:35 +0000 | [diff] [blame] | 1297 | err.write('\t' + "TypeName -> " + val.GetTypeName() + '\n') |
| 1298 | err.write('\t' + "ByteSize -> " + str(val.GetByteSize()) + '\n') |
| 1299 | err.write('\t' + "NumChildren -> " + str(val.GetNumChildren()) + '\n') |
| 1300 | err.write('\t' + "Value -> " + str(val.GetValue()) + '\n') |
| 1301 | err.write('\t' + "ValueAsUnsigned -> " + str(val.GetValueAsUnsigned())+ '\n') |
| 1302 | err.write('\t' + "ValueType -> " + value_type_to_str(val.GetValueType()) + '\n') |
| 1303 | err.write('\t' + "Summary -> " + str(val.GetSummary()) + '\n') |
| 1304 | err.write('\t' + "IsPointerType -> " + str(val.TypeIsPointerType()) + '\n') |
| 1305 | err.write('\t' + "Location -> " + val.GetLocation() + '\n') |
Johnny Chen | 9c10c18 | 2010-08-27 00:15:48 +0000 | [diff] [blame] | 1306 | |
Johnny Chen | d7e04d9 | 2011-08-05 20:17:27 +0000 | [diff] [blame] | 1307 | def DebugSBType(self, type): |
| 1308 | """Debug print a SBType object, if traceAlways is True.""" |
| 1309 | if not traceAlways: |
| 1310 | return |
| 1311 | |
| 1312 | err = sys.stderr |
| 1313 | err.write(type.GetName() + ":\n") |
| 1314 | err.write('\t' + "ByteSize -> " + str(type.GetByteSize()) + '\n') |
| 1315 | err.write('\t' + "IsPointerType -> " + str(type.IsPointerType()) + '\n') |
| 1316 | err.write('\t' + "IsReferenceType -> " + str(type.IsReferenceType()) + '\n') |
| 1317 | |
Johnny Chen | 7304147 | 2011-03-12 01:18:19 +0000 | [diff] [blame] | 1318 | def DebugPExpect(self, child): |
| 1319 | """Debug the spwaned pexpect object.""" |
| 1320 | if not traceAlways: |
| 1321 | return |
| 1322 | |
| 1323 | print child |
Filipe Cabecinhas | dee13ce | 2012-06-20 10:13:40 +0000 | [diff] [blame] | 1324 | |
| 1325 | @classmethod |
| 1326 | def RemoveTempFile(cls, file): |
| 1327 | if os.path.exists(file): |
| 1328 | os.remove(file) |