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/ADT/STLExtras.h"
12 #include "llvm/Support/ConvertUTF.h"
13 #include "llvm/Support/Errc.h"
14 #include "llvm/Support/ErrorHandling.h"
15 #include "llvm/Support/FileSystem.h"
16 #include "llvm/Support/FileUtilities.h"
17 #include "llvm/Support/MemoryBuffer.h"
18 #include "llvm/Support/raw_ostream.h"
19 #include "gtest/gtest.h"
22 #include "llvm/ADT/ArrayRef.h"
32 using namespace llvm::sys;
34 #define ASSERT_NO_ERROR(x) \
35 if (std::error_code ASSERT_NO_ERROR_ec = x) { \
36 SmallString<128> MessageStorage; \
37 raw_svector_ostream Message(MessageStorage); \
38 Message << #x ": did not return errc::success.\n" \
39 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
40 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
41 GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \
47 TEST(is_separator, Works) {
48 EXPECT_TRUE(path::is_separator('/'));
49 EXPECT_FALSE(path::is_separator('\0'));
50 EXPECT_FALSE(path::is_separator('-'));
51 EXPECT_FALSE(path::is_separator(' '));
54 EXPECT_TRUE(path::is_separator('\\'));
56 EXPECT_FALSE(path::is_separator('\\'));
61 SmallVector<StringRef, 40> paths;
64 paths.push_back("..");
65 paths.push_back("foo");
67 paths.push_back("/foo");
68 paths.push_back("foo/");
69 paths.push_back("/foo/");
70 paths.push_back("foo/bar");
71 paths.push_back("/foo/bar");
72 paths.push_back("//net");
73 paths.push_back("//net/foo");
74 paths.push_back("///foo///");
75 paths.push_back("///foo///bar");
76 paths.push_back("/.");
77 paths.push_back("./");
78 paths.push_back("/..");
79 paths.push_back("../");
80 paths.push_back("foo/.");
81 paths.push_back("foo/..");
82 paths.push_back("foo/./");
83 paths.push_back("foo/./bar");
84 paths.push_back("foo/..");
85 paths.push_back("foo/../");
86 paths.push_back("foo/../bar");
87 paths.push_back("c:");
88 paths.push_back("c:/");
89 paths.push_back("c:foo");
90 paths.push_back("c:/foo");
91 paths.push_back("c:foo/");
92 paths.push_back("c:/foo/");
93 paths.push_back("c:/foo/bar");
94 paths.push_back("prn:");
95 paths.push_back("c:\\");
96 paths.push_back("c:foo");
97 paths.push_back("c:\\foo");
98 paths.push_back("c:foo\\");
99 paths.push_back("c:\\foo\\");
100 paths.push_back("c:\\foo/");
101 paths.push_back("c:/foo\\bar");
103 SmallVector<StringRef, 5> ComponentStack;
104 for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
108 for (sys::path::const_iterator ci = sys::path::begin(*i),
109 ce = sys::path::end(*i);
112 ASSERT_FALSE(ci->empty());
113 ComponentStack.push_back(*ci);
116 for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
117 ce = sys::path::rend(*i);
120 ASSERT_TRUE(*ci == ComponentStack.back());
121 ComponentStack.pop_back();
123 ASSERT_TRUE(ComponentStack.empty());
125 // Crash test most of the API - since we're iterating over all of our paths
126 // here there isn't really anything reasonable to assert on in the results.
127 (void)path::has_root_path(*i);
128 (void)path::root_path(*i);
129 (void)path::has_root_name(*i);
130 (void)path::root_name(*i);
131 (void)path::has_root_directory(*i);
132 (void)path::root_directory(*i);
133 (void)path::has_parent_path(*i);
134 (void)path::parent_path(*i);
135 (void)path::has_filename(*i);
136 (void)path::filename(*i);
137 (void)path::has_stem(*i);
138 (void)path::stem(*i);
139 (void)path::has_extension(*i);
140 (void)path::extension(*i);
141 (void)path::is_absolute(*i);
142 (void)path::is_relative(*i);
144 SmallString<128> temp_store;
146 ASSERT_NO_ERROR(fs::make_absolute(temp_store));
148 path::remove_filename(temp_store);
151 path::replace_extension(temp_store, "ext");
152 StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
153 stem = path::stem(filename);
154 ext = path::extension(filename);
155 EXPECT_EQ(*sys::path::rbegin(filename), (stem + ext).str());
157 path::native(*i, temp_store);
160 SmallString<32> Relative("foo.cpp");
161 ASSERT_NO_ERROR(sys::fs::make_absolute("/root", Relative));
162 Relative[5] = '/'; // Fix up windows paths.
163 ASSERT_EQ("/root/foo.cpp", Relative);
166 TEST(Support, RelativePathIterator) {
167 SmallString<64> Path(StringRef("c/d/e/foo.txt"));
168 typedef SmallVector<StringRef, 4> PathComponents;
169 PathComponents ExpectedPathComponents;
170 PathComponents ActualPathComponents;
172 StringRef(Path).split(ExpectedPathComponents, '/');
174 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
176 ActualPathComponents.push_back(*I);
179 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
181 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
182 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
186 TEST(Support, RelativePathDotIterator) {
187 SmallString<64> Path(StringRef(".c/.d/../."));
188 typedef SmallVector<StringRef, 4> PathComponents;
189 PathComponents ExpectedPathComponents;
190 PathComponents ActualPathComponents;
192 StringRef(Path).split(ExpectedPathComponents, '/');
194 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
196 ActualPathComponents.push_back(*I);
199 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
201 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
202 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
206 TEST(Support, AbsolutePathIterator) {
207 SmallString<64> Path(StringRef("/c/d/e/foo.txt"));
208 typedef SmallVector<StringRef, 4> PathComponents;
209 PathComponents ExpectedPathComponents;
210 PathComponents ActualPathComponents;
212 StringRef(Path).split(ExpectedPathComponents, '/');
214 // The root path will also be a component when iterating
215 ExpectedPathComponents[0] = "/";
217 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
219 ActualPathComponents.push_back(*I);
222 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
224 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
225 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
229 TEST(Support, AbsolutePathDotIterator) {
230 SmallString<64> Path(StringRef("/.c/.d/../."));
231 typedef SmallVector<StringRef, 4> PathComponents;
232 PathComponents ExpectedPathComponents;
233 PathComponents ActualPathComponents;
235 StringRef(Path).split(ExpectedPathComponents, '/');
237 // The root path will also be a component when iterating
238 ExpectedPathComponents[0] = "/";
240 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
242 ActualPathComponents.push_back(*I);
245 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
247 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
248 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
253 TEST(Support, AbsolutePathIteratorWin32) {
254 SmallString<64> Path(StringRef("c:\\c\\e\\foo.txt"));
255 typedef SmallVector<StringRef, 4> PathComponents;
256 PathComponents ExpectedPathComponents;
257 PathComponents ActualPathComponents;
259 StringRef(Path).split(ExpectedPathComponents, "\\");
261 // The root path (which comes after the drive name) will also be a component
263 ExpectedPathComponents.insert(ExpectedPathComponents.begin()+1, "\\");
265 for (path::const_iterator I = path::begin(Path), E = path::end(Path); I != E;
267 ActualPathComponents.push_back(*I);
270 ASSERT_EQ(ExpectedPathComponents.size(), ActualPathComponents.size());
272 for (size_t i = 0; i <ExpectedPathComponents.size(); ++i) {
273 EXPECT_EQ(ExpectedPathComponents[i].str(), ActualPathComponents[i].str());
276 #endif // LLVM_ON_WIN32
278 TEST(Support, AbsolutePathIteratorEnd) {
279 // Trailing slashes are converted to '.' unless they are part of the root path.
280 SmallVector<StringRef, 4> Paths;
281 Paths.push_back("/foo/");
282 Paths.push_back("/foo//");
283 Paths.push_back("//net//");
285 Paths.push_back("c:\\\\");
288 for (StringRef Path : Paths) {
289 StringRef LastComponent = *path::rbegin(Path);
290 EXPECT_EQ(".", LastComponent);
293 SmallVector<StringRef, 3> RootPaths;
294 RootPaths.push_back("/");
295 RootPaths.push_back("//net/");
297 RootPaths.push_back("c:\\");
300 for (StringRef Path : RootPaths) {
301 StringRef LastComponent = *path::rbegin(Path);
302 EXPECT_EQ(1u, LastComponent.size());
303 EXPECT_TRUE(path::is_separator(LastComponent[0]));
307 TEST(Support, HomeDirectory) {
308 std::string expected;
310 if (wchar_t const *path = ::_wgetenv(L"USERPROFILE")) {
311 auto pathLen = ::wcslen(path);
312 ArrayRef<char> ref{reinterpret_cast<char const *>(path),
313 pathLen * sizeof(wchar_t)};
314 convertUTF16ToUTF8String(ref, expected);
317 if (char const *path = ::getenv("HOME"))
320 // Do not try to test it if we don't know what to expect.
321 // On Windows we use something better than env vars.
322 if (!expected.empty()) {
323 SmallString<128> HomeDir;
324 auto status = path::home_directory(HomeDir);
326 EXPECT_EQ(expected, HomeDir);
330 TEST(Support, UserCacheDirectory) {
331 SmallString<13> CacheDir;
332 SmallString<20> CacheDir2;
333 auto Status = path::user_cache_directory(CacheDir, "");
334 EXPECT_TRUE(Status ^ CacheDir.empty());
337 EXPECT_TRUE(path::user_cache_directory(CacheDir2, "")); // should succeed
338 EXPECT_EQ(CacheDir, CacheDir2); // and return same paths
340 EXPECT_TRUE(path::user_cache_directory(CacheDir, "A", "B", "file.c"));
341 auto It = path::rbegin(CacheDir);
342 EXPECT_EQ("file.c", *It);
343 EXPECT_EQ("B", *++It);
344 EXPECT_EQ("A", *++It);
345 auto ParentDir = *++It;
347 // Test Unicode: "<user_cache_dir>/(pi)r^2/aleth.0"
348 EXPECT_TRUE(path::user_cache_directory(CacheDir2, "\xCF\x80r\xC2\xB2",
350 auto It2 = path::rbegin(CacheDir2);
351 EXPECT_EQ("\xE2\x84\xB5.0", *It2);
352 EXPECT_EQ("\xCF\x80r\xC2\xB2", *++It2);
353 auto ParentDir2 = *++It2;
355 EXPECT_EQ(ParentDir, ParentDir2);
359 TEST(Support, TempDirectory) {
360 SmallString<32> TempDir;
361 path::system_temp_directory(false, TempDir);
362 EXPECT_TRUE(!TempDir.empty());
364 path::system_temp_directory(true, TempDir);
365 EXPECT_TRUE(!TempDir.empty());
369 static std::string path2regex(std::string Path) {
371 while ((Pos = Path.find('\\', Pos)) != std::string::npos) {
372 Path.replace(Pos, 1, "\\\\");
378 /// Helper for running temp dir test in separated process. See below.
379 #define EXPECT_TEMP_DIR(prepare, expected) \
383 SmallString<300> TempDir; \
384 path::system_temp_directory(true, TempDir); \
385 raw_os_ostream(std::cerr) << TempDir; \
388 ::testing::ExitedWithCode(0), path2regex(expected))
390 TEST(SupportDeathTest, TempDirectoryOnWindows) {
391 // In this test we want to check how system_temp_directory responds to
392 // different values of specific env vars. To prevent corrupting env vars of
393 // the current process all checks are done in separated processes.
394 EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"C:\\OtherFolder"), "C:\\OtherFolder");
395 EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"C:/Unix/Path/Seperators"),
396 "C:\\Unix\\Path\\Seperators");
397 EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"Local Path"), ".+\\Local Path$");
398 EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"F:\\TrailingSep\\"), "F:\\TrailingSep");
400 _wputenv_s(L"TMP", L"C:\\2\x03C0r-\x00B5\x00B3\\\x2135\x2080"),
401 "C:\\2\xCF\x80r-\xC2\xB5\xC2\xB3\\\xE2\x84\xB5\xE2\x82\x80");
403 // Test $TMP empty, $TEMP set.
406 _wputenv_s(L"TMP", L"");
407 _wputenv_s(L"TEMP", L"C:\\Valid\\Path");
411 // All related env vars empty
414 _wputenv_s(L"TMP", L"");
415 _wputenv_s(L"TEMP", L"");
416 _wputenv_s(L"USERPROFILE", L"");
420 // Test evn var / path with 260 chars.
421 SmallString<270> Expected{"C:\\Temp\\AB\\123456789"};
422 while (Expected.size() < 260)
423 Expected.append("\\DirNameWith19Charss");
424 ASSERT_EQ(260U, Expected.size());
425 EXPECT_TEMP_DIR(_putenv_s("TMP", Expected.c_str()), Expected.c_str());
429 class FileSystemTest : public testing::Test {
431 /// Unique temporary directory in which all created filesystem entities must
432 /// be placed. It is removed at the end of each test (must be empty).
433 SmallString<128> TestDirectory;
435 void SetUp() override {
437 fs::createUniqueDirectory("file-system-test", TestDirectory));
438 // We don't care about this specific file.
439 errs() << "Test Directory: " << TestDirectory << '\n';
443 void TearDown() override { ASSERT_NO_ERROR(fs::remove(TestDirectory.str())); }
446 TEST_F(FileSystemTest, Unique) {
447 // Create a temp file.
449 SmallString<64> TempPath;
451 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
453 // The same file should return an identical unique id.
455 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
456 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
459 // Different files should return different unique ids.
461 SmallString<64> TempPath2;
463 fs::createTemporaryFile("prefix", "temp", FileDescriptor2, TempPath2));
466 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
468 ::close(FileDescriptor2);
470 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
472 // Two paths representing the same file on disk should still provide the
473 // same unique id. We can test this by making a hard link.
474 ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
476 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
479 ::close(FileDescriptor);
481 SmallString<128> Dir1;
483 fs::createUniqueDirectory("dir1", Dir1));
484 ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F1));
485 ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F2));
488 SmallString<128> Dir2;
490 fs::createUniqueDirectory("dir2", Dir2));
491 ASSERT_NO_ERROR(fs::getUniqueID(Dir2.c_str(), F2));
493 ASSERT_NO_ERROR(fs::remove(Dir1));
494 ASSERT_NO_ERROR(fs::remove(Dir2));
495 ASSERT_NO_ERROR(fs::remove(TempPath2));
496 ASSERT_NO_ERROR(fs::remove(TempPath));
499 TEST_F(FileSystemTest, TempFiles) {
500 // Create a temp file.
502 SmallString<64> TempPath;
504 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
506 // Make sure it exists.
507 ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
509 // Create another temp tile.
511 SmallString<64> TempPath2;
512 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD2, TempPath2));
513 ASSERT_TRUE(TempPath2.endswith(".temp"));
514 ASSERT_NE(TempPath.str(), TempPath2.str());
516 fs::file_status A, B;
517 ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
518 ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
519 EXPECT_FALSE(fs::equivalent(A, B));
524 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
525 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
526 ASSERT_EQ(fs::remove(Twine(TempPath2), false),
527 errc::no_such_file_or_directory);
529 std::error_code EC = fs::status(TempPath2.c_str(), B);
530 EXPECT_EQ(EC, errc::no_such_file_or_directory);
531 EXPECT_EQ(B.type(), fs::file_type::file_not_found);
533 // Make sure Temp2 doesn't exist.
534 ASSERT_EQ(fs::access(Twine(TempPath2), sys::fs::AccessMode::Exist),
535 errc::no_such_file_or_directory);
537 SmallString<64> TempPath3;
538 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "", TempPath3));
539 ASSERT_FALSE(TempPath3.endswith("."));
540 FileRemover Cleanup3(TempPath3);
542 // Create a hard link to Temp1.
543 ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
545 ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
547 ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
548 ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
549 EXPECT_TRUE(fs::equivalent(A, B));
552 ::close(FileDescriptor);
553 ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
555 // Remove the hard link.
556 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
558 // Make sure Temp1 doesn't exist.
559 ASSERT_EQ(fs::access(Twine(TempPath), sys::fs::AccessMode::Exist),
560 errc::no_such_file_or_directory);
563 // Path name > 260 chars should get an error.
564 const char *Path270 =
565 "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
566 "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
567 "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
568 "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
569 "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
570 EXPECT_EQ(fs::createUniqueFile(Path270, FileDescriptor, TempPath),
571 errc::invalid_argument);
572 // Relative path < 247 chars, no problem.
573 const char *Path216 =
574 "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
575 "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
576 "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
577 "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
578 ASSERT_NO_ERROR(fs::createTemporaryFile(Path216, "", TempPath));
579 ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
583 TEST_F(FileSystemTest, CreateDir) {
584 ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
585 ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
586 ASSERT_EQ(fs::create_directory(Twine(TestDirectory) + "foo", false),
588 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "foo"));
591 // Set a 0000 umask so that we can test our directory permissions.
592 mode_t OldUmask = ::umask(0000);
594 fs::file_status Status;
596 fs::create_directory(Twine(TestDirectory) + "baz500", false,
597 fs::perms::owner_read | fs::perms::owner_exe));
598 ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz500", Status));
599 ASSERT_EQ(Status.permissions() & fs::perms::all_all,
600 fs::perms::owner_read | fs::perms::owner_exe);
601 ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "baz777", false,
602 fs::perms::all_all));
603 ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz777", Status));
604 ASSERT_EQ(Status.permissions() & fs::perms::all_all, fs::perms::all_all);
606 // Restore umask to be safe.
611 // Prove that create_directories() can handle a pathname > 248 characters,
612 // which is the documented limit for CreateDirectory().
613 // (248 is MAX_PATH subtracting room for an 8.3 filename.)
614 // Generate a directory path guaranteed to fall into that range.
615 size_t TmpLen = TestDirectory.size();
616 const char *OneDir = "\\123456789";
617 size_t OneDirLen = strlen(OneDir);
618 ASSERT_LT(OneDirLen, 12U);
619 size_t NLevels = ((248 - TmpLen) / OneDirLen) + 1;
620 SmallString<260> LongDir(TestDirectory);
621 for (size_t I = 0; I < NLevels; ++I)
622 LongDir.append(OneDir);
623 ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
624 ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
625 ASSERT_EQ(fs::create_directories(Twine(LongDir), false),
627 // Tidy up, "recursively" removing the directories.
628 StringRef ThisDir(LongDir);
629 for (size_t J = 0; J < NLevels; ++J) {
630 ASSERT_NO_ERROR(fs::remove(ThisDir));
631 ThisDir = path::parent_path(ThisDir);
634 // Similarly for a relative pathname. Need to set the current directory to
635 // TestDirectory so that the one we create ends up in the right place.
636 char PreviousDir[260];
637 size_t PreviousDirLen = ::GetCurrentDirectoryA(260, PreviousDir);
638 ASSERT_GT(PreviousDirLen, 0U);
639 ASSERT_LT(PreviousDirLen, 260U);
640 ASSERT_NE(::SetCurrentDirectoryA(TestDirectory.c_str()), 0);
642 // Generate a relative directory name with absolute length > 248.
643 size_t LongDirLen = 249 - TestDirectory.size();
644 LongDir.assign(LongDirLen, 'a');
645 ASSERT_NO_ERROR(fs::create_directory(Twine(LongDir)));
646 // While we're here, prove that .. and . handling works in these long paths.
647 const char *DotDotDirs = "\\..\\.\\b";
648 LongDir.append(DotDotDirs);
649 ASSERT_NO_ERROR(fs::create_directory("b"));
650 ASSERT_EQ(fs::create_directory(Twine(LongDir), false), errc::file_exists);
652 ASSERT_NO_ERROR(fs::remove("b"));
653 ASSERT_NO_ERROR(fs::remove(
654 Twine(LongDir.substr(0, LongDir.size() - strlen(DotDotDirs)))));
655 ASSERT_NE(::SetCurrentDirectoryA(PreviousDir), 0);
659 TEST_F(FileSystemTest, DirectoryIteration) {
661 for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
664 // Create a known hierarchy to recurse over.
666 fs::create_directories(Twine(TestDirectory) + "/recursive/a0/aa1"));
668 fs::create_directories(Twine(TestDirectory) + "/recursive/a0/ab1"));
669 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory) +
670 "/recursive/dontlookhere/da1"));
672 fs::create_directories(Twine(TestDirectory) + "/recursive/z0/za1"));
674 fs::create_directories(Twine(TestDirectory) + "/recursive/pop/p1"));
675 typedef std::vector<std::string> v_t;
677 for (fs::recursive_directory_iterator i(Twine(TestDirectory)
678 + "/recursive", ec), e; i != e; i.increment(ec)){
680 if (path::filename(i->path()) == "p1") {
682 // FIXME: recursive_directory_iterator should be more robust.
685 if (path::filename(i->path()) == "dontlookhere")
687 visited.push_back(path::filename(i->path()));
689 v_t::const_iterator a0 = find(visited, "a0");
690 v_t::const_iterator aa1 = find(visited, "aa1");
691 v_t::const_iterator ab1 = find(visited, "ab1");
692 v_t::const_iterator dontlookhere = find(visited, "dontlookhere");
693 v_t::const_iterator da1 = find(visited, "da1");
694 v_t::const_iterator z0 = find(visited, "z0");
695 v_t::const_iterator za1 = find(visited, "za1");
696 v_t::const_iterator pop = find(visited, "pop");
697 v_t::const_iterator p1 = find(visited, "p1");
699 // Make sure that each path was visited correctly.
700 ASSERT_NE(a0, visited.end());
701 ASSERT_NE(aa1, visited.end());
702 ASSERT_NE(ab1, visited.end());
703 ASSERT_NE(dontlookhere, visited.end());
704 ASSERT_EQ(da1, visited.end()); // Not visited.
705 ASSERT_NE(z0, visited.end());
706 ASSERT_NE(za1, visited.end());
707 ASSERT_NE(pop, visited.end());
708 ASSERT_EQ(p1, visited.end()); // Not visited.
710 // Make sure that parents were visited before children. No other ordering
711 // guarantees can be made across siblings.
716 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/aa1"));
717 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/ab1"));
718 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0"));
720 fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere/da1"));
721 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere"));
722 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop/p1"));
723 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop"));
724 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0/za1"));
725 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0"));
726 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive"));
728 // Test recursive_directory_iterator level()
730 fs::create_directories(Twine(TestDirectory) + "/reclevel/a/b/c"));
731 fs::recursive_directory_iterator I(Twine(TestDirectory) + "/reclevel", ec), E;
732 for (int l = 0; I != E; I.increment(ec), ++l) {
734 EXPECT_EQ(I.level(), l);
737 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel/a/b/c"));
738 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel/a/b"));
739 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel/a"));
740 ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel"));
743 const char archive[] = "!<arch>\x0A";
744 const char bitcode[] = "\xde\xc0\x17\x0b";
745 const char coff_object[] = "\x00\x00......";
746 const char coff_bigobj[] = "\x00\x00\xff\xff\x00\x02......"
747 "\xc7\xa1\xba\xd1\xee\xba\xa9\x4b\xaf\x20\xfa\xf6\x6a\xa4\xdc\xb8";
748 const char coff_import_library[] = "\x00\x00\xff\xff....";
749 const char elf_relocatable[] = { 0x7f, 'E', 'L', 'F', 1, 2, 1, 0, 0,
750 0, 0, 0, 0, 0, 0, 0, 0, 1 };
751 const char macho_universal_binary[] = "\xca\xfe\xba\xbe...\x00";
752 const char macho_object[] =
753 "\xfe\xed\xfa\xce........\x00\x00\x00\x01............";
754 const char macho_executable[] =
755 "\xfe\xed\xfa\xce........\x00\x00\x00\x02............";
756 const char macho_fixed_virtual_memory_shared_lib[] =
757 "\xfe\xed\xfa\xce........\x00\x00\x00\x03............";
758 const char macho_core[] =
759 "\xfe\xed\xfa\xce........\x00\x00\x00\x04............";
760 const char macho_preload_executable[] =
761 "\xfe\xed\xfa\xce........\x00\x00\x00\x05............";
762 const char macho_dynamically_linked_shared_lib[] =
763 "\xfe\xed\xfa\xce........\x00\x00\x00\x06............";
764 const char macho_dynamic_linker[] =
765 "\xfe\xed\xfa\xce........\x00\x00\x00\x07............";
766 const char macho_bundle[] =
767 "\xfe\xed\xfa\xce........\x00\x00\x00\x08............";
768 const char macho_dsym_companion[] =
769 "\xfe\xed\xfa\xce........\x00\x00\x00\x0a............";
770 const char macho_kext_bundle[] =
771 "\xfe\xed\xfa\xce........\x00\x00\x00\x0b............";
772 const char windows_resource[] = "\x00\x00\x00\x00\x020\x00\x00\x00\xff";
773 const char macho_dynamically_linked_shared_lib_stub[] =
774 "\xfe\xed\xfa\xce........\x00\x00\x00\x09............";
776 TEST_F(FileSystemTest, Magic) {
778 const char *filename;
779 const char *magic_str;
780 size_t magic_str_len;
781 fs::file_magic magic;
783 #define DEFINE(magic) \
784 { #magic, magic, sizeof(magic), fs::file_magic::magic }
788 { "coff_bigobj", coff_bigobj, sizeof(coff_bigobj), fs::file_magic::coff_object },
789 DEFINE(coff_import_library),
790 DEFINE(elf_relocatable),
791 DEFINE(macho_universal_binary),
792 DEFINE(macho_object),
793 DEFINE(macho_executable),
794 DEFINE(macho_fixed_virtual_memory_shared_lib),
796 DEFINE(macho_preload_executable),
797 DEFINE(macho_dynamically_linked_shared_lib),
798 DEFINE(macho_dynamic_linker),
799 DEFINE(macho_bundle),
800 DEFINE(macho_dynamically_linked_shared_lib_stub),
801 DEFINE(macho_dsym_companion),
802 DEFINE(macho_kext_bundle),
803 DEFINE(windows_resource)
807 // Create some files filled with magic.
808 for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
810 SmallString<128> file_pathname(TestDirectory);
811 path::append(file_pathname, i->filename);
813 raw_fd_ostream file(file_pathname, EC, sys::fs::F_None);
814 ASSERT_FALSE(file.has_error());
815 StringRef magic(i->magic_str, i->magic_str_len);
818 EXPECT_EQ(i->magic, fs::identify_magic(magic));
819 ASSERT_NO_ERROR(fs::remove(Twine(file_pathname)));
824 TEST_F(FileSystemTest, CarriageReturn) {
825 SmallString<128> FilePathname(TestDirectory);
827 path::append(FilePathname, "test");
830 raw_fd_ostream File(FilePathname, EC, sys::fs::F_Text);
835 auto Buf = MemoryBuffer::getFile(FilePathname.str());
836 EXPECT_TRUE((bool)Buf);
837 EXPECT_EQ(Buf.get()->getBuffer(), "\r\n");
841 raw_fd_ostream File(FilePathname, EC, sys::fs::F_None);
846 auto Buf = MemoryBuffer::getFile(FilePathname.str());
847 EXPECT_TRUE((bool)Buf);
848 EXPECT_EQ(Buf.get()->getBuffer(), "\n");
850 ASSERT_NO_ERROR(fs::remove(Twine(FilePathname)));
854 TEST_F(FileSystemTest, Resize) {
856 SmallString<64> TempPath;
857 ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
858 ASSERT_NO_ERROR(fs::resize_file(FD, 123));
859 fs::file_status Status;
860 ASSERT_NO_ERROR(fs::status(FD, Status));
861 ASSERT_EQ(Status.getSize(), 123U);
863 ASSERT_NO_ERROR(fs::remove(TempPath));
866 TEST_F(FileSystemTest, FileMapping) {
867 // Create a temp file.
869 SmallString<64> TempPath;
871 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
872 unsigned Size = 4096;
873 ASSERT_NO_ERROR(fs::resize_file(FileDescriptor, Size));
875 // Map in temp file and add some content
877 StringRef Val("hello there");
879 fs::mapped_file_region mfr(FileDescriptor,
880 fs::mapped_file_region::readwrite, Size, 0, EC);
882 std::copy(Val.begin(), Val.end(), mfr.data());
883 // Explicitly add a 0.
884 mfr.data()[Val.size()] = 0;
887 ASSERT_EQ(close(FileDescriptor), 0);
889 // Map it back in read-only
892 EC = fs::openFileForRead(Twine(TempPath), FD);
894 fs::mapped_file_region mfr(FD, fs::mapped_file_region::readonly, Size, 0, EC);
898 EXPECT_EQ(StringRef(mfr.const_data()), Val);
901 fs::mapped_file_region m(FD, fs::mapped_file_region::readonly, Size, 0, EC);
903 ASSERT_EQ(close(FD), 0);
905 ASSERT_NO_ERROR(fs::remove(TempPath));
908 TEST(Support, NormalizePath) {
909 #if defined(LLVM_ON_WIN32)
910 #define EXPECT_PATH_IS(path__, windows__, not_windows__) \
911 EXPECT_EQ(path__, windows__);
913 #define EXPECT_PATH_IS(path__, windows__, not_windows__) \
914 EXPECT_EQ(path__, not_windows__);
917 SmallString<64> Path1("a");
918 SmallString<64> Path2("a/b");
919 SmallString<64> Path3("a\\b");
920 SmallString<64> Path4("a\\\\b");
921 SmallString<64> Path5("\\a");
922 SmallString<64> Path6("a\\");
925 EXPECT_PATH_IS(Path1, "a", "a");
928 EXPECT_PATH_IS(Path2, "a\\b", "a/b");
931 EXPECT_PATH_IS(Path3, "a\\b", "a/b");
934 EXPECT_PATH_IS(Path4, "a\\\\b", "a\\\\b");
937 EXPECT_PATH_IS(Path5, "\\a", "/a");
940 EXPECT_PATH_IS(Path6, "a\\", "a/");
942 #undef EXPECT_PATH_IS
945 TEST(Support, RemoveLeadingDotSlash) {
946 StringRef Path1("././/foolz/wat");
947 StringRef Path2("./////");
949 Path1 = path::remove_leading_dotslash(Path1);
950 EXPECT_EQ(Path1, "foolz/wat");
951 Path2 = path::remove_leading_dotslash(Path2);
952 EXPECT_EQ(Path2, "");
955 static std::string remove_dots(StringRef path,
956 bool remove_dot_dot) {
957 SmallString<256> buffer(path);
958 path::remove_dots(buffer, remove_dot_dot);
962 TEST(Support, RemoveDots) {
963 #if defined(LLVM_ON_WIN32)
964 EXPECT_EQ("foolz\\wat", remove_dots(".\\.\\\\foolz\\wat", false));
965 EXPECT_EQ("", remove_dots(".\\\\\\\\\\", false));
967 EXPECT_EQ("a\\..\\b\\c", remove_dots(".\\a\\..\\b\\c", false));
968 EXPECT_EQ("b\\c", remove_dots(".\\a\\..\\b\\c", true));
969 EXPECT_EQ("c", remove_dots(".\\.\\c", true));
970 EXPECT_EQ("..\\a\\c", remove_dots("..\\a\\b\\..\\c", true));
971 EXPECT_EQ("..\\..\\a\\c", remove_dots("..\\..\\a\\b\\..\\c", true));
973 SmallString<64> Path1(".\\.\\c");
974 EXPECT_TRUE(path::remove_dots(Path1, true));
975 EXPECT_EQ("c", Path1);
977 EXPECT_EQ("foolz/wat", remove_dots("././/foolz/wat", false));
978 EXPECT_EQ("", remove_dots("./////", false));
980 EXPECT_EQ("a/../b/c", remove_dots("./a/../b/c", false));
981 EXPECT_EQ("b/c", remove_dots("./a/../b/c", true));
982 EXPECT_EQ("c", remove_dots("././c", true));
983 EXPECT_EQ("../a/c", remove_dots("../a/b/../c", true));
984 EXPECT_EQ("../../a/c", remove_dots("../../a/b/../c", true));
985 EXPECT_EQ("/a/c", remove_dots("/../../a/c", true));
986 EXPECT_EQ("/a/c", remove_dots("/../a/b//../././/c", true));
988 SmallString<64> Path1("././c");
989 EXPECT_TRUE(path::remove_dots(Path1, true));
990 EXPECT_EQ("c", Path1);
994 TEST(Support, ReplacePathPrefix) {
995 SmallString<64> Path1("/foo");
996 SmallString<64> Path2("/old/foo");
997 SmallString<64> OldPrefix("/old");
998 SmallString<64> NewPrefix("/new");
999 SmallString<64> NewPrefix2("/longernew");
1000 SmallString<64> EmptyPrefix("");
1002 SmallString<64> Path = Path1;
1003 path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1004 EXPECT_EQ(Path, "/foo");
1006 path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1007 EXPECT_EQ(Path, "/new/foo");
1009 path::replace_path_prefix(Path, OldPrefix, NewPrefix2);
1010 EXPECT_EQ(Path, "/longernew/foo");
1012 path::replace_path_prefix(Path, EmptyPrefix, NewPrefix);
1013 EXPECT_EQ(Path, "/new/foo");
1015 path::replace_path_prefix(Path, OldPrefix, EmptyPrefix);
1016 EXPECT_EQ(Path, "/foo");
1019 TEST_F(FileSystemTest, PathFromFD) {
1020 // Create a temp file.
1022 SmallString<64> TempPath;
1024 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
1025 FileRemover Cleanup(TempPath);
1027 // Make sure it exists.
1028 ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
1030 // Try to get the path from the file descriptor
1031 SmallString<64> ResultPath;
1032 std::error_code ErrorCode =
1033 fs::getPathFromOpenFD(FileDescriptor, ResultPath);
1035 // If we succeeded, check that the paths are the same (modulo case):
1037 // The paths returned by createTemporaryFile and getPathFromOpenFD
1038 // should reference the same file on disk.
1039 fs::UniqueID D1, D2;
1040 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), D1));
1041 ASSERT_NO_ERROR(fs::getUniqueID(Twine(ResultPath), D2));
1045 ::close(FileDescriptor);
1048 TEST_F(FileSystemTest, PathFromFDWin32) {
1049 // Create a temp file.
1051 SmallString<64> TempPath;
1053 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
1054 FileRemover Cleanup(TempPath);
1056 // Make sure it exists.
1057 ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
1059 SmallVector<char, 8> ResultPath;
1060 std::error_code ErrorCode =
1061 fs::getPathFromOpenFD(FileDescriptor, ResultPath);
1064 // Now that we know how much space is required for the path, create a path
1065 // buffer with exactly enough space (sans null terminator, which should not
1066 // be present), and call getPathFromOpenFD again to ensure that the API
1067 // properly handles exactly-sized buffers.
1068 SmallVector<char, 8> ExactSizedPath(ResultPath.size());
1069 ErrorCode = fs::getPathFromOpenFD(FileDescriptor, ExactSizedPath);
1070 ResultPath = ExactSizedPath;
1074 fs::UniqueID D1, D2;
1075 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), D1));
1076 ASSERT_NO_ERROR(fs::getUniqueID(Twine(ResultPath), D2));
1079 ::close(FileDescriptor);
1082 TEST_F(FileSystemTest, PathFromFDUnicode) {
1083 // Create a temp file.
1085 SmallString<64> TempPath;
1087 // Test Unicode: "<temp directory>/(pi)r^2<temp rand chars>.aleth.0"
1089 fs::createTemporaryFile("\xCF\x80r\xC2\xB2",
1090 "\xE2\x84\xB5.0", FileDescriptor, TempPath));
1091 FileRemover Cleanup(TempPath);
1093 // Make sure it exists.
1094 ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
1096 SmallVector<char, 8> ResultPath;
1097 std::error_code ErrorCode =
1098 fs::getPathFromOpenFD(FileDescriptor, ResultPath);
1101 fs::UniqueID D1, D2;
1102 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), D1));
1103 ASSERT_NO_ERROR(fs::getUniqueID(Twine(ResultPath), D2));
1106 ::close(FileDescriptor);
1109 TEST_F(FileSystemTest, OpenFileForRead) {
1110 // Create a temp file.
1112 SmallString<64> TempPath;
1114 fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
1115 FileRemover Cleanup(TempPath);
1117 // Make sure it exists.
1118 ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
1120 // Open the file for read
1121 int FileDescriptor2;
1122 SmallString<64> ResultPath;
1124 fs::openFileForRead(Twine(TempPath), FileDescriptor2, &ResultPath))
1126 // If we succeeded, check that the paths are the same (modulo case):
1127 if (!ResultPath.empty()) {
1128 // The paths returned by createTemporaryFile and getPathFromOpenFD
1129 // should reference the same file on disk.
1130 fs::UniqueID D1, D2;
1131 ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), D1));
1132 ASSERT_NO_ERROR(fs::getUniqueID(Twine(ResultPath), D2));
1136 ::close(FileDescriptor);
1138 } // anonymous namespace