xref: /llvm-project/llvm/unittests/Support/Path.cpp (revision 79f34ae7fe926c907c2e68b22fc15428f2e4be4e)
1 //===- llvm/unittest/Support/Path.cpp - Path tests ------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/Support/Path.h"
10 #include "llvm/ADT/STLExtras.h"
11 #include "llvm/ADT/ScopeExit.h"
12 #include "llvm/ADT/SmallVector.h"
13 #include "llvm/ADT/Triple.h"
14 #include "llvm/BinaryFormat/Magic.h"
15 #include "llvm/Config/llvm-config.h"
16 #include "llvm/Support/Compiler.h"
17 #include "llvm/Support/ConvertUTF.h"
18 #include "llvm/Support/Duration.h"
19 #include "llvm/Support/Errc.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/FileSystem.h"
22 #include "llvm/Support/FileUtilities.h"
23 #include "llvm/Support/Host.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/Support/raw_ostream.h"
26 #include "llvm/Testing/Support/Error.h"
27 #include "llvm/Testing/Support/SupportHelpers.h"
28 #include "gmock/gmock.h"
29 #include "gtest/gtest.h"
30 
31 #ifdef _WIN32
32 #include "llvm/ADT/ArrayRef.h"
33 #include "llvm/Support/Chrono.h"
34 #include "llvm/Support/Windows/WindowsSupport.h"
35 #include <windows.h>
36 #include <winerror.h>
37 #endif
38 
39 #ifdef LLVM_ON_UNIX
40 #include <pwd.h>
41 #include <sys/stat.h>
42 #endif
43 
44 using namespace llvm;
45 using namespace llvm::sys;
46 
47 #define ASSERT_NO_ERROR(x)                                                     \
48   if (std::error_code ASSERT_NO_ERROR_ec = x) {                                \
49     SmallString<128> MessageStorage;                                           \
50     raw_svector_ostream Message(MessageStorage);                               \
51     Message << #x ": did not return errc::success.\n"                          \
52             << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n"          \
53             << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n";      \
54     GTEST_FATAL_FAILURE_(MessageStorage.c_str());                              \
55   } else {                                                                     \
56   }
57 
58 #define ASSERT_ERROR(x)                                                        \
59   if (!x) {                                                                    \
60     SmallString<128> MessageStorage;                                           \
61     raw_svector_ostream Message(MessageStorage);                               \
62     Message << #x ": did not return a failure error code.\n";                  \
63     GTEST_FATAL_FAILURE_(MessageStorage.c_str());                              \
64   }
65 
66 namespace {
67 
68 void checkSeparators(StringRef Path) {
69 #ifdef _WIN32
70   char UndesiredSeparator = sys::path::get_separator()[0] == '/' ? '\\' : '/';
71   ASSERT_EQ(Path.find(UndesiredSeparator), StringRef::npos);
72 #endif
73 }
74 
75 struct FileDescriptorCloser {
76   explicit FileDescriptorCloser(int FD) : FD(FD) {}
77   ~FileDescriptorCloser() { ::close(FD); }
78   int FD;
79 };
80 
81 TEST(is_style_Style, Works) {
82   using namespace llvm::sys::path;
83   // Check platform-independent results.
84   EXPECT_TRUE(is_style_posix(Style::posix));
85   EXPECT_TRUE(is_style_windows(Style::windows));
86   EXPECT_TRUE(is_style_windows(Style::windows_slash));
87   EXPECT_FALSE(is_style_posix(Style::windows));
88   EXPECT_FALSE(is_style_posix(Style::windows_slash));
89   EXPECT_FALSE(is_style_windows(Style::posix));
90 
91   // Check platform-dependent results.
92 #if defined(_WIN32)
93   EXPECT_FALSE(is_style_posix(Style::native));
94   EXPECT_TRUE(is_style_windows(Style::native));
95 #else
96   EXPECT_TRUE(is_style_posix(Style::native));
97   EXPECT_FALSE(is_style_windows(Style::native));
98 #endif
99 }
100 
101 TEST(is_separator, Works) {
102   EXPECT_TRUE(path::is_separator('/'));
103   EXPECT_FALSE(path::is_separator('\0'));
104   EXPECT_FALSE(path::is_separator('-'));
105   EXPECT_FALSE(path::is_separator(' '));
106 
107   EXPECT_TRUE(path::is_separator('\\', path::Style::windows));
108   EXPECT_TRUE(path::is_separator('\\', path::Style::windows_slash));
109   EXPECT_FALSE(path::is_separator('\\', path::Style::posix));
110 
111   EXPECT_EQ(path::is_style_windows(path::Style::native),
112             path::is_separator('\\'));
113 }
114 
115 TEST(get_separator, Works) {
116   EXPECT_EQ(path::get_separator(path::Style::posix), "/");
117   EXPECT_EQ(path::get_separator(path::Style::windows_backslash), "\\");
118   EXPECT_EQ(path::get_separator(path::Style::windows_slash), "/");
119 }
120 
121 TEST(is_absolute_gnu, Works) {
122   // Test tuple <Path, ExpectedPosixValue, ExpectedWindowsValue>.
123   const std::tuple<StringRef, bool, bool> Paths[] = {
124       std::make_tuple("", false, false),
125       std::make_tuple("/", true, true),
126       std::make_tuple("/foo", true, true),
127       std::make_tuple("\\", false, true),
128       std::make_tuple("\\foo", false, true),
129       std::make_tuple("foo", false, false),
130       std::make_tuple("c", false, false),
131       std::make_tuple("c:", false, true),
132       std::make_tuple("c:\\", false, true),
133       std::make_tuple("!:", false, true),
134       std::make_tuple("xx:", false, false),
135       std::make_tuple("c:abc\\", false, true),
136       std::make_tuple(":", false, false)};
137 
138   for (const auto &Path : Paths) {
139     EXPECT_EQ(path::is_absolute_gnu(std::get<0>(Path), path::Style::posix),
140               std::get<1>(Path));
141     EXPECT_EQ(path::is_absolute_gnu(std::get<0>(Path), path::Style::windows),
142               std::get<2>(Path));
143 
144     constexpr int Native = is_style_posix(path::Style::native) ? 1 : 2;
145     EXPECT_EQ(path::is_absolute_gnu(std::get<0>(Path), path::Style::native),
146               std::get<Native>(Path));
147   }
148 }
149 
150 TEST(Support, Path) {
151   SmallVector<StringRef, 40> paths;
152   paths.push_back("");
153   paths.push_back(".");
154   paths.push_back("..");
155   paths.push_back("foo");
156   paths.push_back("/");
157   paths.push_back("/foo");
158   paths.push_back("foo/");
159   paths.push_back("/foo/");
160   paths.push_back("foo/bar");
161   paths.push_back("/foo/bar");
162   paths.push_back("//net");
163   paths.push_back("//net/");
164   paths.push_back("//net/foo");
165   paths.push_back("///foo///");
166   paths.push_back("///foo///bar");
167   paths.push_back("/.");
168   paths.push_back("./");
169   paths.push_back("/..");
170   paths.push_back("../");
171   paths.push_back("foo/.");
172   paths.push_back("foo/..");
173   paths.push_back("foo/./");
174   paths.push_back("foo/./bar");
175   paths.push_back("foo/..");
176   paths.push_back("foo/../");
177   paths.push_back("foo/../bar");
178   paths.push_back("c:");
179   paths.push_back("c:/");
180   paths.push_back("c:foo");
181   paths.push_back("c:/foo");
182   paths.push_back("c:foo/");
183   paths.push_back("c:/foo/");
184   paths.push_back("c:/foo/bar");
185   paths.push_back("prn:");
186   paths.push_back("c:\\");
187   paths.push_back("c:foo");
188   paths.push_back("c:\\foo");
189   paths.push_back("c:foo\\");
190   paths.push_back("c:\\foo\\");
191   paths.push_back("c:\\foo/");
192   paths.push_back("c:/foo\\bar");
193 
194   for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
195                                                   e = paths.end();
196                                                   i != e;
197                                                   ++i) {
198     SCOPED_TRACE(*i);
199     SmallVector<StringRef, 5> ComponentStack;
200     for (sys::path::const_iterator ci = sys::path::begin(*i),
201                                    ce = sys::path::end(*i);
202                                    ci != ce;
203                                    ++ci) {
204       EXPECT_FALSE(ci->empty());
205       ComponentStack.push_back(*ci);
206     }
207 
208     SmallVector<StringRef, 5> ReverseComponentStack;
209     for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
210                                      ce = sys::path::rend(*i);
211                                      ci != ce;
212                                      ++ci) {
213       EXPECT_FALSE(ci->empty());
214       ReverseComponentStack.push_back(*ci);
215     }
216     std::reverse(ReverseComponentStack.begin(), ReverseComponentStack.end());
217     EXPECT_THAT(ComponentStack, testing::ContainerEq(ReverseComponentStack));
218 
219     // Crash test most of the API - since we're iterating over all of our paths
220     // here there isn't really anything reasonable to assert on in the results.
221     (void)path::has_root_path(*i);
222     (void)path::root_path(*i);
223     (void)path::has_root_name(*i);
224     (void)path::root_name(*i);
225     (void)path::has_root_directory(*i);
226     (void)path::root_directory(*i);
227     (void)path::has_parent_path(*i);
228     (void)path::parent_path(*i);
229     (void)path::has_filename(*i);
230     (void)path::filename(*i);
231     (void)path::has_stem(*i);
232     (void)path::stem(*i);
233     (void)path::has_extension(*i);
234     (void)path::extension(*i);
235     (void)path::is_absolute(*i);
236     (void)path::is_absolute_gnu(*i);
237     (void)path::is_relative(*i);
238 
239     SmallString<128> temp_store;
240     temp_store = *i;
241     ASSERT_NO_ERROR(fs::make_absolute(temp_store));
242     temp_store = *i;
243     path::remove_filename(temp_store);
244 
245     temp_store = *i;
246     path::replace_extension(temp_store, "ext");
247     StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
248     stem = path::stem(filename);
249     ext  = path::extension(filename);
250     EXPECT_EQ(*sys::path::rbegin(filename), (stem + ext).str());
251 
252     path::native(*i, temp_store);
253   }
254 
255   {
256     SmallString<32> Relative("foo.cpp");
257     sys::fs::make_absolute("/root", Relative);
258     Relative[5] = '/'; // Fix up windows paths.
259     ASSERT_EQ("/root/foo.cpp", Relative);
260   }
261 
262   {
263     SmallString<32> Relative("foo.cpp");
264     sys::fs::make_absolute("//root", Relative);
265     Relative[6] = '/'; // Fix up windows paths.
266     ASSERT_EQ("//root/foo.cpp", Relative);
267   }
268 }
269 
270 TEST(Support, PathRoot) {
271   ASSERT_EQ(path::root_name("//net/hello", path::Style::posix).str(), "//net");
272   ASSERT_EQ(path::root_name("c:/hello", path::Style::posix).str(), "");
273   ASSERT_EQ(path::root_name("c:/hello", path::Style::windows).str(), "c:");
274   ASSERT_EQ(path::root_name("/hello", path::Style::posix).str(), "");
275 
276   ASSERT_EQ(path::root_directory("/goo/hello", path::Style::posix).str(), "/");
277   ASSERT_EQ(path::root_directory("c:/hello", path::Style::windows).str(), "/");
278   ASSERT_EQ(path::root_directory("d/file.txt", path::Style::posix).str(), "");
279   ASSERT_EQ(path::root_directory("d/file.txt", path::Style::windows).str(), "");
280 
281   SmallVector<StringRef, 40> paths;
282   paths.push_back("");
283   paths.push_back(".");
284   paths.push_back("..");
285   paths.push_back("foo");
286   paths.push_back("/");
287   paths.push_back("/foo");
288   paths.push_back("foo/");
289   paths.push_back("/foo/");
290   paths.push_back("foo/bar");
291   paths.push_back("/foo/bar");
292   paths.push_back("//net");
293   paths.push_back("//net/");
294   paths.push_back("//net/foo");
295   paths.push_back("///foo///");
296   paths.push_back("///foo///bar");
297   paths.push_back("/.");
298   paths.push_back("./");
299   paths.push_back("/..");
300   paths.push_back("../");
301   paths.push_back("foo/.");
302   paths.push_back("foo/..");
303   paths.push_back("foo/./");
304   paths.push_back("foo/./bar");
305   paths.push_back("foo/..");
306   paths.push_back("foo/../");
307   paths.push_back("foo/../bar");
308   paths.push_back("c:");
309   paths.push_back("c:/");
310   paths.push_back("c:foo");
311   paths.push_back("c:/foo");
312   paths.push_back("c:foo/");
313   paths.push_back("c:/foo/");
314   paths.push_back("c:/foo/bar");
315   paths.push_back("prn:");
316   paths.push_back("c:\\");
317   paths.push_back("c:foo");
318   paths.push_back("c:\\foo");
319   paths.push_back("c:foo\\");
320   paths.push_back("c:\\foo\\");
321   paths.push_back("c:\\foo/");
322   paths.push_back("c:/foo\\bar");
323 
324   for (StringRef p : paths) {
325     ASSERT_EQ(
326       path::root_name(p, path::Style::posix).str() + path::root_directory(p, path::Style::posix).str(),
327       path::root_path(p, path::Style::posix).str());
328 
329     ASSERT_EQ(
330       path::root_name(p, path::Style::windows).str() + path::root_directory(p, path::Style::windows).str(),
331       path::root_path(p, path::Style::windows).str());
332   }
333 }
334 
335 TEST(Support, FilenameParent) {
336   EXPECT_EQ("/", path::filename("/"));
337   EXPECT_EQ("", path::parent_path("/"));
338 
339   EXPECT_EQ("\\", path::filename("c:\\", path::Style::windows));
340   EXPECT_EQ("c:", path::parent_path("c:\\", path::Style::windows));
341 
342   EXPECT_EQ("/", path::filename("///"));
343   EXPECT_EQ("", path::parent_path("///"));
344 
345   EXPECT_EQ("\\", path::filename("c:\\\\", path::Style::windows));
346   EXPECT_EQ("c:", path::parent_path("c:\\\\", path::Style::windows));
347 
348   EXPECT_EQ("bar", path::filename("/foo/bar"));
349   EXPECT_EQ("/foo", path::parent_path("/foo/bar"));
350 
351   EXPECT_EQ("foo", path::filename("/foo"));
352   EXPECT_EQ("/", path::parent_path("/foo"));
353 
354   EXPECT_EQ("foo", path::filename("foo"));
355   EXPECT_EQ("", path::parent_path("foo"));
356 
357   EXPECT_EQ(".", path::filename("foo/"));
358   EXPECT_EQ("foo", path::parent_path("foo/"));
359 
360   EXPECT_EQ("//net", path::filename("//net"));
361   EXPECT_EQ("", path::parent_path("//net"));
362 
363   EXPECT_EQ("/", path::filename("//net/"));
364   EXPECT_EQ("//net", path::parent_path("//net/"));
365 
366   EXPECT_EQ("foo", path::filename("//net/foo"));
367   EXPECT_EQ("//net/", path::parent_path("//net/foo"));
368 
369   // These checks are just to make sure we do something reasonable with the
370   // paths below. They are not meant to prescribe the one true interpretation of
371   // these paths. Other decompositions (e.g. "//" -> "" + "//") are also
372   // possible.
373   EXPECT_EQ("/", path::filename("//"));
374   EXPECT_EQ("", path::parent_path("//"));
375 
376   EXPECT_EQ("\\", path::filename("\\\\", path::Style::windows));
377   EXPECT_EQ("", path::parent_path("\\\\", path::Style::windows));
378 
379   EXPECT_EQ("\\", path::filename("\\\\\\", path::Style::windows));
380   EXPECT_EQ("", path::parent_path("\\\\\\", path::Style::windows));
381 }
382 
383 static std::vector<StringRef>
384 GetComponents(StringRef Path, path::Style S = path::Style::native) {
385   return {path::begin(Path, S), path::end(Path)};
386 }
387 
388 TEST(Support, PathIterator) {
389   EXPECT_THAT(GetComponents("/foo"), testing::ElementsAre("/", "foo"));
390   EXPECT_THAT(GetComponents("/"), testing::ElementsAre("/"));
391   EXPECT_THAT(GetComponents("//"), testing::ElementsAre("/"));
392   EXPECT_THAT(GetComponents("///"), testing::ElementsAre("/"));
393   EXPECT_THAT(GetComponents("c/d/e/foo.txt"),
394               testing::ElementsAre("c", "d", "e", "foo.txt"));
395   EXPECT_THAT(GetComponents(".c/.d/../."),
396               testing::ElementsAre(".c", ".d", "..", "."));
397   EXPECT_THAT(GetComponents("/c/d/e/foo.txt"),
398               testing::ElementsAre("/", "c", "d", "e", "foo.txt"));
399   EXPECT_THAT(GetComponents("/.c/.d/../."),
400               testing::ElementsAre("/", ".c", ".d", "..", "."));
401   EXPECT_THAT(GetComponents("c:\\c\\e\\foo.txt", path::Style::windows),
402               testing::ElementsAre("c:", "\\", "c", "e", "foo.txt"));
403   EXPECT_THAT(GetComponents("c:\\c\\e\\foo.txt", path::Style::windows_slash),
404               testing::ElementsAre("c:", "\\", "c", "e", "foo.txt"));
405   EXPECT_THAT(GetComponents("//net/"), testing::ElementsAre("//net", "/"));
406   EXPECT_THAT(GetComponents("//net/c/foo.txt"),
407               testing::ElementsAre("//net", "/", "c", "foo.txt"));
408 }
409 
410 TEST(Support, AbsolutePathIteratorEnd) {
411   // Trailing slashes are converted to '.' unless they are part of the root path.
412   SmallVector<std::pair<StringRef, path::Style>, 4> Paths;
413   Paths.emplace_back("/foo/", path::Style::native);
414   Paths.emplace_back("/foo//", path::Style::native);
415   Paths.emplace_back("//net/foo/", path::Style::native);
416   Paths.emplace_back("c:\\foo\\", path::Style::windows);
417 
418   for (auto &Path : Paths) {
419     SCOPED_TRACE(Path.first);
420     StringRef LastComponent = *path::rbegin(Path.first, Path.second);
421     EXPECT_EQ(".", LastComponent);
422   }
423 
424   SmallVector<std::pair<StringRef, path::Style>, 3> RootPaths;
425   RootPaths.emplace_back("/", path::Style::native);
426   RootPaths.emplace_back("//net/", path::Style::native);
427   RootPaths.emplace_back("c:\\", path::Style::windows);
428   RootPaths.emplace_back("//net//", path::Style::native);
429   RootPaths.emplace_back("c:\\\\", path::Style::windows);
430 
431   for (auto &Path : RootPaths) {
432     SCOPED_TRACE(Path.first);
433     StringRef LastComponent = *path::rbegin(Path.first, Path.second);
434     EXPECT_EQ(1u, LastComponent.size());
435     EXPECT_TRUE(path::is_separator(LastComponent[0], Path.second));
436   }
437 }
438 
439 #ifdef _WIN32
440 std::string getEnvWin(const wchar_t *Var) {
441   std::string expected;
442   if (wchar_t const *path = ::_wgetenv(Var)) {
443     auto pathLen = ::wcslen(path);
444     ArrayRef<char> ref{reinterpret_cast<char const *>(path),
445                        pathLen * sizeof(wchar_t)};
446     convertUTF16ToUTF8String(ref, expected);
447     SmallString<32> Buf(expected);
448     path::make_preferred(Buf);
449     expected.assign(Buf.begin(), Buf.end());
450   }
451   return expected;
452 }
453 #else
454 // RAII helper to set and restore an environment variable.
455 class WithEnv {
456   const char *Var;
457   llvm::Optional<std::string> OriginalValue;
458 
459 public:
460   WithEnv(const char *Var, const char *Value) : Var(Var) {
461     if (const char *V = ::getenv(Var))
462       OriginalValue.emplace(V);
463     if (Value)
464       ::setenv(Var, Value, 1);
465     else
466       ::unsetenv(Var);
467   }
468   ~WithEnv() {
469     if (OriginalValue)
470       ::setenv(Var, OriginalValue->c_str(), 1);
471     else
472       ::unsetenv(Var);
473   }
474 };
475 #endif
476 
477 TEST(Support, HomeDirectory) {
478   std::string expected;
479 #ifdef _WIN32
480   expected = getEnvWin(L"USERPROFILE");
481 #else
482   if (char const *path = ::getenv("HOME"))
483     expected = path;
484 #endif
485   // Do not try to test it if we don't know what to expect.
486   // On Windows we use something better than env vars.
487   if (expected.empty())
488     GTEST_SKIP();
489   SmallString<128> HomeDir;
490   auto status = path::home_directory(HomeDir);
491   EXPECT_TRUE(status);
492   EXPECT_EQ(expected, HomeDir);
493 }
494 
495 // Apple has their own solution for this.
496 #if defined(LLVM_ON_UNIX) && !defined(__APPLE__)
497 TEST(Support, HomeDirectoryWithNoEnv) {
498   WithEnv Env("HOME", nullptr);
499 
500   // Don't run the test if we have nothing to compare against.
501   struct passwd *pw = getpwuid(getuid());
502   if (!pw || !pw->pw_dir) return;
503   std::string PwDir = pw->pw_dir;
504 
505   SmallString<128> HomeDir;
506   EXPECT_TRUE(path::home_directory(HomeDir));
507   EXPECT_EQ(PwDir, HomeDir);
508 }
509 
510 TEST(Support, ConfigDirectoryWithEnv) {
511   WithEnv Env("XDG_CONFIG_HOME", "/xdg/config");
512 
513   SmallString<128> ConfigDir;
514   EXPECT_TRUE(path::user_config_directory(ConfigDir));
515   EXPECT_EQ("/xdg/config", ConfigDir);
516 }
517 
518 TEST(Support, ConfigDirectoryNoEnv) {
519   WithEnv Env("XDG_CONFIG_HOME", nullptr);
520 
521   SmallString<128> Fallback;
522   ASSERT_TRUE(path::home_directory(Fallback));
523   path::append(Fallback, ".config");
524 
525   SmallString<128> CacheDir;
526   EXPECT_TRUE(path::user_config_directory(CacheDir));
527   EXPECT_EQ(Fallback, CacheDir);
528 }
529 
530 TEST(Support, CacheDirectoryWithEnv) {
531   WithEnv Env("XDG_CACHE_HOME", "/xdg/cache");
532 
533   SmallString<128> CacheDir;
534   EXPECT_TRUE(path::cache_directory(CacheDir));
535   EXPECT_EQ("/xdg/cache", CacheDir);
536 }
537 
538 TEST(Support, CacheDirectoryNoEnv) {
539   WithEnv Env("XDG_CACHE_HOME", nullptr);
540 
541   SmallString<128> Fallback;
542   ASSERT_TRUE(path::home_directory(Fallback));
543   path::append(Fallback, ".cache");
544 
545   SmallString<128> CacheDir;
546   EXPECT_TRUE(path::cache_directory(CacheDir));
547   EXPECT_EQ(Fallback, CacheDir);
548 }
549 #endif
550 
551 #ifdef __APPLE__
552 TEST(Support, ConfigDirectory) {
553   SmallString<128> Fallback;
554   ASSERT_TRUE(path::home_directory(Fallback));
555   path::append(Fallback, "Library/Preferences");
556 
557   SmallString<128> ConfigDir;
558   EXPECT_TRUE(path::user_config_directory(ConfigDir));
559   EXPECT_EQ(Fallback, ConfigDir);
560 }
561 #endif
562 
563 #ifdef _WIN32
564 TEST(Support, ConfigDirectory) {
565   std::string Expected = getEnvWin(L"LOCALAPPDATA");
566   // Do not try to test it if we don't know what to expect.
567   if (Expected.empty())
568     GTEST_SKIP();
569   SmallString<128> CacheDir;
570   EXPECT_TRUE(path::user_config_directory(CacheDir));
571   EXPECT_EQ(Expected, CacheDir);
572 }
573 
574 TEST(Support, CacheDirectory) {
575   std::string Expected = getEnvWin(L"LOCALAPPDATA");
576   // Do not try to test it if we don't know what to expect.
577   if (Expected.empty())
578     GTEST_SKIP();
579   SmallString<128> CacheDir;
580   EXPECT_TRUE(path::cache_directory(CacheDir));
581   EXPECT_EQ(Expected, CacheDir);
582 }
583 #endif
584 
585 TEST(Support, TempDirectory) {
586   SmallString<32> TempDir;
587   path::system_temp_directory(false, TempDir);
588   EXPECT_TRUE(!TempDir.empty());
589   TempDir.clear();
590   path::system_temp_directory(true, TempDir);
591   EXPECT_TRUE(!TempDir.empty());
592 }
593 
594 #ifdef _WIN32
595 static std::string path2regex(std::string Path) {
596   size_t Pos = 0;
597   bool Forward = path::get_separator()[0] == '/';
598   while ((Pos = Path.find('\\', Pos)) != std::string::npos) {
599     if (Forward) {
600       Path.replace(Pos, 1, "/");
601       Pos += 1;
602     } else {
603       Path.replace(Pos, 1, "\\\\");
604       Pos += 2;
605     }
606   }
607   return Path;
608 }
609 
610 /// Helper for running temp dir test in separated process. See below.
611 #define EXPECT_TEMP_DIR(prepare, expected)                                     \
612   EXPECT_EXIT(                                                                 \
613       {                                                                        \
614         prepare;                                                               \
615         SmallString<300> TempDir;                                              \
616         path::system_temp_directory(true, TempDir);                            \
617         raw_os_ostream(std::cerr) << TempDir;                                  \
618         std::exit(0);                                                          \
619       },                                                                       \
620       ::testing::ExitedWithCode(0), path2regex(expected))
621 
622 TEST(SupportDeathTest, TempDirectoryOnWindows) {
623   // In this test we want to check how system_temp_directory responds to
624   // different values of specific env vars. To prevent corrupting env vars of
625   // the current process all checks are done in separated processes.
626   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"C:\\OtherFolder"), "C:\\OtherFolder");
627   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"C:/Unix/Path/Seperators"),
628                   "C:\\Unix\\Path\\Seperators");
629   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"Local Path"), ".+\\Local Path$");
630   EXPECT_TEMP_DIR(_wputenv_s(L"TMP", L"F:\\TrailingSep\\"), "F:\\TrailingSep");
631   EXPECT_TEMP_DIR(
632       _wputenv_s(L"TMP", L"C:\\2\x03C0r-\x00B5\x00B3\\\x2135\x2080"),
633       "C:\\2\xCF\x80r-\xC2\xB5\xC2\xB3\\\xE2\x84\xB5\xE2\x82\x80");
634 
635   // Test $TMP empty, $TEMP set.
636   EXPECT_TEMP_DIR(
637       {
638         _wputenv_s(L"TMP", L"");
639         _wputenv_s(L"TEMP", L"C:\\Valid\\Path");
640       },
641       "C:\\Valid\\Path");
642 
643   // All related env vars empty
644   EXPECT_TEMP_DIR(
645   {
646     _wputenv_s(L"TMP", L"");
647     _wputenv_s(L"TEMP", L"");
648     _wputenv_s(L"USERPROFILE", L"");
649   },
650     "C:\\Temp");
651 
652   // Test evn var / path with 260 chars.
653   SmallString<270> Expected{"C:\\Temp\\AB\\123456789"};
654   while (Expected.size() < 260)
655     Expected.append("\\DirNameWith19Charss");
656   ASSERT_EQ(260U, Expected.size());
657   EXPECT_TEMP_DIR(_putenv_s("TMP", Expected.c_str()), Expected.c_str());
658 }
659 #endif
660 
661 class FileSystemTest : public testing::Test {
662 protected:
663   /// Unique temporary directory in which all created filesystem entities must
664   /// be placed. It is removed at the end of each test (must be empty).
665   SmallString<128> TestDirectory;
666   SmallString<128> NonExistantFile;
667 
668   void SetUp() override {
669     ASSERT_NO_ERROR(
670         fs::createUniqueDirectory("file-system-test", TestDirectory));
671     // We don't care about this specific file.
672     errs() << "Test Directory: " << TestDirectory << '\n';
673     errs().flush();
674     NonExistantFile = TestDirectory;
675 
676     // Even though this value is hardcoded, is a 128-bit GUID, so we should be
677     // guaranteed that this file will never exist.
678     sys::path::append(NonExistantFile, "1B28B495C16344CB9822E588CD4C3EF0");
679   }
680 
681   void TearDown() override { ASSERT_NO_ERROR(fs::remove(TestDirectory.str())); }
682 };
683 
684 TEST_F(FileSystemTest, Unique) {
685   // Create a temp file.
686   int FileDescriptor;
687   SmallString<64> TempPath;
688   ASSERT_NO_ERROR(
689       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
690 
691   // The same file should return an identical unique id.
692   fs::UniqueID F1, F2;
693   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
694   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
695   ASSERT_EQ(F1, F2);
696 
697   // Different files should return different unique ids.
698   int FileDescriptor2;
699   SmallString<64> TempPath2;
700   ASSERT_NO_ERROR(
701       fs::createTemporaryFile("prefix", "temp", FileDescriptor2, TempPath2));
702 
703   fs::UniqueID D;
704   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
705   ASSERT_NE(D, F1);
706   ::close(FileDescriptor2);
707 
708   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
709 
710   // Two paths representing the same file on disk should still provide the
711   // same unique id.  We can test this by making a hard link.
712   ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
713   fs::UniqueID D2;
714   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
715   ASSERT_EQ(D2, F1);
716 
717   ::close(FileDescriptor);
718 
719   SmallString<128> Dir1;
720   ASSERT_NO_ERROR(
721      fs::createUniqueDirectory("dir1", Dir1));
722   ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F1));
723   ASSERT_NO_ERROR(fs::getUniqueID(Dir1.c_str(), F2));
724   ASSERT_EQ(F1, F2);
725 
726   SmallString<128> Dir2;
727   ASSERT_NO_ERROR(
728      fs::createUniqueDirectory("dir2", Dir2));
729   ASSERT_NO_ERROR(fs::getUniqueID(Dir2.c_str(), F2));
730   ASSERT_NE(F1, F2);
731   ASSERT_NO_ERROR(fs::remove(Dir1));
732   ASSERT_NO_ERROR(fs::remove(Dir2));
733   ASSERT_NO_ERROR(fs::remove(TempPath2));
734   ASSERT_NO_ERROR(fs::remove(TempPath));
735 }
736 
737 TEST_F(FileSystemTest, RealPath) {
738   ASSERT_NO_ERROR(
739       fs::create_directories(Twine(TestDirectory) + "/test1/test2/test3"));
740   ASSERT_TRUE(fs::exists(Twine(TestDirectory) + "/test1/test2/test3"));
741 
742   SmallString<64> RealBase;
743   SmallString<64> Expected;
744   SmallString<64> Actual;
745 
746   // TestDirectory itself might be under a symlink or have been specified with
747   // a different case than the existing temp directory.  In such cases real_path
748   // on the concatenated path will differ in the TestDirectory portion from
749   // how we specified it.  Make sure to compare against the real_path of the
750   // TestDirectory, and not just the value of TestDirectory.
751   ASSERT_NO_ERROR(fs::real_path(TestDirectory, RealBase));
752   checkSeparators(RealBase);
753   path::native(Twine(RealBase) + "/test1/test2", Expected);
754 
755   ASSERT_NO_ERROR(fs::real_path(
756       Twine(TestDirectory) + "/././test1/../test1/test2/./test3/..", Actual));
757   checkSeparators(Actual);
758 
759   EXPECT_EQ(Expected, Actual);
760 
761   SmallString<64> HomeDir;
762 
763   // This can fail if $HOME is not set and getpwuid fails.
764   bool Result = llvm::sys::path::home_directory(HomeDir);
765   if (Result) {
766     checkSeparators(HomeDir);
767     ASSERT_NO_ERROR(fs::real_path(HomeDir, Expected));
768     checkSeparators(Expected);
769     ASSERT_NO_ERROR(fs::real_path("~", Actual, true));
770     EXPECT_EQ(Expected, Actual);
771     ASSERT_NO_ERROR(fs::real_path("~/", Actual, true));
772     EXPECT_EQ(Expected, Actual);
773   }
774 
775   ASSERT_NO_ERROR(fs::remove_directories(Twine(TestDirectory) + "/test1"));
776 }
777 
778 TEST_F(FileSystemTest, ExpandTilde) {
779   SmallString<64> Expected;
780   SmallString<64> Actual;
781   SmallString<64> HomeDir;
782 
783   // This can fail if $HOME is not set and getpwuid fails.
784   bool Result = llvm::sys::path::home_directory(HomeDir);
785   if (Result) {
786     fs::expand_tilde(HomeDir, Expected);
787 
788     fs::expand_tilde("~", Actual);
789     EXPECT_EQ(Expected, Actual);
790 
791 #ifdef _WIN32
792     Expected += "\\foo";
793     fs::expand_tilde("~\\foo", Actual);
794 #else
795     Expected += "/foo";
796     fs::expand_tilde("~/foo", Actual);
797 #endif
798 
799     EXPECT_EQ(Expected, Actual);
800   }
801 }
802 
803 #ifdef LLVM_ON_UNIX
804 TEST_F(FileSystemTest, RealPathNoReadPerm) {
805   SmallString<64> Expanded;
806 
807   ASSERT_NO_ERROR(
808     fs::create_directories(Twine(TestDirectory) + "/noreadperm"));
809   ASSERT_TRUE(fs::exists(Twine(TestDirectory) + "/noreadperm"));
810 
811   fs::setPermissions(Twine(TestDirectory) + "/noreadperm", fs::no_perms);
812   fs::setPermissions(Twine(TestDirectory) + "/noreadperm", fs::all_exe);
813 
814   ASSERT_NO_ERROR(fs::real_path(Twine(TestDirectory) + "/noreadperm", Expanded,
815                                 false));
816 
817   ASSERT_NO_ERROR(fs::remove_directories(Twine(TestDirectory) + "/noreadperm"));
818 }
819 TEST_F(FileSystemTest, RemoveDirectoriesNoExePerm) {
820   SmallString<64> Expanded;
821 
822   ASSERT_NO_ERROR(
823       fs::create_directories(Twine(TestDirectory) + "/noexeperm/foo"));
824   ASSERT_TRUE(fs::exists(Twine(TestDirectory) + "/noexeperm/foo"));
825 
826   fs::setPermissions(Twine(TestDirectory) + "/noexeperm",
827                      fs::all_read | fs::all_write);
828 
829   ASSERT_NO_ERROR(fs::remove_directories(Twine(TestDirectory) + "/noexeperm",
830                                          /*IgnoreErrors=*/true));
831   ASSERT_TRUE(fs::exists(Twine(TestDirectory) + "/noexeperm"));
832   ASSERT_EQ(fs::remove_directories(Twine(TestDirectory) + "/noexeperm",
833                                    /*IgnoreErrors=*/false),
834             errc::permission_denied);
835 
836   fs::setPermissions(Twine(TestDirectory) + "/noexeperm", fs::all_perms);
837 
838   ASSERT_NO_ERROR(fs::remove_directories(Twine(TestDirectory) + "/noexeperm",
839                                          /*IgnoreErrors=*/false));
840 }
841 #endif
842 
843 
844 TEST_F(FileSystemTest, TempFileKeepDiscard) {
845   // We can keep then discard.
846   auto TempFileOrError = fs::TempFile::create(TestDirectory + "/test-%%%%");
847   ASSERT_TRUE((bool)TempFileOrError);
848   fs::TempFile File = std::move(*TempFileOrError);
849   ASSERT_EQ(-1, TempFileOrError->FD);
850   ASSERT_FALSE((bool)File.keep(TestDirectory + "/keep"));
851   ASSERT_FALSE((bool)File.discard());
852   ASSERT_TRUE(fs::exists(TestDirectory + "/keep"));
853   ASSERT_NO_ERROR(fs::remove(TestDirectory + "/keep"));
854 }
855 
856 TEST_F(FileSystemTest, TempFileDiscardDiscard) {
857   // We can discard twice.
858   auto TempFileOrError = fs::TempFile::create(TestDirectory + "/test-%%%%");
859   ASSERT_TRUE((bool)TempFileOrError);
860   fs::TempFile File = std::move(*TempFileOrError);
861   ASSERT_EQ(-1, TempFileOrError->FD);
862   ASSERT_FALSE((bool)File.discard());
863   ASSERT_FALSE((bool)File.discard());
864   ASSERT_FALSE(fs::exists(TestDirectory + "/keep"));
865 }
866 
867 TEST_F(FileSystemTest, TempFiles) {
868   // Create a temp file.
869   int FileDescriptor;
870   SmallString<64> TempPath;
871   ASSERT_NO_ERROR(
872       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
873 
874   // Make sure it exists.
875   ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
876 
877   // Create another temp tile.
878   int FD2;
879   SmallString<64> TempPath2;
880   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD2, TempPath2));
881   ASSERT_TRUE(TempPath2.endswith(".temp"));
882   ASSERT_NE(TempPath.str(), TempPath2.str());
883 
884   fs::file_status A, B;
885   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
886   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
887   EXPECT_FALSE(fs::equivalent(A, B));
888 
889   ::close(FD2);
890 
891   // Remove Temp2.
892   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
893   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
894   ASSERT_EQ(fs::remove(Twine(TempPath2), false),
895             errc::no_such_file_or_directory);
896 
897   std::error_code EC = fs::status(TempPath2.c_str(), B);
898   EXPECT_EQ(EC, errc::no_such_file_or_directory);
899   EXPECT_EQ(B.type(), fs::file_type::file_not_found);
900 
901   // Make sure Temp2 doesn't exist.
902   ASSERT_EQ(fs::access(Twine(TempPath2), sys::fs::AccessMode::Exist),
903             errc::no_such_file_or_directory);
904 
905   SmallString<64> TempPath3;
906   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "", TempPath3));
907   ASSERT_FALSE(TempPath3.endswith("."));
908   FileRemover Cleanup3(TempPath3);
909 
910   // Create a hard link to Temp1.
911   ASSERT_NO_ERROR(fs::create_link(Twine(TempPath), Twine(TempPath2)));
912   bool equal;
913   ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
914   EXPECT_TRUE(equal);
915   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
916   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
917   EXPECT_TRUE(fs::equivalent(A, B));
918 
919   // Remove Temp1.
920   ::close(FileDescriptor);
921   ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
922 
923   // Remove the hard link.
924   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
925 
926   // Make sure Temp1 doesn't exist.
927   ASSERT_EQ(fs::access(Twine(TempPath), sys::fs::AccessMode::Exist),
928             errc::no_such_file_or_directory);
929 
930 #ifdef _WIN32
931   // Path name > 260 chars should get an error.
932   const char *Path270 =
933     "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
934     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
935     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
936     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
937     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
938   EXPECT_EQ(fs::createUniqueFile(Path270, FileDescriptor, TempPath),
939             errc::invalid_argument);
940   // Relative path < 247 chars, no problem.
941   const char *Path216 =
942     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
943     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
944     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
945     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
946   ASSERT_NO_ERROR(fs::createTemporaryFile(Path216, "", TempPath));
947   ASSERT_NO_ERROR(fs::remove(Twine(TempPath)));
948 #endif
949 }
950 
951 TEST_F(FileSystemTest, TempFileCollisions) {
952   SmallString<128> TestDirectory;
953   ASSERT_NO_ERROR(
954       fs::createUniqueDirectory("CreateUniqueFileTest", TestDirectory));
955   FileRemover Cleanup(TestDirectory);
956   SmallString<128> Model = TestDirectory;
957   path::append(Model, "%.tmp");
958   SmallString<128> Path;
959   std::vector<fs::TempFile> TempFiles;
960 
961   auto TryCreateTempFile = [&]() {
962     Expected<fs::TempFile> T = fs::TempFile::create(Model);
963     if (T) {
964       TempFiles.push_back(std::move(*T));
965       return true;
966     } else {
967       logAllUnhandledErrors(T.takeError(), errs(),
968                             "Failed to create temporary file: ");
969       return false;
970     }
971   };
972 
973   // Our single-character template allows for 16 unique names. Check that
974   // calling TryCreateTempFile repeatedly results in 16 successes.
975   // Because the test depends on random numbers, it could theoretically fail.
976   // However, the probability of this happening is tiny: with 32 calls, each
977   // of which will retry up to 128 times, to not get a given digit we would
978   // have to fail at least 15 + 17 * 128 = 2191 attempts. The probability of
979   // 2191 attempts not producing a given hexadecimal digit is
980   // (1 - 1/16) ** 2191 or 3.88e-62.
981   int Successes = 0;
982   for (int i = 0; i < 32; ++i)
983     if (TryCreateTempFile()) ++Successes;
984   EXPECT_EQ(Successes, 16);
985 
986   for (fs::TempFile &T : TempFiles)
987     cantFail(T.discard());
988 }
989 
990 TEST_F(FileSystemTest, CreateDir) {
991   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
992   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "foo"));
993   ASSERT_EQ(fs::create_directory(Twine(TestDirectory) + "foo", false),
994             errc::file_exists);
995   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "foo"));
996 
997 #ifdef LLVM_ON_UNIX
998   // Set a 0000 umask so that we can test our directory permissions.
999   mode_t OldUmask = ::umask(0000);
1000 
1001   fs::file_status Status;
1002   ASSERT_NO_ERROR(
1003       fs::create_directory(Twine(TestDirectory) + "baz500", false,
1004                            fs::perms::owner_read | fs::perms::owner_exe));
1005   ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz500", Status));
1006   ASSERT_EQ(Status.permissions() & fs::perms::all_all,
1007             fs::perms::owner_read | fs::perms::owner_exe);
1008   ASSERT_NO_ERROR(fs::create_directory(Twine(TestDirectory) + "baz777", false,
1009                                        fs::perms::all_all));
1010   ASSERT_NO_ERROR(fs::status(Twine(TestDirectory) + "baz777", Status));
1011   ASSERT_EQ(Status.permissions() & fs::perms::all_all, fs::perms::all_all);
1012 
1013   // Restore umask to be safe.
1014   ::umask(OldUmask);
1015 #endif
1016 
1017 #ifdef _WIN32
1018   // Prove that create_directories() can handle a pathname > 248 characters,
1019   // which is the documented limit for CreateDirectory().
1020   // (248 is MAX_PATH subtracting room for an 8.3 filename.)
1021   // Generate a directory path guaranteed to fall into that range.
1022   size_t TmpLen = TestDirectory.size();
1023   const char *OneDir = "\\123456789";
1024   size_t OneDirLen = strlen(OneDir);
1025   ASSERT_LT(OneDirLen, 12U);
1026   size_t NLevels = ((248 - TmpLen) / OneDirLen) + 1;
1027   SmallString<260> LongDir(TestDirectory);
1028   for (size_t I = 0; I < NLevels; ++I)
1029     LongDir.append(OneDir);
1030   ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
1031   ASSERT_NO_ERROR(fs::create_directories(Twine(LongDir)));
1032   ASSERT_EQ(fs::create_directories(Twine(LongDir), false),
1033             errc::file_exists);
1034   // Tidy up, "recursively" removing the directories.
1035   StringRef ThisDir(LongDir);
1036   for (size_t J = 0; J < NLevels; ++J) {
1037     ASSERT_NO_ERROR(fs::remove(ThisDir));
1038     ThisDir = path::parent_path(ThisDir);
1039   }
1040 
1041   // Also verify that paths with Unix separators are handled correctly.
1042   std::string LongPathWithUnixSeparators(TestDirectory.str());
1043   // Add at least one subdirectory to TestDirectory, and replace slashes with
1044   // backslashes
1045   do {
1046     LongPathWithUnixSeparators.append("/DirNameWith19Charss");
1047   } while (LongPathWithUnixSeparators.size() < 260);
1048   std::replace(LongPathWithUnixSeparators.begin(),
1049                LongPathWithUnixSeparators.end(),
1050                '\\', '/');
1051   ASSERT_NO_ERROR(fs::create_directories(Twine(LongPathWithUnixSeparators)));
1052   // cleanup
1053   ASSERT_NO_ERROR(fs::remove_directories(Twine(TestDirectory) +
1054                                          "/DirNameWith19Charss"));
1055 
1056   // Similarly for a relative pathname.  Need to set the current directory to
1057   // TestDirectory so that the one we create ends up in the right place.
1058   char PreviousDir[260];
1059   size_t PreviousDirLen = ::GetCurrentDirectoryA(260, PreviousDir);
1060   ASSERT_GT(PreviousDirLen, 0U);
1061   ASSERT_LT(PreviousDirLen, 260U);
1062   ASSERT_NE(::SetCurrentDirectoryA(TestDirectory.c_str()), 0);
1063   LongDir.clear();
1064   // Generate a relative directory name with absolute length > 248.
1065   size_t LongDirLen = 249 - TestDirectory.size();
1066   LongDir.assign(LongDirLen, 'a');
1067   ASSERT_NO_ERROR(fs::create_directory(Twine(LongDir)));
1068   // While we're here, prove that .. and . handling works in these long paths.
1069   const char *DotDotDirs = "\\..\\.\\b";
1070   LongDir.append(DotDotDirs);
1071   ASSERT_NO_ERROR(fs::create_directory("b"));
1072   ASSERT_EQ(fs::create_directory(Twine(LongDir), false), errc::file_exists);
1073   // And clean up.
1074   ASSERT_NO_ERROR(fs::remove("b"));
1075   ASSERT_NO_ERROR(fs::remove(
1076     Twine(LongDir.substr(0, LongDir.size() - strlen(DotDotDirs)))));
1077   ASSERT_NE(::SetCurrentDirectoryA(PreviousDir), 0);
1078 #endif
1079 }
1080 
1081 TEST_F(FileSystemTest, DirectoryIteration) {
1082   std::error_code ec;
1083   for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
1084     ASSERT_NO_ERROR(ec);
1085 
1086   // Create a known hierarchy to recurse over.
1087   ASSERT_NO_ERROR(
1088       fs::create_directories(Twine(TestDirectory) + "/recursive/a0/aa1"));
1089   ASSERT_NO_ERROR(
1090       fs::create_directories(Twine(TestDirectory) + "/recursive/a0/ab1"));
1091   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory) +
1092                                          "/recursive/dontlookhere/da1"));
1093   ASSERT_NO_ERROR(
1094       fs::create_directories(Twine(TestDirectory) + "/recursive/z0/za1"));
1095   ASSERT_NO_ERROR(
1096       fs::create_directories(Twine(TestDirectory) + "/recursive/pop/p1"));
1097   typedef std::vector<std::string> v_t;
1098   v_t visited;
1099   for (fs::recursive_directory_iterator i(Twine(TestDirectory)
1100          + "/recursive", ec), e; i != e; i.increment(ec)){
1101     ASSERT_NO_ERROR(ec);
1102     if (path::filename(i->path()) == "p1") {
1103       i.pop();
1104       // FIXME: recursive_directory_iterator should be more robust.
1105       if (i == e) break;
1106     }
1107     if (path::filename(i->path()) == "dontlookhere")
1108       i.no_push();
1109     visited.push_back(std::string(path::filename(i->path())));
1110   }
1111   v_t::const_iterator a0 = find(visited, "a0");
1112   v_t::const_iterator aa1 = find(visited, "aa1");
1113   v_t::const_iterator ab1 = find(visited, "ab1");
1114   v_t::const_iterator dontlookhere = find(visited, "dontlookhere");
1115   v_t::const_iterator da1 = find(visited, "da1");
1116   v_t::const_iterator z0 = find(visited, "z0");
1117   v_t::const_iterator za1 = find(visited, "za1");
1118   v_t::const_iterator pop = find(visited, "pop");
1119   v_t::const_iterator p1 = find(visited, "p1");
1120 
1121   // Make sure that each path was visited correctly.
1122   ASSERT_NE(a0, visited.end());
1123   ASSERT_NE(aa1, visited.end());
1124   ASSERT_NE(ab1, visited.end());
1125   ASSERT_NE(dontlookhere, visited.end());
1126   ASSERT_EQ(da1, visited.end()); // Not visited.
1127   ASSERT_NE(z0, visited.end());
1128   ASSERT_NE(za1, visited.end());
1129   ASSERT_NE(pop, visited.end());
1130   ASSERT_EQ(p1, visited.end()); // Not visited.
1131 
1132   // Make sure that parents were visited before children. No other ordering
1133   // guarantees can be made across siblings.
1134   ASSERT_LT(a0, aa1);
1135   ASSERT_LT(a0, ab1);
1136   ASSERT_LT(z0, za1);
1137 
1138   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/aa1"));
1139   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0/ab1"));
1140   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/a0"));
1141   ASSERT_NO_ERROR(
1142       fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere/da1"));
1143   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/dontlookhere"));
1144   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop/p1"));
1145   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/pop"));
1146   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0/za1"));
1147   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive/z0"));
1148   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/recursive"));
1149 
1150   // Test recursive_directory_iterator level()
1151   ASSERT_NO_ERROR(
1152       fs::create_directories(Twine(TestDirectory) + "/reclevel/a/b/c"));
1153   fs::recursive_directory_iterator I(Twine(TestDirectory) + "/reclevel", ec), E;
1154   for (int l = 0; I != E; I.increment(ec), ++l) {
1155     ASSERT_NO_ERROR(ec);
1156     EXPECT_EQ(I.level(), l);
1157   }
1158   EXPECT_EQ(I, E);
1159   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel/a/b/c"));
1160   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel/a/b"));
1161   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel/a"));
1162   ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory) + "/reclevel"));
1163 }
1164 
1165 TEST_F(FileSystemTest, DirectoryNotExecutable) {
1166   ASSERT_EQ(fs::access(TestDirectory, sys::fs::AccessMode::Execute),
1167             errc::permission_denied);
1168 }
1169 
1170 #ifdef LLVM_ON_UNIX
1171 TEST_F(FileSystemTest, BrokenSymlinkDirectoryIteration) {
1172   // Create a known hierarchy to recurse over.
1173   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory) + "/symlink"));
1174   ASSERT_NO_ERROR(
1175       fs::create_link("no_such_file", Twine(TestDirectory) + "/symlink/a"));
1176   ASSERT_NO_ERROR(
1177       fs::create_directories(Twine(TestDirectory) + "/symlink/b/bb"));
1178   ASSERT_NO_ERROR(
1179       fs::create_link("no_such_file", Twine(TestDirectory) + "/symlink/b/ba"));
1180   ASSERT_NO_ERROR(
1181       fs::create_link("no_such_file", Twine(TestDirectory) + "/symlink/b/bc"));
1182   ASSERT_NO_ERROR(
1183       fs::create_link("no_such_file", Twine(TestDirectory) + "/symlink/c"));
1184   ASSERT_NO_ERROR(
1185       fs::create_directories(Twine(TestDirectory) + "/symlink/d/dd/ddd"));
1186   ASSERT_NO_ERROR(fs::create_link(Twine(TestDirectory) + "/symlink/d/dd",
1187                                   Twine(TestDirectory) + "/symlink/d/da"));
1188   ASSERT_NO_ERROR(
1189       fs::create_link("no_such_file", Twine(TestDirectory) + "/symlink/e"));
1190 
1191   typedef std::vector<std::string> v_t;
1192   v_t VisitedNonBrokenSymlinks;
1193   v_t VisitedBrokenSymlinks;
1194   std::error_code ec;
1195   using testing::UnorderedElementsAre;
1196   using testing::UnorderedElementsAreArray;
1197 
1198   // Broken symbol links are expected to throw an error.
1199   for (fs::directory_iterator i(Twine(TestDirectory) + "/symlink", ec), e;
1200        i != e; i.increment(ec)) {
1201     ASSERT_NO_ERROR(ec);
1202     if (i->status().getError() ==
1203         std::make_error_code(std::errc::no_such_file_or_directory)) {
1204       VisitedBrokenSymlinks.push_back(std::string(path::filename(i->path())));
1205       continue;
1206     }
1207     VisitedNonBrokenSymlinks.push_back(std::string(path::filename(i->path())));
1208   }
1209   EXPECT_THAT(VisitedNonBrokenSymlinks, UnorderedElementsAre("b", "d"));
1210   VisitedNonBrokenSymlinks.clear();
1211 
1212   EXPECT_THAT(VisitedBrokenSymlinks, UnorderedElementsAre("a", "c", "e"));
1213   VisitedBrokenSymlinks.clear();
1214 
1215   // Broken symbol links are expected to throw an error.
1216   for (fs::recursive_directory_iterator i(
1217       Twine(TestDirectory) + "/symlink", ec), e; i != e; i.increment(ec)) {
1218     ASSERT_NO_ERROR(ec);
1219     if (i->status().getError() ==
1220         std::make_error_code(std::errc::no_such_file_or_directory)) {
1221       VisitedBrokenSymlinks.push_back(std::string(path::filename(i->path())));
1222       continue;
1223     }
1224     VisitedNonBrokenSymlinks.push_back(std::string(path::filename(i->path())));
1225   }
1226   EXPECT_THAT(VisitedNonBrokenSymlinks,
1227               UnorderedElementsAre("b", "bb", "d", "da", "dd", "ddd", "ddd"));
1228   VisitedNonBrokenSymlinks.clear();
1229 
1230   EXPECT_THAT(VisitedBrokenSymlinks,
1231               UnorderedElementsAre("a", "ba", "bc", "c", "e"));
1232   VisitedBrokenSymlinks.clear();
1233 
1234   for (fs::recursive_directory_iterator i(
1235       Twine(TestDirectory) + "/symlink", ec, /*follow_symlinks=*/false), e;
1236        i != e; i.increment(ec)) {
1237     ASSERT_NO_ERROR(ec);
1238     if (i->status().getError() ==
1239         std::make_error_code(std::errc::no_such_file_or_directory)) {
1240       VisitedBrokenSymlinks.push_back(std::string(path::filename(i->path())));
1241       continue;
1242     }
1243     VisitedNonBrokenSymlinks.push_back(std::string(path::filename(i->path())));
1244   }
1245   EXPECT_THAT(VisitedNonBrokenSymlinks,
1246               UnorderedElementsAreArray({"a", "b", "ba", "bb", "bc", "c", "d",
1247                                          "da", "dd", "ddd", "e"}));
1248   VisitedNonBrokenSymlinks.clear();
1249 
1250   EXPECT_THAT(VisitedBrokenSymlinks, UnorderedElementsAre());
1251   VisitedBrokenSymlinks.clear();
1252 
1253   ASSERT_NO_ERROR(fs::remove_directories(Twine(TestDirectory) + "/symlink"));
1254 }
1255 #endif
1256 
1257 #ifdef _WIN32
1258 TEST_F(FileSystemTest, UTF8ToUTF16DirectoryIteration) {
1259   // The Windows filesystem support uses UTF-16 and converts paths from the
1260   // input UTF-8. The UTF-16 equivalent of the input path can be shorter in
1261   // length.
1262 
1263   // This test relies on TestDirectory not being so long such that MAX_PATH
1264   // would be exceeded (see widenPath). If that were the case, the UTF-16
1265   // path is likely to be longer than the input.
1266   const char *Pi = "\xcf\x80"; // UTF-8 lower case pi.
1267   std::string RootDir = (TestDirectory + "/" + Pi).str();
1268 
1269   // Create test directories.
1270   ASSERT_NO_ERROR(fs::create_directories(Twine(RootDir) + "/a"));
1271   ASSERT_NO_ERROR(fs::create_directories(Twine(RootDir) + "/b"));
1272 
1273   std::error_code EC;
1274   unsigned Count = 0;
1275   for (fs::directory_iterator I(Twine(RootDir), EC), E; I != E;
1276        I.increment(EC)) {
1277     ASSERT_NO_ERROR(EC);
1278     StringRef DirName = path::filename(I->path());
1279     EXPECT_TRUE(DirName == "a" || DirName == "b");
1280     ++Count;
1281   }
1282   EXPECT_EQ(Count, 2U);
1283 
1284   ASSERT_NO_ERROR(fs::remove(Twine(RootDir) + "/a"));
1285   ASSERT_NO_ERROR(fs::remove(Twine(RootDir) + "/b"));
1286   ASSERT_NO_ERROR(fs::remove(Twine(RootDir)));
1287 }
1288 #endif
1289 
1290 TEST_F(FileSystemTest, Remove) {
1291   SmallString<64> BaseDir;
1292   SmallString<64> Paths[4];
1293   int fds[4];
1294   ASSERT_NO_ERROR(fs::createUniqueDirectory("fs_remove", BaseDir));
1295 
1296   ASSERT_NO_ERROR(fs::create_directories(Twine(BaseDir) + "/foo/bar/baz"));
1297   ASSERT_NO_ERROR(fs::create_directories(Twine(BaseDir) + "/foo/bar/buzz"));
1298   ASSERT_NO_ERROR(fs::createUniqueFile(
1299       Twine(BaseDir) + "/foo/bar/baz/%%%%%%.tmp", fds[0], Paths[0]));
1300   ASSERT_NO_ERROR(fs::createUniqueFile(
1301       Twine(BaseDir) + "/foo/bar/baz/%%%%%%.tmp", fds[1], Paths[1]));
1302   ASSERT_NO_ERROR(fs::createUniqueFile(
1303       Twine(BaseDir) + "/foo/bar/buzz/%%%%%%.tmp", fds[2], Paths[2]));
1304   ASSERT_NO_ERROR(fs::createUniqueFile(
1305       Twine(BaseDir) + "/foo/bar/buzz/%%%%%%.tmp", fds[3], Paths[3]));
1306 
1307   for (int fd : fds)
1308     ::close(fd);
1309 
1310   EXPECT_TRUE(fs::exists(Twine(BaseDir) + "/foo/bar/baz"));
1311   EXPECT_TRUE(fs::exists(Twine(BaseDir) + "/foo/bar/buzz"));
1312   EXPECT_TRUE(fs::exists(Paths[0]));
1313   EXPECT_TRUE(fs::exists(Paths[1]));
1314   EXPECT_TRUE(fs::exists(Paths[2]));
1315   EXPECT_TRUE(fs::exists(Paths[3]));
1316 
1317   ASSERT_NO_ERROR(fs::remove_directories("D:/footest"));
1318 
1319   ASSERT_NO_ERROR(fs::remove_directories(BaseDir));
1320   ASSERT_FALSE(fs::exists(BaseDir));
1321 }
1322 
1323 #ifdef _WIN32
1324 TEST_F(FileSystemTest, CarriageReturn) {
1325   SmallString<128> FilePathname(TestDirectory);
1326   std::error_code EC;
1327   path::append(FilePathname, "test");
1328 
1329   {
1330     raw_fd_ostream File(FilePathname, EC, sys::fs::OF_TextWithCRLF);
1331     ASSERT_NO_ERROR(EC);
1332     File << '\n';
1333   }
1334   {
1335     auto Buf = MemoryBuffer::getFile(FilePathname.str());
1336     EXPECT_TRUE((bool)Buf);
1337     EXPECT_EQ(Buf.get()->getBuffer(), "\r\n");
1338   }
1339 
1340   {
1341     raw_fd_ostream File(FilePathname, EC, sys::fs::OF_None);
1342     ASSERT_NO_ERROR(EC);
1343     File << '\n';
1344   }
1345   {
1346     auto Buf = MemoryBuffer::getFile(FilePathname.str());
1347     EXPECT_TRUE((bool)Buf);
1348     EXPECT_EQ(Buf.get()->getBuffer(), "\n");
1349   }
1350   ASSERT_NO_ERROR(fs::remove(Twine(FilePathname)));
1351 }
1352 #endif
1353 
1354 TEST_F(FileSystemTest, Resize) {
1355   int FD;
1356   SmallString<64> TempPath;
1357   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
1358   ASSERT_NO_ERROR(fs::resize_file(FD, 123));
1359   fs::file_status Status;
1360   ASSERT_NO_ERROR(fs::status(FD, Status));
1361   ASSERT_EQ(Status.getSize(), 123U);
1362   ::close(FD);
1363   ASSERT_NO_ERROR(fs::remove(TempPath));
1364 }
1365 
1366 TEST_F(FileSystemTest, ResizeBeforeMapping) {
1367   // Create a temp file.
1368   int FD;
1369   SmallString<64> TempPath;
1370   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
1371   ASSERT_NO_ERROR(fs::resize_file_before_mapping_readwrite(FD, 123));
1372 
1373   // Map in temp file. On Windows, fs::resize_file_before_mapping_readwrite is
1374   // a no-op and the mapping itself will resize the file.
1375   std::error_code EC;
1376   {
1377     fs::mapped_file_region mfr(fs::convertFDToNativeFile(FD),
1378                                fs::mapped_file_region::readwrite, 123, 0, EC);
1379     ASSERT_NO_ERROR(EC);
1380     // Unmap temp file
1381   }
1382 
1383   // Check the size.
1384   fs::file_status Status;
1385   ASSERT_NO_ERROR(fs::status(FD, Status));
1386   ASSERT_EQ(Status.getSize(), 123U);
1387   ::close(FD);
1388   ASSERT_NO_ERROR(fs::remove(TempPath));
1389 }
1390 
1391 TEST_F(FileSystemTest, MD5) {
1392   int FD;
1393   SmallString<64> TempPath;
1394   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
1395   StringRef Data("abcdefghijklmnopqrstuvwxyz");
1396   ASSERT_EQ(write(FD, Data.data(), Data.size()), static_cast<ssize_t>(Data.size()));
1397   lseek(FD, 0, SEEK_SET);
1398   auto Hash = fs::md5_contents(FD);
1399   ::close(FD);
1400   ASSERT_NO_ERROR(Hash.getError());
1401 
1402   EXPECT_STREQ("c3fcd3d76192e4007dfb496cca67e13b", Hash->digest().c_str());
1403 }
1404 
1405 TEST_F(FileSystemTest, FileMapping) {
1406   // Create a temp file.
1407   int FileDescriptor;
1408   SmallString<64> TempPath;
1409   ASSERT_NO_ERROR(
1410       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
1411   unsigned Size = 4096;
1412   ASSERT_NO_ERROR(
1413       fs::resize_file_before_mapping_readwrite(FileDescriptor, Size));
1414 
1415   // Map in temp file and add some content
1416   std::error_code EC;
1417   StringRef Val("hello there");
1418   fs::mapped_file_region MaybeMFR;
1419   EXPECT_FALSE(MaybeMFR);
1420   {
1421     fs::mapped_file_region mfr(fs::convertFDToNativeFile(FileDescriptor),
1422                                fs::mapped_file_region::readwrite, Size, 0, EC);
1423     ASSERT_NO_ERROR(EC);
1424     std::copy(Val.begin(), Val.end(), mfr.data());
1425     // Explicitly add a 0.
1426     mfr.data()[Val.size()] = 0;
1427 
1428     // Move it out of the scope and confirm mfr is reset.
1429     MaybeMFR = std::move(mfr);
1430     EXPECT_FALSE(mfr);
1431 #if !defined(NDEBUG) && GTEST_HAS_DEATH_TEST
1432     EXPECT_DEATH(mfr.data(), "Mapping failed but used anyway!");
1433     EXPECT_DEATH(mfr.size(), "Mapping failed but used anyway!");
1434 #endif
1435   }
1436 
1437   // Check that the moved-to region is still valid.
1438   EXPECT_EQ(Val, StringRef(MaybeMFR.data()));
1439   EXPECT_EQ(Size, MaybeMFR.size());
1440 
1441   // Unmap temp file.
1442   MaybeMFR.unmap();
1443 
1444   ASSERT_EQ(close(FileDescriptor), 0);
1445 
1446   // Map it back in read-only
1447   {
1448     int FD;
1449     EC = fs::openFileForRead(Twine(TempPath), FD);
1450     ASSERT_NO_ERROR(EC);
1451     fs::mapped_file_region mfr(fs::convertFDToNativeFile(FD),
1452                                fs::mapped_file_region::readonly, Size, 0, EC);
1453     ASSERT_NO_ERROR(EC);
1454 
1455     // Verify content
1456     EXPECT_EQ(StringRef(mfr.const_data()), Val);
1457 
1458     // Unmap temp file
1459     fs::mapped_file_region m(fs::convertFDToNativeFile(FD),
1460                              fs::mapped_file_region::readonly, Size, 0, EC);
1461     ASSERT_NO_ERROR(EC);
1462     ASSERT_EQ(close(FD), 0);
1463   }
1464   ASSERT_NO_ERROR(fs::remove(TempPath));
1465 }
1466 
1467 TEST(Support, NormalizePath) {
1468   //                           Input,        Expected Win, Expected Posix
1469   using TestTuple = std::tuple<const char *, const char *, const char *>;
1470   std::vector<TestTuple> Tests;
1471   Tests.emplace_back("a", "a", "a");
1472   Tests.emplace_back("a/b", "a\\b", "a/b");
1473   Tests.emplace_back("a\\b", "a\\b", "a/b");
1474   Tests.emplace_back("a\\\\b", "a\\\\b", "a//b");
1475   Tests.emplace_back("\\a", "\\a", "/a");
1476   Tests.emplace_back("a\\", "a\\", "a/");
1477   Tests.emplace_back("a\\t", "a\\t", "a/t");
1478 
1479   for (auto &T : Tests) {
1480     SmallString<64> Win(std::get<0>(T));
1481     SmallString<64> Posix(Win);
1482     SmallString<64> WinSlash(Win);
1483     path::native(Win, path::Style::windows);
1484     path::native(Posix, path::Style::posix);
1485     path::native(WinSlash, path::Style::windows_slash);
1486     EXPECT_EQ(std::get<1>(T), Win);
1487     EXPECT_EQ(std::get<2>(T), Posix);
1488     EXPECT_EQ(std::get<2>(T), WinSlash);
1489   }
1490 
1491   for (auto &T : Tests) {
1492     SmallString<64> WinBackslash(std::get<0>(T));
1493     SmallString<64> Posix(WinBackslash);
1494     SmallString<64> WinSlash(WinBackslash);
1495     path::make_preferred(WinBackslash, path::Style::windows_backslash);
1496     path::make_preferred(Posix, path::Style::posix);
1497     path::make_preferred(WinSlash, path::Style::windows_slash);
1498     EXPECT_EQ(std::get<1>(T), WinBackslash);
1499     EXPECT_EQ(std::get<0>(T), Posix); // Posix remains unchanged here
1500     EXPECT_EQ(std::get<2>(T), WinSlash);
1501   }
1502 
1503 #if defined(_WIN32)
1504   SmallString<64> PathHome;
1505   path::home_directory(PathHome);
1506 
1507   const char *Path7a = "~/aaa";
1508   SmallString<64> Path7(Path7a);
1509   path::native(Path7, path::Style::windows_backslash);
1510   EXPECT_TRUE(Path7.endswith("\\aaa"));
1511   EXPECT_TRUE(Path7.startswith(PathHome));
1512   EXPECT_EQ(Path7.size(), PathHome.size() + strlen(Path7a + 1));
1513   Path7 = Path7a;
1514   path::native(Path7, path::Style::windows_slash);
1515   EXPECT_TRUE(Path7.endswith("/aaa"));
1516   EXPECT_TRUE(Path7.startswith(PathHome));
1517   EXPECT_EQ(Path7.size(), PathHome.size() + strlen(Path7a + 1));
1518 
1519   const char *Path8a = "~";
1520   SmallString<64> Path8(Path8a);
1521   path::native(Path8);
1522   EXPECT_EQ(Path8, PathHome);
1523 
1524   const char *Path9a = "~aaa";
1525   SmallString<64> Path9(Path9a);
1526   path::native(Path9);
1527   EXPECT_EQ(Path9, "~aaa");
1528 
1529   const char *Path10a = "aaa/~/b";
1530   SmallString<64> Path10(Path10a);
1531   path::native(Path10, path::Style::windows_backslash);
1532   EXPECT_EQ(Path10, "aaa\\~\\b");
1533 #endif
1534 }
1535 
1536 TEST(Support, RemoveLeadingDotSlash) {
1537   StringRef Path1("././/foolz/wat");
1538   StringRef Path2("./////");
1539 
1540   Path1 = path::remove_leading_dotslash(Path1);
1541   EXPECT_EQ(Path1, "foolz/wat");
1542   Path2 = path::remove_leading_dotslash(Path2);
1543   EXPECT_EQ(Path2, "");
1544 }
1545 
1546 static std::string remove_dots(StringRef path, bool remove_dot_dot,
1547                                path::Style style) {
1548   SmallString<256> buffer(path);
1549   path::remove_dots(buffer, remove_dot_dot, style);
1550   return std::string(buffer.str());
1551 }
1552 
1553 TEST(Support, RemoveDots) {
1554   EXPECT_EQ("foolz\\wat",
1555             remove_dots(".\\.\\\\foolz\\wat", false, path::Style::windows));
1556   EXPECT_EQ("", remove_dots(".\\\\\\\\\\", false, path::Style::windows));
1557 
1558   EXPECT_EQ("a\\..\\b\\c",
1559             remove_dots(".\\a\\..\\b\\c", false, path::Style::windows));
1560   EXPECT_EQ("b\\c", remove_dots(".\\a\\..\\b\\c", true, path::Style::windows));
1561   EXPECT_EQ("c", remove_dots(".\\.\\c", true, path::Style::windows));
1562   EXPECT_EQ("..\\a\\c",
1563             remove_dots("..\\a\\b\\..\\c", true, path::Style::windows));
1564   EXPECT_EQ("..\\..\\a\\c",
1565             remove_dots("..\\..\\a\\b\\..\\c", true, path::Style::windows));
1566   EXPECT_EQ("C:\\a\\c", remove_dots("C:\\foo\\bar//..\\..\\a\\c", true,
1567                                     path::Style::windows));
1568 
1569   EXPECT_EQ("C:\\bar",
1570             remove_dots("C:/foo/../bar", true, path::Style::windows));
1571   EXPECT_EQ("C:\\foo\\bar",
1572             remove_dots("C:/foo/bar", true, path::Style::windows));
1573   EXPECT_EQ("C:\\foo\\bar",
1574             remove_dots("C:/foo\\bar", true, path::Style::windows));
1575   EXPECT_EQ("\\", remove_dots("/", true, path::Style::windows));
1576   EXPECT_EQ("C:\\", remove_dots("C:/", true, path::Style::windows));
1577 
1578   // Some clients of remove_dots expect it to remove trailing slashes. Again,
1579   // this is emergent behavior that VFS relies on, and not inherently part of
1580   // the specification.
1581   EXPECT_EQ("C:\\foo\\bar",
1582             remove_dots("C:\\foo\\bar\\", true, path::Style::windows));
1583   EXPECT_EQ("/foo/bar",
1584             remove_dots("/foo/bar/", true, path::Style::posix));
1585 
1586   // A double separator is rewritten.
1587   EXPECT_EQ("C:\\foo\\bar",
1588             remove_dots("C:/foo//bar", true, path::Style::windows));
1589 
1590   SmallString<64> Path1(".\\.\\c");
1591   EXPECT_TRUE(path::remove_dots(Path1, true, path::Style::windows));
1592   EXPECT_EQ("c", Path1);
1593 
1594   EXPECT_EQ("foolz/wat",
1595             remove_dots("././/foolz/wat", false, path::Style::posix));
1596   EXPECT_EQ("", remove_dots("./////", false, path::Style::posix));
1597 
1598   EXPECT_EQ("a/../b/c", remove_dots("./a/../b/c", false, path::Style::posix));
1599   EXPECT_EQ("b/c", remove_dots("./a/../b/c", true, path::Style::posix));
1600   EXPECT_EQ("c", remove_dots("././c", true, path::Style::posix));
1601   EXPECT_EQ("../a/c", remove_dots("../a/b/../c", true, path::Style::posix));
1602   EXPECT_EQ("../../a/c",
1603             remove_dots("../../a/b/../c", true, path::Style::posix));
1604   EXPECT_EQ("/a/c", remove_dots("/../../a/c", true, path::Style::posix));
1605   EXPECT_EQ("/a/c",
1606             remove_dots("/../a/b//../././/c", true, path::Style::posix));
1607   EXPECT_EQ("/", remove_dots("/", true, path::Style::posix));
1608 
1609   // FIXME: Leaving behind this double leading slash seems like a bug.
1610   EXPECT_EQ("//foo/bar",
1611             remove_dots("//foo/bar/", true, path::Style::posix));
1612 
1613   SmallString<64> Path2("././c");
1614   EXPECT_TRUE(path::remove_dots(Path2, true, path::Style::posix));
1615   EXPECT_EQ("c", Path2);
1616 }
1617 
1618 TEST(Support, ReplacePathPrefix) {
1619   SmallString<64> Path1("/foo");
1620   SmallString<64> Path2("/old/foo");
1621   SmallString<64> Path3("/oldnew/foo");
1622   SmallString<64> Path4("C:\\old/foo\\bar");
1623   SmallString<64> OldPrefix("/old");
1624   SmallString<64> OldPrefixSep("/old/");
1625   SmallString<64> OldPrefixWin("c:/oLD/F");
1626   SmallString<64> NewPrefix("/new");
1627   SmallString<64> NewPrefix2("/longernew");
1628   SmallString<64> EmptyPrefix("");
1629   bool Found;
1630 
1631   SmallString<64> Path = Path1;
1632   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1633   EXPECT_FALSE(Found);
1634   EXPECT_EQ(Path, "/foo");
1635   Path = Path2;
1636   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1637   EXPECT_TRUE(Found);
1638   EXPECT_EQ(Path, "/new/foo");
1639   Path = Path2;
1640   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix2);
1641   EXPECT_TRUE(Found);
1642   EXPECT_EQ(Path, "/longernew/foo");
1643   Path = Path1;
1644   Found = path::replace_path_prefix(Path, EmptyPrefix, NewPrefix);
1645   EXPECT_TRUE(Found);
1646   EXPECT_EQ(Path, "/new/foo");
1647   Path = Path2;
1648   Found = path::replace_path_prefix(Path, OldPrefix, EmptyPrefix);
1649   EXPECT_TRUE(Found);
1650   EXPECT_EQ(Path, "/foo");
1651   Path = Path2;
1652   Found = path::replace_path_prefix(Path, OldPrefixSep, EmptyPrefix);
1653   EXPECT_TRUE(Found);
1654   EXPECT_EQ(Path, "foo");
1655   Path = Path3;
1656   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1657   EXPECT_TRUE(Found);
1658   EXPECT_EQ(Path, "/newnew/foo");
1659   Path = Path3;
1660   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix2);
1661   EXPECT_TRUE(Found);
1662   EXPECT_EQ(Path, "/longernewnew/foo");
1663   Path = Path1;
1664   Found = path::replace_path_prefix(Path, EmptyPrefix, NewPrefix);
1665   EXPECT_TRUE(Found);
1666   EXPECT_EQ(Path, "/new/foo");
1667   Path = OldPrefix;
1668   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1669   EXPECT_TRUE(Found);
1670   EXPECT_EQ(Path, "/new");
1671   Path = OldPrefixSep;
1672   Found = path::replace_path_prefix(Path, OldPrefix, NewPrefix);
1673   EXPECT_TRUE(Found);
1674   EXPECT_EQ(Path, "/new/");
1675   Path = OldPrefix;
1676   Found = path::replace_path_prefix(Path, OldPrefixSep, NewPrefix);
1677   EXPECT_FALSE(Found);
1678   EXPECT_EQ(Path, "/old");
1679   Path = Path4;
1680   Found = path::replace_path_prefix(Path, OldPrefixWin, NewPrefix,
1681                                     path::Style::windows);
1682   EXPECT_TRUE(Found);
1683   EXPECT_EQ(Path, "/newoo\\bar");
1684   Path = Path4;
1685   Found = path::replace_path_prefix(Path, OldPrefixWin, NewPrefix,
1686                                     path::Style::posix);
1687   EXPECT_FALSE(Found);
1688   EXPECT_EQ(Path, "C:\\old/foo\\bar");
1689 }
1690 
1691 TEST_F(FileSystemTest, OpenFileForRead) {
1692   // Create a temp file.
1693   int FileDescriptor;
1694   SmallString<64> TempPath;
1695   ASSERT_NO_ERROR(
1696       fs::createTemporaryFile("prefix", "temp", FileDescriptor, TempPath));
1697   FileRemover Cleanup(TempPath);
1698 
1699   // Make sure it exists.
1700   ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
1701 
1702   // Open the file for read
1703   int FileDescriptor2;
1704   SmallString<64> ResultPath;
1705   ASSERT_NO_ERROR(fs::openFileForRead(Twine(TempPath), FileDescriptor2,
1706                                       fs::OF_None, &ResultPath))
1707 
1708   // If we succeeded, check that the paths are the same (modulo case):
1709   if (!ResultPath.empty()) {
1710     // The paths returned by createTemporaryFile and getPathFromOpenFD
1711     // should reference the same file on disk.
1712     fs::UniqueID D1, D2;
1713     ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), D1));
1714     ASSERT_NO_ERROR(fs::getUniqueID(Twine(ResultPath), D2));
1715     ASSERT_EQ(D1, D2);
1716   }
1717   ::close(FileDescriptor);
1718   ::close(FileDescriptor2);
1719 
1720 #ifdef _WIN32
1721   // Since Windows Vista, file access time is not updated by default.
1722   // This is instead updated manually by openFileForRead.
1723   // https://blogs.technet.microsoft.com/filecab/2006/11/07/disabling-last-access-time-in-windows-vista-to-improve-ntfs-performance/
1724   // This part of the unit test is Windows specific as the updating of
1725   // access times can be disabled on Linux using /etc/fstab.
1726 
1727   // Set access time to UNIX epoch.
1728   ASSERT_NO_ERROR(sys::fs::openFileForWrite(Twine(TempPath), FileDescriptor,
1729                                             fs::CD_OpenExisting));
1730   TimePoint<> Epoch(std::chrono::milliseconds(0));
1731   ASSERT_NO_ERROR(fs::setLastAccessAndModificationTime(FileDescriptor, Epoch));
1732   ::close(FileDescriptor);
1733 
1734   // Open the file and ensure access time is updated, when forced.
1735   ASSERT_NO_ERROR(fs::openFileForRead(Twine(TempPath), FileDescriptor,
1736                                       fs::OF_UpdateAtime, &ResultPath));
1737 
1738   sys::fs::file_status Status;
1739   ASSERT_NO_ERROR(sys::fs::status(FileDescriptor, Status));
1740   auto FileAccessTime = Status.getLastAccessedTime();
1741 
1742   ASSERT_NE(Epoch, FileAccessTime);
1743   ::close(FileDescriptor);
1744 
1745   // Ideally this test would include a case when ATime is not forced to update,
1746   // however the expected behaviour will differ depending on the configuration
1747   // of the Windows file system.
1748 #endif
1749 }
1750 
1751 static void createFileWithData(const Twine &Path, bool ShouldExistBefore,
1752                                fs::CreationDisposition Disp, StringRef Data) {
1753   int FD;
1754   ASSERT_EQ(ShouldExistBefore, fs::exists(Path));
1755   ASSERT_NO_ERROR(fs::openFileForWrite(Path, FD, Disp));
1756   FileDescriptorCloser Closer(FD);
1757   ASSERT_TRUE(fs::exists(Path));
1758 
1759   ASSERT_EQ(Data.size(), (size_t)write(FD, Data.data(), Data.size()));
1760 }
1761 
1762 static void verifyFileContents(const Twine &Path, StringRef Contents) {
1763   auto Buffer = MemoryBuffer::getFile(Path);
1764   ASSERT_TRUE((bool)Buffer);
1765   StringRef Data = Buffer.get()->getBuffer();
1766   ASSERT_EQ(Data, Contents);
1767 }
1768 
1769 TEST_F(FileSystemTest, CreateNew) {
1770   int FD;
1771   Optional<FileDescriptorCloser> Closer;
1772 
1773   // Succeeds if the file does not exist.
1774   ASSERT_FALSE(fs::exists(NonExistantFile));
1775   ASSERT_NO_ERROR(fs::openFileForWrite(NonExistantFile, FD, fs::CD_CreateNew));
1776   ASSERT_TRUE(fs::exists(NonExistantFile));
1777 
1778   FileRemover Cleanup(NonExistantFile);
1779   Closer.emplace(FD);
1780 
1781   // And creates a file of size 0.
1782   sys::fs::file_status Status;
1783   ASSERT_NO_ERROR(sys::fs::status(FD, Status));
1784   EXPECT_EQ(0ULL, Status.getSize());
1785 
1786   // Close this first, before trying to re-open the file.
1787   Closer.reset();
1788 
1789   // But fails if the file does exist.
1790   ASSERT_ERROR(fs::openFileForWrite(NonExistantFile, FD, fs::CD_CreateNew));
1791 }
1792 
1793 TEST_F(FileSystemTest, CreateAlways) {
1794   int FD;
1795   Optional<FileDescriptorCloser> Closer;
1796 
1797   // Succeeds if the file does not exist.
1798   ASSERT_FALSE(fs::exists(NonExistantFile));
1799   ASSERT_NO_ERROR(
1800       fs::openFileForWrite(NonExistantFile, FD, fs::CD_CreateAlways));
1801 
1802   Closer.emplace(FD);
1803 
1804   ASSERT_TRUE(fs::exists(NonExistantFile));
1805 
1806   FileRemover Cleanup(NonExistantFile);
1807 
1808   // And creates a file of size 0.
1809   uint64_t FileSize;
1810   ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1811   ASSERT_EQ(0ULL, FileSize);
1812 
1813   // If we write some data to it re-create it with CreateAlways, it succeeds and
1814   // truncates to 0 bytes.
1815   ASSERT_EQ(4, write(FD, "Test", 4));
1816 
1817   Closer.reset();
1818 
1819   ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1820   ASSERT_EQ(4ULL, FileSize);
1821 
1822   ASSERT_NO_ERROR(
1823       fs::openFileForWrite(NonExistantFile, FD, fs::CD_CreateAlways));
1824   Closer.emplace(FD);
1825   ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1826   ASSERT_EQ(0ULL, FileSize);
1827 }
1828 
1829 TEST_F(FileSystemTest, OpenExisting) {
1830   int FD;
1831 
1832   // Fails if the file does not exist.
1833   ASSERT_FALSE(fs::exists(NonExistantFile));
1834   ASSERT_ERROR(fs::openFileForWrite(NonExistantFile, FD, fs::CD_OpenExisting));
1835   ASSERT_FALSE(fs::exists(NonExistantFile));
1836 
1837   // Make a dummy file now so that we can try again when the file does exist.
1838   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "Fizz");
1839   FileRemover Cleanup(NonExistantFile);
1840   uint64_t FileSize;
1841   ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1842   ASSERT_EQ(4ULL, FileSize);
1843 
1844   // If we re-create it with different data, it overwrites rather than
1845   // appending.
1846   createFileWithData(NonExistantFile, true, fs::CD_OpenExisting, "Buzz");
1847   verifyFileContents(NonExistantFile, "Buzz");
1848 }
1849 
1850 TEST_F(FileSystemTest, OpenAlways) {
1851   // Succeeds if the file does not exist.
1852   createFileWithData(NonExistantFile, false, fs::CD_OpenAlways, "Fizz");
1853   FileRemover Cleanup(NonExistantFile);
1854   uint64_t FileSize;
1855   ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1856   ASSERT_EQ(4ULL, FileSize);
1857 
1858   // Now re-open it and write again, verifying the contents get over-written.
1859   createFileWithData(NonExistantFile, true, fs::CD_OpenAlways, "Bu");
1860   verifyFileContents(NonExistantFile, "Buzz");
1861 }
1862 
1863 TEST_F(FileSystemTest, AppendSetsCorrectFileOffset) {
1864   fs::CreationDisposition Disps[] = {fs::CD_CreateAlways, fs::CD_OpenAlways,
1865                                      fs::CD_OpenExisting};
1866 
1867   // Write some data and re-open it with every possible disposition (this is a
1868   // hack that shouldn't work, but is left for compatibility.  OF_Append
1869   // overrides
1870   // the specified disposition.
1871   for (fs::CreationDisposition Disp : Disps) {
1872     int FD;
1873     Optional<FileDescriptorCloser> Closer;
1874 
1875     createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "Fizz");
1876 
1877     FileRemover Cleanup(NonExistantFile);
1878 
1879     uint64_t FileSize;
1880     ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1881     ASSERT_EQ(4ULL, FileSize);
1882     ASSERT_NO_ERROR(
1883         fs::openFileForWrite(NonExistantFile, FD, Disp, fs::OF_Append));
1884     Closer.emplace(FD);
1885     ASSERT_NO_ERROR(sys::fs::file_size(NonExistantFile, FileSize));
1886     ASSERT_EQ(4ULL, FileSize);
1887 
1888     ASSERT_EQ(4, write(FD, "Buzz", 4));
1889     Closer.reset();
1890 
1891     verifyFileContents(NonExistantFile, "FizzBuzz");
1892   }
1893 }
1894 
1895 static void verifyRead(int FD, StringRef Data, bool ShouldSucceed) {
1896   std::vector<char> Buffer;
1897   Buffer.resize(Data.size());
1898   int Result = ::read(FD, Buffer.data(), Buffer.size());
1899   if (ShouldSucceed) {
1900     ASSERT_EQ((size_t)Result, Data.size());
1901     ASSERT_EQ(Data, StringRef(Buffer.data(), Buffer.size()));
1902   } else {
1903     ASSERT_EQ(-1, Result);
1904     ASSERT_EQ(EBADF, errno);
1905   }
1906 }
1907 
1908 static void verifyWrite(int FD, StringRef Data, bool ShouldSucceed) {
1909   int Result = ::write(FD, Data.data(), Data.size());
1910   if (ShouldSucceed)
1911     ASSERT_EQ((size_t)Result, Data.size());
1912   else {
1913     ASSERT_EQ(-1, Result);
1914     ASSERT_EQ(EBADF, errno);
1915   }
1916 }
1917 
1918 TEST_F(FileSystemTest, ReadOnlyFileCantWrite) {
1919   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "Fizz");
1920   FileRemover Cleanup(NonExistantFile);
1921 
1922   int FD;
1923   ASSERT_NO_ERROR(fs::openFileForRead(NonExistantFile, FD));
1924   FileDescriptorCloser Closer(FD);
1925 
1926   verifyWrite(FD, "Buzz", false);
1927   verifyRead(FD, "Fizz", true);
1928 }
1929 
1930 TEST_F(FileSystemTest, WriteOnlyFileCantRead) {
1931   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "Fizz");
1932   FileRemover Cleanup(NonExistantFile);
1933 
1934   int FD;
1935   ASSERT_NO_ERROR(
1936       fs::openFileForWrite(NonExistantFile, FD, fs::CD_OpenExisting));
1937   FileDescriptorCloser Closer(FD);
1938   verifyRead(FD, "Fizz", false);
1939   verifyWrite(FD, "Buzz", true);
1940 }
1941 
1942 TEST_F(FileSystemTest, ReadWriteFileCanReadOrWrite) {
1943   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "Fizz");
1944   FileRemover Cleanup(NonExistantFile);
1945 
1946   int FD;
1947   ASSERT_NO_ERROR(fs::openFileForReadWrite(NonExistantFile, FD,
1948                                            fs::CD_OpenExisting, fs::OF_None));
1949   FileDescriptorCloser Closer(FD);
1950   verifyRead(FD, "Fizz", true);
1951   verifyWrite(FD, "Buzz", true);
1952 }
1953 
1954 TEST_F(FileSystemTest, readNativeFile) {
1955   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "01234");
1956   FileRemover Cleanup(NonExistantFile);
1957   const auto &Read = [&](size_t ToRead) -> Expected<std::string> {
1958     std::string Buf(ToRead, '?');
1959     Expected<fs::file_t> FD = fs::openNativeFileForRead(NonExistantFile);
1960     if (!FD)
1961       return FD.takeError();
1962     auto Close = make_scope_exit([&] { fs::closeFile(*FD); });
1963     if (Expected<size_t> BytesRead = fs::readNativeFile(
1964             *FD, makeMutableArrayRef(&*Buf.begin(), Buf.size())))
1965       return Buf.substr(0, *BytesRead);
1966     else
1967       return BytesRead.takeError();
1968   };
1969   EXPECT_THAT_EXPECTED(Read(5), HasValue("01234"));
1970   EXPECT_THAT_EXPECTED(Read(3), HasValue("012"));
1971   EXPECT_THAT_EXPECTED(Read(6), HasValue("01234"));
1972 }
1973 
1974 TEST_F(FileSystemTest, readNativeFileToEOF) {
1975   constexpr StringLiteral Content = "0123456789";
1976   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, Content);
1977   FileRemover Cleanup(NonExistantFile);
1978   const auto &Read = [&](SmallVectorImpl<char> &V,
1979                          Optional<ssize_t> ChunkSize) {
1980     Expected<fs::file_t> FD = fs::openNativeFileForRead(NonExistantFile);
1981     if (!FD)
1982       return FD.takeError();
1983     auto Close = make_scope_exit([&] { fs::closeFile(*FD); });
1984     if (ChunkSize)
1985       return fs::readNativeFileToEOF(*FD, V, *ChunkSize);
1986     return fs::readNativeFileToEOF(*FD, V);
1987   };
1988 
1989   // Check basic operation.
1990   {
1991     SmallString<0> NoSmall;
1992     SmallString<fs::DefaultReadChunkSize + Content.size()> StaysSmall;
1993     SmallVectorImpl<char> *Vectors[] = {
1994         static_cast<SmallVectorImpl<char> *>(&NoSmall),
1995         static_cast<SmallVectorImpl<char> *>(&StaysSmall),
1996     };
1997     for (SmallVectorImpl<char> *V : Vectors) {
1998       ASSERT_THAT_ERROR(Read(*V, None), Succeeded());
1999       ASSERT_EQ(Content, StringRef(V->begin(), V->size()));
2000     }
2001     ASSERT_EQ(fs::DefaultReadChunkSize + Content.size(), StaysSmall.capacity());
2002 
2003     // Check appending.
2004     {
2005       constexpr StringLiteral Prefix = "prefix-";
2006       for (SmallVectorImpl<char> *V : Vectors) {
2007         V->assign(Prefix.begin(), Prefix.end());
2008         ASSERT_THAT_ERROR(Read(*V, None), Succeeded());
2009         ASSERT_EQ((Prefix + Content).str(), StringRef(V->begin(), V->size()));
2010       }
2011     }
2012   }
2013 
2014   // Check that the chunk size (if specified) is respected.
2015   SmallString<Content.size() + 5> SmallChunks;
2016   ASSERT_THAT_ERROR(Read(SmallChunks, 5), Succeeded());
2017   ASSERT_EQ(SmallChunks, Content);
2018   ASSERT_EQ(Content.size() + 5, SmallChunks.capacity());
2019 }
2020 
2021 TEST_F(FileSystemTest, readNativeFileSlice) {
2022   createFileWithData(NonExistantFile, false, fs::CD_CreateNew, "01234");
2023   FileRemover Cleanup(NonExistantFile);
2024   Expected<fs::file_t> FD = fs::openNativeFileForRead(NonExistantFile);
2025   ASSERT_THAT_EXPECTED(FD, Succeeded());
2026   auto Close = make_scope_exit([&] { fs::closeFile(*FD); });
2027   const auto &Read = [&](size_t Offset,
2028                          size_t ToRead) -> Expected<std::string> {
2029     std::string Buf(ToRead, '?');
2030     if (Expected<size_t> BytesRead = fs::readNativeFileSlice(
2031             *FD, makeMutableArrayRef(&*Buf.begin(), Buf.size()), Offset))
2032       return Buf.substr(0, *BytesRead);
2033     else
2034       return BytesRead.takeError();
2035   };
2036   EXPECT_THAT_EXPECTED(Read(0, 5), HasValue("01234"));
2037   EXPECT_THAT_EXPECTED(Read(0, 3), HasValue("012"));
2038   EXPECT_THAT_EXPECTED(Read(2, 3), HasValue("234"));
2039   EXPECT_THAT_EXPECTED(Read(0, 6), HasValue("01234"));
2040   EXPECT_THAT_EXPECTED(Read(2, 6), HasValue("234"));
2041   EXPECT_THAT_EXPECTED(Read(5, 5), HasValue(""));
2042 }
2043 
2044 TEST_F(FileSystemTest, is_local) {
2045   bool TestDirectoryIsLocal;
2046   ASSERT_NO_ERROR(fs::is_local(TestDirectory, TestDirectoryIsLocal));
2047   EXPECT_EQ(TestDirectoryIsLocal, fs::is_local(TestDirectory));
2048 
2049   int FD;
2050   SmallString<128> TempPath;
2051   ASSERT_NO_ERROR(
2052       fs::createUniqueFile(Twine(TestDirectory) + "/temp", FD, TempPath));
2053   FileRemover Cleanup(TempPath);
2054 
2055   // Make sure it exists.
2056   ASSERT_TRUE(sys::fs::exists(Twine(TempPath)));
2057 
2058   bool TempFileIsLocal;
2059   ASSERT_NO_ERROR(fs::is_local(FD, TempFileIsLocal));
2060   EXPECT_EQ(TempFileIsLocal, fs::is_local(FD));
2061   ::close(FD);
2062 
2063   // Expect that the file and its parent directory are equally local or equally
2064   // remote.
2065   EXPECT_EQ(TestDirectoryIsLocal, TempFileIsLocal);
2066 }
2067 
2068 TEST_F(FileSystemTest, getUmask) {
2069 #ifdef _WIN32
2070   EXPECT_EQ(fs::getUmask(), 0U) << "Should always be 0 on Windows.";
2071 #else
2072   unsigned OldMask = ::umask(0022);
2073   unsigned CurrentMask = fs::getUmask();
2074   EXPECT_EQ(CurrentMask, 0022U)
2075       << "getUmask() didn't return previously set umask()";
2076   EXPECT_EQ(::umask(OldMask), mode_t(0022U))
2077       << "getUmask() may have changed umask()";
2078 #endif
2079 }
2080 
2081 TEST_F(FileSystemTest, RespectUmask) {
2082 #ifndef _WIN32
2083   unsigned OldMask = ::umask(0022);
2084 
2085   int FD;
2086   SmallString<128> TempPath;
2087   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
2088 
2089   fs::perms AllRWE = static_cast<fs::perms>(0777);
2090 
2091   ASSERT_NO_ERROR(fs::setPermissions(TempPath, AllRWE));
2092 
2093   ErrorOr<fs::perms> Perms = fs::getPermissions(TempPath);
2094   ASSERT_TRUE(!!Perms);
2095   EXPECT_EQ(Perms.get(), AllRWE) << "Should have ignored umask by default";
2096 
2097   ASSERT_NO_ERROR(fs::setPermissions(TempPath, AllRWE));
2098 
2099   Perms = fs::getPermissions(TempPath);
2100   ASSERT_TRUE(!!Perms);
2101   EXPECT_EQ(Perms.get(), AllRWE) << "Should have ignored umask";
2102 
2103   ASSERT_NO_ERROR(
2104       fs::setPermissions(FD, static_cast<fs::perms>(AllRWE & ~fs::getUmask())));
2105   Perms = fs::getPermissions(TempPath);
2106   ASSERT_TRUE(!!Perms);
2107   EXPECT_EQ(Perms.get(), static_cast<fs::perms>(0755))
2108       << "Did not respect umask";
2109 
2110   (void)::umask(0057);
2111 
2112   ASSERT_NO_ERROR(
2113       fs::setPermissions(FD, static_cast<fs::perms>(AllRWE & ~fs::getUmask())));
2114   Perms = fs::getPermissions(TempPath);
2115   ASSERT_TRUE(!!Perms);
2116   EXPECT_EQ(Perms.get(), static_cast<fs::perms>(0720))
2117       << "Did not respect umask";
2118 
2119   (void)::umask(OldMask);
2120   (void)::close(FD);
2121 #endif
2122 }
2123 
2124 TEST_F(FileSystemTest, set_current_path) {
2125   SmallString<128> path;
2126 
2127   ASSERT_NO_ERROR(fs::current_path(path));
2128   ASSERT_NE(TestDirectory, path);
2129 
2130   struct RestorePath {
2131     SmallString<128> path;
2132     RestorePath(const SmallString<128> &path) : path(path) {}
2133     ~RestorePath() { fs::set_current_path(path); }
2134   } restore_path(path);
2135 
2136   ASSERT_NO_ERROR(fs::set_current_path(TestDirectory));
2137 
2138   ASSERT_NO_ERROR(fs::current_path(path));
2139 
2140   fs::UniqueID D1, D2;
2141   ASSERT_NO_ERROR(fs::getUniqueID(TestDirectory, D1));
2142   ASSERT_NO_ERROR(fs::getUniqueID(path, D2));
2143   ASSERT_EQ(D1, D2) << "D1: " << TestDirectory << "\nD2: " << path;
2144 }
2145 
2146 TEST_F(FileSystemTest, permissions) {
2147   int FD;
2148   SmallString<64> TempPath;
2149   ASSERT_NO_ERROR(fs::createTemporaryFile("prefix", "temp", FD, TempPath));
2150   FileRemover Cleanup(TempPath);
2151 
2152   // Make sure it exists.
2153   ASSERT_TRUE(fs::exists(Twine(TempPath)));
2154 
2155   auto CheckPermissions = [&](fs::perms Expected) {
2156     ErrorOr<fs::perms> Actual = fs::getPermissions(TempPath);
2157     return Actual && *Actual == Expected;
2158   };
2159 
2160   std::error_code NoError;
2161   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_all), NoError);
2162   EXPECT_TRUE(CheckPermissions(fs::all_all));
2163 
2164   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_read | fs::all_exe), NoError);
2165   EXPECT_TRUE(CheckPermissions(fs::all_read | fs::all_exe));
2166 
2167 #if defined(_WIN32)
2168   fs::perms ReadOnly = fs::all_read | fs::all_exe;
2169   EXPECT_EQ(fs::setPermissions(TempPath, fs::no_perms), NoError);
2170   EXPECT_TRUE(CheckPermissions(ReadOnly));
2171 
2172   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_read), NoError);
2173   EXPECT_TRUE(CheckPermissions(ReadOnly));
2174 
2175   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_write), NoError);
2176   EXPECT_TRUE(CheckPermissions(fs::all_all));
2177 
2178   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_exe), NoError);
2179   EXPECT_TRUE(CheckPermissions(ReadOnly));
2180 
2181   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_all), NoError);
2182   EXPECT_TRUE(CheckPermissions(fs::all_all));
2183 
2184   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_read), NoError);
2185   EXPECT_TRUE(CheckPermissions(ReadOnly));
2186 
2187   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_write), NoError);
2188   EXPECT_TRUE(CheckPermissions(fs::all_all));
2189 
2190   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_exe), NoError);
2191   EXPECT_TRUE(CheckPermissions(ReadOnly));
2192 
2193   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_all), NoError);
2194   EXPECT_TRUE(CheckPermissions(fs::all_all));
2195 
2196   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_read), NoError);
2197   EXPECT_TRUE(CheckPermissions(ReadOnly));
2198 
2199   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_write), NoError);
2200   EXPECT_TRUE(CheckPermissions(fs::all_all));
2201 
2202   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_exe), NoError);
2203   EXPECT_TRUE(CheckPermissions(ReadOnly));
2204 
2205   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_all), NoError);
2206   EXPECT_TRUE(CheckPermissions(fs::all_all));
2207 
2208   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_read), NoError);
2209   EXPECT_TRUE(CheckPermissions(ReadOnly));
2210 
2211   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_write), NoError);
2212   EXPECT_TRUE(CheckPermissions(fs::all_all));
2213 
2214   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_exe), NoError);
2215   EXPECT_TRUE(CheckPermissions(ReadOnly));
2216 
2217   EXPECT_EQ(fs::setPermissions(TempPath, fs::set_uid_on_exe), NoError);
2218   EXPECT_TRUE(CheckPermissions(ReadOnly));
2219 
2220   EXPECT_EQ(fs::setPermissions(TempPath, fs::set_gid_on_exe), NoError);
2221   EXPECT_TRUE(CheckPermissions(ReadOnly));
2222 
2223   EXPECT_EQ(fs::setPermissions(TempPath, fs::sticky_bit), NoError);
2224   EXPECT_TRUE(CheckPermissions(ReadOnly));
2225 
2226   EXPECT_EQ(fs::setPermissions(TempPath, fs::set_uid_on_exe |
2227                                              fs::set_gid_on_exe |
2228                                              fs::sticky_bit),
2229             NoError);
2230   EXPECT_TRUE(CheckPermissions(ReadOnly));
2231 
2232   EXPECT_EQ(fs::setPermissions(TempPath, ReadOnly | fs::set_uid_on_exe |
2233                                              fs::set_gid_on_exe |
2234                                              fs::sticky_bit),
2235             NoError);
2236   EXPECT_TRUE(CheckPermissions(ReadOnly));
2237 
2238   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_perms), NoError);
2239   EXPECT_TRUE(CheckPermissions(fs::all_all));
2240 #else
2241   EXPECT_EQ(fs::setPermissions(TempPath, fs::no_perms), NoError);
2242   EXPECT_TRUE(CheckPermissions(fs::no_perms));
2243 
2244   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_read), NoError);
2245   EXPECT_TRUE(CheckPermissions(fs::owner_read));
2246 
2247   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_write), NoError);
2248   EXPECT_TRUE(CheckPermissions(fs::owner_write));
2249 
2250   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_exe), NoError);
2251   EXPECT_TRUE(CheckPermissions(fs::owner_exe));
2252 
2253   EXPECT_EQ(fs::setPermissions(TempPath, fs::owner_all), NoError);
2254   EXPECT_TRUE(CheckPermissions(fs::owner_all));
2255 
2256   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_read), NoError);
2257   EXPECT_TRUE(CheckPermissions(fs::group_read));
2258 
2259   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_write), NoError);
2260   EXPECT_TRUE(CheckPermissions(fs::group_write));
2261 
2262   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_exe), NoError);
2263   EXPECT_TRUE(CheckPermissions(fs::group_exe));
2264 
2265   EXPECT_EQ(fs::setPermissions(TempPath, fs::group_all), NoError);
2266   EXPECT_TRUE(CheckPermissions(fs::group_all));
2267 
2268   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_read), NoError);
2269   EXPECT_TRUE(CheckPermissions(fs::others_read));
2270 
2271   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_write), NoError);
2272   EXPECT_TRUE(CheckPermissions(fs::others_write));
2273 
2274   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_exe), NoError);
2275   EXPECT_TRUE(CheckPermissions(fs::others_exe));
2276 
2277   EXPECT_EQ(fs::setPermissions(TempPath, fs::others_all), NoError);
2278   EXPECT_TRUE(CheckPermissions(fs::others_all));
2279 
2280   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_read), NoError);
2281   EXPECT_TRUE(CheckPermissions(fs::all_read));
2282 
2283   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_write), NoError);
2284   EXPECT_TRUE(CheckPermissions(fs::all_write));
2285 
2286   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_exe), NoError);
2287   EXPECT_TRUE(CheckPermissions(fs::all_exe));
2288 
2289   EXPECT_EQ(fs::setPermissions(TempPath, fs::set_uid_on_exe), NoError);
2290   EXPECT_TRUE(CheckPermissions(fs::set_uid_on_exe));
2291 
2292   EXPECT_EQ(fs::setPermissions(TempPath, fs::set_gid_on_exe), NoError);
2293   EXPECT_TRUE(CheckPermissions(fs::set_gid_on_exe));
2294 
2295   // Modern BSDs require root to set the sticky bit on files.
2296   // AIX and Solaris without root will mask off (i.e., lose) the sticky bit
2297   // on files.
2298 #if !defined(__FreeBSD__) && !defined(__NetBSD__) && !defined(__OpenBSD__) &&  \
2299     !defined(_AIX) && !(defined(__sun__) && defined(__svr4__))
2300   EXPECT_EQ(fs::setPermissions(TempPath, fs::sticky_bit), NoError);
2301   EXPECT_TRUE(CheckPermissions(fs::sticky_bit));
2302 
2303   EXPECT_EQ(fs::setPermissions(TempPath, fs::set_uid_on_exe |
2304                                              fs::set_gid_on_exe |
2305                                              fs::sticky_bit),
2306             NoError);
2307   EXPECT_TRUE(CheckPermissions(fs::set_uid_on_exe | fs::set_gid_on_exe |
2308                                fs::sticky_bit));
2309 
2310   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_read | fs::set_uid_on_exe |
2311                                              fs::set_gid_on_exe |
2312                                              fs::sticky_bit),
2313             NoError);
2314   EXPECT_TRUE(CheckPermissions(fs::all_read | fs::set_uid_on_exe |
2315                                fs::set_gid_on_exe | fs::sticky_bit));
2316 
2317   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_perms), NoError);
2318   EXPECT_TRUE(CheckPermissions(fs::all_perms));
2319 #endif // !FreeBSD && !NetBSD && !OpenBSD && !AIX
2320 
2321   EXPECT_EQ(fs::setPermissions(TempPath, fs::all_perms & ~fs::sticky_bit),
2322                                NoError);
2323   EXPECT_TRUE(CheckPermissions(fs::all_perms & ~fs::sticky_bit));
2324 #endif
2325 }
2326 
2327 #ifdef _WIN32
2328 TEST_F(FileSystemTest, widenPath) {
2329   const std::wstring LongPathPrefix(L"\\\\?\\");
2330 
2331   // Test that the length limit is checked against the UTF-16 length and not the
2332   // UTF-8 length.
2333   std::string Input("C:\\foldername\\");
2334   const std::string Pi("\xcf\x80"); // UTF-8 lower case pi.
2335   // Add Pi up to the MAX_PATH limit.
2336   const size_t NumChars = MAX_PATH - Input.size() - 1;
2337   for (size_t i = 0; i < NumChars; ++i)
2338     Input += Pi;
2339   // Check that UTF-8 length already exceeds MAX_PATH.
2340   EXPECT_GT(Input.size(), (size_t)MAX_PATH);
2341   SmallVector<wchar_t, MAX_PATH + 16> Result;
2342   ASSERT_NO_ERROR(windows::widenPath(Input, Result));
2343   // Result should not start with the long path prefix.
2344   EXPECT_TRUE(std::wmemcmp(Result.data(), LongPathPrefix.c_str(),
2345                            LongPathPrefix.size()) != 0);
2346   EXPECT_EQ(Result.size(), (size_t)MAX_PATH - 1);
2347 
2348   // Add another Pi to exceed the MAX_PATH limit.
2349   Input += Pi;
2350   // Construct the expected result.
2351   SmallVector<wchar_t, MAX_PATH + 16> Expected;
2352   ASSERT_NO_ERROR(windows::UTF8ToUTF16(Input, Expected));
2353   Expected.insert(Expected.begin(), LongPathPrefix.begin(),
2354                   LongPathPrefix.end());
2355 
2356   ASSERT_NO_ERROR(windows::widenPath(Input, Result));
2357   EXPECT_EQ(Result, Expected);
2358   // Pass a path with forward slashes, check that it ends up with
2359   // backslashes when widened with the long path prefix.
2360   SmallString<MAX_PATH + 16> InputForward(Input);
2361   path::make_preferred(InputForward, path::Style::windows_slash);
2362   ASSERT_NO_ERROR(windows::widenPath(InputForward, Result));
2363   EXPECT_EQ(Result, Expected);
2364 
2365   // Pass a path which has the long path prefix prepended originally, but
2366   // which is short enough to not require the long path prefix. If such a
2367   // path is passed with forward slashes, make sure it gets normalized to
2368   // backslashes.
2369   SmallString<MAX_PATH + 16> PrefixedPath("\\\\?\\C:\\foldername");
2370   ASSERT_NO_ERROR(windows::UTF8ToUTF16(PrefixedPath, Expected));
2371   // Mangle the input to forward slashes.
2372   path::make_preferred(PrefixedPath, path::Style::windows_slash);
2373   ASSERT_NO_ERROR(windows::widenPath(PrefixedPath, Result));
2374   EXPECT_EQ(Result, Expected);
2375 
2376   // A short path with an inconsistent prefix is passed through as-is; this
2377   // is a degenerate case that we currently don't care about handling.
2378   PrefixedPath.assign("/\\?/C:/foldername");
2379   ASSERT_NO_ERROR(windows::UTF8ToUTF16(PrefixedPath, Expected));
2380   ASSERT_NO_ERROR(windows::widenPath(PrefixedPath, Result));
2381   EXPECT_EQ(Result, Expected);
2382 
2383   // Test that UNC paths are handled correctly.
2384   const std::string ShareName("\\\\sharename\\");
2385   const std::string FileName("\\filename");
2386   // Initialize directory name so that the input is within the MAX_PATH limit.
2387   const char DirChar = 'x';
2388   std::string DirName(MAX_PATH - ShareName.size() - FileName.size() - 1,
2389                       DirChar);
2390 
2391   Input = ShareName + DirName + FileName;
2392   ASSERT_NO_ERROR(windows::widenPath(Input, Result));
2393   // Result should not start with the long path prefix.
2394   EXPECT_TRUE(std::wmemcmp(Result.data(), LongPathPrefix.c_str(),
2395                            LongPathPrefix.size()) != 0);
2396   EXPECT_EQ(Result.size(), (size_t)MAX_PATH - 1);
2397 
2398   // Extend the directory name so the input exceeds the MAX_PATH limit.
2399   DirName += DirChar;
2400   Input = ShareName + DirName + FileName;
2401   // Construct the expected result.
2402   ASSERT_NO_ERROR(windows::UTF8ToUTF16(StringRef(Input).substr(2), Expected));
2403   const std::wstring UNCPrefix(LongPathPrefix + L"UNC\\");
2404   Expected.insert(Expected.begin(), UNCPrefix.begin(), UNCPrefix.end());
2405 
2406   ASSERT_NO_ERROR(windows::widenPath(Input, Result));
2407   EXPECT_EQ(Result, Expected);
2408 
2409   // Check that Unix separators are handled correctly.
2410   std::replace(Input.begin(), Input.end(), '\\', '/');
2411   ASSERT_NO_ERROR(windows::widenPath(Input, Result));
2412   EXPECT_EQ(Result, Expected);
2413 
2414   // Check the removal of "dots".
2415   Input = ShareName + DirName + "\\.\\foo\\.\\.." + FileName;
2416   ASSERT_NO_ERROR(windows::widenPath(Input, Result));
2417   EXPECT_EQ(Result, Expected);
2418 }
2419 #endif
2420 
2421 #ifdef _WIN32
2422 // Windows refuses lock request if file region is already locked by the same
2423 // process. POSIX system in this case updates the existing lock.
2424 TEST_F(FileSystemTest, FileLocker) {
2425   using namespace std::chrono;
2426   int FD;
2427   std::error_code EC;
2428   SmallString<64> TempPath;
2429   EC = fs::createTemporaryFile("test", "temp", FD, TempPath);
2430   ASSERT_NO_ERROR(EC);
2431   FileRemover Cleanup(TempPath);
2432   raw_fd_ostream Stream(TempPath, EC);
2433 
2434   EC = fs::tryLockFile(FD);
2435   ASSERT_NO_ERROR(EC);
2436   EC = fs::unlockFile(FD);
2437   ASSERT_NO_ERROR(EC);
2438 
2439   if (auto L = Stream.lock()) {
2440     ASSERT_ERROR(fs::tryLockFile(FD));
2441     ASSERT_NO_ERROR(L->unlock());
2442     ASSERT_NO_ERROR(fs::tryLockFile(FD));
2443     ASSERT_NO_ERROR(fs::unlockFile(FD));
2444   } else {
2445     ADD_FAILURE();
2446     handleAllErrors(L.takeError(), [&](ErrorInfoBase &EIB) {});
2447   }
2448 
2449   ASSERT_NO_ERROR(fs::tryLockFile(FD));
2450   ASSERT_NO_ERROR(fs::unlockFile(FD));
2451 
2452   {
2453     Expected<fs::FileLocker> L1 = Stream.lock();
2454     ASSERT_THAT_EXPECTED(L1, Succeeded());
2455     raw_fd_ostream Stream2(FD, false);
2456     Expected<fs::FileLocker> L2 = Stream2.tryLockFor(250ms);
2457     ASSERT_THAT_EXPECTED(L2, Failed());
2458     ASSERT_NO_ERROR(L1->unlock());
2459     Expected<fs::FileLocker> L3 = Stream.tryLockFor(0ms);
2460     ASSERT_THAT_EXPECTED(L3, Succeeded());
2461   }
2462 
2463   ASSERT_NO_ERROR(fs::tryLockFile(FD));
2464   ASSERT_NO_ERROR(fs::unlockFile(FD));
2465 }
2466 #endif
2467 
2468 TEST_F(FileSystemTest, CopyFile) {
2469   unittest::TempDir RootTestDirectory("CopyFileTest", /*Unique=*/true);
2470 
2471   SmallVector<std::string> Data;
2472   SmallVector<SmallString<128>> Sources;
2473   for (int I = 0, E = 3; I != E; ++I) {
2474     Data.push_back(Twine(I).str());
2475     Sources.emplace_back(RootTestDirectory.path());
2476     path::append(Sources.back(), "source" + Data.back() + ".txt");
2477     createFileWithData(Sources.back(), /*ShouldExistBefore=*/false,
2478                        fs::CD_CreateNew, Data.back());
2479   }
2480 
2481   // Copy the first file to a non-existing file.
2482   SmallString<128> Destination(RootTestDirectory.path());
2483   path::append(Destination, "destination");
2484   ASSERT_FALSE(fs::exists(Destination));
2485   fs::copy_file(Sources[0], Destination);
2486   verifyFileContents(Destination, Data[0]);
2487 
2488   // Copy the second file to an existing file.
2489   fs::copy_file(Sources[1], Destination);
2490   verifyFileContents(Destination, Data[1]);
2491 
2492   // Note: The remaining logic is targeted at a potential failure case related
2493   // to file cloning and symlinks on Darwin. On Windows, fs::create_link() does
2494   // not return success here so the test is skipped.
2495 #if !defined(_WIN32)
2496   // Set up a symlink to the third file.
2497   SmallString<128> Symlink(RootTestDirectory.path());
2498   path::append(Symlink, "symlink");
2499   ASSERT_NO_ERROR(fs::create_link(path::filename(Sources[2]), Symlink));
2500   verifyFileContents(Symlink, Data[2]);
2501 
2502   // fs::getUniqueID() should follow symlinks. Otherwise, this isn't good test
2503   // coverage.
2504   fs::UniqueID SymlinkID;
2505   fs::UniqueID Data2ID;
2506   ASSERT_NO_ERROR(fs::getUniqueID(Symlink, SymlinkID));
2507   ASSERT_NO_ERROR(fs::getUniqueID(Sources[2], Data2ID));
2508   ASSERT_EQ(SymlinkID, Data2ID);
2509 
2510   // Copy the third file through the symlink.
2511   fs::copy_file(Symlink, Destination);
2512   verifyFileContents(Destination, Data[2]);
2513 
2514   // Confirm the destination is not a link to the original file, and not a
2515   // symlink.
2516   bool IsDestinationSymlink;
2517   ASSERT_NO_ERROR(fs::is_symlink_file(Destination, IsDestinationSymlink));
2518   ASSERT_FALSE(IsDestinationSymlink);
2519   fs::UniqueID DestinationID;
2520   ASSERT_NO_ERROR(fs::getUniqueID(Destination, DestinationID));
2521   ASSERT_NE(SymlinkID, DestinationID);
2522 #endif
2523 }
2524 
2525 } // anonymous namespace
2526