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
49 lines
1.6 KiB
Python
49 lines
1.6 KiB
Python
"""
|
|
Make sure running internal expressions doesn't
|
|
influence the result variable numbering.
|
|
"""
|
|
|
|
|
|
|
|
import lldb
|
|
import lldbsuite.test.lldbutil as lldbutil
|
|
from lldbsuite.test.lldbtest import *
|
|
|
|
|
|
class TestExpressionResultNumbering(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
def test_sample_rename_this(self):
|
|
self.build()
|
|
self.main_source_file = lldb.SBFileSpec("main.c")
|
|
self.do_numbering_test()
|
|
|
|
def do_numbering_test(self):
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(self,
|
|
"Set a breakpoint here", self.main_source_file)
|
|
|
|
bkpt = target.BreakpointCreateBySourceRegex("Add conditions to this breakpoint",
|
|
self.main_source_file)
|
|
self.assertEqual(bkpt.GetNumLocations(), 1, "Set the breakpoint")
|
|
|
|
bkpt.SetCondition("call_me(value) < 6")
|
|
|
|
# Get the number of the last expression:
|
|
result = thread.frames[0].EvaluateExpression("call_me(200)")
|
|
self.assertSuccess(result.GetError(), "Our expression succeeded")
|
|
name = result.GetName()
|
|
ordinal = int(name[1:])
|
|
|
|
process.Continue()
|
|
|
|
# The condition evaluation had to run a 4 expressions, but we haven't
|
|
# run any user expressions.
|
|
result = thread.frames[0].EvaluateExpression("call_me(200)")
|
|
self.assertSuccess(result.GetError(), "Our expression succeeded the second time")
|
|
after_name = result.GetName()
|
|
after_ordinal = int(after_name[1:])
|
|
self.assertEqual(ordinal + 1, after_ordinal)
|