1*67e74705SXin Li //===- unittest/Tooling/CompilationDatabaseTest.cpp -----------------------===//
2*67e74705SXin Li //
3*67e74705SXin Li // The LLVM Compiler Infrastructure
4*67e74705SXin Li //
5*67e74705SXin Li // This file is distributed under the University of Illinois Open Source
6*67e74705SXin Li // License. See LICENSE.TXT for details.
7*67e74705SXin Li //
8*67e74705SXin Li //===----------------------------------------------------------------------===//
9*67e74705SXin Li
10*67e74705SXin Li #include "clang/AST/ASTConsumer.h"
11*67e74705SXin Li #include "clang/AST/DeclCXX.h"
12*67e74705SXin Li #include "clang/AST/DeclGroup.h"
13*67e74705SXin Li #include "clang/Frontend/FrontendAction.h"
14*67e74705SXin Li #include "clang/Tooling/FileMatchTrie.h"
15*67e74705SXin Li #include "clang/Tooling/JSONCompilationDatabase.h"
16*67e74705SXin Li #include "clang/Tooling/Tooling.h"
17*67e74705SXin Li #include "llvm/Support/Path.h"
18*67e74705SXin Li #include "gtest/gtest.h"
19*67e74705SXin Li
20*67e74705SXin Li namespace clang {
21*67e74705SXin Li namespace tooling {
22*67e74705SXin Li
expectFailure(StringRef JSONDatabase,StringRef Explanation)23*67e74705SXin Li static void expectFailure(StringRef JSONDatabase, StringRef Explanation) {
24*67e74705SXin Li std::string ErrorMessage;
25*67e74705SXin Li EXPECT_EQ(nullptr, JSONCompilationDatabase::loadFromBuffer(JSONDatabase,
26*67e74705SXin Li ErrorMessage))
27*67e74705SXin Li << "Expected an error because of: " << Explanation.str();
28*67e74705SXin Li }
29*67e74705SXin Li
TEST(JSONCompilationDatabase,ErrsOnInvalidFormat)30*67e74705SXin Li TEST(JSONCompilationDatabase, ErrsOnInvalidFormat) {
31*67e74705SXin Li expectFailure("", "Empty database");
32*67e74705SXin Li expectFailure("{", "Invalid JSON");
33*67e74705SXin Li expectFailure("[[]]", "Array instead of object");
34*67e74705SXin Li expectFailure("[{\"a\":[]}]", "Array instead of value");
35*67e74705SXin Li expectFailure("[{\"a\":\"b\"}]", "Unknown key");
36*67e74705SXin Li expectFailure("[{[]:\"\"}]", "Incorrectly typed entry");
37*67e74705SXin Li expectFailure("[{}]", "Empty entry");
38*67e74705SXin Li expectFailure("[{\"directory\":\"\",\"command\":\"\"}]", "Missing file");
39*67e74705SXin Li expectFailure("[{\"directory\":\"\",\"file\":\"\"}]", "Missing command or arguments");
40*67e74705SXin Li expectFailure("[{\"command\":\"\",\"file\":\"\"}]", "Missing directory");
41*67e74705SXin Li expectFailure("[{\"directory\":\"\",\"arguments\":[]}]", "Missing file");
42*67e74705SXin Li expectFailure("[{\"arguments\":\"\",\"file\":\"\"}]", "Missing directory");
43*67e74705SXin Li expectFailure("[{\"directory\":\"\",\"arguments\":\"\",\"file\":\"\"}]", "Arguments not array");
44*67e74705SXin Li expectFailure("[{\"directory\":\"\",\"command\":[],\"file\":\"\"}]", "Command not string");
45*67e74705SXin Li expectFailure("[{\"directory\":\"\",\"arguments\":[[]],\"file\":\"\"}]",
46*67e74705SXin Li "Arguments contain non-string");
47*67e74705SXin Li }
48*67e74705SXin Li
getAllFiles(StringRef JSONDatabase,std::string & ErrorMessage)49*67e74705SXin Li static std::vector<std::string> getAllFiles(StringRef JSONDatabase,
50*67e74705SXin Li std::string &ErrorMessage) {
51*67e74705SXin Li std::unique_ptr<CompilationDatabase> Database(
52*67e74705SXin Li JSONCompilationDatabase::loadFromBuffer(JSONDatabase, ErrorMessage));
53*67e74705SXin Li if (!Database) {
54*67e74705SXin Li ADD_FAILURE() << ErrorMessage;
55*67e74705SXin Li return std::vector<std::string>();
56*67e74705SXin Li }
57*67e74705SXin Li return Database->getAllFiles();
58*67e74705SXin Li }
59*67e74705SXin Li
getAllCompileCommands(StringRef JSONDatabase,std::string & ErrorMessage)60*67e74705SXin Li static std::vector<CompileCommand> getAllCompileCommands(StringRef JSONDatabase,
61*67e74705SXin Li std::string &ErrorMessage) {
62*67e74705SXin Li std::unique_ptr<CompilationDatabase> Database(
63*67e74705SXin Li JSONCompilationDatabase::loadFromBuffer(JSONDatabase, ErrorMessage));
64*67e74705SXin Li if (!Database) {
65*67e74705SXin Li ADD_FAILURE() << ErrorMessage;
66*67e74705SXin Li return std::vector<CompileCommand>();
67*67e74705SXin Li }
68*67e74705SXin Li return Database->getAllCompileCommands();
69*67e74705SXin Li }
70*67e74705SXin Li
TEST(JSONCompilationDatabase,GetAllFiles)71*67e74705SXin Li TEST(JSONCompilationDatabase, GetAllFiles) {
72*67e74705SXin Li std::string ErrorMessage;
73*67e74705SXin Li EXPECT_EQ(std::vector<std::string>(),
74*67e74705SXin Li getAllFiles("[]", ErrorMessage)) << ErrorMessage;
75*67e74705SXin Li
76*67e74705SXin Li std::vector<std::string> expected_files;
77*67e74705SXin Li SmallString<16> PathStorage;
78*67e74705SXin Li llvm::sys::path::native("//net/dir/file1", PathStorage);
79*67e74705SXin Li expected_files.push_back(PathStorage.str());
80*67e74705SXin Li llvm::sys::path::native("//net/dir/file2", PathStorage);
81*67e74705SXin Li expected_files.push_back(PathStorage.str());
82*67e74705SXin Li EXPECT_EQ(expected_files, getAllFiles(
83*67e74705SXin Li "[{\"directory\":\"//net/dir\","
84*67e74705SXin Li "\"command\":\"command\","
85*67e74705SXin Li "\"file\":\"file1\"},"
86*67e74705SXin Li " {\"directory\":\"//net/dir\","
87*67e74705SXin Li "\"command\":\"command\","
88*67e74705SXin Li "\"file\":\"file2\"}]",
89*67e74705SXin Li ErrorMessage)) << ErrorMessage;
90*67e74705SXin Li }
91*67e74705SXin Li
TEST(JSONCompilationDatabase,GetAllCompileCommands)92*67e74705SXin Li TEST(JSONCompilationDatabase, GetAllCompileCommands) {
93*67e74705SXin Li std::string ErrorMessage;
94*67e74705SXin Li EXPECT_EQ(0u,
95*67e74705SXin Li getAllCompileCommands("[]", ErrorMessage).size()) << ErrorMessage;
96*67e74705SXin Li
97*67e74705SXin Li StringRef Directory1("//net/dir1");
98*67e74705SXin Li StringRef FileName1("file1");
99*67e74705SXin Li StringRef Command1("command1");
100*67e74705SXin Li StringRef Directory2("//net/dir2");
101*67e74705SXin Li StringRef FileName2("file2");
102*67e74705SXin Li StringRef Command2("command2");
103*67e74705SXin Li
104*67e74705SXin Li std::vector<CompileCommand> Commands = getAllCompileCommands(
105*67e74705SXin Li ("[{\"directory\":\"" + Directory1 + "\"," +
106*67e74705SXin Li "\"command\":\"" + Command1 + "\","
107*67e74705SXin Li "\"file\":\"" + FileName1 + "\"},"
108*67e74705SXin Li " {\"directory\":\"" + Directory2 + "\"," +
109*67e74705SXin Li "\"command\":\"" + Command2 + "\","
110*67e74705SXin Li "\"file\":\"" + FileName2 + "\"}]").str(),
111*67e74705SXin Li ErrorMessage);
112*67e74705SXin Li EXPECT_EQ(2U, Commands.size()) << ErrorMessage;
113*67e74705SXin Li EXPECT_EQ(Directory1, Commands[0].Directory) << ErrorMessage;
114*67e74705SXin Li EXPECT_EQ(FileName1, Commands[0].Filename) << ErrorMessage;
115*67e74705SXin Li ASSERT_EQ(1u, Commands[0].CommandLine.size());
116*67e74705SXin Li EXPECT_EQ(Command1, Commands[0].CommandLine[0]) << ErrorMessage;
117*67e74705SXin Li EXPECT_EQ(Directory2, Commands[1].Directory) << ErrorMessage;
118*67e74705SXin Li EXPECT_EQ(FileName2, Commands[1].Filename) << ErrorMessage;
119*67e74705SXin Li ASSERT_EQ(1u, Commands[1].CommandLine.size());
120*67e74705SXin Li EXPECT_EQ(Command2, Commands[1].CommandLine[0]) << ErrorMessage;
121*67e74705SXin Li
122*67e74705SXin Li // Check that order is preserved.
123*67e74705SXin Li Commands = getAllCompileCommands(
124*67e74705SXin Li ("[{\"directory\":\"" + Directory2 + "\"," +
125*67e74705SXin Li "\"command\":\"" + Command2 + "\","
126*67e74705SXin Li "\"file\":\"" + FileName2 + "\"},"
127*67e74705SXin Li " {\"directory\":\"" + Directory1 + "\"," +
128*67e74705SXin Li "\"command\":\"" + Command1 + "\","
129*67e74705SXin Li "\"file\":\"" + FileName1 + "\"}]").str(),
130*67e74705SXin Li ErrorMessage);
131*67e74705SXin Li EXPECT_EQ(2U, Commands.size()) << ErrorMessage;
132*67e74705SXin Li EXPECT_EQ(Directory2, Commands[0].Directory) << ErrorMessage;
133*67e74705SXin Li EXPECT_EQ(FileName2, Commands[0].Filename) << ErrorMessage;
134*67e74705SXin Li ASSERT_EQ(1u, Commands[0].CommandLine.size());
135*67e74705SXin Li EXPECT_EQ(Command2, Commands[0].CommandLine[0]) << ErrorMessage;
136*67e74705SXin Li EXPECT_EQ(Directory1, Commands[1].Directory) << ErrorMessage;
137*67e74705SXin Li EXPECT_EQ(FileName1, Commands[1].Filename) << ErrorMessage;
138*67e74705SXin Li ASSERT_EQ(1u, Commands[1].CommandLine.size());
139*67e74705SXin Li EXPECT_EQ(Command1, Commands[1].CommandLine[0]) << ErrorMessage;
140*67e74705SXin Li }
141*67e74705SXin Li
findCompileArgsInJsonDatabase(StringRef FileName,StringRef JSONDatabase,std::string & ErrorMessage)142*67e74705SXin Li static CompileCommand findCompileArgsInJsonDatabase(StringRef FileName,
143*67e74705SXin Li StringRef JSONDatabase,
144*67e74705SXin Li std::string &ErrorMessage) {
145*67e74705SXin Li std::unique_ptr<CompilationDatabase> Database(
146*67e74705SXin Li JSONCompilationDatabase::loadFromBuffer(JSONDatabase, ErrorMessage));
147*67e74705SXin Li if (!Database)
148*67e74705SXin Li return CompileCommand();
149*67e74705SXin Li std::vector<CompileCommand> Commands = Database->getCompileCommands(FileName);
150*67e74705SXin Li EXPECT_LE(Commands.size(), 1u);
151*67e74705SXin Li if (Commands.empty())
152*67e74705SXin Li return CompileCommand();
153*67e74705SXin Li return Commands[0];
154*67e74705SXin Li }
155*67e74705SXin Li
TEST(JSONCompilationDatabase,ArgumentsPreferredOverCommand)156*67e74705SXin Li TEST(JSONCompilationDatabase, ArgumentsPreferredOverCommand) {
157*67e74705SXin Li StringRef Directory("//net/dir");
158*67e74705SXin Li StringRef FileName("//net/dir/filename");
159*67e74705SXin Li StringRef Command("command");
160*67e74705SXin Li StringRef Arguments = "arguments";
161*67e74705SXin Li Twine ArgumentsAccumulate;
162*67e74705SXin Li std::string ErrorMessage;
163*67e74705SXin Li CompileCommand FoundCommand = findCompileArgsInJsonDatabase(
164*67e74705SXin Li FileName,
165*67e74705SXin Li ("[{\"directory\":\"" + Directory + "\","
166*67e74705SXin Li "\"arguments\":[\"" + Arguments + "\"],"
167*67e74705SXin Li "\"command\":\"" + Command + "\","
168*67e74705SXin Li "\"file\":\"" + FileName + "\"}]").str(),
169*67e74705SXin Li ErrorMessage);
170*67e74705SXin Li EXPECT_EQ(Directory, FoundCommand.Directory) << ErrorMessage;
171*67e74705SXin Li EXPECT_EQ(1u, FoundCommand.CommandLine.size()) << ErrorMessage;
172*67e74705SXin Li EXPECT_EQ(Arguments, FoundCommand.CommandLine[0]) << ErrorMessage;
173*67e74705SXin Li }
174*67e74705SXin Li
175*67e74705SXin Li struct FakeComparator : public PathComparator {
~FakeComparatorclang::tooling::FakeComparator176*67e74705SXin Li ~FakeComparator() override {}
equivalentclang::tooling::FakeComparator177*67e74705SXin Li bool equivalent(StringRef FileA, StringRef FileB) const override {
178*67e74705SXin Li return FileA.equals_lower(FileB);
179*67e74705SXin Li }
180*67e74705SXin Li };
181*67e74705SXin Li
182*67e74705SXin Li class FileMatchTrieTest : public ::testing::Test {
183*67e74705SXin Li protected:
FileMatchTrieTest()184*67e74705SXin Li FileMatchTrieTest() : Trie(new FakeComparator()) {}
185*67e74705SXin Li
find(StringRef Path)186*67e74705SXin Li StringRef find(StringRef Path) {
187*67e74705SXin Li llvm::raw_string_ostream ES(Error);
188*67e74705SXin Li return Trie.findEquivalent(Path, ES);
189*67e74705SXin Li }
190*67e74705SXin Li
191*67e74705SXin Li FileMatchTrie Trie;
192*67e74705SXin Li std::string Error;
193*67e74705SXin Li };
194*67e74705SXin Li
TEST_F(FileMatchTrieTest,InsertingRelativePath)195*67e74705SXin Li TEST_F(FileMatchTrieTest, InsertingRelativePath) {
196*67e74705SXin Li Trie.insert("//net/path/file.cc");
197*67e74705SXin Li Trie.insert("file.cc");
198*67e74705SXin Li EXPECT_EQ("//net/path/file.cc", find("//net/path/file.cc"));
199*67e74705SXin Li }
200*67e74705SXin Li
TEST_F(FileMatchTrieTest,MatchingRelativePath)201*67e74705SXin Li TEST_F(FileMatchTrieTest, MatchingRelativePath) {
202*67e74705SXin Li EXPECT_EQ("", find("file.cc"));
203*67e74705SXin Li }
204*67e74705SXin Li
TEST_F(FileMatchTrieTest,ReturnsBestResults)205*67e74705SXin Li TEST_F(FileMatchTrieTest, ReturnsBestResults) {
206*67e74705SXin Li Trie.insert("//net/d/c/b.cc");
207*67e74705SXin Li Trie.insert("//net/d/b/b.cc");
208*67e74705SXin Li EXPECT_EQ("//net/d/b/b.cc", find("//net/d/b/b.cc"));
209*67e74705SXin Li }
210*67e74705SXin Li
TEST_F(FileMatchTrieTest,HandlesSymlinks)211*67e74705SXin Li TEST_F(FileMatchTrieTest, HandlesSymlinks) {
212*67e74705SXin Li Trie.insert("//net/AA/file.cc");
213*67e74705SXin Li EXPECT_EQ("//net/AA/file.cc", find("//net/aa/file.cc"));
214*67e74705SXin Li }
215*67e74705SXin Li
TEST_F(FileMatchTrieTest,ReportsSymlinkAmbiguity)216*67e74705SXin Li TEST_F(FileMatchTrieTest, ReportsSymlinkAmbiguity) {
217*67e74705SXin Li Trie.insert("//net/Aa/file.cc");
218*67e74705SXin Li Trie.insert("//net/aA/file.cc");
219*67e74705SXin Li EXPECT_TRUE(find("//net/aa/file.cc").empty());
220*67e74705SXin Li EXPECT_EQ("Path is ambiguous", Error);
221*67e74705SXin Li }
222*67e74705SXin Li
TEST_F(FileMatchTrieTest,LongerMatchingSuffixPreferred)223*67e74705SXin Li TEST_F(FileMatchTrieTest, LongerMatchingSuffixPreferred) {
224*67e74705SXin Li Trie.insert("//net/src/Aa/file.cc");
225*67e74705SXin Li Trie.insert("//net/src/aA/file.cc");
226*67e74705SXin Li Trie.insert("//net/SRC/aa/file.cc");
227*67e74705SXin Li EXPECT_EQ("//net/SRC/aa/file.cc", find("//net/src/aa/file.cc"));
228*67e74705SXin Li }
229*67e74705SXin Li
TEST_F(FileMatchTrieTest,EmptyTrie)230*67e74705SXin Li TEST_F(FileMatchTrieTest, EmptyTrie) {
231*67e74705SXin Li EXPECT_TRUE(find("//net/some/path").empty());
232*67e74705SXin Li }
233*67e74705SXin Li
TEST_F(FileMatchTrieTest,NoResult)234*67e74705SXin Li TEST_F(FileMatchTrieTest, NoResult) {
235*67e74705SXin Li Trie.insert("//net/somepath/otherfile.cc");
236*67e74705SXin Li Trie.insert("//net/otherpath/somefile.cc");
237*67e74705SXin Li EXPECT_EQ("", find("//net/somepath/somefile.cc"));
238*67e74705SXin Li }
239*67e74705SXin Li
TEST_F(FileMatchTrieTest,RootElementDifferent)240*67e74705SXin Li TEST_F(FileMatchTrieTest, RootElementDifferent) {
241*67e74705SXin Li Trie.insert("//net/path/file.cc");
242*67e74705SXin Li Trie.insert("//net/otherpath/file.cc");
243*67e74705SXin Li EXPECT_EQ("//net/path/file.cc", find("//net/path/file.cc"));
244*67e74705SXin Li }
245*67e74705SXin Li
TEST_F(FileMatchTrieTest,CannotResolveRelativePath)246*67e74705SXin Li TEST_F(FileMatchTrieTest, CannotResolveRelativePath) {
247*67e74705SXin Li EXPECT_EQ("", find("relative-path.cc"));
248*67e74705SXin Li EXPECT_EQ("Cannot resolve relative paths", Error);
249*67e74705SXin Li }
250*67e74705SXin Li
TEST(findCompileArgsInJsonDatabase,FindsNothingIfEmpty)251*67e74705SXin Li TEST(findCompileArgsInJsonDatabase, FindsNothingIfEmpty) {
252*67e74705SXin Li std::string ErrorMessage;
253*67e74705SXin Li CompileCommand NotFound = findCompileArgsInJsonDatabase(
254*67e74705SXin Li "a-file.cpp", "", ErrorMessage);
255*67e74705SXin Li EXPECT_TRUE(NotFound.CommandLine.empty()) << ErrorMessage;
256*67e74705SXin Li EXPECT_TRUE(NotFound.Directory.empty()) << ErrorMessage;
257*67e74705SXin Li }
258*67e74705SXin Li
TEST(findCompileArgsInJsonDatabase,ReadsSingleEntry)259*67e74705SXin Li TEST(findCompileArgsInJsonDatabase, ReadsSingleEntry) {
260*67e74705SXin Li StringRef Directory("//net/some/directory");
261*67e74705SXin Li StringRef FileName("//net/path/to/a-file.cpp");
262*67e74705SXin Li StringRef Command("//net/path/to/compiler and some arguments");
263*67e74705SXin Li std::string ErrorMessage;
264*67e74705SXin Li CompileCommand FoundCommand = findCompileArgsInJsonDatabase(
265*67e74705SXin Li FileName,
266*67e74705SXin Li ("[{\"directory\":\"" + Directory + "\"," +
267*67e74705SXin Li "\"command\":\"" + Command + "\","
268*67e74705SXin Li "\"file\":\"" + FileName + "\"}]").str(),
269*67e74705SXin Li ErrorMessage);
270*67e74705SXin Li EXPECT_EQ(Directory, FoundCommand.Directory) << ErrorMessage;
271*67e74705SXin Li ASSERT_EQ(4u, FoundCommand.CommandLine.size()) << ErrorMessage;
272*67e74705SXin Li EXPECT_EQ("//net/path/to/compiler",
273*67e74705SXin Li FoundCommand.CommandLine[0]) << ErrorMessage;
274*67e74705SXin Li EXPECT_EQ("and", FoundCommand.CommandLine[1]) << ErrorMessage;
275*67e74705SXin Li EXPECT_EQ("some", FoundCommand.CommandLine[2]) << ErrorMessage;
276*67e74705SXin Li EXPECT_EQ("arguments", FoundCommand.CommandLine[3]) << ErrorMessage;
277*67e74705SXin Li
278*67e74705SXin Li CompileCommand NotFound = findCompileArgsInJsonDatabase(
279*67e74705SXin Li "a-file.cpp",
280*67e74705SXin Li ("[{\"directory\":\"" + Directory + "\"," +
281*67e74705SXin Li "\"command\":\"" + Command + "\","
282*67e74705SXin Li "\"file\":\"" + FileName + "\"}]").str(),
283*67e74705SXin Li ErrorMessage);
284*67e74705SXin Li EXPECT_TRUE(NotFound.Directory.empty()) << ErrorMessage;
285*67e74705SXin Li EXPECT_TRUE(NotFound.CommandLine.empty()) << ErrorMessage;
286*67e74705SXin Li }
287*67e74705SXin Li
TEST(findCompileArgsInJsonDatabase,ReadsCompileCommandLinesWithSpaces)288*67e74705SXin Li TEST(findCompileArgsInJsonDatabase, ReadsCompileCommandLinesWithSpaces) {
289*67e74705SXin Li StringRef Directory("//net/some/directory");
290*67e74705SXin Li StringRef FileName("//net/path/to/a-file.cpp");
291*67e74705SXin Li StringRef Command("\\\"//net/path to compiler\\\" \\\"and an argument\\\"");
292*67e74705SXin Li std::string ErrorMessage;
293*67e74705SXin Li CompileCommand FoundCommand = findCompileArgsInJsonDatabase(
294*67e74705SXin Li FileName,
295*67e74705SXin Li ("[{\"directory\":\"" + Directory + "\"," +
296*67e74705SXin Li "\"command\":\"" + Command + "\","
297*67e74705SXin Li "\"file\":\"" + FileName + "\"}]").str(),
298*67e74705SXin Li ErrorMessage);
299*67e74705SXin Li ASSERT_EQ(2u, FoundCommand.CommandLine.size());
300*67e74705SXin Li EXPECT_EQ("//net/path to compiler",
301*67e74705SXin Li FoundCommand.CommandLine[0]) << ErrorMessage;
302*67e74705SXin Li EXPECT_EQ("and an argument", FoundCommand.CommandLine[1]) << ErrorMessage;
303*67e74705SXin Li }
304*67e74705SXin Li
TEST(findCompileArgsInJsonDatabase,ReadsDirectoryWithSpaces)305*67e74705SXin Li TEST(findCompileArgsInJsonDatabase, ReadsDirectoryWithSpaces) {
306*67e74705SXin Li StringRef Directory("//net/some directory / with spaces");
307*67e74705SXin Li StringRef FileName("//net/path/to/a-file.cpp");
308*67e74705SXin Li StringRef Command("a command");
309*67e74705SXin Li std::string ErrorMessage;
310*67e74705SXin Li CompileCommand FoundCommand = findCompileArgsInJsonDatabase(
311*67e74705SXin Li FileName,
312*67e74705SXin Li ("[{\"directory\":\"" + Directory + "\"," +
313*67e74705SXin Li "\"command\":\"" + Command + "\","
314*67e74705SXin Li "\"file\":\"" + FileName + "\"}]").str(),
315*67e74705SXin Li ErrorMessage);
316*67e74705SXin Li EXPECT_EQ(Directory, FoundCommand.Directory) << ErrorMessage;
317*67e74705SXin Li }
318*67e74705SXin Li
TEST(findCompileArgsInJsonDatabase,FindsEntry)319*67e74705SXin Li TEST(findCompileArgsInJsonDatabase, FindsEntry) {
320*67e74705SXin Li StringRef Directory("//net/directory");
321*67e74705SXin Li StringRef FileName("file");
322*67e74705SXin Li StringRef Command("command");
323*67e74705SXin Li std::string JsonDatabase = "[";
324*67e74705SXin Li for (int I = 0; I < 10; ++I) {
325*67e74705SXin Li if (I > 0) JsonDatabase += ",";
326*67e74705SXin Li JsonDatabase +=
327*67e74705SXin Li ("{\"directory\":\"" + Directory + Twine(I) + "\"," +
328*67e74705SXin Li "\"command\":\"" + Command + Twine(I) + "\","
329*67e74705SXin Li "\"file\":\"" + FileName + Twine(I) + "\"}").str();
330*67e74705SXin Li }
331*67e74705SXin Li JsonDatabase += "]";
332*67e74705SXin Li std::string ErrorMessage;
333*67e74705SXin Li CompileCommand FoundCommand = findCompileArgsInJsonDatabase(
334*67e74705SXin Li "//net/directory4/file4", JsonDatabase, ErrorMessage);
335*67e74705SXin Li EXPECT_EQ("//net/directory4", FoundCommand.Directory) << ErrorMessage;
336*67e74705SXin Li ASSERT_EQ(1u, FoundCommand.CommandLine.size()) << ErrorMessage;
337*67e74705SXin Li EXPECT_EQ("command4", FoundCommand.CommandLine[0]) << ErrorMessage;
338*67e74705SXin Li }
339*67e74705SXin Li
unescapeJsonCommandLine(StringRef Command)340*67e74705SXin Li static std::vector<std::string> unescapeJsonCommandLine(StringRef Command) {
341*67e74705SXin Li std::string JsonDatabase =
342*67e74705SXin Li ("[{\"directory\":\"//net/root\", \"file\":\"test\", \"command\": \"" +
343*67e74705SXin Li Command + "\"}]").str();
344*67e74705SXin Li std::string ErrorMessage;
345*67e74705SXin Li CompileCommand FoundCommand = findCompileArgsInJsonDatabase(
346*67e74705SXin Li "//net/root/test", JsonDatabase, ErrorMessage);
347*67e74705SXin Li EXPECT_TRUE(ErrorMessage.empty()) << ErrorMessage;
348*67e74705SXin Li return FoundCommand.CommandLine;
349*67e74705SXin Li }
350*67e74705SXin Li
TEST(unescapeJsonCommandLine,ReturnsEmptyArrayOnEmptyString)351*67e74705SXin Li TEST(unescapeJsonCommandLine, ReturnsEmptyArrayOnEmptyString) {
352*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine("");
353*67e74705SXin Li EXPECT_TRUE(Result.empty());
354*67e74705SXin Li }
355*67e74705SXin Li
TEST(unescapeJsonCommandLine,SplitsOnSpaces)356*67e74705SXin Li TEST(unescapeJsonCommandLine, SplitsOnSpaces) {
357*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine("a b c");
358*67e74705SXin Li ASSERT_EQ(3ul, Result.size());
359*67e74705SXin Li EXPECT_EQ("a", Result[0]);
360*67e74705SXin Li EXPECT_EQ("b", Result[1]);
361*67e74705SXin Li EXPECT_EQ("c", Result[2]);
362*67e74705SXin Li }
363*67e74705SXin Li
TEST(unescapeJsonCommandLine,MungesMultipleSpaces)364*67e74705SXin Li TEST(unescapeJsonCommandLine, MungesMultipleSpaces) {
365*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine(" a b ");
366*67e74705SXin Li ASSERT_EQ(2ul, Result.size());
367*67e74705SXin Li EXPECT_EQ("a", Result[0]);
368*67e74705SXin Li EXPECT_EQ("b", Result[1]);
369*67e74705SXin Li }
370*67e74705SXin Li
TEST(unescapeJsonCommandLine,UnescapesBackslashCharacters)371*67e74705SXin Li TEST(unescapeJsonCommandLine, UnescapesBackslashCharacters) {
372*67e74705SXin Li std::vector<std::string> Backslash = unescapeJsonCommandLine("a\\\\\\\\");
373*67e74705SXin Li ASSERT_EQ(1ul, Backslash.size());
374*67e74705SXin Li EXPECT_EQ("a\\", Backslash[0]);
375*67e74705SXin Li std::vector<std::string> Quote = unescapeJsonCommandLine("a\\\\\\\"");
376*67e74705SXin Li ASSERT_EQ(1ul, Quote.size());
377*67e74705SXin Li EXPECT_EQ("a\"", Quote[0]);
378*67e74705SXin Li }
379*67e74705SXin Li
TEST(unescapeJsonCommandLine,DoesNotMungeSpacesBetweenQuotes)380*67e74705SXin Li TEST(unescapeJsonCommandLine, DoesNotMungeSpacesBetweenQuotes) {
381*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine("\\\" a b \\\"");
382*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
383*67e74705SXin Li EXPECT_EQ(" a b ", Result[0]);
384*67e74705SXin Li }
385*67e74705SXin Li
TEST(unescapeJsonCommandLine,AllowsMultipleQuotedArguments)386*67e74705SXin Li TEST(unescapeJsonCommandLine, AllowsMultipleQuotedArguments) {
387*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine(
388*67e74705SXin Li " \\\" a \\\" \\\" b \\\" ");
389*67e74705SXin Li ASSERT_EQ(2ul, Result.size());
390*67e74705SXin Li EXPECT_EQ(" a ", Result[0]);
391*67e74705SXin Li EXPECT_EQ(" b ", Result[1]);
392*67e74705SXin Li }
393*67e74705SXin Li
TEST(unescapeJsonCommandLine,AllowsEmptyArgumentsInQuotes)394*67e74705SXin Li TEST(unescapeJsonCommandLine, AllowsEmptyArgumentsInQuotes) {
395*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine(
396*67e74705SXin Li "\\\"\\\"\\\"\\\"");
397*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
398*67e74705SXin Li EXPECT_TRUE(Result[0].empty()) << Result[0];
399*67e74705SXin Li }
400*67e74705SXin Li
TEST(unescapeJsonCommandLine,ParsesEscapedQuotesInQuotedStrings)401*67e74705SXin Li TEST(unescapeJsonCommandLine, ParsesEscapedQuotesInQuotedStrings) {
402*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine(
403*67e74705SXin Li "\\\"\\\\\\\"\\\"");
404*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
405*67e74705SXin Li EXPECT_EQ("\"", Result[0]);
406*67e74705SXin Li }
407*67e74705SXin Li
TEST(unescapeJsonCommandLine,ParsesMultipleArgumentsWithEscapedCharacters)408*67e74705SXin Li TEST(unescapeJsonCommandLine, ParsesMultipleArgumentsWithEscapedCharacters) {
409*67e74705SXin Li std::vector<std::string> Result = unescapeJsonCommandLine(
410*67e74705SXin Li " \\\\\\\" \\\"a \\\\\\\" b \\\" \\\"and\\\\\\\\c\\\" \\\\\\\"");
411*67e74705SXin Li ASSERT_EQ(4ul, Result.size());
412*67e74705SXin Li EXPECT_EQ("\"", Result[0]);
413*67e74705SXin Li EXPECT_EQ("a \" b ", Result[1]);
414*67e74705SXin Li EXPECT_EQ("and\\c", Result[2]);
415*67e74705SXin Li EXPECT_EQ("\"", Result[3]);
416*67e74705SXin Li }
417*67e74705SXin Li
TEST(unescapeJsonCommandLine,ParsesStringsWithoutSpacesIntoSingleArgument)418*67e74705SXin Li TEST(unescapeJsonCommandLine, ParsesStringsWithoutSpacesIntoSingleArgument) {
419*67e74705SXin Li std::vector<std::string> QuotedNoSpaces = unescapeJsonCommandLine(
420*67e74705SXin Li "\\\"a\\\"\\\"b\\\"");
421*67e74705SXin Li ASSERT_EQ(1ul, QuotedNoSpaces.size());
422*67e74705SXin Li EXPECT_EQ("ab", QuotedNoSpaces[0]);
423*67e74705SXin Li
424*67e74705SXin Li std::vector<std::string> MixedNoSpaces = unescapeJsonCommandLine(
425*67e74705SXin Li "\\\"a\\\"bcd\\\"ef\\\"\\\"\\\"\\\"g\\\"");
426*67e74705SXin Li ASSERT_EQ(1ul, MixedNoSpaces.size());
427*67e74705SXin Li EXPECT_EQ("abcdefg", MixedNoSpaces[0]);
428*67e74705SXin Li }
429*67e74705SXin Li
TEST(unescapeJsonCommandLine,ParsesQuotedStringWithoutClosingQuote)430*67e74705SXin Li TEST(unescapeJsonCommandLine, ParsesQuotedStringWithoutClosingQuote) {
431*67e74705SXin Li std::vector<std::string> Unclosed = unescapeJsonCommandLine("\\\"abc");
432*67e74705SXin Li ASSERT_EQ(1ul, Unclosed.size());
433*67e74705SXin Li EXPECT_EQ("abc", Unclosed[0]);
434*67e74705SXin Li
435*67e74705SXin Li std::vector<std::string> Empty = unescapeJsonCommandLine("\\\"");
436*67e74705SXin Li ASSERT_EQ(1ul, Empty.size());
437*67e74705SXin Li EXPECT_EQ("", Empty[0]);
438*67e74705SXin Li }
439*67e74705SXin Li
TEST(unescapeJsonCommandLine,ParsesSingleQuotedString)440*67e74705SXin Li TEST(unescapeJsonCommandLine, ParsesSingleQuotedString) {
441*67e74705SXin Li std::vector<std::string> Args = unescapeJsonCommandLine("a'\\\\b \\\"c\\\"'");
442*67e74705SXin Li ASSERT_EQ(1ul, Args.size());
443*67e74705SXin Li EXPECT_EQ("a\\b \"c\"", Args[0]);
444*67e74705SXin Li }
445*67e74705SXin Li
TEST(FixedCompilationDatabase,ReturnsFixedCommandLine)446*67e74705SXin Li TEST(FixedCompilationDatabase, ReturnsFixedCommandLine) {
447*67e74705SXin Li std::vector<std::string> CommandLine;
448*67e74705SXin Li CommandLine.push_back("one");
449*67e74705SXin Li CommandLine.push_back("two");
450*67e74705SXin Li FixedCompilationDatabase Database(".", CommandLine);
451*67e74705SXin Li StringRef FileName("source");
452*67e74705SXin Li std::vector<CompileCommand> Result =
453*67e74705SXin Li Database.getCompileCommands(FileName);
454*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
455*67e74705SXin Li std::vector<std::string> ExpectedCommandLine(1, "clang-tool");
456*67e74705SXin Li ExpectedCommandLine.insert(ExpectedCommandLine.end(),
457*67e74705SXin Li CommandLine.begin(), CommandLine.end());
458*67e74705SXin Li ExpectedCommandLine.push_back("source");
459*67e74705SXin Li EXPECT_EQ(".", Result[0].Directory);
460*67e74705SXin Li EXPECT_EQ(FileName, Result[0].Filename);
461*67e74705SXin Li EXPECT_EQ(ExpectedCommandLine, Result[0].CommandLine);
462*67e74705SXin Li }
463*67e74705SXin Li
TEST(FixedCompilationDatabase,GetAllFiles)464*67e74705SXin Li TEST(FixedCompilationDatabase, GetAllFiles) {
465*67e74705SXin Li std::vector<std::string> CommandLine;
466*67e74705SXin Li CommandLine.push_back("one");
467*67e74705SXin Li CommandLine.push_back("two");
468*67e74705SXin Li FixedCompilationDatabase Database(".", CommandLine);
469*67e74705SXin Li
470*67e74705SXin Li EXPECT_EQ(0ul, Database.getAllFiles().size());
471*67e74705SXin Li }
472*67e74705SXin Li
TEST(FixedCompilationDatabase,GetAllCompileCommands)473*67e74705SXin Li TEST(FixedCompilationDatabase, GetAllCompileCommands) {
474*67e74705SXin Li std::vector<std::string> CommandLine;
475*67e74705SXin Li CommandLine.push_back("one");
476*67e74705SXin Li CommandLine.push_back("two");
477*67e74705SXin Li FixedCompilationDatabase Database(".", CommandLine);
478*67e74705SXin Li
479*67e74705SXin Li EXPECT_EQ(0ul, Database.getAllCompileCommands().size());
480*67e74705SXin Li }
481*67e74705SXin Li
TEST(ParseFixedCompilationDatabase,ReturnsNullOnEmptyArgumentList)482*67e74705SXin Li TEST(ParseFixedCompilationDatabase, ReturnsNullOnEmptyArgumentList) {
483*67e74705SXin Li int Argc = 0;
484*67e74705SXin Li std::unique_ptr<FixedCompilationDatabase> Database(
485*67e74705SXin Li FixedCompilationDatabase::loadFromCommandLine(Argc, nullptr));
486*67e74705SXin Li EXPECT_FALSE(Database);
487*67e74705SXin Li EXPECT_EQ(0, Argc);
488*67e74705SXin Li }
489*67e74705SXin Li
TEST(ParseFixedCompilationDatabase,ReturnsNullWithoutDoubleDash)490*67e74705SXin Li TEST(ParseFixedCompilationDatabase, ReturnsNullWithoutDoubleDash) {
491*67e74705SXin Li int Argc = 2;
492*67e74705SXin Li const char *Argv[] = { "1", "2" };
493*67e74705SXin Li std::unique_ptr<FixedCompilationDatabase> Database(
494*67e74705SXin Li FixedCompilationDatabase::loadFromCommandLine(Argc, Argv));
495*67e74705SXin Li EXPECT_FALSE(Database);
496*67e74705SXin Li EXPECT_EQ(2, Argc);
497*67e74705SXin Li }
498*67e74705SXin Li
TEST(ParseFixedCompilationDatabase,ReturnsArgumentsAfterDoubleDash)499*67e74705SXin Li TEST(ParseFixedCompilationDatabase, ReturnsArgumentsAfterDoubleDash) {
500*67e74705SXin Li int Argc = 5;
501*67e74705SXin Li const char *Argv[] = {
502*67e74705SXin Li "1", "2", "--\0no-constant-folding", "-DDEF3", "-DDEF4"
503*67e74705SXin Li };
504*67e74705SXin Li std::unique_ptr<FixedCompilationDatabase> Database(
505*67e74705SXin Li FixedCompilationDatabase::loadFromCommandLine(Argc, Argv));
506*67e74705SXin Li ASSERT_TRUE((bool)Database);
507*67e74705SXin Li std::vector<CompileCommand> Result =
508*67e74705SXin Li Database->getCompileCommands("source");
509*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
510*67e74705SXin Li ASSERT_EQ(".", Result[0].Directory);
511*67e74705SXin Li std::vector<std::string> CommandLine;
512*67e74705SXin Li CommandLine.push_back("clang-tool");
513*67e74705SXin Li CommandLine.push_back("-DDEF3");
514*67e74705SXin Li CommandLine.push_back("-DDEF4");
515*67e74705SXin Li CommandLine.push_back("source");
516*67e74705SXin Li ASSERT_EQ(CommandLine, Result[0].CommandLine);
517*67e74705SXin Li EXPECT_EQ(2, Argc);
518*67e74705SXin Li }
519*67e74705SXin Li
TEST(ParseFixedCompilationDatabase,ReturnsEmptyCommandLine)520*67e74705SXin Li TEST(ParseFixedCompilationDatabase, ReturnsEmptyCommandLine) {
521*67e74705SXin Li int Argc = 3;
522*67e74705SXin Li const char *Argv[] = { "1", "2", "--\0no-constant-folding" };
523*67e74705SXin Li std::unique_ptr<FixedCompilationDatabase> Database(
524*67e74705SXin Li FixedCompilationDatabase::loadFromCommandLine(Argc, Argv));
525*67e74705SXin Li ASSERT_TRUE((bool)Database);
526*67e74705SXin Li std::vector<CompileCommand> Result =
527*67e74705SXin Li Database->getCompileCommands("source");
528*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
529*67e74705SXin Li ASSERT_EQ(".", Result[0].Directory);
530*67e74705SXin Li std::vector<std::string> CommandLine;
531*67e74705SXin Li CommandLine.push_back("clang-tool");
532*67e74705SXin Li CommandLine.push_back("source");
533*67e74705SXin Li ASSERT_EQ(CommandLine, Result[0].CommandLine);
534*67e74705SXin Li EXPECT_EQ(2, Argc);
535*67e74705SXin Li }
536*67e74705SXin Li
TEST(ParseFixedCompilationDatabase,HandlesPositionalArgs)537*67e74705SXin Li TEST(ParseFixedCompilationDatabase, HandlesPositionalArgs) {
538*67e74705SXin Li const char *Argv[] = {"1", "2", "--", "-c", "somefile.cpp", "-DDEF3"};
539*67e74705SXin Li int Argc = sizeof(Argv) / sizeof(char*);
540*67e74705SXin Li std::unique_ptr<FixedCompilationDatabase> Database(
541*67e74705SXin Li FixedCompilationDatabase::loadFromCommandLine(Argc, Argv));
542*67e74705SXin Li ASSERT_TRUE((bool)Database);
543*67e74705SXin Li std::vector<CompileCommand> Result =
544*67e74705SXin Li Database->getCompileCommands("source");
545*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
546*67e74705SXin Li ASSERT_EQ(".", Result[0].Directory);
547*67e74705SXin Li std::vector<std::string> Expected;
548*67e74705SXin Li Expected.push_back("clang-tool");
549*67e74705SXin Li Expected.push_back("-c");
550*67e74705SXin Li Expected.push_back("-DDEF3");
551*67e74705SXin Li Expected.push_back("source");
552*67e74705SXin Li ASSERT_EQ(Expected, Result[0].CommandLine);
553*67e74705SXin Li EXPECT_EQ(2, Argc);
554*67e74705SXin Li }
555*67e74705SXin Li
TEST(ParseFixedCompilationDatabase,HandlesArgv0)556*67e74705SXin Li TEST(ParseFixedCompilationDatabase, HandlesArgv0) {
557*67e74705SXin Li const char *Argv[] = {"1", "2", "--", "mytool", "somefile.cpp"};
558*67e74705SXin Li int Argc = sizeof(Argv) / sizeof(char*);
559*67e74705SXin Li std::unique_ptr<FixedCompilationDatabase> Database(
560*67e74705SXin Li FixedCompilationDatabase::loadFromCommandLine(Argc, Argv));
561*67e74705SXin Li ASSERT_TRUE((bool)Database);
562*67e74705SXin Li std::vector<CompileCommand> Result =
563*67e74705SXin Li Database->getCompileCommands("source");
564*67e74705SXin Li ASSERT_EQ(1ul, Result.size());
565*67e74705SXin Li ASSERT_EQ(".", Result[0].Directory);
566*67e74705SXin Li std::vector<std::string> Expected;
567*67e74705SXin Li Expected.push_back("clang-tool");
568*67e74705SXin Li Expected.push_back("source");
569*67e74705SXin Li ASSERT_EQ(Expected, Result[0].CommandLine);
570*67e74705SXin Li EXPECT_EQ(2, Argc);
571*67e74705SXin Li }
572*67e74705SXin Li
573*67e74705SXin Li } // end namespace tooling
574*67e74705SXin Li } // end namespace clang
575