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
83 lines
3.2 KiB
Python
83 lines
3.2 KiB
Python
"""
|
|
Test that --allow-jit=false does disallow JITting:
|
|
"""
|
|
|
|
|
|
|
|
import lldb
|
|
import lldbsuite.test.lldbutil as lldbutil
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test.decorators import *
|
|
|
|
class TestAllowJIT(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
# If your test case doesn't stress debug info, the
|
|
# set this to true. That way it won't be run once for
|
|
# each debug info format.
|
|
NO_DEBUG_INFO_TESTCASE = True
|
|
|
|
def test_allow_jit_expr_command(self):
|
|
"""Test the --allow-jit command line flag"""
|
|
self.build()
|
|
self.main_source_file = lldb.SBFileSpec("main.c")
|
|
self.expr_cmd_test()
|
|
|
|
def test_allow_jit_options(self):
|
|
"""Test the SetAllowJIT SBExpressionOption setting"""
|
|
self.build()
|
|
self.main_source_file = lldb.SBFileSpec("main.c")
|
|
self.expr_options_test()
|
|
|
|
def expr_cmd_test(self):
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(self,
|
|
"Set a breakpoint here", self.main_source_file)
|
|
|
|
frame = thread.GetFrameAtIndex(0)
|
|
|
|
# First make sure we can call the function with
|
|
interp = self.dbg.GetCommandInterpreter()
|
|
self.expect("expr --allow-jit 1 -- call_me(10)",
|
|
substrs = ["(int) $", "= 18"])
|
|
# Now make sure it fails with the "can't IR interpret message" if allow-jit is false:
|
|
self.expect("expr --allow-jit 0 -- call_me(10)",
|
|
error=True,
|
|
substrs = ["Can't evaluate the expression without a running target"])
|
|
|
|
def expr_options_test(self):
|
|
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(self,
|
|
"Set a breakpoint here", self.main_source_file)
|
|
|
|
frame = thread.GetFrameAtIndex(0)
|
|
|
|
# First make sure we can call the function with the default option set.
|
|
options = lldb.SBExpressionOptions()
|
|
# Check that the default is to allow JIT:
|
|
self.assertEqual(options.GetAllowJIT(), True, "Default is true")
|
|
|
|
# Now use the options:
|
|
result = frame.EvaluateExpression("call_me(10)", options)
|
|
self.assertSuccess(result.GetError())
|
|
self.assertEqual(result.GetValueAsSigned(), 18, "got the right value.")
|
|
|
|
# Now disallow JIT and make sure it fails:
|
|
options.SetAllowJIT(False)
|
|
# Check that we got the right value:
|
|
self.assertEqual(options.GetAllowJIT(), False, "Got False after setting to False")
|
|
|
|
# Again use it and ensure we fail:
|
|
result = frame.EvaluateExpression("call_me(10)", options)
|
|
self.assertTrue(result.GetError().Fail(), "expression failed with no JIT")
|
|
self.assertTrue("Can't evaluate the expression without a running target" in result.GetError().GetCString(), "Got right error")
|
|
|
|
# Finally set the allow JIT value back to true and make sure that works:
|
|
options.SetAllowJIT(True)
|
|
self.assertEqual(options.GetAllowJIT(), True, "Set back to True correctly")
|
|
|
|
# And again, make sure this works:
|
|
result = frame.EvaluateExpression("call_me(10)", options)
|
|
self.assertSuccess(result.GetError())
|
|
self.assertEqual(result.GetValueAsSigned(), 18, "got the right value.")
|
|
|