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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
| //===-- FileCollectorTest.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 "gmock/gmock.h"
#include "gtest/gtest.h"
#include "llvm/Support/FileCollector.h"
#include "llvm/Support/FileSystem.h"
using namespace llvm;
namespace llvm {
namespace vfs {
inline bool operator==(const llvm::vfs::YAMLVFSEntry &LHS,
const llvm::vfs::YAMLVFSEntry &RHS) {
return LHS.VPath == RHS.VPath && LHS.RPath == RHS.RPath;
}
} // namespace vfs
} // namespace llvm
namespace {
class TestingFileCollector : public FileCollector {
public:
using FileCollector::FileCollector;
using FileCollector::Root;
using FileCollector::Seen;
using FileCollector::SymlinkMap;
using FileCollector::VFSWriter;
bool hasSeen(StringRef fs) {
return Seen.find(fs) != Seen.end();
}
};
struct ScopedDir {
SmallString<128> Path;
ScopedDir(const Twine &Name, bool Unique = false) {
std::error_code EC;
if (Unique) {
EC = llvm::sys::fs::createUniqueDirectory(Name, Path);
} else {
Path = Name.str();
EC = llvm::sys::fs::create_directory(Twine(Path));
}
if (EC)
Path = "";
EXPECT_FALSE(EC);
// Ensure the path is the real path so tests can use it to compare against
// realpath output.
SmallString<128> RealPath;
if (!llvm::sys::fs::real_path(Path, RealPath))
Path.swap(RealPath);
}
~ScopedDir() {
if (Path != "") {
EXPECT_FALSE(llvm::sys::fs::remove_directories(Path.str()));
}
}
operator StringRef() { return Path.str(); }
};
struct ScopedLink {
SmallString<128> Path;
ScopedLink(const Twine &To, const Twine &From) {
Path = From.str();
std::error_code EC = sys::fs::create_link(To, From);
if (EC)
Path = "";
EXPECT_FALSE(EC);
}
~ScopedLink() {
if (Path != "") {
EXPECT_FALSE(llvm::sys::fs::remove(Path.str()));
}
}
operator StringRef() { return Path.str(); }
};
struct ScopedFile {
SmallString<128> Path;
ScopedFile(const Twine &Name) {
std::error_code EC;
EC = llvm::sys::fs::createUniqueFile(Name, Path);
if (EC)
Path = "";
EXPECT_FALSE(EC);
}
~ScopedFile() {
if (Path != "") {
EXPECT_FALSE(llvm::sys::fs::remove(Path.str()));
}
}
operator StringRef() { return Path.str(); }
};
} // end anonymous namespace
TEST(FileCollectorTest, addFile) {
ScopedDir root("add_file_root", true);
std::string root_fs = root.Path.str();
TestingFileCollector FileCollector(root_fs, root_fs);
FileCollector.addFile("/path/to/a");
FileCollector.addFile("/path/to/b");
FileCollector.addFile("/path/to/c");
// Make sure the root is correct.
EXPECT_EQ(FileCollector.Root, root_fs);
// Make sure we've seen all the added files.
EXPECT_TRUE(FileCollector.hasSeen("/path/to/a"));
EXPECT_TRUE(FileCollector.hasSeen("/path/to/b"));
EXPECT_TRUE(FileCollector.hasSeen("/path/to/c"));
// Make sure we've only seen the added files.
EXPECT_FALSE(FileCollector.hasSeen("/path/to/d"));
}
TEST(FileCollectorTest, copyFiles) {
ScopedDir file_root("file_root", true);
ScopedFile a(file_root + "/aaa");
ScopedFile b(file_root + "/bbb");
ScopedFile c(file_root + "/ccc");
// Create file collector and add files.
ScopedDir root("copy_files_root", true);
std::string root_fs = root.Path.str();
TestingFileCollector FileCollector(root_fs, root_fs);
FileCollector.addFile(a.Path);
FileCollector.addFile(b.Path);
FileCollector.addFile(c.Path);
// Make sure we can copy the files.
std::error_code ec = FileCollector.copyFiles(true);
EXPECT_FALSE(ec);
// Now add a bogus file and make sure we error out.
FileCollector.addFile("/some/bogus/file");
ec = FileCollector.copyFiles(true);
EXPECT_TRUE(ec);
// However, if stop_on_error is true the copy should still succeed.
ec = FileCollector.copyFiles(false);
EXPECT_FALSE(ec);
}
TEST(FileCollectorTest, recordAndConstructDirectory) {
ScopedDir file_root("dir_root", true);
ScopedDir subdir(file_root + "/subdir");
ScopedDir subdir2(file_root + "/subdir2");
ScopedFile a(subdir2 + "/a");
// Create file collector and add files.
ScopedDir root("copy_files_root", true);
std::string root_fs = root.Path.str();
TestingFileCollector FileCollector(root_fs, root_fs);
FileCollector.addFile(a.Path);
// The empty directory isn't seen until we add it.
EXPECT_TRUE(FileCollector.hasSeen(a.Path));
EXPECT_FALSE(FileCollector.hasSeen(subdir.Path));
FileCollector.addFile(subdir.Path);
EXPECT_TRUE(FileCollector.hasSeen(subdir.Path));
// Make sure we can construct the directory.
std::error_code ec = FileCollector.copyFiles(true);
EXPECT_FALSE(ec);
bool IsDirectory = false;
llvm::SmallString<128> SubdirInRoot = root.Path;
llvm::sys::path::append(SubdirInRoot,
llvm::sys::path::relative_path(subdir.Path));
ec = sys::fs::is_directory(SubdirInRoot, IsDirectory);
EXPECT_FALSE(ec);
ASSERT_TRUE(IsDirectory);
}
TEST(FileCollectorTest, recordVFSAccesses) {
ScopedDir file_root("dir_root", true);
ScopedDir subdir(file_root + "/subdir");
ScopedDir subdir2(file_root + "/subdir2");
ScopedFile a(subdir2 + "/a");
ScopedFile b(file_root + "/b");
ScopedDir subdir3(file_root + "/subdir3");
ScopedFile subdir3a(subdir3 + "/aa");
ScopedDir subdir3b(subdir3 + "/subdirb");
{
ScopedFile subdir3fileremoved(subdir3 + "/removed");
}
// Create file collector and add files.
ScopedDir root("copy_files_root", true);
std::string root_fs = root.Path.str();
auto Collector = std::make_shared<TestingFileCollector>(root_fs, root_fs);
auto VFS =
FileCollector::createCollectorVFS(vfs::getRealFileSystem(), Collector);
VFS->status(a.Path);
EXPECT_TRUE(Collector->hasSeen(a.Path));
VFS->openFileForRead(b.Path);
EXPECT_TRUE(Collector->hasSeen(b.Path));
VFS->status(subdir.Path);
EXPECT_TRUE(Collector->hasSeen(subdir.Path));
#ifndef _WIN32
std::error_code EC;
auto It = VFS->dir_begin(subdir3.Path, EC);
EXPECT_FALSE(EC);
EXPECT_TRUE(Collector->hasSeen(subdir3.Path));
EXPECT_TRUE(Collector->hasSeen(subdir3a.Path));
EXPECT_TRUE(Collector->hasSeen(subdir3b.Path));
std::string RemovedFileName = (Twine(subdir3.Path) + "/removed").str();
EXPECT_FALSE(Collector->hasSeen(RemovedFileName));
#endif
}
#ifndef _WIN32
TEST(FileCollectorTest, Symlinks) {
// Root where the original files live.
ScopedDir file_root("file_root", true);
// Create some files in the file root.
ScopedFile a(file_root + "/aaa");
ScopedFile b(file_root + "/bbb");
ScopedFile c(file_root + "/ccc");
// Create a directory foo with file ddd.
ScopedDir foo(file_root + "/foo");
ScopedFile d(foo + "/ddd");
// Create a file eee in the foo's parent directory.
ScopedFile e(foo + "/../eee");
// Create a symlink bar pointing to foo.
ScopedLink symlink(file_root + "/foo", file_root + "/bar");
// Root where files are copied to.
ScopedDir reproducer_root("reproducer_root", true);
std::string root_fs = reproducer_root.Path.str();
TestingFileCollector FileCollector(root_fs, root_fs);
// Add all the files to the collector.
FileCollector.addFile(a.Path);
FileCollector.addFile(b.Path);
FileCollector.addFile(c.Path);
FileCollector.addFile(d.Path);
FileCollector.addFile(e.Path);
FileCollector.addFile(file_root + "/bar/ddd");
auto mapping = FileCollector.VFSWriter.getMappings();
{
// Make sure the common case works.
std::string vpath = (file_root + "/aaa").str();
std::string rpath = (reproducer_root.Path + file_root.Path + "/aaa").str();
printf("%s -> %s\n", vpath.c_str(), rpath.c_str());
EXPECT_THAT(mapping, testing::Contains(vfs::YAMLVFSEntry(vpath, rpath)));
}
{
// Make sure the virtual path points to the real source path.
std::string vpath = (file_root + "/bar/ddd").str();
std::string rpath =
(reproducer_root.Path + file_root.Path + "/foo/ddd").str();
printf("%s -> %s\n", vpath.c_str(), rpath.c_str());
EXPECT_THAT(mapping, testing::Contains(vfs::YAMLVFSEntry(vpath, rpath)));
}
{
// Make sure that .. is removed from the source path.
std::string vpath = (file_root + "/eee").str();
std::string rpath = (reproducer_root.Path + file_root.Path + "/eee").str();
printf("%s -> %s\n", vpath.c_str(), rpath.c_str());
EXPECT_THAT(mapping, testing::Contains(vfs::YAMLVFSEntry(vpath, rpath)));
}
}
TEST(FileCollectorTest, recordVFSSymlinkAccesses) {
ScopedDir file_root("dir_root", true);
ScopedFile a(file_root + "/a");
ScopedLink symlink(file_root + "/a", file_root + "/b");
// Create file collector and add files.
ScopedDir root("copy_files_root", true);
std::string root_fs = root.Path.str();
auto Collector = std::make_shared<TestingFileCollector>(root_fs, root_fs);
auto VFS =
FileCollector::createCollectorVFS(vfs::getRealFileSystem(), Collector);
SmallString<256> Output;
VFS->getRealPath(symlink.Path, Output);
EXPECT_TRUE(Collector->hasSeen(a.Path));
EXPECT_TRUE(Collector->hasSeen(symlink.Path));
}
#endif
|