[lldb] Simplify some tests to run_to_source_breakpoint (NFC)#190082
Open
kastiglione wants to merge 1 commit intollvm:mainfrom
Open
[lldb] Simplify some tests to run_to_source_breakpoint (NFC)#190082kastiglione wants to merge 1 commit intollvm:mainfrom
kastiglione wants to merge 1 commit intollvm:mainfrom
Conversation
Member
|
@llvm/pr-subscribers-lldb Author: Dave Lee (kastiglione) ChangesFull diff: https://github.com/llvm/llvm-project/pull/190082.diff 10 Files Affected:
diff --git a/lldb/test/API/commands/disassemble/basic/TestFrameDisassemble.py b/lldb/test/API/commands/disassemble/basic/TestFrameDisassemble.py
index 0d324918d0658..1659f18ac90e2 100644
--- a/lldb/test/API/commands/disassemble/basic/TestFrameDisassemble.py
+++ b/lldb/test/API/commands/disassemble/basic/TestFrameDisassemble.py
@@ -18,39 +18,11 @@ def test_frame_disassemble(self):
def frame_disassemble_test(self):
"""Sample test to ensure SBFrame::Disassemble produces SOME output"""
- # Create a target by the debugger.
- target = self.createTestTarget()
-
- # Now create a breakpoint in main.c at the source matching
- # "Set a breakpoint here"
- breakpoint = target.BreakpointCreateBySourceRegex(
- "Set a breakpoint here", lldb.SBFileSpec("main.cpp")
- )
- self.assertTrue(
- breakpoint and breakpoint.GetNumLocations() >= 1, VALID_BREAKPOINT
- )
-
- error = lldb.SBError()
- # This is the launch info. If you want to launch with arguments or
- # environment variables, add them using SetArguments or
- # SetEnvironmentEntries
-
- launch_info = target.GetLaunchInfo()
- process = target.Launch(launch_info, error)
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # Did we hit our breakpoint?
- from lldbsuite.test.lldbutil import get_threads_stopped_at_breakpoint
-
- threads = get_threads_stopped_at_breakpoint(process, breakpoint)
- self.assertEqual(
- len(threads), 1, "There should be a thread stopped at our breakpoint"
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "Set a breakpoint here", lldb.SBFileSpec("main.cpp")
)
- # The hit count for the breakpoint should be 1.
- self.assertEqual(breakpoint.GetHitCount(), 1)
-
- frame = threads[0].GetFrameAtIndex(0)
+ frame = thread.GetFrameAtIndex(0)
disassembly = frame.Disassemble()
self.assertNotEqual(disassembly, "")
self.assertNotIn("error", disassembly)
diff --git a/lldb/test/API/commands/frame/language/TestGuessLanguage.py b/lldb/test/API/commands/frame/language/TestGuessLanguage.py
index dbf581ed7a12d..d8fd563242e1b 100644
--- a/lldb/test/API/commands/frame/language/TestGuessLanguage.py
+++ b/lldb/test/API/commands/frame/language/TestGuessLanguage.py
@@ -30,39 +30,10 @@ def check_language(self, thread, frame_no, test_lang):
def do_test(self):
"""Test GuessLanguage for C & C++."""
- target = self.createTestTarget()
-
- # Now create a breakpoint in main.c at the source matching
- # "Set a breakpoint here"
- breakpoint = target.BreakpointCreateBySourceRegex(
- "Set breakpoint here", lldb.SBFileSpec("somefunc.c")
- )
- self.assertTrue(
- breakpoint and breakpoint.GetNumLocations() >= 1, VALID_BREAKPOINT
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "Set breakpoint here", lldb.SBFileSpec("somefunc.c")
)
- error = lldb.SBError()
- # This is the launch info. If you want to launch with arguments or
- # environment variables, add them using SetArguments or
- # SetEnvironmentEntries
-
- launch_info = target.GetLaunchInfo()
- process = target.Launch(launch_info, error)
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # Did we hit our breakpoint?
- from lldbsuite.test.lldbutil import get_threads_stopped_at_breakpoint
-
- threads = get_threads_stopped_at_breakpoint(process, breakpoint)
- self.assertEqual(
- len(threads), 1, "There should be a thread stopped at our breakpoint"
- )
-
- # The hit count for the breakpoint should be 1.
- self.assertEqual(breakpoint.GetHitCount(), 1)
-
- thread = threads[0]
-
c_frame_language = lldb.eLanguageTypeC99
cxx_frame_language = lldb.eLanguageTypeC_plus_plus_11
# gcc emits DW_LANG_C89 even if -std=c99 was specified
diff --git a/lldb/test/API/commands/frame/var/TestFrameVar.py b/lldb/test/API/commands/frame/var/TestFrameVar.py
index b70120cb2d8e1..18c67b291c77a 100644
--- a/lldb/test/API/commands/frame/var/TestFrameVar.py
+++ b/lldb/test/API/commands/frame/var/TestFrameVar.py
@@ -23,38 +23,10 @@ def test_frame_var(self):
self.do_test()
def do_test(self):
- target = self.createTestTarget()
-
- # Now create a breakpoint in main.c at the source matching
- # "Set a breakpoint here"
- breakpoint = target.BreakpointCreateBySourceRegex(
- "Set a breakpoint here", lldb.SBFileSpec("main.c")
- )
- self.assertTrue(
- breakpoint and breakpoint.GetNumLocations() >= 1, VALID_BREAKPOINT
- )
-
- error = lldb.SBError()
- # This is the launch info. If you want to launch with arguments or
- # environment variables, add them using SetArguments or
- # SetEnvironmentEntries
-
- launch_info = target.GetLaunchInfo()
- process = target.Launch(launch_info, error)
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # Did we hit our breakpoint?
- from lldbsuite.test.lldbutil import get_threads_stopped_at_breakpoint
-
- threads = get_threads_stopped_at_breakpoint(process, breakpoint)
- self.assertEqual(
- len(threads), 1, "There should be a thread stopped at our breakpoint"
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "Set a breakpoint here", lldb.SBFileSpec("main.c")
)
- # The hit count for the breakpoint should be 1.
- self.assertEqual(breakpoint.GetHitCount(), 1)
-
- frame = threads[0].GetFrameAtIndex(0)
command_result = lldb.SBCommandReturnObject()
interp = self.dbg.GetCommandInterpreter()
diff --git a/lldb/test/API/functionalities/ptr_refs/TestPtrRefs.py b/lldb/test/API/functionalities/ptr_refs/TestPtrRefs.py
index e638718e5e95e..d04a15eed10ab 100644
--- a/lldb/test/API/functionalities/ptr_refs/TestPtrRefs.py
+++ b/lldb/test/API/functionalities/ptr_refs/TestPtrRefs.py
@@ -16,28 +16,8 @@ class TestPtrRefs(TestBase):
def test_ptr_refs(self):
"""Test format string functionality."""
self.build()
- exe = self.getBuildArtifact("a.out")
- target = self.dbg.CreateTarget(exe)
- self.assertTrue(target, VALID_TARGET)
-
- main_file_spec = lldb.SBFileSpec("main.c")
- breakpoint = target.BreakpointCreateBySourceRegex("break", main_file_spec)
- self.assertTrue(
- breakpoint and breakpoint.GetNumLocations() == 1, VALID_BREAKPOINT
- )
-
- process = target.LaunchSimple(None, None, self.get_process_working_directory())
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # Frame #0 should be on self.line1 and the break condition should hold.
- thread = lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
- self.assertTrue(
- thread.IsValid(),
- "There should be a thread stopped due to breakpoint condition",
- )
-
- frame = thread.GetFrameAtIndex(0)
+ lldbutil.run_to_source_breakpoint(self, "break", lldb.SBFileSpec("main.c"))
self.runCmd("command script import lldb.macosx.heap")
self.expect("ptr_refs my_ptr", substrs=["malloc", "stack"])
diff --git a/lldb/test/API/functionalities/step-avoids-no-debug/TestStepNoDebug.py b/lldb/test/API/functionalities/step-avoids-no-debug/TestStepNoDebug.py
index a5ec87274a5ba..7ace6918a0c23 100644
--- a/lldb/test/API/functionalities/step-avoids-no-debug/TestStepNoDebug.py
+++ b/lldb/test/API/functionalities/step-avoids-no-debug/TestStepNoDebug.py
@@ -90,29 +90,10 @@ def hit_correct_function(self, pattern):
)
def get_to_starting_point(self):
- exe = self.getBuildArtifact("a.out")
- error = lldb.SBError()
-
- self.target = self.dbg.CreateTarget(exe)
- self.assertTrue(self.target, VALID_TARGET)
-
- inner_bkpt = self.target.BreakpointCreateBySourceRegex(
- "Stop here and step out of me", self.main_source_spec
- )
- self.assertTrue(inner_bkpt, VALID_BREAKPOINT)
-
- # Now launch the process, and do not stop at entry point.
- self.process = self.target.LaunchSimple(
- None, None, self.get_process_working_directory()
+ self.target, self.process, self.thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "Stop here and step out of me", self.main_source_spec
)
- self.assertTrue(self.process, PROCESS_IS_VALID)
-
- # Now finish, and make sure the return value is correct.
- threads = lldbutil.get_threads_stopped_at_breakpoint(self.process, inner_bkpt)
- self.assertEqual(len(threads), 1, "Stopped at inner breakpoint.")
- self.thread = threads[0]
-
def do_step_out_past_nodebug(self):
# The first step out takes us to the called_from_nodebug frame, just to make sure setting
# step-out-avoid-nodebug doesn't change the behavior in frames with
diff --git a/lldb/test/API/functionalities/tail_call_frames/sbapi_support/TestTailCallFrameSBAPI.py b/lldb/test/API/functionalities/tail_call_frames/sbapi_support/TestTailCallFrameSBAPI.py
index d63d8502a7233..fa913883ba617 100644
--- a/lldb/test/API/functionalities/tail_call_frames/sbapi_support/TestTailCallFrameSBAPI.py
+++ b/lldb/test/API/functionalities/tail_call_frames/sbapi_support/TestTailCallFrameSBAPI.py
@@ -17,34 +17,10 @@ def test_tail_call_frame_sbapi(self):
self.do_test()
def do_test(self):
- exe = self.getBuildArtifact("a.out")
-
- # Create a target by the debugger.
- target = self.dbg.CreateTarget(exe)
- self.assertTrue(target, VALID_TARGET)
-
- breakpoint = target.BreakpointCreateBySourceRegex(
- "break here", lldb.SBFileSpec("main.cpp")
- )
- self.assertTrue(
- breakpoint and breakpoint.GetNumLocations() == 1, VALID_BREAKPOINT
- )
-
- error = lldb.SBError()
- launch_info = target.GetLaunchInfo()
- process = target.Launch(launch_info, error)
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # Did we hit our breakpoint?
- threads = lldbutil.get_threads_stopped_at_breakpoint(process, breakpoint)
- self.assertEqual(
- len(threads), 1, "There should be a thread stopped at our breakpoint"
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "break here", lldb.SBFileSpec("main.cpp")
)
- self.assertEqual(breakpoint.GetHitCount(), 1)
-
- thread = threads[0]
-
# Here's what we expect to see in the backtrace:
# frame #0: ... a.out`sink() at main.cpp:13:4 [opt]
# frame #1: ... a.out`func3() at main.cpp:14:1 [opt] [artificial]
diff --git a/lldb/test/API/functionalities/tail_call_frames/thread_step_out_or_return/TestSteppingOutWithArtificialFrames.py b/lldb/test/API/functionalities/tail_call_frames/thread_step_out_or_return/TestSteppingOutWithArtificialFrames.py
index 88971447bda1e..72fcefd7017f4 100644
--- a/lldb/test/API/functionalities/tail_call_frames/thread_step_out_or_return/TestSteppingOutWithArtificialFrames.py
+++ b/lldb/test/API/functionalities/tail_call_frames/thread_step_out_or_return/TestSteppingOutWithArtificialFrames.py
@@ -15,34 +15,10 @@ class TestArtificialFrameThreadStepOut1(TestBase):
NO_DEBUG_INFO_TESTCASE = True
def prepare_thread(self):
- exe = self.getBuildArtifact("a.out")
-
- # Create a target by the debugger.
- target = self.dbg.CreateTarget(exe)
- self.assertTrue(target, VALID_TARGET)
-
- breakpoint = target.BreakpointCreateBySourceRegex(
- "break here", lldb.SBFileSpec("main.cpp")
- )
- self.assertTrue(
- breakpoint and breakpoint.GetNumLocations() == 1, VALID_BREAKPOINT
- )
-
- error = lldb.SBError()
- launch_info = target.GetLaunchInfo()
- process = target.Launch(launch_info, error)
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # Did we hit our breakpoint?
- threads = lldbutil.get_threads_stopped_at_breakpoint(process, breakpoint)
- self.assertEqual(
- len(threads), 1, "There should be a thread stopped at our breakpoint"
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "break here", lldb.SBFileSpec("main.cpp")
)
- self.assertEqual(breakpoint.GetHitCount(), 1)
-
- thread = threads[0]
-
# Here's what we expect to see in the backtrace:
# frame #0: ... a.out`sink() at main.cpp:13:4 [opt]
# frame #1: ... a.out`func3() at main.cpp:14:1 [opt] [artificial]
diff --git a/lldb/test/API/lang/c/anonymous/TestAnonymous.py b/lldb/test/API/lang/c/anonymous/TestAnonymous.py
index da342aaa8d8c4..dc2aa4fba6223 100644
--- a/lldb/test/API/lang/c/anonymous/TestAnonymous.py
+++ b/lldb/test/API/lang/c/anonymous/TestAnonymous.py
@@ -87,31 +87,12 @@ def test_expr_null(self):
def test_child_by_name(self):
self.build()
- # Set debugger into synchronous mode
- self.dbg.SetAsync(False)
-
- # Create a target
- exe = self.getBuildArtifact("a.out")
- target = self.dbg.CreateTarget(exe)
- self.assertTrue(target, VALID_TARGET)
-
- break_in_main = target.BreakpointCreateBySourceRegex(
- "// Set breakpoint 2 here.", lldb.SBFileSpec(self.source)
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "// Set breakpoint 2 here.", lldb.SBFileSpec(self.source)
)
- self.assertTrue(break_in_main, VALID_BREAKPOINT)
-
- process = target.LaunchSimple(None, None, self.get_process_working_directory())
- self.assertTrue(process, PROCESS_IS_VALID)
-
- threads = lldbutil.get_threads_stopped_at_breakpoint(process, break_in_main)
- if len(threads) != 1:
- self.fail("Failed to stop at breakpoint in main.")
- thread = threads[0]
frame = thread.frames[0]
-
- if not frame.IsValid():
- self.fail("Failed to get frame 0.")
+ self.assertTrue(frame.IsValid(), "Failed to get frame 0.")
var_n = frame.FindVariable("n")
if not var_n.IsValid():
diff --git a/lldb/test/API/lang/c/step-target/TestStepTarget.py b/lldb/test/API/lang/c/step-target/TestStepTarget.py
index e5bd64d8927af..3aab10cf285ed 100644
--- a/lldb/test/API/lang/c/step-target/TestStepTarget.py
+++ b/lldb/test/API/lang/c/step-target/TestStepTarget.py
@@ -18,31 +18,13 @@ def setUp(self):
@add_test_categories(["pyapi"])
def get_to_start(self):
self.build()
- exe = self.getBuildArtifact("a.out")
-
- target = self.dbg.CreateTarget(exe)
- self.assertTrue(target, VALID_TARGET)
self.main_source_spec = lldb.SBFileSpec(self.main_source)
- break_in_main = target.BreakpointCreateBySourceRegex(
- "Break here to try targetted stepping", self.main_source_spec
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "Break here to try targetted stepping", self.main_source_spec
)
- self.assertTrue(break_in_main, VALID_BREAKPOINT)
- self.assertGreater(break_in_main.GetNumLocations(), 0, "Has locations.")
-
- # Now launch the process, and do not stop at entry point.
- process = target.LaunchSimple(None, None, self.get_process_working_directory())
-
- self.assertTrue(process, PROCESS_IS_VALID)
-
- # The stop reason of the thread should be breakpoint.
- threads = lldbutil.get_threads_stopped_at_breakpoint(process, break_in_main)
-
- if len(threads) != 1:
- self.fail("Failed to stop at first breakpoint in main.")
- thread = threads[0]
return thread
@expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr32343")
diff --git a/lldb/test/API/lang/cpp/global_operators/TestCppGlobalOperators.py b/lldb/test/API/lang/cpp/global_operators/TestCppGlobalOperators.py
index b659f4aec2a44..2aff6fdee9002 100644
--- a/lldb/test/API/lang/cpp/global_operators/TestCppGlobalOperators.py
+++ b/lldb/test/API/lang/cpp/global_operators/TestCppGlobalOperators.py
@@ -11,36 +11,9 @@ class TestCppGlobalOperators(TestBase):
def prepare_executable_and_get_frame(self):
self.build()
- # Get main source file
- src_file = "main.cpp"
- src_file_spec = lldb.SBFileSpec(src_file)
- self.assertTrue(src_file_spec.IsValid(), "Main source file")
-
- # Get the path of the executable
- exe_path = self.getBuildArtifact("a.out")
-
- # Load the executable
- target = self.dbg.CreateTarget(exe_path)
- self.assertTrue(target.IsValid(), VALID_TARGET)
-
- # Break on main function
- main_breakpoint = target.BreakpointCreateBySourceRegex(
- "// break here", src_file_spec
+ _, _, thread, _ = lldbutil.run_to_source_breakpoint(
+ self, "// break here", lldb.SBFileSpec("main.cpp")
)
- self.assertTrue(
- main_breakpoint.IsValid() and main_breakpoint.GetNumLocations() >= 1,
- VALID_BREAKPOINT,
- )
-
- # Launch the process
- args = None
- env = None
- process = target.LaunchSimple(args, env, self.get_process_working_directory())
- self.assertTrue(process.IsValid(), PROCESS_IS_VALID)
-
- # Get the thread of the process
- self.assertEqual(process.GetState(), lldb.eStateStopped, PROCESS_STOPPED)
- thread = lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
return thread.GetSelectedFrame()
|
jimingham
approved these changes
Apr 1, 2026
Collaborator
jimingham
left a comment
jimingham
left a comment
There was a problem hiding this comment.
Thanks for doing this! Makes the tests so much easier to read.
lldbutil.run_to_breakpoint_do_run does
test.self.get_process_working_directory()
internally. So that's right for the tests that were doing that explicitly, and the others presumably didn't care what the working directory was.
So this looks like a faithful translation to me.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Many tests have ad hoc forms of the launch & break steps done by
lldbutil.run_to_source_breakpoint. This changes some of those tests to userun_to_source_breakpointinstead.Assisted-by: claude