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
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#include <atomic>
#include <chrono>
#include <functional>
#include <future>
#include <memory>
#include <string>
#include <vector>
#include <cm3p/cppdap/future.h>
#include <cm3p/cppdap/optional.h>
#include <cm3p/cppdap/protocol.h>
#include <cm3p/cppdap/session.h>
#include <cm3p/cppdap/types.h>
#include "cmDebuggerBreakpointManager.h"
#include "cmDebuggerSourceBreakpoint.h" // IWYU pragma: keep
#include "cmListFileCache.h"
#include "testCommon.h"
#include "testDebugger.h"
static bool testHandleBreakpointRequestBeforeFileIsLoaded()
{
// Arrange
DebuggerTestHelper helper;
cmDebugger::cmDebuggerBreakpointManager breakpointManager(
helper.Debugger.get());
helper.bind();
dap::SetBreakpointsRequest setBreakpointRequest;
std::string sourcePath = "C:/CMakeLists.txt";
setBreakpointRequest.source.path = sourcePath;
dap::array<dap::SourceBreakpoint> sourceBreakpoints(3);
sourceBreakpoints[0].line = 1;
sourceBreakpoints[1].line = 2;
sourceBreakpoints[2].line = 3;
setBreakpointRequest.breakpoints = sourceBreakpoints;
// Act
auto got = helper.Client->send(setBreakpointRequest).get();
// Assert
auto& response = got.response;
ASSERT_TRUE(!got.error);
ASSERT_TRUE(response.breakpoints.size() == sourceBreakpoints.size());
ASSERT_BREAKPOINT(response.breakpoints[0], 0, sourceBreakpoints[0].line,
sourcePath, false);
ASSERT_BREAKPOINT(response.breakpoints[1], 1, sourceBreakpoints[1].line,
sourcePath, false);
ASSERT_BREAKPOINT(response.breakpoints[2], 2, sourceBreakpoints[2].line,
sourcePath, false);
return true;
}
static bool testHandleBreakpointRequestAfterFileIsLoaded()
{
// Arrange
DebuggerTestHelper helper;
std::atomic<bool> notExpectBreakpointEvents(true);
helper.Client->registerHandler([&](const dap::BreakpointEvent&) {
notExpectBreakpointEvents.store(false);
});
cmDebugger::cmDebuggerBreakpointManager breakpointManager(
helper.Debugger.get());
helper.bind();
std::string sourcePath = "C:/CMakeLists.txt";
std::vector<cmListFileFunction> functions = helper.CreateListFileFunctions(
"# Comment1\nset(var1 foo)\n# Comment2\nset(var2\nbar)\n",
sourcePath.c_str());
breakpointManager.SourceFileLoaded(sourcePath, functions);
dap::SetBreakpointsRequest setBreakpointRequest;
setBreakpointRequest.source.path = sourcePath;
dap::array<dap::SourceBreakpoint> sourceBreakpoints(5);
sourceBreakpoints[0].line = 1;
sourceBreakpoints[1].line = 2;
sourceBreakpoints[2].line = 3;
sourceBreakpoints[3].line = 4;
sourceBreakpoints[4].line = 5;
setBreakpointRequest.breakpoints = sourceBreakpoints;
// Act
auto got = helper.Client->send(setBreakpointRequest).get();
// Assert
auto& response = got.response;
ASSERT_TRUE(!got.error);
ASSERT_TRUE(response.breakpoints.size() == sourceBreakpoints.size());
// Line 1 is a comment. Move it to next valid function, which is line 2.
ASSERT_BREAKPOINT(response.breakpoints[0], 0, 2, sourcePath, true);
ASSERT_BREAKPOINT(response.breakpoints[1], 1, sourceBreakpoints[1].line,
sourcePath, true);
// Line 3 is a comment. Move it to next valid function, which is line 4.
ASSERT_BREAKPOINT(response.breakpoints[2], 2, 4, sourcePath, true);
ASSERT_BREAKPOINT(response.breakpoints[3], 3, sourceBreakpoints[3].line,
sourcePath, true);
// Line 5 is the 2nd part of line 4 function. No valid function after line 5,
// show the breakpoint at line 4.
ASSERT_BREAKPOINT(response.breakpoints[4], 4, sourceBreakpoints[3].line,
sourcePath, true);
ASSERT_TRUE(notExpectBreakpointEvents.load());
return true;
}
static bool testSourceFileLoadedAfterHandleBreakpointRequest()
{
// Arrange
DebuggerTestHelper helper;
std::vector<dap::BreakpointEvent> breakpointEvents;
std::atomic<int> remainingBreakpointEvents(5);
std::promise<void> allBreakpointEventsReceivedPromise;
std::future<void> allBreakpointEventsReceivedFuture =
allBreakpointEventsReceivedPromise.get_future();
helper.Client->registerHandler([&](const dap::BreakpointEvent& event) {
breakpointEvents.emplace_back(event);
if (--remainingBreakpointEvents == 0) {
allBreakpointEventsReceivedPromise.set_value();
}
});
cmDebugger::cmDebuggerBreakpointManager breakpointManager(
helper.Debugger.get());
helper.bind();
dap::SetBreakpointsRequest setBreakpointRequest;
std::string sourcePath = "C:/CMakeLists.txt";
setBreakpointRequest.source.path = sourcePath;
dap::array<dap::SourceBreakpoint> sourceBreakpoints(5);
sourceBreakpoints[0].line = 1;
sourceBreakpoints[1].line = 2;
sourceBreakpoints[2].line = 3;
sourceBreakpoints[3].line = 4;
sourceBreakpoints[4].line = 5;
setBreakpointRequest.breakpoints = sourceBreakpoints;
std::vector<cmListFileFunction> functions = helper.CreateListFileFunctions(
"# Comment1\nset(var1 foo)\n# Comment2\nset(var2\nbar)\n",
sourcePath.c_str());
auto got = helper.Client->send(setBreakpointRequest).get();
// Act
breakpointManager.SourceFileLoaded(sourcePath, functions);
ASSERT_TRUE(allBreakpointEventsReceivedFuture.wait_for(
std::chrono::seconds(10)) == std::future_status::ready);
// Assert
ASSERT_TRUE(breakpointEvents.size() > 0);
// Line 1 is a comment. Move it to next valid function, which is line 2.
ASSERT_BREAKPOINT(breakpointEvents[0].breakpoint, 0, 2, sourcePath, true);
ASSERT_BREAKPOINT(breakpointEvents[1].breakpoint, 1,
sourceBreakpoints[1].line, sourcePath, true);
// Line 3 is a comment. Move it to next valid function, which is line 4.
ASSERT_BREAKPOINT(breakpointEvents[2].breakpoint, 2, 4, sourcePath, true);
ASSERT_BREAKPOINT(breakpointEvents[3].breakpoint, 3,
sourceBreakpoints[3].line, sourcePath, true);
// Line 5 is the 2nd part of line 4 function. No valid function after line 5,
// show the breakpoint at line 4.
ASSERT_BREAKPOINT(breakpointEvents[4].breakpoint, 4,
sourceBreakpoints[3].line, sourcePath, true);
return true;
}
int testDebuggerBreakpointManager(int, char*[])
{
return runTests(std::vector<std::function<bool()>>{
testHandleBreakpointRequestBeforeFileIsLoaded,
testHandleBreakpointRequestAfterFileIsLoaded,
testSourceFileLoadedAfterHandleBreakpointRequest,
});
}
|
