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
91 lines
2.9 KiB
Python
91 lines
2.9 KiB
Python
"""
|
|
Test expression command options.
|
|
|
|
Test cases:
|
|
|
|
o test_expr_options:
|
|
Test expression command options.
|
|
"""
|
|
|
|
|
|
|
|
import lldb
|
|
import lldbsuite.test.lldbutil as lldbutil
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
|
|
|
|
class ExprOptionsTestCase(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
def setUp(self):
|
|
# Call super's setUp().
|
|
TestBase.setUp(self)
|
|
|
|
self.main_source = "main.cpp"
|
|
self.main_source_spec = lldb.SBFileSpec(self.main_source)
|
|
self.line = line_number('main.cpp', '// breakpoint_in_main')
|
|
self.exe = self.getBuildArtifact("a.out")
|
|
|
|
def test_expr_options(self):
|
|
"""These expression command options should work as expected."""
|
|
self.build()
|
|
|
|
# Set debugger into synchronous mode
|
|
self.dbg.SetAsync(False)
|
|
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, '// breakpoint_in_main', self.main_source_spec)
|
|
|
|
frame = thread.GetFrameAtIndex(0)
|
|
options = lldb.SBExpressionOptions()
|
|
|
|
# test --language on C++ expression using the SB API's
|
|
|
|
# Make sure we can evaluate a C++11 expression.
|
|
val = frame.EvaluateExpression('foo != nullptr')
|
|
self.assertTrue(val.IsValid())
|
|
self.assertSuccess(val.GetError())
|
|
self.DebugSBValue(val)
|
|
|
|
# Make sure it still works if language is set to C++11:
|
|
options.SetLanguage(lldb.eLanguageTypeC_plus_plus_11)
|
|
val = frame.EvaluateExpression('foo != nullptr', options)
|
|
self.assertTrue(val.IsValid())
|
|
self.assertSuccess(val.GetError())
|
|
self.DebugSBValue(val)
|
|
|
|
# Make sure it fails if language is set to C:
|
|
options.SetLanguage(lldb.eLanguageTypeC)
|
|
val = frame.EvaluateExpression('foo != nullptr', options)
|
|
self.assertTrue(val.IsValid())
|
|
self.assertFalse(val.GetError().Success())
|
|
|
|
@skipIfDarwin
|
|
def test_expr_options_lang(self):
|
|
"""These expression language options should work as expected."""
|
|
self.build()
|
|
|
|
# Set debugger into synchronous mode
|
|
self.dbg.SetAsync(False)
|
|
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
|
|
self, '// breakpoint_in_main', self.main_source_spec)
|
|
|
|
frame = thread.GetFrameAtIndex(0)
|
|
options = lldb.SBExpressionOptions()
|
|
|
|
# Make sure we can retrieve `id` variable if language is set to C++11:
|
|
options.SetLanguage(lldb.eLanguageTypeC_plus_plus_11)
|
|
val = frame.EvaluateExpression('id == 0', options)
|
|
self.assertTrue(val.IsValid())
|
|
self.assertSuccess(val.GetError())
|
|
self.DebugSBValue(val)
|
|
|
|
# Make sure we can't retrieve `id` variable if language is set to ObjC:
|
|
options.SetLanguage(lldb.eLanguageTypeObjC)
|
|
val = frame.EvaluateExpression('id == 0', options)
|
|
self.assertTrue(val.IsValid())
|
|
self.assertFalse(val.GetError().Success())
|