fmt/test/gtest-extra.h

171 lines
7.5 KiB
C
Raw Normal View History

2018-03-04 17:16:51 +00:00
// Formatting library for C++ - custom Google Test assertions
//
// Copyright (c) 2012 - present, Victor Zverovich
// All rights reserved.
//
// For the license information refer to format.h.
2014-05-01 23:49:08 +00:00
#ifndef FMT_GTEST_EXTRA_H_
#define FMT_GTEST_EXTRA_H_
2014-05-02 14:23:25 +00:00
2021-05-02 12:55:55 +00:00
#include <stdlib.h> // _invalid_parameter_handler
2014-05-03 18:26:46 +00:00
#include <string>
2020-05-07 22:59:46 +00:00
2021-07-17 16:16:49 +00:00
#ifdef FMT_MODULE_TEST
import fmt;
#else
# include "fmt/os.h"
#endif // FMG_MODULE_TEST
2021-07-17 16:16:49 +00:00
#include "gmock/gmock.h"
2014-06-09 15:33:48 +00:00
2014-05-01 23:49:08 +00:00
#define FMT_TEST_THROW_(statement, expected_exception, expected_message, fail) \
2019-01-13 02:27:38 +00:00
GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
if (::testing::AssertionResult gtest_ar = ::testing::AssertionSuccess()) { \
std::string gtest_expected_message = expected_message; \
bool gtest_caught_expected = false; \
try { \
GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
} catch (expected_exception const& e) { \
if (gtest_expected_message != e.what()) { \
gtest_ar << #statement \
" throws an exception with a different message.\n" \
<< "Expected: " << gtest_expected_message << "\n" \
<< " Actual: " << e.what(); \
goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \
} \
gtest_caught_expected = true; \
} catch (...) { \
gtest_ar << "Expected: " #statement \
" throws an exception of type " #expected_exception \
".\n Actual: it throws a different type."; \
goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \
} \
if (!gtest_caught_expected) { \
gtest_ar << "Expected: " #statement \
" throws an exception of type " #expected_exception \
".\n Actual: it throws nothing."; \
goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \
} \
} else \
GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__) \
: fail(gtest_ar.failure_message())
2014-05-01 23:49:08 +00:00
// Tests that the statement throws the expected exception and the exception's
// what() method returns expected message.
#define EXPECT_THROW_MSG(statement, expected_exception, expected_message) \
2019-01-13 02:27:38 +00:00
FMT_TEST_THROW_(statement, expected_exception, expected_message, \
GTEST_NONFATAL_FAILURE_)
2014-05-02 14:23:25 +00:00
inline std::string system_error_message(int error_code,
const std::string& message) {
auto ec = std::error_code(error_code, std::generic_category());
return std::system_error(ec, message).what();
}
2014-05-06 13:11:39 +00:00
#define EXPECT_SYSTEM_ERROR(statement, error_code, message) \
EXPECT_THROW_MSG(statement, std::system_error, \
system_error_message(error_code, message))
2014-05-06 13:11:39 +00:00
2019-11-15 13:41:14 +00:00
#if FMT_USE_FCNTL
2014-05-03 23:47:00 +00:00
// Captures file output by redirecting it to a pipe.
// The output it can handle is limited by the pipe capacity.
2021-05-02 12:55:55 +00:00
class output_redirect {
private:
2019-01-13 02:27:38 +00:00
FILE* file_;
2018-05-19 17:32:53 +00:00
fmt::file original_; // Original file passed to redirector.
fmt::file read_end_; // Read end of the pipe where the output is redirected.
void flush();
void restore();
2014-05-03 23:47:00 +00:00
public:
2021-05-02 12:55:55 +00:00
explicit output_redirect(FILE* file);
2022-01-21 00:55:47 +00:00
~output_redirect() noexcept;
2021-05-02 12:55:55 +00:00
output_redirect(const output_redirect&) = delete;
void operator=(const output_redirect&) = delete;
2014-05-03 23:47:00 +00:00
// Restores the original file, reads output from the pipe into a string
// and returns it.
std::string restore_and_read();
};
2019-01-13 02:27:38 +00:00
# define FMT_TEST_WRITE_(statement, expected_output, file, fail) \
GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
if (::testing::AssertionResult gtest_ar = ::testing::AssertionSuccess()) { \
std::string gtest_expected_output = expected_output; \
2021-05-02 12:55:55 +00:00
output_redirect gtest_redir(file); \
2019-01-13 02:27:38 +00:00
GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
std::string gtest_output = gtest_redir.restore_and_read(); \
if (gtest_output != gtest_expected_output) { \
gtest_ar << #statement " produces different output.\n" \
<< "Expected: " << gtest_expected_output << "\n" \
<< " Actual: " << gtest_output; \
goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \
} \
} else \
GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__) \
: fail(gtest_ar.failure_message())
// Tests that the statement writes the expected output to file.
2019-01-13 02:27:38 +00:00
# define EXPECT_WRITE(file, statement, expected_output) \
FMT_TEST_WRITE_(statement, expected_output, file, GTEST_NONFATAL_FAILURE_)
2019-01-13 02:27:38 +00:00
# ifdef _MSC_VER
// Suppresses Windows assertions on invalid file descriptors, making
// POSIX functions return proper error codes instead of crashing on Windows.
2021-05-02 12:55:55 +00:00
class suppress_assert {
private:
_invalid_parameter_handler original_handler_;
int original_report_mode_;
2019-01-13 02:27:38 +00:00
static void handle_invalid_parameter(const wchar_t*, const wchar_t*,
const wchar_t*, unsigned, uintptr_t) {}
public:
2021-05-02 12:55:55 +00:00
suppress_assert()
2019-01-13 02:27:38 +00:00
: original_handler_(
_set_invalid_parameter_handler(handle_invalid_parameter)),
original_report_mode_(_CrtSetReportMode(_CRT_ASSERT, 0)) {}
2021-05-02 12:55:55 +00:00
~suppress_assert() {
_set_invalid_parameter_handler(original_handler_);
_CrtSetReportMode(_CRT_ASSERT, original_report_mode_);
(void)original_report_mode_;
}
};
2019-01-13 02:27:38 +00:00
# define SUPPRESS_ASSERT(statement) \
{ \
2021-05-02 12:55:55 +00:00
suppress_assert sa; \
2019-01-13 02:27:38 +00:00
statement; \
}
# else
# define SUPPRESS_ASSERT(statement) statement
# endif // _MSC_VER
2019-01-13 02:27:38 +00:00
# define EXPECT_SYSTEM_ERROR_NOASSERT(statement, error_code, message) \
EXPECT_SYSTEM_ERROR(SUPPRESS_ASSERT(statement), error_code, message)
// Attempts to read count characters from a file.
2020-05-07 22:59:46 +00:00
std::string read(fmt::file& f, size_t count);
2019-01-13 02:27:38 +00:00
# define EXPECT_READ(file, expected_content) \
2021-05-02 12:55:55 +00:00
EXPECT_EQ(expected_content, \
read(file, fmt::string_view(expected_content).size()))
2019-11-15 13:41:14 +00:00
#else
# define EXPECT_WRITE(file, statement, expected_output) \
do { \
(void)(file); \
(void)(statement); \
(void)(expected_output); \
SUCCEED(); \
} while (false)
2019-11-15 13:41:14 +00:00
#endif // FMT_USE_FCNTL
#endif // FMT_GTEST_EXTRA_H_