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
|
//===- Transport.cpp - LSP JSON transport unit tests ----------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/Support/LSP/Transport.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/LSP/Logging.h"
#include "llvm/Support/LSP/Protocol.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
using namespace llvm;
using namespace llvm::lsp;
using namespace testing;
namespace {
TEST(TransportTest, SendReply) {
std::string out;
llvm::raw_string_ostream os(out);
JSONTransport transport(nullptr, os);
MessageHandler handler(transport);
transport.reply(1989, nullptr);
EXPECT_THAT(out, HasSubstr("\"id\":1989"));
EXPECT_THAT(out, HasSubstr("\"result\":null"));
}
class TransportInputTest : public Test {
llvm::SmallVector<char> inputPath;
std::FILE *in = nullptr;
std::string output = "";
llvm::raw_string_ostream os;
std::optional<JSONTransport> transport = std::nullopt;
std::optional<MessageHandler> messageHandler = std::nullopt;
protected:
TransportInputTest() : os(output) {}
void SetUp() override {
std::error_code ec =
llvm::sys::fs::createTemporaryFile("lsp-unittest", "json", inputPath);
ASSERT_FALSE(ec) << "Could not create temporary file: " << ec.message();
in = std::fopen(inputPath.data(), "r");
ASSERT_TRUE(in) << "Could not open temporary file: "
<< std::strerror(errno);
transport.emplace(in, os, JSONStreamStyle::Delimited);
messageHandler.emplace(*transport);
}
void TearDown() override {
EXPECT_EQ(std::fclose(in), 0)
<< "Could not close temporary file FD: " << std::strerror(errno);
std::error_code ec =
llvm::sys::fs::remove(inputPath, /*IgnoreNonExisting=*/false);
EXPECT_FALSE(ec) << "Could not remove temporary file '" << inputPath.data()
<< "': " << ec.message();
}
void writeInput(StringRef buffer) {
std::error_code ec;
llvm::raw_fd_ostream os(inputPath.data(), ec);
ASSERT_FALSE(ec) << "Could not write to '" << inputPath.data()
<< "': " << ec.message();
os << buffer;
os.close();
}
StringRef getOutput() const { return output; }
MessageHandler &getMessageHandler() { return *messageHandler; }
void runTransport() {
bool gotEOF = false;
llvm::Error err = llvm::handleErrors(
transport->run(*messageHandler), [&](const llvm::ECError &ecErr) {
gotEOF = ecErr.convertToErrorCode() == std::errc::io_error;
});
llvm::consumeError(std::move(err));
EXPECT_TRUE(gotEOF);
}
};
TEST_F(TransportInputTest, RequestWithInvalidParams) {
struct Handler {
void onMethod(const TextDocumentItem ¶ms,
llvm::lsp::Callback<TextDocumentIdentifier> callback) {}
} handler;
getMessageHandler().method("invalid-params-request", &handler,
&Handler::onMethod);
writeInput("{\"jsonrpc\":\"2.0\",\"id\":92,"
"\"method\":\"invalid-params-request\",\"params\":{}}\n");
runTransport();
EXPECT_THAT(getOutput(), HasSubstr("error"));
EXPECT_THAT(getOutput(), HasSubstr("missing value at (root).uri"));
}
TEST_F(TransportInputTest, NotificationWithInvalidParams) {
// JSON parsing errors are only reported via error logging. As a result, this
// test can't make any expectations -- but it prints the output anyway, by way
// of demonstration.
Logger::setLogLevel(Logger::Level::Error);
struct Handler {
void onNotification(const TextDocumentItem ¶ms) {}
} handler;
getMessageHandler().notification("invalid-params-notification", &handler,
&Handler::onNotification);
writeInput("{\"jsonrpc\":\"2.0\",\"method\":\"invalid-params-notification\","
"\"params\":{}}\n");
runTransport();
}
TEST_F(TransportInputTest, MethodNotFound) {
writeInput("{\"jsonrpc\":\"2.0\",\"id\":29,\"method\":\"ack\"}\n");
runTransport();
EXPECT_THAT(getOutput(), HasSubstr("\"id\":29"));
EXPECT_THAT(getOutput(), HasSubstr("\"error\""));
EXPECT_THAT(getOutput(), HasSubstr("\"message\":\"method not found: ack\""));
}
TEST_F(TransportInputTest, OutgoingNotification) {
auto notifyFn = getMessageHandler().outgoingNotification<CompletionList>(
"outgoing-notification");
notifyFn(CompletionList{});
EXPECT_THAT(getOutput(), HasSubstr("\"method\":\"outgoing-notification\""));
}
TEST_F(TransportInputTest, ResponseHandlerNotFound) {
// Unhandled responses are only reported via error logging. As a result, this
// test can't make any expectations -- but it prints the output anyway, by way
// of demonstration.
Logger::setLogLevel(Logger::Level::Error);
writeInput("{\"jsonrpc\":\"2.0\",\"id\":81,\"result\":null}\n");
runTransport();
}
TEST_F(TransportInputTest, OutgoingRequest) {
// Make some outgoing requests.
int responseCallbackInvoked = 0;
auto callFn =
getMessageHandler().outgoingRequest<CompletionList, CompletionContext>(
"outgoing-request",
[&responseCallbackInvoked](const llvm::json::Value &id,
llvm::Expected<CompletionContext> result) {
// Make expectations on the expected response.
EXPECT_EQ(id, 83);
ASSERT_TRUE((bool)result);
EXPECT_EQ(result->triggerKind, CompletionTriggerKind::Invoked);
responseCallbackInvoked += 1;
});
callFn({}, 82);
callFn({}, 83);
callFn({}, 84);
EXPECT_THAT(getOutput(), HasSubstr("\"method\":\"outgoing-request\""));
EXPECT_EQ(responseCallbackInvoked, 0);
// One of the requests receives a response. The message handler handles this
// response by invoking the callback from above. Subsequent responses with the
// same ID are ignored.
writeInput(
"{\"jsonrpc\":\"2.0\",\"id\":83,\"result\":{\"triggerKind\":1}}\n"
"// -----\n"
"{\"jsonrpc\":\"2.0\",\"id\":83,\"result\":{\"triggerKind\":3}}\n");
runTransport();
EXPECT_EQ(responseCallbackInvoked, 1);
}
TEST_F(TransportInputTest, OutgoingRequestJSONParseFailure) {
// Make an outgoing request that expects a failure response.
unsigned responseCallbackInvoked = 0;
auto callFn = getMessageHandler().outgoingRequest<CompletionList, Position>(
"outgoing-request-json-parse-failure",
[&responseCallbackInvoked](const llvm::json::Value &id,
llvm::Expected<Position> result) {
llvm::Error err = result.takeError();
EXPECT_EQ(id, 109);
ASSERT_TRUE((bool)err);
EXPECT_THAT(debugString(err),
HasSubstr("failed to decode "
"reply:outgoing-request-json-parse-failure(109) "
"response: missing value at (root).character"));
llvm::consumeError(std::move(err));
responseCallbackInvoked += 1;
});
callFn({}, 109);
EXPECT_EQ(responseCallbackInvoked, 0u);
// The request receives multiple responses, but only the first one triggers
// the response callback. The first response has erroneous JSON that causes a
// parse failure.
writeInput("{\"jsonrpc\":\"2.0\",\"id\":109,\"result\":{\"line\":7}}\n"
"// -----\n"
"{\"jsonrpc\":\"2.0\",\"id\":109,\"result\":{\"line\":3,"
"\"character\":2}}\n");
runTransport();
EXPECT_EQ(responseCallbackInvoked, 1u);
}
} // namespace
|
