1 // Copyright 2007, Google Inc. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above 11 // copyright notice, this list of conditions and the following disclaimer 12 // in the documentation and/or other materials provided with the 13 // distribution. 14 // * Neither the name of Google Inc. nor the names of its 15 // contributors may be used to endorse or promote products derived from 16 // this software without specific prior written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // Author: wan@google.com (Zhanyong Wan) 31 // 32 // Utilities for testing Google Test itself and code that uses Google Test 33 // (e.g. frameworks built on top of Google Test). 34 35 #ifndef GTEST_INCLUDE_GTEST_GTEST_SPI_H_ 36 #define GTEST_INCLUDE_GTEST_GTEST_SPI_H_ 37 38 #include "gtest/gtest.h" 39 40 namespace testing 41 { 42 // This helper class can be used to mock out Google Test failure reporting 43 // so that we can test Google Test or code that builds on Google Test. 44 // 45 // An object of this class appends a TestPartResult object to the 46 // TestPartResultArray object given in the constructor whenever a Google Test 47 // failure is reported. It can either intercept only failures that are 48 // generated in the same thread that created this object or it can intercept 49 // all generated failures. The scope of this mock object can be controlled with 50 // the second argument to the two arguments constructor. 51 class GTEST_API_ ScopedFakeTestPartResultReporter 52 : public TestPartResultReporterInterface 53 { 54 public: 55 // The two possible mocking modes of this object. 56 enum InterceptMode 57 { 58 INTERCEPT_ONLY_CURRENT_THREAD, // Intercepts only thread local failures. 59 INTERCEPT_ALL_THREADS // Intercepts all failures. 60 }; 61 62 // The c'tor sets this object as the test part result reporter used 63 // by Google Test. The 'result' parameter specifies where to report the 64 // results. This reporter will only catch failures generated in the current 65 // thread. DEPRECATED 66 explicit ScopedFakeTestPartResultReporter(TestPartResultArray* result); 67 68 // Same as above, but you can choose the interception scope of this object. 69 ScopedFakeTestPartResultReporter(InterceptMode intercept_mode, 70 TestPartResultArray* result); 71 72 // The d'tor restores the previous test part result reporter. 73 virtual ~ScopedFakeTestPartResultReporter(); 74 75 // Appends the TestPartResult object to the TestPartResultArray 76 // received in the constructor. 77 // 78 // This method is from the TestPartResultReporterInterface 79 // interface. 80 virtual void ReportTestPartResult(const TestPartResult& result); 81 82 private: 83 void Init(); 84 85 const InterceptMode intercept_mode_; 86 TestPartResultReporterInterface* old_reporter_; 87 TestPartResultArray* const result_; 88 89 GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedFakeTestPartResultReporter); 90 }; 91 92 namespace internal 93 { 94 // A helper class for implementing EXPECT_FATAL_FAILURE() and 95 // EXPECT_NONFATAL_FAILURE(). Its destructor verifies that the given 96 // TestPartResultArray contains exactly one failure that has the given 97 // type and contains the given substring. If that's not the case, a 98 // non-fatal failure will be generated. 99 class GTEST_API_ SingleFailureChecker 100 { 101 public: 102 // The constructor remembers the arguments. 103 SingleFailureChecker(const TestPartResultArray* results, 104 TestPartResult::Type type, 105 const string& substr); 106 ~SingleFailureChecker(); 107 108 private: 109 const TestPartResultArray* const results_; 110 const TestPartResult::Type type_; 111 const string substr_; 112 113 GTEST_DISALLOW_COPY_AND_ASSIGN_(SingleFailureChecker); 114 }; 115 116 } // namespace internal 117 118 } // namespace testing 119 120 // A set of macros for testing Google Test assertions or code that's expected 121 // to generate Google Test fatal failures. It verifies that the given 122 // statement will cause exactly one fatal Google Test failure with 'substr' 123 // being part of the failure message. 124 // 125 // There are two different versions of this macro. EXPECT_FATAL_FAILURE only 126 // affects and considers failures generated in the current thread and 127 // EXPECT_FATAL_FAILURE_ON_ALL_THREADS does the same but for all threads. 128 // 129 // The verification of the assertion is done correctly even when the statement 130 // throws an exception or aborts the current function. 131 // 132 // Known restrictions: 133 // - 'statement' cannot reference local non-static variables or 134 // non-static members of the current object. 135 // - 'statement' cannot return a value. 136 // - You cannot stream a failure message to this macro. 137 // 138 // Note that even though the implementations of the following two 139 // macros are much alike, we cannot refactor them to use a common 140 // helper macro, due to some peculiarity in how the preprocessor 141 // works. The AcceptsMacroThatExpandsToUnprotectedComma test in 142 // gtest_unittest.cc will fail to compile if we do that. 143 #define EXPECT_FATAL_FAILURE(statement, substr) \ 144 do \ 145 { \ 146 class GTestExpectFatalFailureHelper \ 147 { \ 148 public: \ 149 static void Execute() { statement; } \ 150 }; \ 151 ::testing::TestPartResultArray gtest_failures; \ 152 ::testing::internal::SingleFailureChecker gtest_checker( \ 153 >est_failures, ::testing::TestPartResult::kFatalFailure, (substr)); \ 154 { \ 155 ::testing::ScopedFakeTestPartResultReporter gtest_reporter( \ 156 ::testing::ScopedFakeTestPartResultReporter:: \ 157 INTERCEPT_ONLY_CURRENT_THREAD, \ 158 >est_failures); \ 159 GTestExpectFatalFailureHelper::Execute(); \ 160 } \ 161 } while (::testing::internal::AlwaysFalse()) 162 163 #define EXPECT_FATAL_FAILURE_ON_ALL_THREADS(statement, substr) \ 164 do \ 165 { \ 166 class GTestExpectFatalFailureHelper \ 167 { \ 168 public: \ 169 static void Execute() { statement; } \ 170 }; \ 171 ::testing::TestPartResultArray gtest_failures; \ 172 ::testing::internal::SingleFailureChecker gtest_checker( \ 173 >est_failures, ::testing::TestPartResult::kFatalFailure, (substr)); \ 174 { \ 175 ::testing::ScopedFakeTestPartResultReporter gtest_reporter( \ 176 ::testing::ScopedFakeTestPartResultReporter:: \ 177 INTERCEPT_ALL_THREADS, \ 178 >est_failures); \ 179 GTestExpectFatalFailureHelper::Execute(); \ 180 } \ 181 } while (::testing::internal::AlwaysFalse()) 182 183 // A macro for testing Google Test assertions or code that's expected to 184 // generate Google Test non-fatal failures. It asserts that the given 185 // statement will cause exactly one non-fatal Google Test failure with 'substr' 186 // being part of the failure message. 187 // 188 // There are two different versions of this macro. EXPECT_NONFATAL_FAILURE only 189 // affects and considers failures generated in the current thread and 190 // EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS does the same but for all threads. 191 // 192 // 'statement' is allowed to reference local variables and members of 193 // the current object. 194 // 195 // The verification of the assertion is done correctly even when the statement 196 // throws an exception or aborts the current function. 197 // 198 // Known restrictions: 199 // - You cannot stream a failure message to this macro. 200 // 201 // Note that even though the implementations of the following two 202 // macros are much alike, we cannot refactor them to use a common 203 // helper macro, due to some peculiarity in how the preprocessor 204 // works. If we do that, the code won't compile when the user gives 205 // EXPECT_NONFATAL_FAILURE() a statement that contains a macro that 206 // expands to code containing an unprotected comma. The 207 // AcceptsMacroThatExpandsToUnprotectedComma test in gtest_unittest.cc 208 // catches that. 209 // 210 // For the same reason, we have to write 211 // if (::testing::internal::AlwaysTrue()) { statement; } 212 // instead of 213 // GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) 214 // to avoid an MSVC warning on unreachable code. 215 #define EXPECT_NONFATAL_FAILURE(statement, substr) \ 216 do \ 217 { \ 218 ::testing::TestPartResultArray gtest_failures; \ 219 ::testing::internal::SingleFailureChecker gtest_checker( \ 220 >est_failures, ::testing::TestPartResult::kNonFatalFailure, \ 221 (substr)); \ 222 { \ 223 ::testing::ScopedFakeTestPartResultReporter gtest_reporter( \ 224 ::testing::ScopedFakeTestPartResultReporter:: \ 225 INTERCEPT_ONLY_CURRENT_THREAD, \ 226 >est_failures); \ 227 if (::testing::internal::AlwaysTrue()) \ 228 { \ 229 statement; \ 230 } \ 231 } \ 232 } while (::testing::internal::AlwaysFalse()) 233 234 #define EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS(statement, substr) \ 235 do \ 236 { \ 237 ::testing::TestPartResultArray gtest_failures; \ 238 ::testing::internal::SingleFailureChecker gtest_checker( \ 239 >est_failures, ::testing::TestPartResult::kNonFatalFailure, \ 240 (substr)); \ 241 { \ 242 ::testing::ScopedFakeTestPartResultReporter gtest_reporter( \ 243 ::testing::ScopedFakeTestPartResultReporter::INTERCEPT_ALL_THREADS, \ 244 >est_failures); \ 245 if (::testing::internal::AlwaysTrue()) \ 246 { \ 247 statement; \ 248 } \ 249 } \ 250 } while (::testing::internal::AlwaysFalse()) 251 252 #endif // GTEST_INCLUDE_GTEST_GTEST_SPI_H_ 253