1 //===- llvm/unittest/Support/Path.cpp - Path tests ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/Path.h"
11 #include "llvm/Support/ErrorHandling.h"
12 #include "llvm/Support/FileSystem.h"
13 #include "llvm/Support/MemoryBuffer.h"
14 #include "llvm/Support/raw_ostream.h"
15 #include "gtest/gtest.h"
18 using namespace llvm::sys;
20 #define ASSERT_NO_ERROR(x) \
21 if (error_code ASSERT_NO_ERROR_ec = x) { \
22 SmallString<128> MessageStorage; \
23 raw_svector_ostream Message(MessageStorage); \
24 Message << #x ": did not return errc::success.\n" \
25 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
26 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
27 GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \
32 TEST(is_separator, Works) {
33 EXPECT_TRUE(path::is_separator('/'));
34 EXPECT_FALSE(path::is_separator('\0'));
35 EXPECT_FALSE(path::is_separator('-'));
36 EXPECT_FALSE(path::is_separator(' '));
39 EXPECT_TRUE(path::is_separator('\\'));
41 EXPECT_FALSE(path::is_separator('\\'));
46 SmallVector<StringRef, 40> paths;
49 paths.push_back("..");
50 paths.push_back("foo");
52 paths.push_back("/foo");
53 paths.push_back("foo/");
54 paths.push_back("/foo/");
55 paths.push_back("foo/bar");
56 paths.push_back("/foo/bar");
57 paths.push_back("//net");
58 paths.push_back("//net/foo");
59 paths.push_back("///foo///");
60 paths.push_back("///foo///bar");
61 paths.push_back("/.");
62 paths.push_back("./");
63 paths.push_back("/..");
64 paths.push_back("../");
65 paths.push_back("foo/.");
66 paths.push_back("foo/..");
67 paths.push_back("foo/./");
68 paths.push_back("foo/./bar");
69 paths.push_back("foo/..");
70 paths.push_back("foo/../");
71 paths.push_back("foo/../bar");
72 paths.push_back("c:");
73 paths.push_back("c:/");
74 paths.push_back("c:foo");
75 paths.push_back("c:/foo");
76 paths.push_back("c:foo/");
77 paths.push_back("c:/foo/");
78 paths.push_back("c:/foo/bar");
79 paths.push_back("prn:");
80 paths.push_back("c:\\");
81 paths.push_back("c:foo");
82 paths.push_back("c:\\foo");
83 paths.push_back("c:foo\\");
84 paths.push_back("c:\\foo\\");
85 paths.push_back("c:\\foo/");
86 paths.push_back("c:/foo\\bar");
88 for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
92 for (sys::path::const_iterator ci = sys::path::begin(*i),
93 ce = sys::path::end(*i);
96 ASSERT_FALSE(ci->empty());
99 #if 0 // Valgrind is whining about this.
100 outs() << " Reverse Iteration: [";
101 for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
102 ce = sys::path::rend(*i);
105 outs() << *ci << ',';
110 path::has_root_path(*i);
112 path::has_root_name(*i);
114 path::has_root_directory(*i);
115 path::root_directory(*i);
116 path::has_parent_path(*i);
117 path::parent_path(*i);
118 path::has_filename(*i);
122 path::has_extension(*i);
124 path::is_absolute(*i);
125 path::is_relative(*i);
127 SmallString<128> temp_store;
129 ASSERT_NO_ERROR(fs::make_absolute(temp_store));
131 path::remove_filename(temp_store);
134 path::replace_extension(temp_store, "ext");
135 StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
136 stem = path::stem(filename);
137 ext = path::extension(filename);
138 EXPECT_EQ(*(--sys::path::end(filename)), (stem + ext).str());
140 path::native(*i, temp_store);
144 class FileSystemTest : public testing::Test {
146 /// Unique temporary directory in which all created filesystem entities must
147 /// be placed. It is recursively removed at the end of each test.
148 SmallString<128> TestDirectory;
150 virtual void SetUp() {
152 fs::createUniqueDirectory("file-system-test", TestDirectory));
153 // We don't care about this specific file.
154 errs() << "Test Directory: " << TestDirectory << '\n';
158 virtual void TearDown() {
160 ASSERT_NO_ERROR(fs::remove_all(TestDirectory.str(), removed));
164 TEST_F(FileSystemTest, Unique) {
165 // Create a temp file.
167 SmallString<64> TempPath;
169 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
171 // The same file should return an identical unique id.
173 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
174 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
177 // Different files should return different unique ids.
179 SmallString<64> TempPath2;
181 fs::createTemporaryFile("prefix", "temp", FileDescriptor2, TempPath2));
184 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
186 ::close(FileDescriptor2);
188 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
190 // Two paths representing the same file on disk should still provide the
191 // same unique id. We can test this by making a hard link.
192 ASSERT_NO_ERROR(fs::create_hard_link(Twine(TempPath), Twine(TempPath2)));
194 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
197 ::close(FileDescriptor);
200 TEST_F(FileSystemTest, TempFiles) {
201 // Create a temp file.
203 SmallString<64> TempPath;
205 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
207 // Make sure it exists.
209 ASSERT_NO_ERROR(sys::fs::exists(Twine(TempPath), TempFileExists));
210 EXPECT_TRUE(TempFileExists);
212 // Create another temp tile.
214 SmallString<64> TempPath2;
215 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD2, TempPath2));
216 ASSERT_TRUE(TempPath2.endswith(".temp"));
217 ASSERT_NE(TempPath.str(), TempPath2.str());
219 fs::file_status A, B;
220 ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
221 ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
222 EXPECT_FALSE(fs::equivalent(A, B));
227 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
228 EXPECT_TRUE(TempFileExists);
230 // Make sure Temp2 doesn't exist.
231 ASSERT_NO_ERROR(fs::exists(Twine(TempPath2), TempFileExists));
232 EXPECT_FALSE(TempFileExists);
234 SmallString<64> TempPath3;
235 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "", TempPath3));
236 ASSERT_FALSE(TempPath3.endswith("."));
238 // Create a hard link to Temp1.
239 ASSERT_NO_ERROR(fs::create_hard_link(Twine(TempPath), Twine(TempPath2)));
241 ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
243 ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
244 ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
245 EXPECT_TRUE(fs::equivalent(A, B));
248 ::close(FileDescriptor);
249 ASSERT_NO_ERROR(fs::remove(Twine(TempPath), TempFileExists));
250 EXPECT_TRUE(TempFileExists);
252 // Remove the hard link.
253 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
254 EXPECT_TRUE(TempFileExists);
256 // Make sure Temp1 doesn't exist.
257 ASSERT_NO_ERROR(fs::exists(Twine(TempPath), TempFileExists));
258 EXPECT_FALSE(TempFileExists);
261 // Path name > 260 chars should get an error.
262 const char *Path270 =
263 "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
264 "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
265 "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
266 "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
267 "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
268 EXPECT_EQ(fs::createUniqueFile(Twine(Path270), FileDescriptor, TempPath),
269 windows_error::path_not_found);
273 TEST_F(FileSystemTest, DirectoryIteration) {
275 for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
278 // Create a known hierarchy to recurse over.
280 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
281 + "/recursive/a0/aa1", existed));
282 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
283 + "/recursive/a0/ab1", existed));
284 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
285 + "/recursive/dontlookhere/da1", existed));
286 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
287 + "/recursive/z0/za1", existed));
288 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
289 + "/recursive/pop/p1", existed));
290 typedef std::vector<std::string> v_t;
292 for (fs::recursive_directory_iterator i(Twine(TestDirectory)
293 + "/recursive", ec), e; i != e; i.increment(ec)){
295 if (path::filename(i->path()) == "p1") {
297 // FIXME: recursive_directory_iterator should be more robust.
300 if (path::filename(i->path()) == "dontlookhere")
302 visited.push_back(path::filename(i->path()));
304 v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
305 v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
306 v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
307 v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
309 v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
310 v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
311 v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
312 v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
313 v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
315 // Make sure that each path was visited correctly.
316 ASSERT_NE(a0, visited.end());
317 ASSERT_NE(aa1, visited.end());
318 ASSERT_NE(ab1, visited.end());
319 ASSERT_NE(dontlookhere, visited.end());
320 ASSERT_EQ(da1, visited.end()); // Not visited.
321 ASSERT_NE(z0, visited.end());
322 ASSERT_NE(za1, visited.end());
323 ASSERT_NE(pop, visited.end());
324 ASSERT_EQ(p1, visited.end()); // Not visited.
326 // Make sure that parents were visited before children. No other ordering
327 // guarantees can be made across siblings.
333 const char elf[] = {0x7f, 'E', 'L', 'F', 1, 2, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1};
335 TEST_F(FileSystemTest, Magic) {
337 const char *filename;
338 const char *magic_str;
339 size_t magic_str_len;
340 fs::file_magic magic;
342 {"magic.archive", "!<arch>\x0A", 8, fs::file_magic::archive},
343 {"magic.elf", elf, sizeof(elf),
344 fs::file_magic::elf_relocatable}
347 // Create some files filled with magic.
348 for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
350 SmallString<128> file_pathname(TestDirectory);
351 path::append(file_pathname, i->filename);
353 raw_fd_ostream file(file_pathname.c_str(), ErrMsg, sys::fs::F_Binary);
354 ASSERT_FALSE(file.has_error());
355 StringRef magic(i->magic_str, i->magic_str_len);
359 ASSERT_NO_ERROR(fs::has_magic(file_pathname.c_str(), magic, res));
361 EXPECT_EQ(i->magic, fs::identify_magic(magic));
366 TEST_F(FileSystemTest, CarriageReturn) {
367 SmallString<128> FilePathname(TestDirectory);
369 path::append(FilePathname, "test");
372 raw_fd_ostream File(FilePathname.c_str(), ErrMsg);
373 EXPECT_EQ(ErrMsg, "");
377 OwningPtr<MemoryBuffer> Buf;
378 MemoryBuffer::getFile(FilePathname, Buf);
379 EXPECT_EQ(Buf->getBuffer(), "\r\n");
383 raw_fd_ostream File(FilePathname.c_str(), ErrMsg, sys::fs::F_Binary);
384 EXPECT_EQ(ErrMsg, "");
388 OwningPtr<MemoryBuffer> Buf;
389 MemoryBuffer::getFile(FilePathname, Buf);
390 EXPECT_EQ(Buf->getBuffer(), "\n");
395 TEST_F(FileSystemTest, FileMapping) {
396 // Create a temp file.
398 SmallString<64> TempPath;
400 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
401 // Map in temp file and add some content
403 StringRef Val("hello there");
405 fs::mapped_file_region mfr(FileDescriptor,
407 fs::mapped_file_region::readwrite,
412 std::copy(Val.begin(), Val.end(), mfr.data());
413 // Explicitly add a 0.
414 mfr.data()[Val.size()] = 0;
418 // Map it back in read-only
419 fs::mapped_file_region mfr(Twine(TempPath),
420 fs::mapped_file_region::readonly,
427 EXPECT_EQ(StringRef(mfr.const_data()), Val);
431 #if LLVM_HAS_RVALUE_REFERENCES
432 fs::mapped_file_region m(Twine(TempPath),
433 fs::mapped_file_region::readonly,
438 const char *Data = m.const_data();
439 fs::mapped_file_region mfrrv(llvm_move(m));
440 EXPECT_EQ(mfrrv.const_data(), Data);
443 } // anonymous namespace