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
81 lines
2.7 KiB
Python
81 lines
2.7 KiB
Python
"""
|
|
Test calling a function that waits a while, and make sure the timeout option to expr works.
|
|
"""
|
|
|
|
|
|
|
|
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
|
|
|
|
class ExprCommandWithTimeoutsTestCase(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
def setUp(self):
|
|
# Call super's setUp().
|
|
TestBase.setUp(self)
|
|
|
|
self.main_source = "wait-a-while.cpp"
|
|
self.main_source_spec = lldb.SBFileSpec(self.main_source)
|
|
|
|
@expectedFlakeyFreeBSD("llvm.org/pr19605")
|
|
@expectedFailureAll(
|
|
oslist=[
|
|
"windows"],
|
|
bugnumber="llvm.org/pr21765")
|
|
@skipIfReproducer # Timeouts are not currently modeled.
|
|
def test(self):
|
|
"""Test calling std::String member function."""
|
|
self.build()
|
|
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, 'stop here in main.', self.main_source_spec)
|
|
|
|
# First set the timeout too short, and make sure we fail.
|
|
options = lldb.SBExpressionOptions()
|
|
options.SetTimeoutInMicroSeconds(10)
|
|
options.SetUnwindOnError(True)
|
|
|
|
frame = thread.GetFrameAtIndex(0)
|
|
|
|
value = frame.EvaluateExpression("wait_a_while(1000000)", options)
|
|
self.assertTrue(value.IsValid())
|
|
self.assertFalse(value.GetError().Success())
|
|
|
|
# Now do the same thing with the command line command, and make sure it
|
|
# works too.
|
|
interp = self.dbg.GetCommandInterpreter()
|
|
|
|
result = lldb.SBCommandReturnObject()
|
|
return_value = interp.HandleCommand(
|
|
"expr -t 100 -u true -- wait_a_while(1000000)", result)
|
|
self.assertEquals(return_value, lldb.eReturnStatusFailed)
|
|
|
|
# Okay, now do it again with long enough time outs:
|
|
|
|
options.SetTimeoutInMicroSeconds(1000000)
|
|
value = frame.EvaluateExpression("wait_a_while (1000)", options)
|
|
self.assertTrue(value.IsValid())
|
|
self.assertSuccess(value.GetError())
|
|
|
|
# Now do the same thingwith the command line command, and make sure it
|
|
# works too.
|
|
interp = self.dbg.GetCommandInterpreter()
|
|
|
|
result = lldb.SBCommandReturnObject()
|
|
return_value = interp.HandleCommand(
|
|
"expr -t 1000000 -u true -- wait_a_while(1000)", result)
|
|
self.assertEquals(return_value, lldb.eReturnStatusSuccessFinishResult)
|
|
|
|
# Finally set the one thread timeout and make sure that doesn't change
|
|
# things much:
|
|
|
|
options.SetTimeoutInMicroSeconds(1000000)
|
|
options.SetOneThreadTimeoutInMicroSeconds(500000)
|
|
value = frame.EvaluateExpression("wait_a_while (1000)", options)
|
|
self.assertTrue(value.IsValid())
|
|
self.assertSuccess(value.GetError())
|