fmt/test/os-test.cc

517 lines
14 KiB
C++
Raw Normal View History

2019-12-15 22:51:37 +00:00
// Formatting library for C++ - tests of the OS-specific functionality
2018-03-04 17:16:51 +00:00
//
// Copyright (c) 2012 - present, Victor Zverovich
// All rights reserved.
//
// For the license information refer to format.h.
2020-05-07 22:59:46 +00:00
#include "fmt/os.h"
#include <cstdlib> // std::exit
#include <cstring>
#include <memory>
#include "gtest-extra.h"
#include "util.h"
2018-05-19 15:57:31 +00:00
using fmt::buffered_file;
using testing::HasSubstr;
2021-05-22 00:37:07 +00:00
using wstring_view = fmt::basic_string_view<wchar_t>;
2019-11-15 13:41:14 +00:00
static std::string uniq_file_name(unsigned line_number) {
return "test-file" + std::to_string(line_number);
}
#ifdef _WIN32
2019-12-21 21:10:45 +00:00
# include <windows.h>
2021-05-02 12:55:55 +00:00
TEST(os_test, format_windows_error) {
LPWSTR message = nullptr;
auto result = FormatMessageW(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_IGNORE_INSERTS,
nullptr, ERROR_FILE_EXISTS, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
reinterpret_cast<LPWSTR>(&message), 0, nullptr);
auto utf8_message =
fmt::detail::to_utf8<wchar_t>(wstring_view(message, result - 2));
LocalFree(message);
fmt::memory_buffer actual_message;
2020-05-10 14:25:42 +00:00
fmt::detail::format_windows_error(actual_message, ERROR_FILE_EXISTS, "test");
EXPECT_EQ(fmt::format("test: {}", utf8_message.str()),
fmt::to_string(actual_message));
actual_message.resize(0);
}
2021-05-02 12:55:55 +00:00
TEST(os_test, format_long_windows_error) {
LPWSTR message = nullptr;
// this error code is not available on all Windows platforms and
// Windows SDKs, so do not fail the test if the error string cannot
// be retrieved.
int provisioning_not_allowed = 0x80284013L; // TBS_E_PROVISIONING_NOT_ALLOWED
auto result = FormatMessageW(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM |
FORMAT_MESSAGE_IGNORE_INSERTS,
nullptr, static_cast<DWORD>(provisioning_not_allowed),
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
reinterpret_cast<LPWSTR>(&message), 0, nullptr);
2021-05-09 20:33:14 +00:00
if (result == 0) {
LocalFree(message);
return;
}
auto utf8_message =
fmt::detail::to_utf8<wchar_t>(wstring_view(message, result - 2));
LocalFree(message);
fmt::memory_buffer actual_message;
2020-05-10 14:25:42 +00:00
fmt::detail::format_windows_error(actual_message, provisioning_not_allowed,
"test");
EXPECT_EQ(fmt::format("test: {}", utf8_message.str()),
fmt::to_string(actual_message));
}
2021-05-02 12:55:55 +00:00
TEST(os_test, windows_error) {
auto error = std::system_error(std::error_code());
try {
throw fmt::windows_error(ERROR_FILE_EXISTS, "test {}", "error");
} catch (const std::system_error& e) {
error = e;
}
fmt::memory_buffer message;
2020-05-10 14:25:42 +00:00
fmt::detail::format_windows_error(message, ERROR_FILE_EXISTS, "test error");
EXPECT_THAT(error.what(), HasSubstr(to_string(message)));
EXPECT_EQ(ERROR_FILE_EXISTS, error.code().value());
}
2021-05-02 12:55:55 +00:00
TEST(os_test, report_windows_error) {
fmt::memory_buffer out;
2020-05-10 14:25:42 +00:00
fmt::detail::format_windows_error(out, ERROR_FILE_EXISTS, "test error");
out.push_back('\n');
EXPECT_WRITE(stderr,
fmt::report_windows_error(ERROR_FILE_EXISTS, "test error"),
fmt::to_string(out));
}
# if FMT_USE_FCNTL && !defined(__MINGW32__)
TEST(file_test, open_windows_file) {
using fmt::file;
file out = file::open_windows_file(L"test-file",
file::WRONLY | file::CREATE | file::TRUNC);
out.write("x", 1);
file in = file::open_windows_file(L"test-file", file::RDONLY);
EXPECT_READ(in, "x");
}
# endif // FMT_USE_FCNTL && !defined(__MINGW32__)
#endif // _WIN32
2019-11-15 13:41:14 +00:00
#if FMT_USE_FCNTL
2018-05-19 17:32:53 +00:00
using fmt::file;
2024-01-01 21:25:07 +00:00
auto isclosed(int fd) -> bool {
char buffer;
2021-05-02 12:55:55 +00:00
auto result = std::streamsize();
SUPPRESS_ASSERT(result = FMT_POSIX(read(fd, &buffer, 1)));
return result == -1 && errno == EBADF;
}
// Opens a file for reading.
2024-01-01 21:25:07 +00:00
auto open_file() -> file {
auto pipe = fmt::pipe();
pipe.write_end.write(file_content, std::strlen(file_content));
pipe.write_end.close();
return std::move(pipe.read_end);
}
// Attempts to write a string to a file.
2021-05-02 12:55:55 +00:00
void write(file& f, fmt::string_view s) {
2020-05-07 22:59:46 +00:00
size_t num_chars_left = s.size();
2019-01-13 02:27:38 +00:00
const char* ptr = s.data();
do {
2020-05-07 22:59:46 +00:00
size_t count = f.write(ptr, num_chars_left);
ptr += count;
// We can't write more than size_t bytes since num_chars_left
// has type size_t.
num_chars_left -= count;
} while (num_chars_left != 0);
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, default_ctor) {
auto f = buffered_file();
EXPECT_TRUE(f.get() == nullptr);
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, move_ctor) {
2018-05-19 15:57:31 +00:00
buffered_file bf = open_buffered_file();
2019-01-13 02:27:38 +00:00
FILE* fp = bf.get();
EXPECT_TRUE(fp != nullptr);
2018-05-19 15:57:31 +00:00
buffered_file bf2(std::move(bf));
EXPECT_EQ(fp, bf2.get());
EXPECT_TRUE(bf.get() == nullptr);
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, move_assignment) {
2018-05-19 15:57:31 +00:00
buffered_file bf = open_buffered_file();
2019-01-13 02:27:38 +00:00
FILE* fp = bf.get();
EXPECT_TRUE(fp != nullptr);
2018-05-19 15:57:31 +00:00
buffered_file bf2;
bf2 = std::move(bf);
EXPECT_EQ(fp, bf2.get());
EXPECT_TRUE(bf.get() == nullptr);
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, move_assignment_closes_file) {
2018-05-19 15:57:31 +00:00
buffered_file bf = open_buffered_file();
buffered_file bf2 = open_buffered_file();
2022-05-22 13:49:31 +00:00
int old_fd = bf2.descriptor();
bf2 = std::move(bf);
EXPECT_TRUE(isclosed(old_fd));
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, move_from_temporary_in_ctor) {
FILE* fp = nullptr;
2021-05-02 12:55:55 +00:00
buffered_file f = open_buffered_file(&fp);
EXPECT_EQ(fp, f.get());
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, move_from_temporary_in_assignment) {
FILE* fp = nullptr;
2021-05-02 12:55:55 +00:00
auto f = buffered_file();
f = open_buffered_file(&fp);
EXPECT_EQ(fp, f.get());
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, move_from_temporary_in_assignment_closes_file) {
2018-05-19 15:57:31 +00:00
buffered_file f = open_buffered_file();
2022-05-22 13:49:31 +00:00
int old_fd = f.descriptor();
f = open_buffered_file();
EXPECT_TRUE(isclosed(old_fd));
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, close_file_in_dtor) {
int fd = 0;
{
2018-05-19 15:57:31 +00:00
buffered_file f = open_buffered_file();
2022-05-22 13:49:31 +00:00
fd = f.descriptor();
}
EXPECT_TRUE(isclosed(fd));
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, close_error_in_dtor) {
auto f =
std::unique_ptr<buffered_file>(new buffered_file(open_buffered_file()));
2020-05-07 22:59:46 +00:00
EXPECT_WRITE(
stderr,
{
// The close function must be called inside EXPECT_WRITE,
// otherwise the system may recycle closed file descriptor when
// redirecting the output in EXPECT_STDERR and the second close
// will break output redirection.
2022-05-22 13:49:31 +00:00
FMT_POSIX(close(f->descriptor()));
2020-05-07 22:59:46 +00:00
SUPPRESS_ASSERT(f.reset(nullptr));
},
system_error_message(EBADF, "cannot close file") + "\n");
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, close) {
2018-05-19 15:57:31 +00:00
buffered_file f = open_buffered_file();
2022-05-22 13:49:31 +00:00
int fd = f.descriptor();
f.close();
EXPECT_TRUE(f.get() == nullptr);
EXPECT_TRUE(isclosed(fd));
}
2021-05-02 12:55:55 +00:00
TEST(buffered_file_test, close_error) {
2018-05-19 15:57:31 +00:00
buffered_file f = open_buffered_file();
2022-05-22 13:49:31 +00:00
FMT_POSIX(close(f.descriptor()));
EXPECT_SYSTEM_ERROR_NOASSERT(f.close(), EBADF, "cannot close file");
EXPECT_TRUE(f.get() == nullptr);
}
2022-05-22 13:49:31 +00:00
TEST(buffered_file_test, descriptor) {
auto f = open_buffered_file();
2022-05-22 13:49:31 +00:00
EXPECT_TRUE(f.descriptor() != -1);
file copy = file::dup(f.descriptor());
2021-05-06 00:43:06 +00:00
EXPECT_READ(copy, file_content);
}
2021-05-02 12:55:55 +00:00
TEST(ostream_test, move) {
auto test_file = uniq_file_name(__LINE__);
fmt::ostream out = fmt::output_file(test_file);
2020-09-01 15:16:53 +00:00
fmt::ostream moved(std::move(out));
moved.print("hello");
}
2021-05-02 12:55:55 +00:00
TEST(ostream_test, move_while_holding_data) {
auto test_file = uniq_file_name(__LINE__);
{
fmt::ostream out = fmt::output_file(test_file);
out.print("Hello, ");
fmt::ostream moved(std::move(out));
moved.print("world!\n");
}
{
file in(test_file, file::RDONLY);
EXPECT_READ(in, "Hello, world!\n");
}
}
2021-05-02 12:55:55 +00:00
TEST(ostream_test, print) {
auto test_file = uniq_file_name(__LINE__);
fmt::ostream out = fmt::output_file(test_file);
out.print("The answer is {}.\n", 42);
out.close();
file in(test_file, file::RDONLY);
EXPECT_READ(in, "The answer is 42.\n");
}
2021-05-02 12:55:55 +00:00
TEST(ostream_test, buffer_boundary) {
auto str = std::string(4096, 'x');
auto test_file = uniq_file_name(__LINE__);
fmt::ostream out = fmt::output_file(test_file);
2020-07-11 18:06:52 +00:00
out.print("{}", str);
out.print("{}", str);
out.close();
file in(test_file, file::RDONLY);
EXPECT_READ(in, str + str);
}
2021-05-02 12:55:55 +00:00
TEST(ostream_test, buffer_size) {
auto test_file = uniq_file_name(__LINE__);
fmt::ostream out = fmt::output_file(test_file, fmt::buffer_size = 1);
2020-08-01 17:25:39 +00:00
out.print("{}", "foo");
out.close();
file in(test_file, file::RDONLY);
2020-08-01 17:25:39 +00:00
EXPECT_READ(in, "foo");
}
2021-05-02 12:55:55 +00:00
TEST(ostream_test, truncate) {
auto test_file = uniq_file_name(__LINE__);
2020-11-27 16:15:14 +00:00
{
fmt::ostream out = fmt::output_file(test_file);
2020-11-27 16:15:14 +00:00
out.print("0123456789");
}
{
fmt::ostream out = fmt::output_file(test_file);
2020-11-27 16:15:14 +00:00
out.print("foo");
}
file in(test_file, file::RDONLY);
2020-11-27 16:15:14 +00:00
EXPECT_EQ("foo", read(in, 4));
}
2021-07-30 14:02:49 +00:00
TEST(ostream_test, flush) {
auto test_file = uniq_file_name(__LINE__);
auto out = fmt::output_file(test_file);
2021-07-30 14:02:49 +00:00
out.print("x");
out.flush();
auto in = fmt::file(test_file, file::RDONLY);
2021-07-30 14:02:49 +00:00
EXPECT_READ(in, "x");
}
2021-05-02 12:55:55 +00:00
TEST(file_test, default_ctor) {
2018-05-19 17:32:53 +00:00
file f;
EXPECT_EQ(-1, f.descriptor());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, open_buffered_file_in_ctor) {
auto test_file = uniq_file_name(__LINE__);
FILE* fp = safe_fopen(test_file.c_str(), "w");
2021-05-06 00:43:06 +00:00
std::fputs(file_content, fp);
std::fclose(fp);
file f(test_file.c_str(), file::RDONLY);
2021-05-02 12:55:55 +00:00
// Check if the file is open by reading one character from it.
char buffer;
bool isopen = FMT_POSIX(read(f.descriptor(), &buffer, 1)) == 1;
ASSERT_TRUE(isopen);
}
2021-05-02 12:55:55 +00:00
TEST(file_test, open_buffered_file_error) {
2019-01-13 02:27:38 +00:00
EXPECT_SYSTEM_ERROR(file("nonexistent", file::RDONLY), ENOENT,
"cannot open file nonexistent");
}
2021-05-02 12:55:55 +00:00
TEST(file_test, move_ctor) {
2018-05-19 17:32:53 +00:00
file f = open_file();
int fd = f.descriptor();
EXPECT_NE(-1, fd);
2018-05-19 17:32:53 +00:00
file f2(std::move(f));
EXPECT_EQ(fd, f2.descriptor());
EXPECT_EQ(-1, f.descriptor());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, move_assignment) {
2018-05-19 17:32:53 +00:00
file f = open_file();
int fd = f.descriptor();
EXPECT_NE(-1, fd);
2018-05-19 17:32:53 +00:00
file f2;
f2 = std::move(f);
EXPECT_EQ(fd, f2.descriptor());
EXPECT_EQ(-1, f.descriptor());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, move_assignment_closes_file) {
2018-05-19 17:32:53 +00:00
file f = open_file();
file f2 = open_file();
int old_fd = f2.descriptor();
f2 = std::move(f);
EXPECT_TRUE(isclosed(old_fd));
}
2021-05-02 12:55:55 +00:00
file open_buffered_file(int& fd) {
2018-05-19 17:32:53 +00:00
file f = open_file();
fd = f.descriptor();
2016-06-14 22:53:40 +00:00
return f;
}
2021-05-02 12:55:55 +00:00
TEST(file_test, move_from_temporary_in_ctor) {
2016-03-02 15:53:14 +00:00
int fd = 0xdead;
2021-05-02 12:55:55 +00:00
file f(open_buffered_file(fd));
EXPECT_EQ(fd, f.descriptor());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, move_from_temporary_in_assignment) {
2016-03-02 15:53:14 +00:00
int fd = 0xdead;
2018-05-19 17:32:53 +00:00
file f;
2021-05-02 12:55:55 +00:00
f = open_buffered_file(fd);
EXPECT_EQ(fd, f.descriptor());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, move_from_temporary_in_assignment_closes_file) {
2016-03-02 15:53:14 +00:00
int fd = 0xdead;
2018-05-19 17:32:53 +00:00
file f = open_file();
int old_fd = f.descriptor();
2021-05-02 12:55:55 +00:00
f = open_buffered_file(fd);
EXPECT_TRUE(isclosed(old_fd));
}
2021-05-02 12:55:55 +00:00
TEST(file_test, close_file_in_dtor) {
int fd = 0;
{
2018-05-19 17:32:53 +00:00
file f = open_file();
fd = f.descriptor();
}
EXPECT_TRUE(isclosed(fd));
}
2021-05-02 12:55:55 +00:00
TEST(file_test, close_error_in_dtor) {
std::unique_ptr<file> f(new file(open_file()));
2020-05-07 22:59:46 +00:00
EXPECT_WRITE(
stderr,
{
// The close function must be called inside EXPECT_WRITE,
// otherwise the system may recycle closed file descriptor when
// redirecting the output in EXPECT_STDERR and the second close
// will break output redirection.
FMT_POSIX(close(f->descriptor()));
SUPPRESS_ASSERT(f.reset(nullptr));
},
system_error_message(EBADF, "cannot close file") + "\n");
}
2021-05-02 12:55:55 +00:00
TEST(file_test, close) {
2018-05-19 17:32:53 +00:00
file f = open_file();
int fd = f.descriptor();
f.close();
EXPECT_EQ(-1, f.descriptor());
EXPECT_TRUE(isclosed(fd));
}
2021-05-02 12:55:55 +00:00
TEST(file_test, close_error) {
2018-05-19 17:32:53 +00:00
file f = open_file();
FMT_POSIX(close(f.descriptor()));
EXPECT_SYSTEM_ERROR_NOASSERT(f.close(), EBADF, "cannot close file");
EXPECT_EQ(-1, f.descriptor());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, read) {
2018-05-19 17:32:53 +00:00
file f = open_file();
2021-05-06 00:43:06 +00:00
EXPECT_READ(f, file_content);
}
2021-05-02 12:55:55 +00:00
TEST(file_test, read_error) {
2024-08-25 16:20:40 +00:00
auto test_file = uniq_file_name(__LINE__);
file f(test_file, file::WRONLY | file::CREATE);
char buf;
2015-06-25 14:06:30 +00:00
// We intentionally read from a file opened in the write-only mode to
// cause error.
EXPECT_SYSTEM_ERROR(f.read(&buf, 1), EBADF, "cannot read from file");
}
2021-05-02 12:55:55 +00:00
TEST(file_test, write) {
2024-01-01 21:25:07 +00:00
auto pipe = fmt::pipe();
auto test_file = uniq_file_name(__LINE__);
write(pipe.write_end, test_file);
2024-01-01 21:25:07 +00:00
pipe.write_end.close();
EXPECT_READ(pipe.read_end, test_file);
}
2021-05-02 12:55:55 +00:00
TEST(file_test, write_error) {
auto test_file = uniq_file_name(__LINE__);
file f(test_file, file::RDONLY | file::CREATE);
2015-06-25 14:06:30 +00:00
// We intentionally write to a file opened in the read-only mode to
// cause error.
EXPECT_SYSTEM_ERROR(f.write(" ", 1), EBADF, "cannot write to file");
}
2021-05-02 12:55:55 +00:00
TEST(file_test, dup) {
2018-05-19 17:32:53 +00:00
file f = open_file();
file copy = file::dup(f.descriptor());
EXPECT_NE(f.descriptor(), copy.descriptor());
2021-05-06 00:43:06 +00:00
EXPECT_EQ(file_content, read(copy, std::strlen(file_content)));
}
2019-12-21 21:10:45 +00:00
# ifndef __COVERITY__
2021-05-02 12:55:55 +00:00
TEST(file_test, dup_error) {
2015-10-21 15:30:10 +00:00
int value = -1;
2019-01-13 02:27:38 +00:00
EXPECT_SYSTEM_ERROR_NOASSERT(file::dup(value), EBADF,
"cannot duplicate file descriptor -1");
}
2019-12-21 21:10:45 +00:00
# endif
2021-05-02 12:55:55 +00:00
TEST(file_test, dup2) {
2018-05-19 17:32:53 +00:00
file f = open_file();
file copy = open_file();
f.dup2(copy.descriptor());
EXPECT_NE(f.descriptor(), copy.descriptor());
2021-05-06 00:43:06 +00:00
EXPECT_READ(copy, file_content);
}
2021-05-02 12:55:55 +00:00
TEST(file_test, dup2_error) {
2018-05-19 17:32:53 +00:00
file f = open_file();
2019-01-13 02:27:38 +00:00
EXPECT_SYSTEM_ERROR_NOASSERT(
f.dup2(-1), EBADF,
fmt::format("cannot duplicate file descriptor {} to -1", f.descriptor()));
}
2021-05-02 12:55:55 +00:00
TEST(file_test, dup2_noexcept) {
2018-05-19 17:32:53 +00:00
file f = open_file();
file copy = open_file();
std::error_code ec;
f.dup2(copy.descriptor(), ec);
EXPECT_EQ(ec.value(), 0);
EXPECT_NE(f.descriptor(), copy.descriptor());
2021-05-06 00:43:06 +00:00
EXPECT_READ(copy, file_content);
}
2021-05-02 12:55:55 +00:00
TEST(file_test, dup2_noexcept_error) {
2018-05-19 17:32:53 +00:00
file f = open_file();
std::error_code ec;
SUPPRESS_ASSERT(f.dup2(-1, ec));
EXPECT_EQ(EBADF, ec.value());
}
2021-05-02 12:55:55 +00:00
TEST(file_test, pipe) {
2024-01-01 21:25:07 +00:00
auto pipe = fmt::pipe();
EXPECT_NE(-1, pipe.read_end.descriptor());
EXPECT_NE(-1, pipe.write_end.descriptor());
write(pipe.write_end, "test");
EXPECT_READ(pipe.read_end, "test");
}
2021-05-02 12:55:55 +00:00
TEST(file_test, fdopen) {
2024-01-01 21:25:07 +00:00
auto pipe = fmt::pipe();
int read_fd = pipe.read_end.descriptor();
EXPECT_EQ(read_fd, FMT_POSIX(fileno(pipe.read_end.fdopen("r").get())));
}
2020-05-07 22:59:46 +00:00
#endif // FMT_USE_FCNTL