git repos / blockattack-game

blame: source/misc/embedded_libs/fmt-11.0.2/test/gtest-extra.h

normal view · raw

f8deb5b9 Poul Sander 2022-01-15 13:55 1
// Formatting library for C++ - custom Google Test assertions
f8deb5b9 Poul Sander 2022-01-15 13:55 2
//
f8deb5b9 Poul Sander 2022-01-15 13:55 3
// Copyright (c) 2012 - present, Victor Zverovich
f8deb5b9 Poul Sander 2022-01-15 13:55 4
// All rights reserved.
f8deb5b9 Poul Sander 2022-01-15 13:55 5
//
f8deb5b9 Poul Sander 2022-01-15 13:55 6
// For the license information refer to format.h.
f8deb5b9 Poul Sander 2022-01-15 13:55 7
f8deb5b9 Poul Sander 2022-01-15 13:55 8
#ifndef FMT_GTEST_EXTRA_H_
f8deb5b9 Poul Sander 2022-01-15 13:55 9
#define FMT_GTEST_EXTRA_H_
f8deb5b9 Poul Sander 2022-01-15 13:55 10
f8deb5b9 Poul Sander 2022-01-15 13:55 11
#include <stdlib.h>  // _invalid_parameter_handler
f8deb5b9 Poul Sander 2022-01-15 13:55 12
f8deb5b9 Poul Sander 2022-01-15 13:55 13
#include <string>
f8deb5b9 Poul Sander 2022-01-15 13:55 14
47fd5c32 Poul Sander 2024-10-05 08:44 15
#include "fmt/os.h"
f8deb5b9 Poul Sander 2022-01-15 13:55 16
#include "gmock/gmock.h"
f8deb5b9 Poul Sander 2022-01-15 13:55 17
f8deb5b9 Poul Sander 2022-01-15 13:55 18
#define FMT_TEST_THROW_(statement, expected_exception, expected_message, fail) \
f8deb5b9 Poul Sander 2022-01-15 13:55 19
  GTEST_AMBIGUOUS_ELSE_BLOCKER_                                                \
f8deb5b9 Poul Sander 2022-01-15 13:55 20
  if (::testing::AssertionResult gtest_ar = ::testing::AssertionSuccess()) {   \
f8deb5b9 Poul Sander 2022-01-15 13:55 21
    std::string gtest_expected_message = expected_message;                     \
f8deb5b9 Poul Sander 2022-01-15 13:55 22
    bool gtest_caught_expected = false;                                        \
f8deb5b9 Poul Sander 2022-01-15 13:55 23
    try {                                                                      \
f8deb5b9 Poul Sander 2022-01-15 13:55 24
      GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement);               \
f8deb5b9 Poul Sander 2022-01-15 13:55 25
    } catch (expected_exception const& e) {                                    \
f8deb5b9 Poul Sander 2022-01-15 13:55 26
      if (gtest_expected_message != e.what()) {                                \
f8deb5b9 Poul Sander 2022-01-15 13:55 27
        gtest_ar << #statement                                                 \
f8deb5b9 Poul Sander 2022-01-15 13:55 28
            " throws an exception with a different message.\n"                 \
f8deb5b9 Poul Sander 2022-01-15 13:55 29
                 << "Expected: " << gtest_expected_message << "\n"             \
f8deb5b9 Poul Sander 2022-01-15 13:55 30
                 << "  Actual: " << e.what();                                  \
f8deb5b9 Poul Sander 2022-01-15 13:55 31
        goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__);            \
f8deb5b9 Poul Sander 2022-01-15 13:55 32
      }                                                                        \
f8deb5b9 Poul Sander 2022-01-15 13:55 33
      gtest_caught_expected = true;                                            \
f8deb5b9 Poul Sander 2022-01-15 13:55 34
    } catch (...) {                                                            \
f8deb5b9 Poul Sander 2022-01-15 13:55 35
      gtest_ar << "Expected: " #statement                                      \
f8deb5b9 Poul Sander 2022-01-15 13:55 36
                  " throws an exception of type " #expected_exception          \
f8deb5b9 Poul Sander 2022-01-15 13:55 37
                  ".\n  Actual: it throws a different type.";                  \
f8deb5b9 Poul Sander 2022-01-15 13:55 38
      goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__);              \
f8deb5b9 Poul Sander 2022-01-15 13:55 39
    }                                                                          \
f8deb5b9 Poul Sander 2022-01-15 13:55 40
    if (!gtest_caught_expected) {                                              \
f8deb5b9 Poul Sander 2022-01-15 13:55 41
      gtest_ar << "Expected: " #statement                                      \
f8deb5b9 Poul Sander 2022-01-15 13:55 42
                  " throws an exception of type " #expected_exception          \
f8deb5b9 Poul Sander 2022-01-15 13:55 43
                  ".\n  Actual: it throws nothing.";                           \
f8deb5b9 Poul Sander 2022-01-15 13:55 44
      goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__);              \
f8deb5b9 Poul Sander 2022-01-15 13:55 45
    }                                                                          \
f8deb5b9 Poul Sander 2022-01-15 13:55 46
  } else                                                                       \
f8deb5b9 Poul Sander 2022-01-15 13:55 47
    GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__)                      \
f8deb5b9 Poul Sander 2022-01-15 13:55 48
        : fail(gtest_ar.failure_message())
f8deb5b9 Poul Sander 2022-01-15 13:55 49
f8deb5b9 Poul Sander 2022-01-15 13:55 50
// Tests that the statement throws the expected exception and the exception's
f8deb5b9 Poul Sander 2022-01-15 13:55 51
// what() method returns expected message.
f8deb5b9 Poul Sander 2022-01-15 13:55 52
#define EXPECT_THROW_MSG(statement, expected_exception, expected_message) \
f8deb5b9 Poul Sander 2022-01-15 13:55 53
  FMT_TEST_THROW_(statement, expected_exception, expected_message,        \
f8deb5b9 Poul Sander 2022-01-15 13:55 54
                  GTEST_NONFATAL_FAILURE_)
f8deb5b9 Poul Sander 2022-01-15 13:55 55
f8deb5b9 Poul Sander 2022-01-15 13:55 56
inline std::string system_error_message(int error_code,
f8deb5b9 Poul Sander 2022-01-15 13:55 57
                                        const std::string& message) {
f8deb5b9 Poul Sander 2022-01-15 13:55 58
  auto ec = std::error_code(error_code, std::generic_category());
f8deb5b9 Poul Sander 2022-01-15 13:55 59
  return std::system_error(ec, message).what();
f8deb5b9 Poul Sander 2022-01-15 13:55 60
}
f8deb5b9 Poul Sander 2022-01-15 13:55 61
f8deb5b9 Poul Sander 2022-01-15 13:55 62
#define EXPECT_SYSTEM_ERROR(statement, error_code, message) \
f8deb5b9 Poul Sander 2022-01-15 13:55 63
  EXPECT_THROW_MSG(statement, std::system_error,            \
f8deb5b9 Poul Sander 2022-01-15 13:55 64
                   system_error_message(error_code, message))
f8deb5b9 Poul Sander 2022-01-15 13:55 65
f8deb5b9 Poul Sander 2022-01-15 13:55 66
#if FMT_USE_FCNTL
f8deb5b9 Poul Sander 2022-01-15 13:55 67
f8deb5b9 Poul Sander 2022-01-15 13:55 68
// Captures file output by redirecting it to a pipe.
f8deb5b9 Poul Sander 2022-01-15 13:55 69
// The output it can handle is limited by the pipe capacity.
f8deb5b9 Poul Sander 2022-01-15 13:55 70
class output_redirect {
f8deb5b9 Poul Sander 2022-01-15 13:55 71
 private:
f8deb5b9 Poul Sander 2022-01-15 13:55 72
  FILE* file_;
f8deb5b9 Poul Sander 2022-01-15 13:55 73
  fmt::file original_;  // Original file passed to redirector.
f8deb5b9 Poul Sander 2022-01-15 13:55 74
  fmt::file read_end_;  // Read end of the pipe where the output is redirected.
f8deb5b9 Poul Sander 2022-01-15 13:55 75
f8deb5b9 Poul Sander 2022-01-15 13:55 76
  void flush();
f8deb5b9 Poul Sander 2022-01-15 13:55 77
  void restore();
f8deb5b9 Poul Sander 2022-01-15 13:55 78
f8deb5b9 Poul Sander 2022-01-15 13:55 79
 public:
47fd5c32 Poul Sander 2024-10-05 08:44 80
  explicit output_redirect(FILE* file, bool flush = true);
47fd5c32 Poul Sander 2024-10-05 08:44 81
  ~output_redirect() noexcept;
f8deb5b9 Poul Sander 2022-01-15 13:55 82
f8deb5b9 Poul Sander 2022-01-15 13:55 83
  output_redirect(const output_redirect&) = delete;
f8deb5b9 Poul Sander 2022-01-15 13:55 84
  void operator=(const output_redirect&) = delete;
f8deb5b9 Poul Sander 2022-01-15 13:55 85
f8deb5b9 Poul Sander 2022-01-15 13:55 86
  // Restores the original file, reads output from the pipe into a string
f8deb5b9 Poul Sander 2022-01-15 13:55 87
  // and returns it.
f8deb5b9 Poul Sander 2022-01-15 13:55 88
  std::string restore_and_read();
f8deb5b9 Poul Sander 2022-01-15 13:55 89
};
f8deb5b9 Poul Sander 2022-01-15 13:55 90
f8deb5b9 Poul Sander 2022-01-15 13:55 91
#  define FMT_TEST_WRITE_(statement, expected_output, file, fail)              \
f8deb5b9 Poul Sander 2022-01-15 13:55 92
    GTEST_AMBIGUOUS_ELSE_BLOCKER_                                              \
f8deb5b9 Poul Sander 2022-01-15 13:55 93
    if (::testing::AssertionResult gtest_ar = ::testing::AssertionSuccess()) { \
f8deb5b9 Poul Sander 2022-01-15 13:55 94
      std::string gtest_expected_output = expected_output;                     \
f8deb5b9 Poul Sander 2022-01-15 13:55 95
      output_redirect gtest_redir(file);                                       \
f8deb5b9 Poul Sander 2022-01-15 13:55 96
      GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement);               \
f8deb5b9 Poul Sander 2022-01-15 13:55 97
      std::string gtest_output = gtest_redir.restore_and_read();               \
f8deb5b9 Poul Sander 2022-01-15 13:55 98
      if (gtest_output != gtest_expected_output) {                             \
f8deb5b9 Poul Sander 2022-01-15 13:55 99
        gtest_ar << #statement " produces different output.\n"                 \
f8deb5b9 Poul Sander 2022-01-15 13:55 100
                 << "Expected: " << gtest_expected_output << "\n"              \
f8deb5b9 Poul Sander 2022-01-15 13:55 101
                 << "  Actual: " << gtest_output;                              \
f8deb5b9 Poul Sander 2022-01-15 13:55 102
        goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__);            \
f8deb5b9 Poul Sander 2022-01-15 13:55 103
      }                                                                        \
f8deb5b9 Poul Sander 2022-01-15 13:55 104
    } else                                                                     \
f8deb5b9 Poul Sander 2022-01-15 13:55 105
      GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__)                    \
f8deb5b9 Poul Sander 2022-01-15 13:55 106
          : fail(gtest_ar.failure_message())
f8deb5b9 Poul Sander 2022-01-15 13:55 107
f8deb5b9 Poul Sander 2022-01-15 13:55 108
// Tests that the statement writes the expected output to file.
f8deb5b9 Poul Sander 2022-01-15 13:55 109
#  define EXPECT_WRITE(file, statement, expected_output) \
f8deb5b9 Poul Sander 2022-01-15 13:55 110
    FMT_TEST_WRITE_(statement, expected_output, file, GTEST_NONFATAL_FAILURE_)
f8deb5b9 Poul Sander 2022-01-15 13:55 111
f8deb5b9 Poul Sander 2022-01-15 13:55 112
#  ifdef _MSC_VER
f8deb5b9 Poul Sander 2022-01-15 13:55 113
f8deb5b9 Poul Sander 2022-01-15 13:55 114
// Suppresses Windows assertions on invalid file descriptors, making
f8deb5b9 Poul Sander 2022-01-15 13:55 115
// POSIX functions return proper error codes instead of crashing on Windows.
f8deb5b9 Poul Sander 2022-01-15 13:55 116
class suppress_assert {
f8deb5b9 Poul Sander 2022-01-15 13:55 117
 private:
f8deb5b9 Poul Sander 2022-01-15 13:55 118
  _invalid_parameter_handler original_handler_;
f8deb5b9 Poul Sander 2022-01-15 13:55 119
  int original_report_mode_;
f8deb5b9 Poul Sander 2022-01-15 13:55 120
f8deb5b9 Poul Sander 2022-01-15 13:55 121
  static void handle_invalid_parameter(const wchar_t*, const wchar_t*,
f8deb5b9 Poul Sander 2022-01-15 13:55 122
                                       const wchar_t*, unsigned, uintptr_t) {}
f8deb5b9 Poul Sander 2022-01-15 13:55 123
f8deb5b9 Poul Sander 2022-01-15 13:55 124
 public:
f8deb5b9 Poul Sander 2022-01-15 13:55 125
  suppress_assert()
f8deb5b9 Poul Sander 2022-01-15 13:55 126
      : original_handler_(
f8deb5b9 Poul Sander 2022-01-15 13:55 127
            _set_invalid_parameter_handler(handle_invalid_parameter)),
f8deb5b9 Poul Sander 2022-01-15 13:55 128
        original_report_mode_(_CrtSetReportMode(_CRT_ASSERT, 0)) {}
f8deb5b9 Poul Sander 2022-01-15 13:55 129
  ~suppress_assert() {
f8deb5b9 Poul Sander 2022-01-15 13:55 130
    _set_invalid_parameter_handler(original_handler_);
f8deb5b9 Poul Sander 2022-01-15 13:55 131
    _CrtSetReportMode(_CRT_ASSERT, original_report_mode_);
f8deb5b9 Poul Sander 2022-01-15 13:55 132
    (void)original_report_mode_;
f8deb5b9 Poul Sander 2022-01-15 13:55 133
  }
f8deb5b9 Poul Sander 2022-01-15 13:55 134
};
f8deb5b9 Poul Sander 2022-01-15 13:55 135
f8deb5b9 Poul Sander 2022-01-15 13:55 136
#    define SUPPRESS_ASSERT(statement) \
f8deb5b9 Poul Sander 2022-01-15 13:55 137
      {                                \
f8deb5b9 Poul Sander 2022-01-15 13:55 138
        suppress_assert sa;            \
f8deb5b9 Poul Sander 2022-01-15 13:55 139
        statement;                     \
f8deb5b9 Poul Sander 2022-01-15 13:55 140
      }
f8deb5b9 Poul Sander 2022-01-15 13:55 141
#  else
f8deb5b9 Poul Sander 2022-01-15 13:55 142
#    define SUPPRESS_ASSERT(statement) statement
f8deb5b9 Poul Sander 2022-01-15 13:55 143
#  endif  // _MSC_VER
f8deb5b9 Poul Sander 2022-01-15 13:55 144
f8deb5b9 Poul Sander 2022-01-15 13:55 145
#  define EXPECT_SYSTEM_ERROR_NOASSERT(statement, error_code, message) \
f8deb5b9 Poul Sander 2022-01-15 13:55 146
    EXPECT_SYSTEM_ERROR(SUPPRESS_ASSERT(statement), error_code, message)
f8deb5b9 Poul Sander 2022-01-15 13:55 147
f8deb5b9 Poul Sander 2022-01-15 13:55 148
// Attempts to read count characters from a file.
f8deb5b9 Poul Sander 2022-01-15 13:55 149
std::string read(fmt::file& f, size_t count);
f8deb5b9 Poul Sander 2022-01-15 13:55 150
f8deb5b9 Poul Sander 2022-01-15 13:55 151
#  define EXPECT_READ(file, expected_content) \
f8deb5b9 Poul Sander 2022-01-15 13:55 152
    EXPECT_EQ(expected_content,               \
f8deb5b9 Poul Sander 2022-01-15 13:55 153
              read(file, fmt::string_view(expected_content).size()))
f8deb5b9 Poul Sander 2022-01-15 13:55 154
f8deb5b9 Poul Sander 2022-01-15 13:55 155
#else
f8deb5b9 Poul Sander 2022-01-15 13:55 156
#  define EXPECT_WRITE(file, statement, expected_output) \
f8deb5b9 Poul Sander 2022-01-15 13:55 157
    do {                                                 \
f8deb5b9 Poul Sander 2022-01-15 13:55 158
      (void)(file);                                      \
f8deb5b9 Poul Sander 2022-01-15 13:55 159
      (void)(statement);                                 \
f8deb5b9 Poul Sander 2022-01-15 13:55 160
      (void)(expected_output);                           \
f8deb5b9 Poul Sander 2022-01-15 13:55 161
      SUCCEED();                                         \
f8deb5b9 Poul Sander 2022-01-15 13:55 162
    } while (false)
f8deb5b9 Poul Sander 2022-01-15 13:55 163
#endif  // FMT_USE_FCNTL
f8deb5b9 Poul Sander 2022-01-15 13:55 164
f8deb5b9 Poul Sander 2022-01-15 13:55 165
#endif  // FMT_GTEST_EXTRA_H_
1970-01-01 00:00 166