unittests/Support/Path.cpp

   1 //===- llvm/unittest/Support/Path.cpp - Path tests ------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/Support/Path.h"
  11 #include "llvm/Support/ErrorHandling.h"
  12 #include "llvm/Support/FileSystem.h"
  13 #include "llvm/Support/raw_ostream.h"
  14 #include "gtest/gtest.h"
  15
  16 using namespace llvm;
  17 using namespace llvm::sys;
  18
  19 #define ASSERT_NO_ERROR(x) \
  20   if (error_code ASSERT_NO_ERROR_ec = x) { \
  21     SmallString<128> MessageStorage; \
  22     raw_svector_ostream Message(MessageStorage); \
  23     Message << #x ": did not return errc::success.\n" \
  24             << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
  25             << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
  26     GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \
  27   } else {}
  28
  29 namespace {
  30
  31 TEST(is_separator, Works) {
  32   EXPECT_TRUE(path::is_separator('/'));
  33   EXPECT_FALSE(path::is_separator('\0'));
  34   EXPECT_FALSE(path::is_separator('-'));
  35   EXPECT_FALSE(path::is_separator(' '));
  36
  37 #ifdef LLVM_ON_WIN32
  38   EXPECT_TRUE(path::is_separator('\\'));
  39 #else
  40   EXPECT_FALSE(path::is_separator('\\'));
  41 #endif
  42 }
  43
  44 TEST(Support, Path) {
  45   SmallVector<StringRef, 40> paths;
  46   paths.push_back("");
  47   paths.push_back(".");
  48   paths.push_back("..");
  49   paths.push_back("foo");
  50   paths.push_back("/");
  51   paths.push_back("/foo");
  52   paths.push_back("foo/");
  53   paths.push_back("/foo/");
  54   paths.push_back("foo/bar");
  55   paths.push_back("/foo/bar");
  56   paths.push_back("//net");
  57   paths.push_back("//net/foo");
  58   paths.push_back("///foo///");
  59   paths.push_back("///foo///bar");
  60   paths.push_back("/.");
  61   paths.push_back("./");
  62   paths.push_back("/..");
  63   paths.push_back("../");
  64   paths.push_back("foo/.");
  65   paths.push_back("foo/..");
  66   paths.push_back("foo/./");
  67   paths.push_back("foo/./bar");
  68   paths.push_back("foo/..");
  69   paths.push_back("foo/../");
  70   paths.push_back("foo/../bar");
  71   paths.push_back("c:");
  72   paths.push_back("c:/");
  73   paths.push_back("c:foo");
  74   paths.push_back("c:/foo");
  75   paths.push_back("c:foo/");
  76   paths.push_back("c:/foo/");
  77   paths.push_back("c:/foo/bar");
  78   paths.push_back("prn:");
  79   paths.push_back("c:\\");
  80   paths.push_back("c:foo");
  81   paths.push_back("c:\\foo");
  82   paths.push_back("c:foo\\");
  83   paths.push_back("c:\\foo\\");
  84   paths.push_back("c:\\foo/");
  85   paths.push_back("c:/foo\\bar");
  86
  87   for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
  88                                                   e = paths.end();
  89                                                   i != e;
  90                                                   ++i) {
  91     for (sys::path::const_iterator ci = sys::path::begin(*i),
  92                                    ce = sys::path::end(*i);
  93                                    ci != ce;
  94                                    ++ci) {
  95       ASSERT_FALSE(ci->empty());
  96     }
  97
  98 #if 0 // Valgrind is whining about this.
  99     outs() << "    Reverse Iteration: [";
 100     for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
 101                                      ce = sys::path::rend(*i);
 102                                      ci != ce;
 103                                      ++ci) {
 104       outs() << *ci << ',';
 105     }
 106     outs() << "]\n";
 107 #endif
 108
 109     path::has_root_path(*i);
 110     path::root_path(*i);
 111     path::has_root_name(*i);
 112     path::root_name(*i);
 113     path::has_root_directory(*i);
 114     path::root_directory(*i);
 115     path::has_parent_path(*i);
 116     path::parent_path(*i);
 117     path::has_filename(*i);
 118     path::filename(*i);
 119     path::has_stem(*i);
 120     path::stem(*i);
 121     path::has_extension(*i);
 122     path::extension(*i);
 123     path::is_absolute(*i);
 124     path::is_relative(*i);
 125
 126     SmallString<128> temp_store;
 127     temp_store = *i;
 128     ASSERT_NO_ERROR(fs::make_absolute(temp_store));
 129     temp_store = *i;
 130     path::remove_filename(temp_store);
 131
 132     temp_store = *i;
 133     path::replace_extension(temp_store, "ext");
 134     StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
 135     stem = path::stem(filename);
 136     ext  = path::extension(filename);
 137     EXPECT_EQ(*(--sys::path::end(filename)), (stem + ext).str());
 138
 139     path::native(*i, temp_store);
 140   }
 141 }
 142
 143 class FileSystemTest : public testing::Test {
 144 protected:
 145   /// Unique temporary directory in which all created filesystem entities must
 146   /// be placed. It is recursively removed at the end of each test.
 147   SmallString<128> TestDirectory;
 148
 149   virtual void SetUp() {
 150     int fd;
 151     ASSERT_NO_ERROR(
 152       fs::unique_file("file-system-test-%%-%%-%%-%%/test-directory.anchor", fd,
 153                       TestDirectory));
 154     // We don't care about this specific file.
 155     ::close(fd);
 156     TestDirectory = path::parent_path(TestDirectory);
 157     errs() << "Test Directory: " << TestDirectory << '\n';
 158     errs().flush();
 159   }
 160
 161   virtual void TearDown() {
 162     uint32_t removed;
 163     ASSERT_NO_ERROR(fs::remove_all(TestDirectory.str(), removed));
 164   }
 165 };
 166
 167 TEST_F(FileSystemTest, Unique) {
 168   // Create a temp file.
 169   int FileDescriptor;
 170   SmallString<64> TempPath;
 171   ASSERT_NO_ERROR(
 172     fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
 173
 174   // The same file should return an identical unique id.
 175   uint64_t F1, F2;
 176   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F1));
 177   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath), F2));
 178   ASSERT_EQ(F1, F2);
 179
 180   // Different files should return different unique ids.
 181   int FileDescriptor2;
 182   SmallString<64> TempPath2;
 183   ASSERT_NO_ERROR(
 184     fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor2, TempPath2));
 185
 186   uint64_t D;
 187   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D));
 188   ASSERT_NE(D, F1);
 189   ::close(FileDescriptor2);
 190
 191   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2)));
 192
 193   // Two paths representing the same file on disk should still provide the
 194   // same unique id.  We can test this by making a hard link.
 195   ASSERT_NO_ERROR(fs::create_hard_link(Twine(TempPath), Twine(TempPath2)));
 196   uint64_t D2;
 197   ASSERT_NO_ERROR(fs::getUniqueID(Twine(TempPath2), D2));
 198   ASSERT_EQ(D2, F1);
 199
 200   ::close(FileDescriptor);
 201 }
 202
 203 TEST_F(FileSystemTest, TempFiles) {
 204   // Create a temp file.
 205   int FileDescriptor;
 206   SmallString<64> TempPath;
 207   ASSERT_NO_ERROR(
 208     fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
 209
 210   // Make sure it exists.
 211   bool TempFileExists;
 212   ASSERT_NO_ERROR(sys::fs::exists(Twine(TempPath), TempFileExists));
 213   EXPECT_TRUE(TempFileExists);
 214
 215   // Create another temp tile.
 216   int FD2;
 217   SmallString<64> TempPath2;
 218   ASSERT_NO_ERROR(fs::unique_file("%%-%%-%%-%%.temp", FD2, TempPath2));
 219   ASSERT_NE(TempPath.str(), TempPath2.str());
 220
 221   fs::file_status A, B;
 222   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
 223   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
 224   EXPECT_FALSE(fs::equivalent(A, B));
 225
 226   // Try to copy the first to the second.
 227   EXPECT_EQ(
 228     fs::copy_file(Twine(TempPath), Twine(TempPath2)), errc::file_exists);
 229
 230   ::close(FD2);
 231   // Try again with the proper options.
 232   ASSERT_NO_ERROR(fs::copy_file(Twine(TempPath), Twine(TempPath2),
 233                                 fs::copy_option::overwrite_if_exists));
 234   // Remove Temp2.
 235   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
 236   EXPECT_TRUE(TempFileExists);
 237
 238   // Make sure Temp2 doesn't exist.
 239   ASSERT_NO_ERROR(fs::exists(Twine(TempPath2), TempFileExists));
 240   EXPECT_FALSE(TempFileExists);
 241
 242   // Create a hard link to Temp1.
 243   ASSERT_NO_ERROR(fs::create_hard_link(Twine(TempPath), Twine(TempPath2)));
 244   bool equal;
 245   ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
 246   EXPECT_TRUE(equal);
 247   ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
 248   ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
 249   EXPECT_TRUE(fs::equivalent(A, B));
 250
 251   // Remove Temp1.
 252   ::close(FileDescriptor);
 253   ASSERT_NO_ERROR(fs::remove(Twine(TempPath), TempFileExists));
 254   EXPECT_TRUE(TempFileExists);
 255
 256   // Remove the hard link.
 257   ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
 258   EXPECT_TRUE(TempFileExists);
 259
 260   // Make sure Temp1 doesn't exist.
 261   ASSERT_NO_ERROR(fs::exists(Twine(TempPath), TempFileExists));
 262   EXPECT_FALSE(TempFileExists);
 263
 264 #ifdef LLVM_ON_WIN32
 265   // Path name > 260 chars should get an error.
 266   const char *Path270 =
 267     "abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz8"
 268     "abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz6"
 269     "abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz4"
 270     "abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz2"
 271     "abcdefghijklmnopqrstuvwxyz1abcdefghijklmnopqrstuvwxyz0";
 272   EXPECT_EQ(fs::unique_file(Twine(Path270), FileDescriptor, TempPath),
 273             windows_error::path_not_found);
 274 #endif
 275 }
 276
 277 TEST_F(FileSystemTest, DirectoryIteration) {
 278   error_code ec;
 279   for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
 280     ASSERT_NO_ERROR(ec);
 281
 282   // Create a known hierarchy to recurse over.
 283   bool existed;
 284   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
 285                   + "/recursive/a0/aa1", existed));
 286   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
 287                   + "/recursive/a0/ab1", existed));
 288   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
 289                   + "/recursive/dontlookhere/da1", existed));
 290   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
 291                   + "/recursive/z0/za1", existed));
 292   ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
 293                   + "/recursive/pop/p1", existed));
 294   typedef std::vector<std::string> v_t;
 295   v_t visited;
 296   for (fs::recursive_directory_iterator i(Twine(TestDirectory)
 297          + "/recursive", ec), e; i != e; i.increment(ec)){
 298     ASSERT_NO_ERROR(ec);
 299     if (path::filename(i->path()) == "p1") {
 300       i.pop();
 301       // FIXME: recursive_directory_iterator should be more robust.
 302       if (i == e) break;
 303     }
 304     if (path::filename(i->path()) == "dontlookhere")
 305       i.no_push();
 306     visited.push_back(path::filename(i->path()));
 307   }
 308   v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
 309   v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
 310   v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
 311   v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
 312                                                "dontlookhere");
 313   v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
 314   v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
 315   v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
 316   v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
 317   v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
 318
 319   // Make sure that each path was visited correctly.
 320   ASSERT_NE(a0, visited.end());
 321   ASSERT_NE(aa1, visited.end());
 322   ASSERT_NE(ab1, visited.end());
 323   ASSERT_NE(dontlookhere, visited.end());
 324   ASSERT_EQ(da1, visited.end()); // Not visited.
 325   ASSERT_NE(z0, visited.end());
 326   ASSERT_NE(za1, visited.end());
 327   ASSERT_NE(pop, visited.end());
 328   ASSERT_EQ(p1, visited.end()); // Not visited.
 329
 330   // Make sure that parents were visited before children. No other ordering
 331   // guarantees can be made across siblings.
 332   ASSERT_LT(a0, aa1);
 333   ASSERT_LT(a0, ab1);
 334   ASSERT_LT(z0, za1);
 335 }
 336
 337 const char elf[] = {0x7f, 'E', 'L', 'F', 1, 2, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1};
 338
 339 TEST_F(FileSystemTest, Magic) {
 340   struct type {
 341     const char *filename;
 342     const char *magic_str;
 343     size_t magic_str_len;
 344     fs::file_magic magic;
 345   } types [] = {
 346     {"magic.archive", "!<arch>\x0A", 8, fs::file_magic::archive},
 347     {"magic.elf", elf, sizeof(elf),
 348      fs::file_magic::elf_relocatable}
 349   };
 350
 351   // Create some files filled with magic.
 352   for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
 353                                                                      ++i) {
 354     SmallString<128> file_pathname(TestDirectory);
 355     path::append(file_pathname, i->filename);
 356     std::string ErrMsg;
 357     raw_fd_ostream file(file_pathname.c_str(), ErrMsg,
 358                         raw_fd_ostream::F_Binary);
 359     ASSERT_FALSE(file.has_error());
 360     StringRef magic(i->magic_str, i->magic_str_len);
 361     file << magic;
 362     file.close();
 363     bool res = false;
 364     ASSERT_NO_ERROR(fs::has_magic(file_pathname.c_str(), magic, res));
 365     EXPECT_TRUE(res);
 366     EXPECT_EQ(i->magic, fs::identify_magic(magic));
 367   }
 368 }
 369
 370 #if !defined(_WIN32) // FIXME: Win32 has different permission schema.
 371 TEST_F(FileSystemTest, Permissions) {
 372   // Create a temp file.
 373   int FileDescriptor;
 374   SmallString<64> TempPath;
 375   ASSERT_NO_ERROR(
 376     fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
 377
 378   // Mark file as read-only
 379   const fs::perms AllWrite = fs::owner_write|fs::group_write|fs::others_write;
 380   ASSERT_NO_ERROR(fs::permissions(Twine(TempPath), fs::remove_perms|AllWrite));
 381
 382   // Verify file is read-only
 383   fs::file_status Status;
 384   ASSERT_NO_ERROR(fs::status(Twine(TempPath), Status));
 385   bool AnyWriteBits = (Status.permissions() & AllWrite);
 386   EXPECT_FALSE(AnyWriteBits);
 387
 388   // Mark file as read-write
 389   ASSERT_NO_ERROR(fs::permissions(Twine(TempPath), fs::add_perms|AllWrite));
 390
 391   // Verify file is read-write
 392   ASSERT_NO_ERROR(fs::status(Twine(TempPath), Status));
 393   AnyWriteBits = (Status.permissions() & AllWrite);
 394   EXPECT_TRUE(AnyWriteBits);
 395 }
 396 #endif
 397
 398 TEST_F(FileSystemTest, FileMapping) {
 399   // Create a temp file.
 400   int FileDescriptor;
 401   SmallString<64> TempPath;
 402   ASSERT_NO_ERROR(
 403     fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
 404   // Map in temp file and add some content
 405   error_code EC;
 406   StringRef Val("hello there");
 407   {
 408     fs::mapped_file_region mfr(FileDescriptor,
 409                                true,
 410                                fs::mapped_file_region::readwrite,
 411                                4096,
 412                                0,
 413                                EC);
 414     ASSERT_NO_ERROR(EC);
 415     std::copy(Val.begin(), Val.end(), mfr.data());
 416     // Explicitly add a 0.
 417     mfr.data()[Val.size()] = 0;
 418     // Unmap temp file
 419   }
 420
 421   // Map it back in read-only
 422   fs::mapped_file_region mfr(Twine(TempPath),
 423                              fs::mapped_file_region::readonly,
 424                              0,
 425                              0,
 426                              EC);
 427   ASSERT_NO_ERROR(EC);
 428
 429   // Verify content
 430   EXPECT_EQ(StringRef(mfr.const_data()), Val);
 431
 432   // Unmap temp file
 433
 434 #if LLVM_HAS_RVALUE_REFERENCES
 435   fs::mapped_file_region m(Twine(TempPath),
 436                              fs::mapped_file_region::readonly,
 437                              0,
 438                              0,
 439                              EC);
 440   ASSERT_NO_ERROR(EC);
 441   const char *Data = m.const_data();
 442   fs::mapped_file_region mfrrv(llvm_move(m));
 443   EXPECT_EQ(mfrrv.const_data(), Data);
 444 #endif
 445 }
 446 } // anonymous namespace