//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
// REQUIRES: can-create-symlinks
// UNSUPPORTED: c++03, c++11, c++14
// UNSUPPORTED: no-filesystem
// UNSUPPORTED: availability-filesystem-missing
// Starting in Android N (API 24), SELinux policy prevents the shell user from
// creating a FIFO file.
// XFAIL: LIBCXX-ANDROID-FIXME && !android-device-api={{21|22|23}}
// <filesystem>
// file_status symlink_status(const path& p);
// file_status symlink_status(const path& p, error_code& ec) noexcept;
#include <filesystem>
#include "assert_macros.h"
#include "test_macros.h"
#include "filesystem_test_helper.h"
namespace fs = std::filesystem;
using namespace fs;
static void signature_test()
{
const path p; ((void)p);
std::error_code ec; ((void)ec);
ASSERT_NOT_NOEXCEPT(symlink_status(p));
ASSERT_NOEXCEPT(symlink_status(p, ec));
}
static void test_symlink_status_not_found()
{
static_test_env static_env;
const std::errc expect_errc = std::errc::no_such_file_or_directory;
const path cases[] {
static_env.DNE
};
for (auto& p : cases) {
std::error_code ec = std::make_error_code(std::errc::address_in_use);
// test non-throwing overload.
file_status st = symlink_status(p, ec);
assert(ErrorIs(ec, expect_errc));
assert(st.type() == file_type::not_found);
assert(st.permissions() == perms::unknown);
// test throwing overload. It should not throw even though it reports
// that the file was not found.
TEST_DOES_NOT_THROW(st = status(p));
assert(st.type() == file_type::not_found);
assert(st.permissions() == perms::unknown);
}
}
// Windows doesn't support setting perms::none to trigger failures
// reading directories. Imaginary files under GetWindowsInaccessibleDir()
// produce no_such_file_or_directory, not the error codes this test checks
// for. Finally, status() for a too long file name doesn't return errors
// on windows.
#ifndef TEST_WIN_NO_FILESYSTEM_PERMS_NONE
static void test_symlink_status_cannot_resolve()
{
scoped_test_env env;
const path dir = env.create_dir("dir");
const path file_in_dir = env.create_file("dir/file", 42);
const path sym_in_dir = env.create_symlink("dir/file", "dir/bad_sym");
const path sym_points_in_dir = env.create_symlink("dir/file", "sym");
permissions(dir, perms::none);
const std::errc set_errc = std::errc::address_in_use;
const std::errc expect_errc = std::errc::permission_denied;
const path fail_cases[] = {
file_in_dir, sym_in_dir
};
for (auto& p : fail_cases)
{
{ // test non-throwing case
std::error_code ec = std::make_error_code(set_errc);
file_status st = symlink_status(p, ec);
assert(ErrorIs(ec, expect_errc));
assert(st.type() == file_type::none);
assert(st.permissions() == perms::unknown);
}
#ifndef TEST_HAS_NO_EXCEPTIONS
{ // test throwing case
try {
(void)symlink_status(p);
} catch (filesystem_error const& err) {
assert(err.path1() == p);
assert(err.path2() == "");
assert(ErrorIs(err.code(), expect_errc));
}
}
#endif
}
// Test that a symlink that points into a directory without read perms
// can be stat-ed using symlink_status
{
std::error_code ec = std::make_error_code(set_errc);
file_status st = symlink_status(sym_points_in_dir, ec);
assert(!ec);
assert(st.type() == file_type::symlink);
assert(st.permissions() != perms::unknown);
// test non-throwing version
TEST_DOES_NOT_THROW(st = symlink_status(sym_points_in_dir));
assert(st.type() == file_type::symlink);
assert(st.permissions() != perms::unknown);
}
}
#endif // TEST_WIN_NO_FILESYSTEM_PERMS_NONE
static void symlink_status_file_types_test()
{
static_test_env static_env;
scoped_test_env env;
struct TestCase {
path p;
file_type expect_type;
} cases[] = {
{static_env.BadSymlink, file_type::symlink},
{static_env.File, file_type::regular},
{static_env.SymlinkToFile, file_type::symlink},
{static_env.Dir, file_type::directory},
{static_env.SymlinkToDir, file_type::symlink},
// file_type::block files tested elsewhere
#ifndef _WIN32
{static_env.CharFile, file_type::character},
#endif
#if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(_WIN32) // No support for domain sockets
{env.create_socket("socket"), file_type::socket},
#endif
#ifndef _WIN32
{env.create_fifo("fifo"), file_type::fifo}
#endif
};
for (const auto& TC : cases) {
// test non-throwing case
std::error_code ec = std::make_error_code(std::errc::address_in_use);
file_status st = symlink_status(TC.p, ec);
assert(!ec);
assert(st.type() == TC.expect_type);
assert(st.permissions() != perms::unknown);
// test throwing case
TEST_DOES_NOT_THROW(st = symlink_status(TC.p));
assert(st.type() == TC.expect_type);
assert(st.permissions() != perms::unknown);
}
}
static void test_block_file()
{
const path possible_paths[] = {
"/dev/drive0", // Apple
"/dev/sda", // Linux
"/dev/loop0" // Linux
// No FreeBSD files known
};
path p;
for (const path& possible_p : possible_paths) {
std::error_code ec;
if (exists(possible_p, ec)) {
p = possible_p;
break;
}
}
if (p == path{}) {
// No possible path found.
return;
}
scoped_test_env env;
{ // test block file
// test non-throwing case
std::error_code ec = std::make_error_code(std::errc::address_in_use);
file_status st = symlink_status(p, ec);
assert(!ec);
assert(st.type() == file_type::block);
assert(st.permissions() != perms::unknown);
// test throwing case
TEST_DOES_NOT_THROW(st = symlink_status(p));
assert(st.type() == file_type::block);
assert(st.permissions() != perms::unknown);
}
const path sym = env.make_env_path("sym");
create_symlink(p, sym);
{ // test symlink to block file
// test non-throwing case
std::error_code ec = std::make_error_code(std::errc::address_in_use);
file_status st = symlink_status(sym, ec);
assert(!ec);
assert(st.type() == file_type::symlink);
assert(st.permissions() != perms::unknown);
// test throwing case
TEST_DOES_NOT_THROW(st = symlink_status(sym));
assert(st.type() == file_type::symlink);
assert(st.permissions() != perms::unknown);
}
}
int main(int, char**) {
signature_test();
test_symlink_status_not_found();
#ifndef TEST_WIN_NO_FILESYSTEM_PERMS_NONE
test_symlink_status_cannot_resolve();
#endif
symlink_status_file_types_test();
test_block_file();
return 0;
}