1from __future__ import print_function 2from __future__ import absolute_import 3 4# System modules 5import os 6 7# Third-party modules 8import io 9 10# LLDB modules 11import lldb 12from .lldbtest import * 13from . import configuration 14from . import lldbutil 15from .decorators import * 16 17def source_type(filename): 18 _, extension = os.path.splitext(filename) 19 return { 20 '.c': 'C_SOURCES', 21 '.cpp': 'CXX_SOURCES', 22 '.cxx': 'CXX_SOURCES', 23 '.cc': 'CXX_SOURCES', 24 '.m': 'OBJC_SOURCES', 25 '.mm': 'OBJCXX_SOURCES' 26 }.get(extension, None) 27 28 29class CommandParser: 30 31 def __init__(self): 32 self.breakpoints = [] 33 34 def parse_one_command(self, line): 35 parts = line.split('//%') 36 37 command = None 38 new_breakpoint = True 39 40 if len(parts) == 2: 41 command = parts[1].strip() # take off whitespace 42 new_breakpoint = parts[0].strip() != "" 43 44 return (command, new_breakpoint) 45 46 def parse_source_files(self, source_files): 47 for source_file in source_files: 48 file_handle = io.open(source_file, encoding='utf-8') 49 lines = file_handle.readlines() 50 line_number = 0 51 # non-NULL means we're looking through whitespace to find 52 # additional commands 53 current_breakpoint = None 54 for line in lines: 55 line_number = line_number + 1 # 1-based, so we do this first 56 (command, new_breakpoint) = self.parse_one_command(line) 57 58 if new_breakpoint: 59 current_breakpoint = None 60 61 if command is not None: 62 if current_breakpoint is None: 63 current_breakpoint = {} 64 current_breakpoint['file_name'] = source_file 65 current_breakpoint['line_number'] = line_number 66 current_breakpoint['command'] = command 67 self.breakpoints.append(current_breakpoint) 68 else: 69 current_breakpoint['command'] = current_breakpoint[ 70 'command'] + "\n" + command 71 72 def set_breakpoints(self, target): 73 for breakpoint in self.breakpoints: 74 breakpoint['breakpoint'] = target.BreakpointCreateByLocation( 75 breakpoint['file_name'], breakpoint['line_number']) 76 77 def handle_breakpoint(self, test, breakpoint_id): 78 for breakpoint in self.breakpoints: 79 if breakpoint['breakpoint'].GetID() == breakpoint_id: 80 test.execute_user_command(breakpoint['command']) 81 return 82 83 84class InlineTest(TestBase): 85 # Overrides 86 87 def getBuildDirBasename(self): 88 return self.__class__.__name__ + "." + self.testMethodName 89 90 # Internal implementation 91 92 def BuildMakefile(self): 93 makefilePath = self.getBuildArtifact("Makefile") 94 if os.path.exists(makefilePath): 95 return 96 97 categories = {} 98 99 for f in os.listdir(self.getSourceDir()): 100 t = source_type(f) 101 if t: 102 if t in list(categories.keys()): 103 categories[t].append(f) 104 else: 105 categories[t] = [f] 106 107 makefile = open(makefilePath, 'w+') 108 109 for t in list(categories.keys()): 110 line = t + " := " + " ".join(categories[t]) 111 makefile.write(line + "\n") 112 113 if ('OBJCXX_SOURCES' in list(categories.keys())) or ( 114 'OBJC_SOURCES' in list(categories.keys())): 115 makefile.write( 116 "LDFLAGS = $(CFLAGS) -lobjc -framework Foundation\n") 117 118 if ('CXX_SOURCES' in list(categories.keys())): 119 makefile.write("CXXFLAGS += -std=c++11\n") 120 121 makefile.write("include Makefile.rules\n") 122 makefile.write("\ncleanup:\n\trm -f Makefile *.d\n\n") 123 makefile.flush() 124 makefile.close() 125 126 def _test(self): 127 self.BuildMakefile() 128 self.build(dictionary=self._build_dict) 129 self.do_test() 130 131 def execute_user_command(self, __command): 132 exec(__command, globals(), locals()) 133 134 def _get_breakpoint_ids(self, thread): 135 ids = set() 136 for i in range(0, thread.GetStopReasonDataCount(), 2): 137 ids.add(thread.GetStopReasonDataAtIndex(i)) 138 self.assertGreater(len(ids), 0) 139 return sorted(ids) 140 141 def do_test(self): 142 exe = self.getBuildArtifact("a.out") 143 source_files = [f for f in os.listdir(self.getSourceDir()) 144 if source_type(f)] 145 target = self.dbg.CreateTarget(exe) 146 147 parser = CommandParser() 148 parser.parse_source_files(source_files) 149 parser.set_breakpoints(target) 150 151 process = target.LaunchSimple(None, None, self.get_process_working_directory()) 152 self.assertIsNotNone(process, PROCESS_IS_VALID) 153 154 hit_breakpoints = 0 155 156 while lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint): 157 hit_breakpoints += 1 158 thread = lldbutil.get_stopped_thread( 159 process, lldb.eStopReasonBreakpoint) 160 for bp_id in self._get_breakpoint_ids(thread): 161 parser.handle_breakpoint(self, bp_id) 162 process.Continue() 163 164 self.assertTrue(hit_breakpoints > 0, 165 "inline test did not hit a single breakpoint") 166 # Either the process exited or the stepping plan is complete. 167 self.assertTrue(process.GetState() in [lldb.eStateStopped, 168 lldb.eStateExited], 169 PROCESS_EXITED) 170 171 # Utilities for testcases 172 173 def check_expression(self, expression, expected_result, use_summary=True): 174 value = self.frame().EvaluateExpression(expression) 175 self.assertTrue(value.IsValid(), expression + "returned a valid value") 176 if self.TraceOn(): 177 print(value.GetSummary()) 178 print(value.GetValue()) 179 if use_summary: 180 answer = value.GetSummary() 181 else: 182 answer = value.GetValue() 183 report_str = "%s expected: %s got: %s" % ( 184 expression, expected_result, answer) 185 self.assertTrue(answer == expected_result, report_str) 186 187 188def ApplyDecoratorsToFunction(func, decorators): 189 tmp = func 190 if isinstance(decorators, list): 191 for decorator in decorators: 192 tmp = decorator(tmp) 193 elif hasattr(decorators, '__call__'): 194 tmp = decorators(tmp) 195 return tmp 196 197 198def MakeInlineTest(__file, __globals, decorators=None, name=None, 199 build_dict=None): 200 # Adjust the filename if it ends in .pyc. We want filenames to 201 # reflect the source python file, not the compiled variant. 202 if __file is not None and __file.endswith(".pyc"): 203 # Strip the trailing "c" 204 __file = __file[0:-1] 205 206 if name is None: 207 # Derive the test name from the current file name 208 file_basename = os.path.basename(__file) 209 name, _ = os.path.splitext(file_basename) 210 211 test_func = ApplyDecoratorsToFunction(InlineTest._test, decorators) 212 # Build the test case 213 test_class = type(name, (InlineTest,), dict(test=test_func, 214 name=name, _build_dict=build_dict)) 215 216 # Add the test case to the globals, and hide InlineTest 217 __globals.update({name: test_class}) 218 219 # Keep track of the original test filename so we report it 220 # correctly in test results. 221 test_class.test_filename = __file 222 test_class.mydir = TestBase.compute_mydir(__file) 223 return test_class 224