Path.cpp revision 5a88dda4be791426ab4d20a6a6c9c65d66614a27 
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/PathV2.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
16using namespace llvm;
17using 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
29namespace {
30
31TEST(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
44TEST(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
143class FileSystemTest : public testing::Test {
144protected:
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
167TEST_F(FileSystemTest, TempFiles) {
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  // Make sure it exists.
175  bool TempFileExists;
176  ASSERT_NO_ERROR(sys::fs::exists(Twine(TempPath), TempFileExists));
177  EXPECT_TRUE(TempFileExists);
178
179  // Create another temp tile.
180  int FD2;
181  SmallString<64> TempPath2;
182  ASSERT_NO_ERROR(fs::unique_file("%%-%%-%%-%%.temp", FD2, TempPath2));
183  ASSERT_NE(TempPath.str(), TempPath2.str());
184
185  fs::file_status A, B;
186  ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
187  ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
188  EXPECT_FALSE(fs::equivalent(A, B));
189
190  // Try to copy the first to the second.
191  EXPECT_EQ(
192    fs::copy_file(Twine(TempPath), Twine(TempPath2)), errc::file_exists);
193
194  ::close(FD2);
195  // Try again with the proper options.
196  ASSERT_NO_ERROR(fs::copy_file(Twine(TempPath), Twine(TempPath2),
197                                fs::copy_option::overwrite_if_exists));
198  // Remove Temp2.
199  ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
200  EXPECT_TRUE(TempFileExists);
201
202  // Make sure Temp2 doesn't exist.
203  ASSERT_NO_ERROR(fs::exists(Twine(TempPath2), TempFileExists));
204  EXPECT_FALSE(TempFileExists);
205
206  // Create a hard link to Temp1.
207  ASSERT_NO_ERROR(fs::create_hard_link(Twine(TempPath), Twine(TempPath2)));
208  bool equal;
209  ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
210  EXPECT_TRUE(equal);
211  ASSERT_NO_ERROR(fs::status(Twine(TempPath), A));
212  ASSERT_NO_ERROR(fs::status(Twine(TempPath2), B));
213  EXPECT_TRUE(fs::equivalent(A, B));
214
215  // Remove Temp1.
216  ::close(FileDescriptor);
217  ASSERT_NO_ERROR(fs::remove(Twine(TempPath), TempFileExists));
218  EXPECT_TRUE(TempFileExists);
219
220  // Remove the hard link.
221  ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
222  EXPECT_TRUE(TempFileExists);
223
224  // Make sure Temp1 doesn't exist.
225  ASSERT_NO_ERROR(fs::exists(Twine(TempPath), TempFileExists));
226  EXPECT_FALSE(TempFileExists);
227}
228
229TEST_F(FileSystemTest, DirectoryIteration) {
230  error_code ec;
231  for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
232    ASSERT_NO_ERROR(ec);
233
234  // Create a known hierarchy to recurse over.
235  bool existed;
236  ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
237                  + "/recursive/a0/aa1", existed));
238  ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
239                  + "/recursive/a0/ab1", existed));
240  ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
241                  + "/recursive/dontlookhere/da1", existed));
242  ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
243                  + "/recursive/z0/za1", existed));
244  ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
245                  + "/recursive/pop/p1", existed));
246  typedef std::vector<std::string> v_t;
247  v_t visited;
248  for (fs::recursive_directory_iterator i(Twine(TestDirectory)
249         + "/recursive", ec), e; i != e; i.increment(ec)){
250    ASSERT_NO_ERROR(ec);
251    if (path::filename(i->path()) == "p1") {
252      i.pop();
253      // FIXME: recursive_directory_iterator should be more robust.
254      if (i == e) break;
255    }
256    if (path::filename(i->path()) == "dontlookhere")
257      i.no_push();
258    visited.push_back(path::filename(i->path()));
259  }
260  v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
261  v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
262  v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
263  v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
264                                               "dontlookhere");
265  v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
266  v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
267  v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
268  v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
269  v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
270
271  // Make sure that each path was visited correctly.
272  ASSERT_NE(a0, visited.end());
273  ASSERT_NE(aa1, visited.end());
274  ASSERT_NE(ab1, visited.end());
275  ASSERT_NE(dontlookhere, visited.end());
276  ASSERT_EQ(da1, visited.end()); // Not visited.
277  ASSERT_NE(z0, visited.end());
278  ASSERT_NE(za1, visited.end());
279  ASSERT_NE(pop, visited.end());
280  ASSERT_EQ(p1, visited.end()); // Not visited.
281
282  // Make sure that parents were visited before children. No other ordering
283  // guarantees can be made across siblings.
284  ASSERT_LT(a0, aa1);
285  ASSERT_LT(a0, ab1);
286  ASSERT_LT(z0, za1);
287}
288
289TEST_F(FileSystemTest, Magic) {
290  struct type {
291    const char *filename;
292    const char *magic_str;
293    size_t      magic_str_len;
294  } types [] = {{"magic.archive", "!<arch>\x0A", 8}};
295
296  // Create some files filled with magic.
297  for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
298                                                                     ++i) {
299    SmallString<128> file_pathname(TestDirectory);
300    path::append(file_pathname, i->filename);
301    std::string ErrMsg;
302    raw_fd_ostream file(file_pathname.c_str(), ErrMsg,
303                        raw_fd_ostream::F_Binary);
304    ASSERT_FALSE(file.has_error());
305    StringRef magic(i->magic_str, i->magic_str_len);
306    file << magic;
307    file.close();
308    bool res = false;
309    ASSERT_NO_ERROR(fs::has_magic(file_pathname.c_str(), magic, res));
310    EXPECT_TRUE(res);
311  }
312}
313
314#if !defined(_WIN32) // FIXME: Win32 has different permission schema.
315TEST_F(FileSystemTest, Permissions) {
316  // Create a temp file.
317  int FileDescriptor;
318  SmallString<64> TempPath;
319  ASSERT_NO_ERROR(
320    fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
321
322  // Mark file as read-only
323  const fs::perms AllWrite = fs::owner_write|fs::group_write|fs::others_write;
324  ASSERT_NO_ERROR(fs::permissions(Twine(TempPath), fs::remove_perms|AllWrite));
325
326  // Verify file is read-only
327  fs::file_status Status;
328  ASSERT_NO_ERROR(fs::status(Twine(TempPath), Status));
329  bool AnyWriteBits = (Status.permissions() & AllWrite);
330  EXPECT_FALSE(AnyWriteBits);
331
332  // Mark file as read-write
333  ASSERT_NO_ERROR(fs::permissions(Twine(TempPath), fs::add_perms|AllWrite));
334
335  // Verify file is read-write
336  ASSERT_NO_ERROR(fs::status(Twine(TempPath), Status));
337  AnyWriteBits = (Status.permissions() & AllWrite);
338  EXPECT_TRUE(AnyWriteBits);
339}
340#endif
341
342TEST_F(FileSystemTest, FileMapping) {
343  // Create a temp file.
344  int FileDescriptor;
345  SmallString<64> TempPath;
346  ASSERT_NO_ERROR(
347    fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
348  // Map in temp file and add some content
349  error_code EC;
350  StringRef Val("hello there");
351  {
352    fs::mapped_file_region mfr(FileDescriptor,
353                               fs::mapped_file_region::readwrite,
354                               4096,
355                               0,
356                               EC);
357    ASSERT_NO_ERROR(EC);
358    std::copy(Val.begin(), Val.end(), mfr.data());
359    // Explicitly add a 0.
360    mfr.data()[Val.size()] = 0;
361    // Unmap temp file
362  }
363
364  // Map it back in read-only
365  fs::mapped_file_region mfr(Twine(TempPath),
366                             fs::mapped_file_region::readonly,
367                             0,
368                             0,
369                             EC);
370  ASSERT_NO_ERROR(EC);
371
372  // Verify content
373  EXPECT_EQ(StringRef(mfr.const_data()), Val);
374
375  // Unmap temp file
376
377#if LLVM_HAS_RVALUE_REFERENCES
378  fs::mapped_file_region m(Twine(TempPath),
379                             fs::mapped_file_region::readonly,
380                             0,
381                             0,
382                             EC);
383  ASSERT_NO_ERROR(EC);
384  const char *Data = m.const_data();
385  fs::mapped_file_region mfrrv(llvm_move(m));
386  EXPECT_EQ(mfrrv.const_data(), Data);
387#endif
388}
389} // anonymous namespace
390