1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
"""
Test lldb-dap logpoints feature.
"""
import dap_server
import shutil
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
import lldbdap_testcase
import os
class TestDAP_logpoints(lldbdap_testcase.DAPTestCaseBase):
def setUp(self):
lldbdap_testcase.DAPTestCaseBase.setUp(self)
self.main_basename = "main-copy.cpp"
self.main_path = os.path.realpath(self.getBuildArtifact(self.main_basename))
@skipIfWindows
def test_logmessage_basic(self):
"""Tests breakpoint logmessage basic functionality."""
before_loop_line = line_number("main.cpp", "// before loop")
loop_line = line_number("main.cpp", "// break loop")
after_loop_line = line_number("main.cpp", "// after loop")
program = self.getBuildArtifact("a.out")
self.build_and_launch(program)
# Set a breakpoint at a line before loop
before_loop_breakpoint_ids = self.set_source_breakpoints(
self.main_path, [before_loop_line]
)
self.assertEqual(len(before_loop_breakpoint_ids), 1, "expect one breakpoint")
self.dap_server.request_continue()
# Verify we hit the breakpoint before loop line
self.verify_breakpoint_hit(before_loop_breakpoint_ids)
# Swallow old console output
self.get_console()
# Set two breakpoints:
# 1. First at the loop line with logMessage
# 2. Second guard breakpoint at a line after loop
logMessage_prefix = "This is log message for { -- "
logMessage = logMessage_prefix + "{i + 3}, {message}"
[loop_breakpoint_id, post_loop_breakpoint_id] = self.set_source_breakpoints(
self.main_path,
[loop_line, after_loop_line],
[{"logMessage": logMessage}, {}],
)
# Continue to trigger the breakpoint with log messages
self.dap_server.request_continue()
# Verify we hit the breakpoint after loop line
self.verify_breakpoint_hit([post_loop_breakpoint_id])
output = self.get_console()
lines = output.splitlines()
logMessage_output = []
for line in lines:
if line.startswith(logMessage_prefix):
logMessage_output.append(line)
# Verify logMessage count
loop_count = 10
self.assertEqual(len(logMessage_output), loop_count)
message_addr_pattern = r"\b0x[0-9A-Fa-f]+\b"
message_content = '"Hello from main!"'
# Verify log message match
for idx, logMessage_line in enumerate(logMessage_output):
result = idx + 3
reg_str = (
f"{logMessage_prefix}{result}, {message_addr_pattern} {message_content}"
)
self.assertRegex(logMessage_line, reg_str)
@skipIfWindows
def test_logmessage_advanced(self):
"""Tests breakpoint logmessage functionality for complex expression."""
before_loop_line = line_number("main.cpp", "// before loop")
loop_line = line_number("main.cpp", "// break loop")
after_loop_line = line_number("main.cpp", "// after loop")
program = self.getBuildArtifact("a.out")
self.build_and_launch(program)
# Set a breakpoint at a line before loop
before_loop_breakpoint_ids = self.set_source_breakpoints(
self.main_path, [before_loop_line]
)
self.assertEqual(len(before_loop_breakpoint_ids), 1, "expect one breakpoint")
self.dap_server.request_continue()
# Verify we hit the breakpoint before loop line
self.verify_breakpoint_hit(before_loop_breakpoint_ids)
# Swallow old console output
self.get_console()
# Set two breakpoints:
# 1. First at the loop line with logMessage
# 2. Second guard breakpoint at a line after loop
logMessage_prefix = "This is log message for { -- "
logMessage = (
logMessage_prefix
+ "{int y = 0; if (i % 3 == 0) { y = i + 3;} else {y = i * 3;} y}"
)
[loop_breakpoint_id, post_loop_breakpoint_id] = self.set_source_breakpoints(
self.main_path,
[loop_line, after_loop_line],
[{"logMessage": logMessage}, {}],
)
# Continue to trigger the breakpoint with log messages
self.dap_server.request_continue()
# Verify we hit the breakpoint after loop line
self.verify_breakpoint_hit([post_loop_breakpoint_id])
output = self.get_console()
lines = output.splitlines()
logMessage_output = []
for line in lines:
if line.startswith(logMessage_prefix):
logMessage_output.append(line)
# Verify logMessage count
loop_count = 10
self.assertEqual(len(logMessage_output), loop_count)
# Verify log message match
for idx, logMessage_line in enumerate(logMessage_output):
result = idx + 3 if idx % 3 == 0 else idx * 3
self.assertEqual(logMessage_line, logMessage_prefix + str(result))
@skipIfWindows
def test_logmessage_format(self):
"""
Tests breakpoint logmessage functionality with format.
"""
before_loop_line = line_number("main.cpp", "// before loop")
loop_line = line_number("main.cpp", "// break loop")
after_loop_line = line_number("main.cpp", "// after loop")
program = self.getBuildArtifact("a.out")
self.build_and_launch(program)
# Set a breakpoint at a line before loop
before_loop_breakpoint_ids = self.set_source_breakpoints(
self.main_path, [before_loop_line]
)
self.assertEqual(len(before_loop_breakpoint_ids), 1, "expect one breakpoint")
self.dap_server.request_continue()
# Verify we hit the breakpoint before loop line
self.verify_breakpoint_hit(before_loop_breakpoint_ids)
# Swallow old console output
self.get_console()
# Set two breakpoints:
# 1. First at the loop line with logMessage
# 2. Second guard breakpoint at a line after loop
logMessage_prefix = "This is log message for -- "
logMessage_with_format = "part1\tpart2\bpart3\x64part4"
logMessage_with_format_raw = r"part1\tpart2\bpart3\x64part4"
logMessage = logMessage_prefix + logMessage_with_format_raw + "{i - 1}"
[loop_breakpoint_id, post_loop_breakpoint_id] = self.set_source_breakpoints(
self.main_path,
[loop_line, after_loop_line],
[{"logMessage": logMessage}, {}],
)
# Continue to trigger the breakpoint with log messages
self.dap_server.request_continue()
# Verify we hit the breakpoint after loop line
self.verify_breakpoint_hit([post_loop_breakpoint_id])
output = self.get_console()
lines = output.splitlines()
logMessage_output = []
for line in lines:
if line.startswith(logMessage_prefix):
logMessage_output.append(line)
# Verify logMessage count
loop_count = 10
self.assertEqual(len(logMessage_output), loop_count)
# Verify log message match
for idx, logMessage_line in enumerate(logMessage_output):
result = idx - 1
self.assertEqual(
logMessage_line,
logMessage_prefix + logMessage_with_format + str(result),
)
@skipIfWindows
def test_logmessage_format_failure(self):
"""
Tests breakpoint logmessage format with parsing failure.
"""
before_loop_line = line_number("main.cpp", "// before loop")
loop_line = line_number("main.cpp", "// break loop")
after_loop_line = line_number("main.cpp", "// after loop")
program = self.getBuildArtifact("a.out")
self.build_and_launch(program)
# Set a breakpoint at a line before loop
before_loop_breakpoint_ids = self.set_source_breakpoints(
self.main_path, [before_loop_line]
)
self.assertEqual(len(before_loop_breakpoint_ids), 1, "expect one breakpoint")
self.dap_server.request_continue()
# Verify we hit the breakpoint before loop line
self.verify_breakpoint_hit(before_loop_breakpoint_ids)
# Swallow old console output
self.get_console()
# Set two breakpoints:
# 1. First at the loop line with logMessage
# 2. Second guard breakpoint at a line after loop
logMessage_prefix = "This is log message for -- "
# log message missing hex number.
logMessage_with_format_raw = r"part1\x"
logMessage = logMessage_prefix + logMessage_with_format_raw
[loop_breakpoint_id, post_loop_breakpoint_id] = self.set_source_breakpoints(
self.main_path,
[loop_line, after_loop_line],
[{"logMessage": logMessage}, {}],
)
# Continue to trigger the breakpoint with log messages
self.dap_server.request_continue()
# Verify we hit logpoint breakpoint if it's format has error.
self.verify_breakpoint_hit([loop_breakpoint_id])
output = self.get_console()
lines = output.splitlines()
failure_prefix = "Log message has error:"
logMessage_output = []
logMessage_failure_output = []
for line in lines:
if line.startswith(logMessage_prefix):
logMessage_output.append(line)
elif line.startswith(failure_prefix):
logMessage_failure_output.append(line)
# Verify logMessage failure message
self.assertEqual(len(logMessage_failure_output), 1)
self.assertEqual(
logMessage_failure_output[0].strip(),
failure_prefix + " missing hex number following '\\x'",
)
|
