35674976f0
Summary: A lot of our tests do 'self.assertTrue(error.Success()'. The problem with that is that when this fails, it produces a completely useless error message (False is not True) and the most important piece of information -- the actual error message -- is completely hidden. Sometimes we mitigate that by including the error message in the "msg" argument, but this has two additional problems: - as the msg argument is evaluated unconditionally, one needs to be careful to not trigger an exception when the operation was actually successful. - it requires more typing, which means we often don't do it assertSuccess solves these problems by taking the entire SBError object as an argument. If the operation was unsuccessful, it can format a reasonable error message itself. The function still accepts a "msg" argument, which can include any additional context, but this context now does not need to include the error message. To demonstrate usage, I replace a number of existing assertTrue assertions with the new function. As this process is not easily automatable, I have just manually updated a representative sample. In some cases, I did not update the code to use assertSuccess, but I went for even higher-level assertion apis (runCmd, expect_expr), as these are even shorter, and can produce even better failure messages. Reviewers: teemperor, JDevlieghere Subscribers: arphaman, lldb-commits Tags: #lldb Differential Revision: https://reviews.llvm.org/D82759
104 lines
3.6 KiB
Python
104 lines
3.6 KiB
Python
"""
|
|
Test calling a function that throws an ObjC exception, make sure that it doesn't propagate the exception.
|
|
"""
|
|
|
|
|
|
|
|
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
|
|
|
|
class ExprCommandWithThrowTestCase(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
def setUp(self):
|
|
# Call super's setUp().
|
|
TestBase.setUp(self)
|
|
|
|
self.main_source = "call-throws.m"
|
|
self.main_source_spec = lldb.SBFileSpec(self.main_source)
|
|
|
|
@skipUnlessDarwin
|
|
def test(self):
|
|
"""Test calling a function that throws and ObjC exception."""
|
|
self.build()
|
|
self.call_function()
|
|
|
|
def check_after_call(self):
|
|
# Check that we are back where we were before:
|
|
frame = self.thread.GetFrameAtIndex(0)
|
|
self.assertTrue(
|
|
self.orig_frame_pc == frame.GetPC(),
|
|
"Restored the zeroth frame correctly")
|
|
|
|
def call_function(self):
|
|
"""Test calling function that throws."""
|
|
(target, process, self.thread, bkpt) = lldbutil.run_to_source_breakpoint(self,
|
|
'I am about to throw.', self.main_source_spec)
|
|
|
|
options = lldb.SBExpressionOptions()
|
|
options.SetUnwindOnError(True)
|
|
|
|
frame = self.thread.GetFrameAtIndex(0)
|
|
# Store away the PC to check that the functions unwind to the right
|
|
# place after calls
|
|
self.orig_frame_pc = frame.GetPC()
|
|
|
|
value = frame.EvaluateExpression("[my_class callMeIThrow]", options)
|
|
self.assertTrue(value.IsValid())
|
|
self.assertEquals(value.GetError().Success(), False)
|
|
|
|
self.check_after_call()
|
|
|
|
# Okay, now try with a breakpoint in the called code in the case where
|
|
# we are ignoring breakpoint hits.
|
|
handler_bkpt = target.BreakpointCreateBySourceRegex(
|
|
"I felt like it", self.main_source_spec)
|
|
self.assertTrue(handler_bkpt.GetNumLocations() > 0)
|
|
options.SetIgnoreBreakpoints(True)
|
|
options.SetUnwindOnError(True)
|
|
|
|
value = frame.EvaluateExpression("[my_class callMeIThrow]", options)
|
|
|
|
self.assertTrue(
|
|
value.IsValid() and value.GetError().Success() == False)
|
|
self.check_after_call()
|
|
|
|
# Now set the ObjC language breakpoint and make sure that doesn't
|
|
# interfere with the call:
|
|
exception_bkpt = target.BreakpointCreateForException(
|
|
lldb.eLanguageTypeObjC, False, True)
|
|
self.assertTrue(exception_bkpt.GetNumLocations() > 0)
|
|
|
|
options.SetIgnoreBreakpoints(True)
|
|
options.SetUnwindOnError(True)
|
|
|
|
value = frame.EvaluateExpression("[my_class callMeIThrow]", options)
|
|
|
|
self.assertTrue(
|
|
value.IsValid() and value.GetError().Success() == False)
|
|
self.check_after_call()
|
|
|
|
# Now turn off exception trapping, and call a function that catches the exceptions,
|
|
# and make sure the function actually completes, and we get the right
|
|
# value:
|
|
options.SetTrapExceptions(False)
|
|
value = frame.EvaluateExpression("[my_class iCatchMyself]", options)
|
|
self.assertTrue(value.IsValid())
|
|
self.assertSuccess(value.GetError())
|
|
self.assertEquals(value.GetValueAsUnsigned(), 57)
|
|
self.check_after_call()
|
|
options.SetTrapExceptions(True)
|
|
|
|
# Now set this unwind on error to false, and make sure that we stop
|
|
# where the exception was thrown
|
|
options.SetUnwindOnError(False)
|
|
value = frame.EvaluateExpression("[my_class callMeIThrow]", options)
|
|
|
|
self.assertTrue(
|
|
value.IsValid() and value.GetError().Success() == False)
|
|
self.check_after_call()
|