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
| //===------ IndexActionTests.cpp -------------------------------*- C++ -*-===//
//
// 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 "Headers.h"
#include "TestFS.h"
#include "index/IndexAction.h"
#include "clang/Tooling/Tooling.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
namespace clang {
namespace clangd {
namespace {
using ::testing::AllOf;
using ::testing::ElementsAre;
using ::testing::Not;
using ::testing::Pair;
using ::testing::UnorderedElementsAre;
using ::testing::UnorderedPointwise;
std::string toUri(llvm::StringRef Path) { return URI::create(Path).toString(); }
MATCHER(IsTU, "") { return arg.Flags & IncludeGraphNode::SourceFlag::IsTU; }
MATCHER_P(HasDigest, Digest, "") { return arg.Digest == Digest; }
MATCHER_P(HasName, Name, "") { return arg.Name == Name; }
MATCHER(HasSameURI, "") {
llvm::StringRef URI = ::testing::get<0>(arg);
const std::string &Path = ::testing::get<1>(arg);
return toUri(Path) == URI;
}
::testing::Matcher<const IncludeGraphNode &>
IncludesAre(const std::vector<std::string> &Includes) {
return ::testing::Field(&IncludeGraphNode::DirectIncludes,
UnorderedPointwise(HasSameURI(), Includes));
}
void checkNodesAreInitialized(const IndexFileIn &IndexFile,
const std::vector<std::string> &Paths) {
ASSERT_TRUE(IndexFile.Sources);
EXPECT_THAT(Paths.size(), IndexFile.Sources->size());
for (llvm::StringRef Path : Paths) {
auto URI = toUri(Path);
const auto &Node = IndexFile.Sources->lookup(URI);
// Uninitialized nodes will have an empty URI.
EXPECT_EQ(Node.URI.data(), IndexFile.Sources->find(URI)->getKeyData());
}
}
std::map<std::string, const IncludeGraphNode &> toMap(const IncludeGraph &IG) {
std::map<std::string, const IncludeGraphNode &> Nodes;
for (auto &I : IG)
Nodes.emplace(I.getKey(), I.getValue());
return Nodes;
}
class IndexActionTest : public ::testing::Test {
public:
IndexActionTest() : InMemoryFileSystem(new llvm::vfs::InMemoryFileSystem) {}
IndexFileIn
runIndexingAction(llvm::StringRef MainFilePath,
const std::vector<std::string> &ExtraArgs = {}) {
IndexFileIn IndexFile;
llvm::IntrusiveRefCntPtr<FileManager> Files(
new FileManager(FileSystemOptions(), InMemoryFileSystem));
auto Action = createStaticIndexingAction(
SymbolCollector::Options(),
[&](SymbolSlab S) { IndexFile.Symbols = std::move(S); },
[&](RefSlab R) { IndexFile.Refs = std::move(R); },
[&](RelationSlab R) { IndexFile.Relations = std::move(R); },
[&](IncludeGraph IG) { IndexFile.Sources = std::move(IG); });
std::vector<std::string> Args = {"index_action", "-fsyntax-only",
"-xc++", "-std=c++11",
"-iquote", testRoot()};
Args.insert(Args.end(), ExtraArgs.begin(), ExtraArgs.end());
Args.push_back(MainFilePath);
tooling::ToolInvocation Invocation(
Args, std::move(Action), Files.get(),
std::make_shared<PCHContainerOperations>());
Invocation.run();
checkNodesAreInitialized(IndexFile, FilePaths);
return IndexFile;
}
void addFile(llvm::StringRef Path, llvm::StringRef Content) {
InMemoryFileSystem->addFile(Path, 0,
llvm::MemoryBuffer::getMemBuffer(Content));
FilePaths.push_back(Path);
}
protected:
std::vector<std::string> FilePaths;
llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> InMemoryFileSystem;
};
TEST_F(IndexActionTest, CollectIncludeGraph) {
std::string MainFilePath = testPath("main.cpp");
std::string MainCode = "#include \"level1.h\"";
std::string Level1HeaderPath = testPath("level1.h");
std::string Level1HeaderCode = "#include \"level2.h\"";
std::string Level2HeaderPath = testPath("level2.h");
std::string Level2HeaderCode = "";
addFile(MainFilePath, MainCode);
addFile(Level1HeaderPath, Level1HeaderCode);
addFile(Level2HeaderPath, Level2HeaderCode);
IndexFileIn IndexFile = runIndexingAction(MainFilePath);
auto Nodes = toMap(*IndexFile.Sources);
EXPECT_THAT(Nodes,
UnorderedElementsAre(
Pair(toUri(MainFilePath),
AllOf(IsTU(), IncludesAre({Level1HeaderPath}),
HasDigest(digest(MainCode)))),
Pair(toUri(Level1HeaderPath),
AllOf(Not(IsTU()), IncludesAre({Level2HeaderPath}),
HasDigest(digest(Level1HeaderCode)))),
Pair(toUri(Level2HeaderPath),
AllOf(Not(IsTU()), IncludesAre({}),
HasDigest(digest(Level2HeaderCode))))));
}
TEST_F(IndexActionTest, IncludeGraphSelfInclude) {
std::string MainFilePath = testPath("main.cpp");
std::string MainCode = "#include \"header.h\"";
std::string HeaderPath = testPath("header.h");
std::string HeaderCode = R"cpp(
#ifndef _GUARD_
#define _GUARD_
#include "header.h"
#endif)cpp";
addFile(MainFilePath, MainCode);
addFile(HeaderPath, HeaderCode);
IndexFileIn IndexFile = runIndexingAction(MainFilePath);
auto Nodes = toMap(*IndexFile.Sources);
EXPECT_THAT(
Nodes,
UnorderedElementsAre(
Pair(toUri(MainFilePath), AllOf(IsTU(), IncludesAre({HeaderPath}),
HasDigest(digest(MainCode)))),
Pair(toUri(HeaderPath), AllOf(Not(IsTU()), IncludesAre({HeaderPath}),
HasDigest(digest(HeaderCode))))));
}
TEST_F(IndexActionTest, IncludeGraphSkippedFile) {
std::string MainFilePath = testPath("main.cpp");
std::string MainCode = R"cpp(
#include "common.h"
#include "header.h"
)cpp";
std::string CommonHeaderPath = testPath("common.h");
std::string CommonHeaderCode = R"cpp(
#ifndef _GUARD_
#define _GUARD_
void f();
#endif)cpp";
std::string HeaderPath = testPath("header.h");
std::string HeaderCode = R"cpp(
#include "common.h"
void g();)cpp";
addFile(MainFilePath, MainCode);
addFile(HeaderPath, HeaderCode);
addFile(CommonHeaderPath, CommonHeaderCode);
IndexFileIn IndexFile = runIndexingAction(MainFilePath);
auto Nodes = toMap(*IndexFile.Sources);
EXPECT_THAT(
Nodes, UnorderedElementsAre(
Pair(toUri(MainFilePath),
AllOf(IsTU(), IncludesAre({HeaderPath, CommonHeaderPath}),
HasDigest(digest(MainCode)))),
Pair(toUri(HeaderPath),
AllOf(Not(IsTU()), IncludesAre({CommonHeaderPath}),
HasDigest(digest(HeaderCode)))),
Pair(toUri(CommonHeaderPath),
AllOf(Not(IsTU()), IncludesAre({}),
HasDigest(digest(CommonHeaderCode))))));
}
TEST_F(IndexActionTest, IncludeGraphDynamicInclude) {
std::string MainFilePath = testPath("main.cpp");
std::string MainCode = R"cpp(
#ifndef FOO
#define FOO "main.cpp"
#else
#define FOO "header.h"
#endif
#include FOO)cpp";
std::string HeaderPath = testPath("header.h");
std::string HeaderCode = "";
addFile(MainFilePath, MainCode);
addFile(HeaderPath, HeaderCode);
IndexFileIn IndexFile = runIndexingAction(MainFilePath);
auto Nodes = toMap(*IndexFile.Sources);
EXPECT_THAT(
Nodes,
UnorderedElementsAre(
Pair(toUri(MainFilePath),
AllOf(IsTU(), IncludesAre({MainFilePath, HeaderPath}),
HasDigest(digest(MainCode)))),
Pair(toUri(HeaderPath), AllOf(Not(IsTU()), IncludesAre({}),
HasDigest(digest(HeaderCode))))));
}
TEST_F(IndexActionTest, NoWarnings) {
std::string MainFilePath = testPath("main.cpp");
std::string MainCode = R"cpp(
void foo(int x) {
if (x = 1) // -Wparentheses
return;
if (x = 1) // -Wparentheses
return;
}
void bar() {}
)cpp";
addFile(MainFilePath, MainCode);
// We set -ferror-limit so the warning-promoted-to-error would be fatal.
// This would cause indexing to stop (if warnings weren't disabled).
IndexFileIn IndexFile = runIndexingAction(
MainFilePath, {"-ferror-limit=1", "-Wparentheses", "-Werror"});
ASSERT_TRUE(IndexFile.Sources);
ASSERT_NE(0u, IndexFile.Sources->size());
EXPECT_THAT(*IndexFile.Symbols, ElementsAre(HasName("foo"), HasName("bar")));
}
} // namespace
} // namespace clangd
} // namespace clang
|