Files
clang-p2996/lldb/test/API/functionalities/breakpoint/consecutive_breakpoints/TestConsecutiveBreakpoints.py
Jonas Devlieghere ce825e4674 [lldb] Add assertState function to the API test suite
Add a function to make it easier to debug a test failure caused by an
unexpected state.

Currently, tests are using assertEqual which results in a cryptic error
message: "AssertionError: 5 != 10". Even when a test provides a message
to make it clear why a particular state is expected, you still have to
figure out which of the two was the expected state, and what the other
value corresponds to.

We have a function in lldbutil that helps you convert the state number
into a user readable string. This patch adds a wrapper around
assertEqual specifically for comparing states and reporting better error
messages.

The aforementioned error message now looks like this: "AssertionError:
stopped (5) != exited (10)". If the user provided a message, that
continues to get printed as well.

Differential revision: https://reviews.llvm.org/D127355
2022-06-08 16:16:38 -07:00

104 lines
3.5 KiB
Python

"""
Test that we handle breakpoints on consecutive instructions correctly.
"""
import unittest2
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
class ConsecutiveBreakpointsTestCase(TestBase):
mydir = TestBase.compute_mydir(__file__)
def prepare_test(self):
self.build()
(self.target, self.process, self.thread, bkpt) = lldbutil.run_to_source_breakpoint(
self, "Set breakpoint here", lldb.SBFileSpec("main.cpp"))
# Set breakpoint to the next instruction
frame = self.thread.GetFrameAtIndex(0)
address = frame.GetPCAddress()
instructions = self.target.ReadInstructions(address, 2)
self.assertEquals(len(instructions), 2)
self.bkpt_address = instructions[1].GetAddress()
self.breakpoint2 = self.target.BreakpointCreateByAddress(
self.bkpt_address.GetLoadAddress(self.target))
self.assertTrue(
self.breakpoint2 and self.breakpoint2.GetNumLocations() == 1,
VALID_BREAKPOINT)
def finish_test(self):
# Run the process until termination
self.process.Continue()
self.assertState(self.process.GetState(), lldb.eStateExited)
@no_debug_info_test
def test_continue(self):
"""Test that continue stops at the second breakpoint."""
self.prepare_test()
self.process.Continue()
self.assertState(self.process.GetState(), lldb.eStateStopped)
# We should be stopped at the second breakpoint
self.thread = lldbutil.get_one_thread_stopped_at_breakpoint(
self.process, self.breakpoint2)
self.assertIsNotNone(
self.thread,
"Expected one thread to be stopped at breakpoint 2")
self.finish_test()
@no_debug_info_test
def test_single_step(self):
"""Test that single step stops at the second breakpoint."""
self.prepare_test()
step_over = False
self.thread.StepInstruction(step_over)
self.assertState(self.process.GetState(), lldb.eStateStopped)
self.assertEquals(
self.thread.GetFrameAtIndex(0).GetPCAddress().GetLoadAddress(
self.target), self.bkpt_address.GetLoadAddress(
self.target))
self.thread = lldbutil.get_one_thread_stopped_at_breakpoint(
self.process, self.breakpoint2)
self.assertIsNotNone(
self.thread,
"Expected one thread to be stopped at breakpoint 2")
self.finish_test()
@no_debug_info_test
def test_single_step_thread_specific(self):
"""Test that single step stops, even though the second breakpoint is not valid."""
self.prepare_test()
# Choose a thread other than the current one. A non-existing thread is
# fine.
thread_index = self.process.GetNumThreads() + 1
self.assertFalse(self.process.GetThreadAtIndex(thread_index).IsValid())
self.breakpoint2.SetThreadIndex(thread_index)
step_over = False
self.thread.StepInstruction(step_over)
self.assertState(self.process.GetState(), lldb.eStateStopped)
self.assertEquals(
self.thread.GetFrameAtIndex(0).GetPCAddress().GetLoadAddress(
self.target), self.bkpt_address.GetLoadAddress(
self.target))
self.assertEquals(
self.thread.GetStopReason(),
lldb.eStopReasonPlanComplete,
"Stop reason should be 'plan complete'")
self.finish_test()