Raphael Isemann 54c2687292 [lldb] Introduce createTestTarget for creating a valid target in API tests
At the moment nearly every test calls something similar to
`self.dbg.CreateTarget(self.getBuildArtifact("a.out"))` and them sometimes
checks if the created target is actually valid with something like
`self.assertTrue(target.IsValid(), "some useless text")`.

Beside being really verbose the error messages generated by this pattern are
always just indicating that the target failed to be created but now why.

This patch introduces a helper function `createTestTarget` to our Test class
that creates the target with the much more verbose `CreateTarget` overload that
gives us back an SBError (with a fancy error). If the target couldn't be created
the function prints out the SBError that LLDB returned and asserts for us. It
also defaults to the "a.out" build artifact path that nearly all tests are using
to avoid to hardcode "a.out" in every test.

I converted a bunch of tests to the new function but I'll do the rest of the
test suite as follow ups.

Reviewed By: JDevlieghere

Differential Revision: https://reviews.llvm.org/D102771
2021-05-24 16:18:44 +02:00

113 lines
3.6 KiB
Python

"""
Test that argdumper is a viable launching strategy.
"""
import os
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
class LaunchWithShellExpandTestCase(TestBase):
mydir = TestBase.compute_mydir(__file__)
NO_DEBUG_INFO_TESTCASE = True
@expectedFailureAll(
oslist=[
"windows",
"linux",
"freebsd"],
bugnumber="llvm.org/pr24778 llvm.org/pr22627 llvm.org/pr48349")
@skipIfDarwinEmbedded # iOS etc don't launch the binary via a shell, so arg expansion won't happen
@expectedFailureNetBSD
def test(self):
self.build()
target = self.createTestTarget()
# Create any breakpoints we need
breakpoint = target.BreakpointCreateBySourceRegex(
'break here', lldb.SBFileSpec("main.cpp", False))
self.assertTrue(breakpoint, VALID_BREAKPOINT)
# Ensure we do the expansion with /bin/sh on POSIX.
os.environ["SHELL"] = '/bin/sh'
self.runCmd(
"process launch -X true -w %s -- fi*.tx? () > <" %
(self.getSourceDir()))
process = self.process()
self.assertEquals(process.GetState(), lldb.eStateStopped,
STOPPED_DUE_TO_BREAKPOINT)
thread = process.GetThreadAtIndex(0)
self.assertTrue(thread.IsValid(),
"Process stopped at 'main' should have a valid thread")
stop_reason = thread.GetStopReason()
self.assertEqual(
stop_reason, lldb.eStopReasonBreakpoint,
"Thread in process stopped in 'main' should have a stop reason of eStopReasonBreakpoint")
self.expect_var_path("argv[1]", summary='"file1.txt"')
self.expect_var_path("argv[2]", summary='"file2.txt"')
self.expect_var_path("argv[3]", summary='"file3.txt"')
self.expect_var_path("argv[4]", summary='"file4.txy"')
self.expect_var_path("argv[5]", summary='"()"')
self.expect_var_path("argv[6]", summary='">"')
self.expect_var_path("argv[7]", summary='"<"')
self.expect_var_path("argc", value='8')
self.runCmd("process kill")
self.runCmd(
'process launch -X true -w %s -- "foo bar"' %
(self.getSourceDir()))
process = self.process()
self.assertEquals(process.GetState(), lldb.eStateStopped,
STOPPED_DUE_TO_BREAKPOINT)
thread = process.GetThreadAtIndex(0)
self.assertTrue(thread.IsValid(),
"Process stopped at 'main' should have a valid thread")
stop_reason = thread.GetStopReason()
self.assertEqual(
stop_reason, lldb.eStopReasonBreakpoint,
"Thread in process stopped in 'main' should have a stop reason of eStopReasonBreakpoint")
self.expect("frame variable argv[1]", substrs=['foo bar'])
self.runCmd("process kill")
self.runCmd('process launch -X true -w %s -- foo\ bar'
% (self.getBuildDir()))
process = self.process()
self.assertEquals(process.GetState(), lldb.eStateStopped,
STOPPED_DUE_TO_BREAKPOINT)
thread = process.GetThreadAtIndex(0)
self.assertTrue(thread.IsValid(),
"Process stopped at 'main' should have a valid thread")
stop_reason = thread.GetStopReason()
self.assertEqual(
stop_reason, lldb.eStopReasonBreakpoint,
"Thread in process stopped in 'main' should have a stop reason of eStopReasonBreakpoint")
self.expect("frame variable argv[1]", substrs=['foo bar'])