1 //===- llvm/unittest/Support/Path.cpp - Path tests ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Support/FileSystem.h"
11 #include "llvm/Support/PathV2.h"
12 #include "llvm/Support/ErrorHandling.h"
13 #include "llvm/Support/raw_ostream.h"
15 #include "gtest/gtest.h"
18 using namespace llvm::sys;
20 #define ASSERT_NO_ERROR(x) \
21 if (error_code ASSERT_NO_ERROR_ec = x) { \
22 SmallString<128> MessageStorage; \
23 raw_svector_ostream Message(MessageStorage); \
24 Message << #x ": did not return errc::success.\n" \
25 << "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
26 << "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
27 GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \
32 TEST(is_separator, Works) {
33 EXPECT_TRUE(path::is_separator('/'));
34 EXPECT_FALSE(path::is_separator('\0'));
35 EXPECT_FALSE(path::is_separator('-'));
36 EXPECT_FALSE(path::is_separator(' '));
39 EXPECT_TRUE(path::is_separator('\\'));
41 EXPECT_FALSE(path::is_separator('\\'));
46 SmallVector<StringRef, 40> paths;
49 paths.push_back("..");
50 paths.push_back("foo");
52 paths.push_back("/foo");
53 paths.push_back("foo/");
54 paths.push_back("/foo/");
55 paths.push_back("foo/bar");
56 paths.push_back("/foo/bar");
57 paths.push_back("//net");
58 paths.push_back("//net/foo");
59 paths.push_back("///foo///");
60 paths.push_back("///foo///bar");
61 paths.push_back("/.");
62 paths.push_back("./");
63 paths.push_back("/..");
64 paths.push_back("../");
65 paths.push_back("foo/.");
66 paths.push_back("foo/..");
67 paths.push_back("foo/./");
68 paths.push_back("foo/./bar");
69 paths.push_back("foo/..");
70 paths.push_back("foo/../");
71 paths.push_back("foo/../bar");
72 paths.push_back("c:");
73 paths.push_back("c:/");
74 paths.push_back("c:foo");
75 paths.push_back("c:/foo");
76 paths.push_back("c:foo/");
77 paths.push_back("c:/foo/");
78 paths.push_back("c:/foo/bar");
79 paths.push_back("prn:");
80 paths.push_back("c:\\");
81 paths.push_back("c:foo");
82 paths.push_back("c:\\foo");
83 paths.push_back("c:foo\\");
84 paths.push_back("c:\\foo\\");
85 paths.push_back("c:\\foo/");
86 paths.push_back("c:/foo\\bar");
88 for (SmallVector<StringRef, 40>::const_iterator i = paths.begin(),
92 for (sys::path::const_iterator ci = sys::path::begin(*i),
93 ce = sys::path::end(*i);
96 ASSERT_FALSE(ci->empty());
99 #if 0 // Valgrind is whining about this.
100 outs() << " Reverse Iteration: [";
101 for (sys::path::reverse_iterator ci = sys::path::rbegin(*i),
102 ce = sys::path::rend(*i);
105 outs() << *ci << ',';
110 path::has_root_path(*i);
112 path::has_root_name(*i);
114 path::has_root_directory(*i);
115 path::root_directory(*i);
116 path::has_parent_path(*i);
117 path::parent_path(*i);
118 path::has_filename(*i);
122 path::has_extension(*i);
124 path::is_absolute(*i);
125 path::is_relative(*i);
127 SmallString<128> temp_store;
129 ASSERT_NO_ERROR(fs::make_absolute(temp_store));
131 path::remove_filename(temp_store);
134 path::replace_extension(temp_store, "ext");
135 StringRef filename(temp_store.begin(), temp_store.size()), stem, ext;
136 stem = path::stem(filename);
137 ext = path::extension(filename);
138 EXPECT_EQ(*(--sys::path::end(filename)), (stem + ext).str());
140 path::native(*i, temp_store);
144 class FileSystemTest : public testing::Test {
146 /// Unique temporary directory in which all created filesystem entities must
147 /// be placed. It is recursively removed at the end of each test.
148 SmallString<128> TestDirectory;
150 virtual void SetUp() {
153 fs::unique_file("file-system-test-%%-%%-%%-%%/test-directory.anchor", fd,
155 // We don't care about this specific file.
157 TestDirectory = path::parent_path(TestDirectory);
158 errs() << "Test Directory: " << TestDirectory << '\n';
162 virtual void TearDown() {
164 ASSERT_NO_ERROR(fs::remove_all(TestDirectory.str(), removed));
168 TEST_F(FileSystemTest, TempFiles) {
169 // Create a temp file.
171 SmallString<64> TempPath;
173 fs::unique_file("%%-%%-%%-%%.temp", FileDescriptor, TempPath));
175 // Make sure it exists.
177 ASSERT_NO_ERROR(sys::fs::exists(Twine(TempPath), TempFileExists));
178 EXPECT_TRUE(TempFileExists);
180 // Create another temp tile.
182 SmallString<64> TempPath2;
183 ASSERT_NO_ERROR(fs::unique_file("%%-%%-%%-%%.temp", FD2, TempPath2));
184 ASSERT_NE(TempPath.str(), TempPath2.str());
186 // Try to copy the first to the second.
188 fs::copy_file(Twine(TempPath), Twine(TempPath2)), errc::file_exists);
191 // Try again with the proper options.
192 ASSERT_NO_ERROR(fs::copy_file(Twine(TempPath), Twine(TempPath2),
193 fs::copy_option::overwrite_if_exists));
195 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
196 EXPECT_TRUE(TempFileExists);
198 // Make sure Temp2 doesn't exist.
199 ASSERT_NO_ERROR(fs::exists(Twine(TempPath2), TempFileExists));
200 EXPECT_FALSE(TempFileExists);
202 // Create a hard link to Temp1.
203 ASSERT_NO_ERROR(fs::create_hard_link(Twine(TempPath), Twine(TempPath2)));
205 ASSERT_NO_ERROR(fs::equivalent(Twine(TempPath), Twine(TempPath2), equal));
209 ::close(FileDescriptor);
210 ASSERT_NO_ERROR(fs::remove(Twine(TempPath), TempFileExists));
211 EXPECT_TRUE(TempFileExists);
213 // Remove the hard link.
214 ASSERT_NO_ERROR(fs::remove(Twine(TempPath2), TempFileExists));
215 EXPECT_TRUE(TempFileExists);
217 // Make sure Temp1 doesn't exist.
218 ASSERT_NO_ERROR(fs::exists(Twine(TempPath), TempFileExists));
219 EXPECT_FALSE(TempFileExists);
222 TEST_F(FileSystemTest, DirectoryIteration) {
224 for (fs::directory_iterator i(".", ec), e; i != e; i.increment(ec))
227 // Create a known hierarchy to recurse over.
229 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
230 + "/recursive/a0/aa1", existed));
231 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
232 + "/recursive/a0/ab1", existed));
233 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
234 + "/recursive/dontlookhere/da1", existed));
235 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
236 + "/recursive/z0/za1", existed));
237 ASSERT_NO_ERROR(fs::create_directories(Twine(TestDirectory)
238 + "/recursive/pop/p1", existed));
239 typedef std::vector<std::string> v_t;
241 for (fs::recursive_directory_iterator i(Twine(TestDirectory)
242 + "/recursive", ec), e; i != e; i.increment(ec)){
244 if (path::filename(i->path()) == "p1") {
246 // FIXME: recursive_directory_iterator should be more robust.
249 if (path::filename(i->path()) == "dontlookhere")
251 visited.push_back(path::filename(i->path()));
253 v_t::const_iterator a0 = std::find(visited.begin(), visited.end(), "a0");
254 v_t::const_iterator aa1 = std::find(visited.begin(), visited.end(), "aa1");
255 v_t::const_iterator ab1 = std::find(visited.begin(), visited.end(), "ab1");
256 v_t::const_iterator dontlookhere = std::find(visited.begin(), visited.end(),
258 v_t::const_iterator da1 = std::find(visited.begin(), visited.end(), "da1");
259 v_t::const_iterator z0 = std::find(visited.begin(), visited.end(), "z0");
260 v_t::const_iterator za1 = std::find(visited.begin(), visited.end(), "za1");
261 v_t::const_iterator pop = std::find(visited.begin(), visited.end(), "pop");
262 v_t::const_iterator p1 = std::find(visited.begin(), visited.end(), "p1");
264 // Make sure that each path was visited correctly.
265 ASSERT_NE(a0, visited.end());
266 ASSERT_NE(aa1, visited.end());
267 ASSERT_NE(ab1, visited.end());
268 ASSERT_NE(dontlookhere, visited.end());
269 ASSERT_EQ(da1, visited.end()); // Not visited.
270 ASSERT_NE(z0, visited.end());
271 ASSERT_NE(za1, visited.end());
272 ASSERT_NE(pop, visited.end());
273 ASSERT_EQ(p1, visited.end()); // Not visited.
275 // Make sure that parents were visited before children. No other ordering
276 // guarantees can be made across siblings.
282 TEST_F(FileSystemTest, Magic) {
284 const char *filename;
285 const char *magic_str;
286 size_t magic_str_len;
287 } types [] = {{"magic.archive", "!<arch>\x0A", 8}};
289 // Create some files filled with magic.
290 for (type *i = types, *e = types + (sizeof(types) / sizeof(type)); i != e;
292 SmallString<128> file_pathname(TestDirectory);
293 path::append(file_pathname, i->filename);
295 raw_fd_ostream file(file_pathname.c_str(), ErrMsg,
296 raw_fd_ostream::F_Binary);
297 ASSERT_FALSE(file.has_error());
298 StringRef magic(i->magic_str, i->magic_str_len);
302 ASSERT_NO_ERROR(fs::has_magic(file_pathname.c_str(), magic, res));
307 } // anonymous namespace