lldbinline.py

importlldb
fromlldbsuite.test.lldbtestimport*
importlldbsuite.test.lldbutilaslldbutil
importlldbsuite.test.test_categoriesastest_categories

# System modules
importos
importtextwrap

# Third-party modules
importio

# LLDB modules
importlldb
from .lldbtestimport*
from . importconfiguration
from . importlldbutil
from .decoratorsimport*


defsource_type(filename):
_, extension=os.path.splitext(filename)
return {
".c": "C_SOURCES",
".cpp": "CXX_SOURCES",
".cxx": "CXX_SOURCES",
".cc": "CXX_SOURCES",
".m": "OBJC_SOURCES",
".mm": "OBJCXX_SOURCES",
".swift": "SWIFT_SOURCES",
 }.get(extension, None)


classCommandParser:
def__init__(self):
self.breakpoints= []

defparse_one_command(self, line):
parts=line.split("//%")

command=None
new_breakpoint=True

iflen(parts) ==2:
command=parts[1].rstrip()
new_breakpoint=parts[0].strip() !=""

return (command, new_breakpoint)

defparse_source_files(self, source_files):
forsource_fileinsource_files:
file_handle=io.open(source_file, encoding="utf-8")
lines=file_handle.readlines()
line_number=0
# non-NULL means we're looking through whitespace to find
# additional commands
current_breakpoint=None
forlineinlines:
line_number=line_number+1# 1-based, so we do this first
 (command, new_breakpoint) =self.parse_one_command(line)

ifnew_breakpoint:
current_breakpoint=None

ifcommandisnotNone:
ifcurrent_breakpointisNone:
current_breakpoint= {}
current_breakpoint["file_name"] =source_file
current_breakpoint["line_number"] =line_number
current_breakpoint["command"] =command
self.breakpoints.append(current_breakpoint)
else:
current_breakpoint["command"] = (
current_breakpoint["command"] +"\n"+command
 )
forbkptinself.breakpoints:
bkpt["command"] =textwrap.dedent(bkpt["command"])

defset_breakpoints(self, target):
forbreakpointinself.breakpoints:
breakpoint["breakpoint"] =target.BreakpointCreateByLocation(
breakpoint["file_name"], breakpoint["line_number"]
 )

defhandle_breakpoint(self, test, breakpoint_id):
forbreakpointinself.breakpoints:
ifbreakpoint["breakpoint"].GetID() ==breakpoint_id:
test.execute_user_command(breakpoint["command"])
return


classInlineTest(TestBase):
defgetBuildDirBasename(self):
returnself.__class__.__name__+"."+self.testMethodName

defBuildMakefile(self):
makefilePath=self.getBuildArtifact("Makefile")
ifos.path.exists(makefilePath):
return

categories= {}
forfinos.listdir(self.getSourceDir()):
t=source_type(f)
ift:
iftinlist(categories.keys()):
categories[t].append(f)
else:
categories[t] = [f]

withopen(makefilePath, "w+") asmakefile:
fortinlist(categories.keys()):
line=t+" := "+" ".join(categories[t])
makefile.write(line+"\n")

if ("OBJCXX_SOURCES"inlist(categories.keys())) or (
"OBJC_SOURCES"inlist(categories.keys())
 ):
makefile.write("LDFLAGS = $(CFLAGS) -lobjc -framework Foundation\n")

if"CXX_SOURCES"inlist(categories.keys()):
makefile.write("CXXFLAGS += -std=c++11\n")

makefile.write("include Makefile.rules\n")

def_test(self):
self.BuildMakefile()
self.build(dictionary=self._build_dict)
self.do_test()

defexecute_user_command(self, __command):
exec(__command, globals(), locals())

def_get_breakpoint_ids(self, thread):
ids=set()
foriinrange(0, thread.GetStopReasonDataCount(), 2):
ids.add(thread.GetStopReasonDataAtIndex(i))
self.assertGreater(len(ids), 0)
returnsorted(ids)

defdo_test(self):
exe=self.getBuildArtifact("a.out")
source_files= [fforfinos.listdir(self.getSourceDir()) ifsource_type(f)]
target=self.dbg.CreateTarget(exe)

parser=CommandParser()
parser.parse_source_files(source_files)
parser.set_breakpoints(target)

process=target.LaunchSimple(None, None, self.get_process_working_directory())
self.assertIsNotNone(process, PROCESS_IS_VALID)

hit_breakpoints=0

whilelldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint):
hit_breakpoints+=1
thread=lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
forbp_idinself._get_breakpoint_ids(thread):
parser.handle_breakpoint(self, bp_id)
process.Continue()

self.assertTrue(
hit_breakpoints>0, "inline test did not hit a single breakpoint"
 )
# Either the process exited or the stepping plan is complete.
self.assertTrue(
process.GetState() in [lldb.eStateStopped, lldb.eStateExited],
PROCESS_EXITED,
 )

defcheck_expression(self, expression, expected_result, use_summary=True):
value=self.frame().EvaluateExpression(expression)
self.assertTrue(value.IsValid(), expression+"returned a valid value")
ifself.TraceOn():
print(value.GetSummary())
print(value.GetValue())
ifuse_summary:
answer=value.GetSummary()
else:
answer=value.GetValue()
report_str="%s expected: %s got: %s"% (expression, expected_result, answer)
self.assertTrue(answer==expected_result, report_str)


defApplyDecoratorsToFunction(func, decorators):
tmp=func
ifisinstance(decorators, list):
fordecoratorindecorators:
tmp=decorator(tmp)
elifhasattr(decorators, "__call__"):
tmp=decorators(tmp)
returntmp


defMakeInlineTest(__file, __globals, decorators=None, name=None, build_dict=None):
# Adjust the filename if it ends in .pyc. We want filenames to
# reflect the source python file, not the compiled variant.
if__fileisnotNoneand__file.endswith(".pyc"):
# Strip the trailing "c"
__file=__file[0:-1]

ifnameisNone:
# Derive the test name from the current file name
file_basename=os.path.basename(__file)
name, _=os.path.splitext(file_basename)

test_func=ApplyDecoratorsToFunction(InlineTest._test, decorators)
# Build the test case
test_class=type(
name, (InlineTest,), dict(test=test_func, name=name, _build_dict=build_dict)
 )

# Add the test case to the globals, and hide InlineTest
__globals.update({name: test_class})

# Keep track of the original test filename so we report it
# correctly in test results.
test_class.test_filename=__file
test_class.mydir=TestBase.compute_mydir(__file)
returntest_class