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
|
//===-- FindSymbolsTests.cpp -------------------------*- C++ -*------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "Annotations.h"
#include "ClangdServer.h"
#include "FindSymbols.h"
#include "SyncAPI.h"
#include "TestFS.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
namespace clang {
namespace clangd {
namespace {
using ::testing::AllOf;
using ::testing::AnyOf;
using ::testing::ElementsAre;
using ::testing::IsEmpty;
using ::testing::UnorderedElementsAre;
class IgnoreDiagnostics : public DiagnosticsConsumer {
void onDiagnosticsReady(PathRef File,
std::vector<Diag> Diagnostics) override {}
};
// GMock helpers for matching SymbolInfos items.
MATCHER_P(Named, Name, "") { return arg.name == Name; }
MATCHER_P(InContainer, ContainerName, "") {
return arg.containerName == ContainerName;
}
MATCHER_P(WithKind, Kind, "") { return arg.kind == Kind; }
ClangdServer::Options optsForTests() {
auto ServerOpts = ClangdServer::optsForTest();
ServerOpts.BuildDynamicSymbolIndex = true;
return ServerOpts;
}
class WorkspaceSymbolsTest : public ::testing::Test {
public:
WorkspaceSymbolsTest()
: Server(CDB, FSProvider, DiagConsumer, optsForTests()) {}
protected:
MockFSProvider FSProvider;
MockCompilationDatabase CDB;
IgnoreDiagnostics DiagConsumer;
ClangdServer Server;
int Limit = 0;
std::vector<SymbolInformation> getSymbols(StringRef Query) {
EXPECT_TRUE(Server.blockUntilIdleForTest()) << "Waiting for preamble";
auto SymbolInfos = runWorkspaceSymbols(Server, Query, Limit);
EXPECT_TRUE(bool(SymbolInfos)) << "workspaceSymbols returned an error";
return *SymbolInfos;
}
void addFile(StringRef FileName, StringRef Contents) {
auto Path = testPath(FileName);
FSProvider.Files[Path] = Contents;
Server.addDocument(Path, Contents);
}
};
} // namespace
TEST_F(WorkspaceSymbolsTest, NoMacro) {
addFile("foo.cpp", R"cpp(
#define MACRO X
)cpp");
// Macros are not in the index.
EXPECT_THAT(getSymbols("macro"), IsEmpty());
}
TEST_F(WorkspaceSymbolsTest, NoLocals) {
addFile("foo.cpp", R"cpp(
void test(int FirstParam, int SecondParam) {
struct LocalClass {};
int local_var;
})cpp");
EXPECT_THAT(getSymbols("l"), IsEmpty());
EXPECT_THAT(getSymbols("p"), IsEmpty());
}
TEST_F(WorkspaceSymbolsTest, Globals) {
addFile("foo.h", R"cpp(
int global_var;
int global_func();
struct GlobalStruct {};)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
)cpp");
EXPECT_THAT(getSymbols("global"),
UnorderedElementsAre(AllOf(Named("GlobalStruct"), InContainer(""),
WithKind(SymbolKind::Struct)),
AllOf(Named("global_func"), InContainer(""),
WithKind(SymbolKind::Function)),
AllOf(Named("global_var"), InContainer(""),
WithKind(SymbolKind::Variable))));
}
TEST_F(WorkspaceSymbolsTest, Unnamed) {
addFile("foo.h", R"cpp(
struct {
int InUnnamed;
} UnnamedStruct;)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
)cpp");
EXPECT_THAT(getSymbols("UnnamedStruct"),
ElementsAre(AllOf(Named("UnnamedStruct"),
WithKind(SymbolKind::Variable))));
EXPECT_THAT(getSymbols("InUnnamed"), IsEmpty());
}
TEST_F(WorkspaceSymbolsTest, InMainFile) {
addFile("foo.cpp", R"cpp(
int test() {
}
)cpp");
EXPECT_THAT(getSymbols("test"), IsEmpty());
}
TEST_F(WorkspaceSymbolsTest, Namespaces) {
addFile("foo.h", R"cpp(
namespace ans1 {
int ai1;
namespace ans2 {
int ai2;
}
}
)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
)cpp");
EXPECT_THAT(
getSymbols("a"),
UnorderedElementsAre(AllOf(Named("ans1"), InContainer("")),
AllOf(Named("ai1"), InContainer("ans1")),
AllOf(Named("ans2"), InContainer("ans1")),
AllOf(Named("ai2"), InContainer("ans1::ans2"))));
EXPECT_THAT(getSymbols("::"),
ElementsAre(AllOf(Named("ans1"), InContainer(""))));
EXPECT_THAT(getSymbols("::a"),
ElementsAre(AllOf(Named("ans1"), InContainer(""))));
EXPECT_THAT(getSymbols("ans1::"),
UnorderedElementsAre(AllOf(Named("ai1"), InContainer("ans1")),
AllOf(Named("ans2"), InContainer("ans1"))));
EXPECT_THAT(getSymbols("::ans1"),
ElementsAre(AllOf(Named("ans1"), InContainer(""))));
EXPECT_THAT(getSymbols("::ans1::"),
UnorderedElementsAre(AllOf(Named("ai1"), InContainer("ans1")),
AllOf(Named("ans2"), InContainer("ans1"))));
EXPECT_THAT(getSymbols("::ans1::ans2"),
ElementsAre(AllOf(Named("ans2"), InContainer("ans1"))));
EXPECT_THAT(getSymbols("::ans1::ans2::"),
ElementsAre(AllOf(Named("ai2"), InContainer("ans1::ans2"))));
}
TEST_F(WorkspaceSymbolsTest, AnonymousNamespace) {
addFile("foo.h", R"cpp(
namespace {
void test() {}
}
)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
)cpp");
EXPECT_THAT(getSymbols("test"), IsEmpty());
}
TEST_F(WorkspaceSymbolsTest, MultiFile) {
addFile("foo.h", R"cpp(
int foo() {
}
)cpp");
addFile("foo2.h", R"cpp(
int foo2() {
}
)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
#include "foo2.h"
)cpp");
EXPECT_THAT(getSymbols("foo"),
UnorderedElementsAre(AllOf(Named("foo"), InContainer("")),
AllOf(Named("foo2"), InContainer(""))));
}
TEST_F(WorkspaceSymbolsTest, GlobalNamespaceQueries) {
addFile("foo.h", R"cpp(
int foo() {
}
class Foo {
int a;
};
namespace ns {
int foo2() {
}
}
)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
)cpp");
EXPECT_THAT(
getSymbols("::"),
UnorderedElementsAre(
AllOf(Named("Foo"), InContainer(""), WithKind(SymbolKind::Class)),
AllOf(Named("foo"), InContainer(""), WithKind(SymbolKind::Function)),
AllOf(Named("ns"), InContainer(""),
WithKind(SymbolKind::Namespace))));
EXPECT_THAT(getSymbols(":"), IsEmpty());
EXPECT_THAT(getSymbols(""), IsEmpty());
}
TEST_F(WorkspaceSymbolsTest, WithLimit) {
addFile("foo.h", R"cpp(
int foo;
int foo2;
)cpp");
addFile("foo.cpp", R"cpp(
#include "foo.h"
)cpp");
EXPECT_THAT(getSymbols("foo"),
ElementsAre(AllOf(Named("foo"), InContainer(""),
WithKind(SymbolKind::Variable)),
AllOf(Named("foo2"), InContainer(""),
WithKind(SymbolKind::Variable))));
Limit = 1;
EXPECT_THAT(getSymbols("foo"),
ElementsAre(AnyOf((Named("foo"), InContainer("")),
AllOf(Named("foo2"), InContainer("")))));
}
} // namespace clangd
} // namespace clang
|
