Skip to content

Commit

Permalink
Add even more tests for canonicalize_path
Browse files Browse the repository at this point in the history 
Also fix a bug on macOS where /path/to/file/ didn't give an error.
  • Loading branch information
@strager
strager committed Jun 4, 2021
1 parent e7db3e0 commit 02b1cc9
Show file tree
Hide file tree
Showing 2 changed files with 140 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/file-canonical.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,18 @@ canonical_path_result canonicalize_path(const char *path) {
}
return canonical_path_result(canonical.string().c_str());
#elif QLJS_HAVE_REALPATH
#if defined(__APPLE__)
{
// macOS' realpath doesn't catch some errors. Catch them with another API.
struct stat s;
int rc = ::stat(path, &s);
if (rc == -1) {
return canonical_path_result::failure(
std::string("failed to canonicalize path ") + path + ": " +
std::strerror(errno));
}
}
#endif
char *allocated_canonical = ::realpath(path, nullptr);
if (!allocated_canonical) {
return canonical_path_result::failure(
Expand Down
128 changes: 128 additions & 0 deletions test/test-file.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@
#include <sys/types.h>
#endif

#if defined(_WIN32)
#define QLJS_FILE_PATH_ALLOWS_FOLLOWING_COMPONENTS 1
#else
#define QLJS_FILE_PATH_ALLOWS_FOLLOWING_COMPONENTS 0
#endif

using ::testing::AnyOf;
using ::testing::HasSubstr;
using ::testing::Not;
Expand Down Expand Up @@ -255,6 +261,21 @@ TEST_F(test_file, canonical_path_to_directory_removes_trailing_slash) {
EXPECT_FALSE(ends_with(canonical.path(), "\\"));
}

TEST_F(test_file, canonical_path_to_file_with_trailing_slash_fails) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/file.txt", u8"");

std::string input_path = temp_dir + "/file.txt/";
canonical_path_result canonical = canonicalize_path(input_path);
EXPECT_FALSE(canonical.ok());
std::string error = std::move(canonical).error();
EXPECT_THAT(error, HasSubstr("file.txt"));
EXPECT_THAT(error, AnyOf(HasSubstr("Not a directory"),
// TODO(strager): Improve error message.
HasSubstr("The filename, directory name, or volume "
"label syntax is incorrect")));
}

TEST_F(test_file, canonical_path_to_non_existing_file_fails) {
std::string temp_file_path =
this->make_temporary_directory() + "/does-not-exist.js";
Expand Down Expand Up @@ -293,6 +314,113 @@ TEST_F(test_file, canonical_path_removes_dot_components) {
EXPECT_SAME_FILE(canonical.path(), input_path);
}

TEST_F(test_file, canonical_path_removes_trailing_dot_component) {
std::string temp_dir = this->make_temporary_directory();

std::string input_path = temp_dir + "/.";
canonical_path_result canonical = canonicalize_path(input_path);
ASSERT_TRUE(canonical.ok()) << std::move(canonical).error();

EXPECT_FALSE(ends_with(canonical.path(), "/.")) << canonical.path();
EXPECT_FALSE(ends_with(canonical.path(), "\\.")) << canonical.path();
EXPECT_SAME_FILE(canonical.path(), temp_dir);
}

TEST_F(test_file, canonical_path_fails_with_dot_component_after_regular_file) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/just-a-file", u8"");

std::string input_path = temp_dir + "/just-a-file/./something";
canonical_path_result canonical = canonicalize_path(input_path);
EXPECT_FALSE(canonical.ok());
std::string error = std::move(canonical).error();
EXPECT_THAT(error, HasSubstr("just-a-file"));
EXPECT_THAT(error,
AnyOf(HasSubstr("Not a directory"),
HasSubstr("The system cannot find the path specified")));
}

// TODO(strager): This test is wrong if
// QLJS_FILE_PATH_ALLOWS_FOLLOWING_COMPONENTS.
TEST_F(test_file,
canonical_path_fails_with_dot_dot_component_after_regular_file) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/just-a-file", u8"");
write_file(temp_dir + "/other.txt", u8"");

std::string input_path = temp_dir + "/just-a-file/../other.text";
canonical_path_result canonical = canonicalize_path(input_path);
EXPECT_FALSE(canonical.ok());
std::string error = std::move(canonical).error();
EXPECT_THAT(error, HasSubstr("just-a-file"));
EXPECT_THAT(error,
AnyOf(HasSubstr("Not a directory"),
HasSubstr("No such file or directory"),
HasSubstr("The system cannot find the file specified")));
}

#if QLJS_FILE_PATH_ALLOWS_FOLLOWING_COMPONENTS
TEST_F(test_file,
canonical_path_with_component_and_dot_dot_after_regular_file) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/just-a-file", u8"");

std::string input_path = temp_dir + "/just-a-file/fake-subdir/..";
canonical_path_result canonical = canonicalize_path(input_path);
ASSERT_TRUE(canonical.ok()) << std::move(canonical).error();

EXPECT_FALSE(ends_with(canonical.path(), "/..")) << canonical.path();
EXPECT_FALSE(ends_with(canonical.path(), "\\..")) << canonical.path();
EXPECT_THAT(std::string(canonical.path()), Not(HasSubstr("fake-subdir")));
EXPECT_SAME_FILE(canonical.path(), temp_dir + "/just-a-file");
}
#else
TEST_F(test_file,
canonical_path_fails_with_component_and_dot_dot_after_regular_file) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/just-a-file", u8"");

std::string input_path = temp_dir + "/just-a-file/fake-subdir/..";
canonical_path_result canonical = canonicalize_path(input_path);
EXPECT_FALSE(canonical.ok());
std::string error = std::move(canonical).error();
EXPECT_THAT(error, HasSubstr("just-a-file"));
EXPECT_THAT(error,
AnyOf(HasSubstr("Not a directory"),
HasSubstr("The system cannot find the path specified")));
}
#endif

#if QLJS_FILE_PATH_ALLOWS_FOLLOWING_COMPONENTS
TEST_F(test_file, canonical_path_with_dot_after_regular_file) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/just-a-file", u8"");

std::string input_path = temp_dir + "/just-a-file/.";
canonical_path_result canonical = canonicalize_path(input_path);
ASSERT_TRUE(canonical.ok()) << std::move(canonical).error();

EXPECT_FALSE(ends_with(canonical.path(), "/.")) << canonical.path();
EXPECT_FALSE(ends_with(canonical.path(), "\\.")) << canonical.path();
EXPECT_SAME_FILE(canonical.path(), temp_dir + "/just-a-file");
}
#else
TEST_F(test_file,
canonical_path_fails_with_trailing_dot_component_for_regular_file) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/just-a-file", u8"");

std::string input_path = temp_dir + "/just-a-file/.";
canonical_path_result canonical = canonicalize_path(input_path);
EXPECT_FALSE(canonical.ok());
std::string error = std::move(canonical).error();
EXPECT_THAT(error, HasSubstr("just-a-file"));
EXPECT_THAT(error,
AnyOf(HasSubstr("Not a directory"),
HasSubstr("The system cannot find the path specified")));
}
#endif

TEST_F(test_file, canonical_path_removes_redundant_slashes) {
std::string temp_dir = this->make_temporary_directory();
write_file(temp_dir + "/temp.js", u8"");
Expand Down

0 comments on commit 02b1cc9

Please sign in to comment.