gtest-death-test.h revision ed8500b341c473ecf46acd13951ae5b4e3acc780
1d201456903f3ecae1f7794edfab0d5678e64226shiqian// Copyright 2005, Google Inc. 2d201456903f3ecae1f7794edfab0d5678e64226shiqian// All rights reserved. 3d201456903f3ecae1f7794edfab0d5678e64226shiqian// 4d201456903f3ecae1f7794edfab0d5678e64226shiqian// Redistribution and use in source and binary forms, with or without 5d201456903f3ecae1f7794edfab0d5678e64226shiqian// modification, are permitted provided that the following conditions are 6d201456903f3ecae1f7794edfab0d5678e64226shiqian// met: 7d201456903f3ecae1f7794edfab0d5678e64226shiqian// 8d201456903f3ecae1f7794edfab0d5678e64226shiqian// * Redistributions of source code must retain the above copyright 9d201456903f3ecae1f7794edfab0d5678e64226shiqian// notice, this list of conditions and the following disclaimer. 10d201456903f3ecae1f7794edfab0d5678e64226shiqian// * Redistributions in binary form must reproduce the above 11d201456903f3ecae1f7794edfab0d5678e64226shiqian// copyright notice, this list of conditions and the following disclaimer 12d201456903f3ecae1f7794edfab0d5678e64226shiqian// in the documentation and/or other materials provided with the 13d201456903f3ecae1f7794edfab0d5678e64226shiqian// distribution. 14d201456903f3ecae1f7794edfab0d5678e64226shiqian// * Neither the name of Google Inc. nor the names of its 15d201456903f3ecae1f7794edfab0d5678e64226shiqian// contributors may be used to endorse or promote products derived from 16d201456903f3ecae1f7794edfab0d5678e64226shiqian// this software without specific prior written permission. 17d201456903f3ecae1f7794edfab0d5678e64226shiqian// 18d201456903f3ecae1f7794edfab0d5678e64226shiqian// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19d201456903f3ecae1f7794edfab0d5678e64226shiqian// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20d201456903f3ecae1f7794edfab0d5678e64226shiqian// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21d201456903f3ecae1f7794edfab0d5678e64226shiqian// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22d201456903f3ecae1f7794edfab0d5678e64226shiqian// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23d201456903f3ecae1f7794edfab0d5678e64226shiqian// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24d201456903f3ecae1f7794edfab0d5678e64226shiqian// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25d201456903f3ecae1f7794edfab0d5678e64226shiqian// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26d201456903f3ecae1f7794edfab0d5678e64226shiqian// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27d201456903f3ecae1f7794edfab0d5678e64226shiqian// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28d201456903f3ecae1f7794edfab0d5678e64226shiqian// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29d201456903f3ecae1f7794edfab0d5678e64226shiqian// 30d201456903f3ecae1f7794edfab0d5678e64226shiqian// Author: wan@google.com (Zhanyong Wan) 31d201456903f3ecae1f7794edfab0d5678e64226shiqian// 32d201456903f3ecae1f7794edfab0d5678e64226shiqian// The Google C++ Testing Framework (Google Test) 33d201456903f3ecae1f7794edfab0d5678e64226shiqian// 34d201456903f3ecae1f7794edfab0d5678e64226shiqian// This header file defines the public API for death tests. It is 35d201456903f3ecae1f7794edfab0d5678e64226shiqian// #included by gtest.h so a user doesn't need to include this 36d201456903f3ecae1f7794edfab0d5678e64226shiqian// directly. 37d201456903f3ecae1f7794edfab0d5678e64226shiqian 38d201456903f3ecae1f7794edfab0d5678e64226shiqian#ifndef GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_ 39d201456903f3ecae1f7794edfab0d5678e64226shiqian#define GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_ 40d201456903f3ecae1f7794edfab0d5678e64226shiqian 41d201456903f3ecae1f7794edfab0d5678e64226shiqian#include <gtest/internal/gtest-death-test-internal.h> 42d201456903f3ecae1f7794edfab0d5678e64226shiqian 43d201456903f3ecae1f7794edfab0d5678e64226shiqiannamespace testing { 44d201456903f3ecae1f7794edfab0d5678e64226shiqian 45d201456903f3ecae1f7794edfab0d5678e64226shiqian// This flag controls the style of death tests. Valid values are "threadsafe", 46d201456903f3ecae1f7794edfab0d5678e64226shiqian// meaning that the death test child process will re-execute the test binary 47d201456903f3ecae1f7794edfab0d5678e64226shiqian// from the start, running only a single death test, or "fast", 48d201456903f3ecae1f7794edfab0d5678e64226shiqian// meaning that the child process will execute the test logic immediately 49d201456903f3ecae1f7794edfab0d5678e64226shiqian// after forking. 50e0865dd9199e8fffd5c2f95a68de6c1851f77c15shiqianGTEST_DECLARE_string_(death_test_style); 51d201456903f3ecae1f7794edfab0d5678e64226shiqian 520af0709b02899f9177db55eba7929e65e5834b29zhanyong.wan#if GTEST_HAS_DEATH_TEST 53d201456903f3ecae1f7794edfab0d5678e64226shiqian 54d201456903f3ecae1f7794edfab0d5678e64226shiqian// The following macros are useful for writing death tests. 55d201456903f3ecae1f7794edfab0d5678e64226shiqian 56d201456903f3ecae1f7794edfab0d5678e64226shiqian// Here's what happens when an ASSERT_DEATH* or EXPECT_DEATH* is 57d201456903f3ecae1f7794edfab0d5678e64226shiqian// executed: 58d201456903f3ecae1f7794edfab0d5678e64226shiqian// 59019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// 1. It generates a warning if there is more than one active 60019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// thread. This is because it's safe to fork() or clone() only 61019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// when there is a single thread. 62d201456903f3ecae1f7794edfab0d5678e64226shiqian// 63019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// 2. The parent process clone()s a sub-process and runs the death 64019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// test in it; the sub-process exits with code 0 at the end of the 65019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// death test, if it hasn't exited already. 66d201456903f3ecae1f7794edfab0d5678e64226shiqian// 67d201456903f3ecae1f7794edfab0d5678e64226shiqian// 3. The parent process waits for the sub-process to terminate. 68d201456903f3ecae1f7794edfab0d5678e64226shiqian// 69d201456903f3ecae1f7794edfab0d5678e64226shiqian// 4. The parent process checks the exit code and error message of 70d201456903f3ecae1f7794edfab0d5678e64226shiqian// the sub-process. 71d201456903f3ecae1f7794edfab0d5678e64226shiqian// 72d201456903f3ecae1f7794edfab0d5678e64226shiqian// Examples: 73d201456903f3ecae1f7794edfab0d5678e64226shiqian// 74d201456903f3ecae1f7794edfab0d5678e64226shiqian// ASSERT_DEATH(server.SendMessage(56, "Hello"), "Invalid port number"); 75d201456903f3ecae1f7794edfab0d5678e64226shiqian// for (int i = 0; i < 5; i++) { 76d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_DEATH(server.ProcessRequest(i), 77d201456903f3ecae1f7794edfab0d5678e64226shiqian// "Invalid request .* in ProcessRequest()") 78d201456903f3ecae1f7794edfab0d5678e64226shiqian// << "Failed to die on request " << i); 79d201456903f3ecae1f7794edfab0d5678e64226shiqian// } 80d201456903f3ecae1f7794edfab0d5678e64226shiqian// 81d201456903f3ecae1f7794edfab0d5678e64226shiqian// ASSERT_EXIT(server.ExitNow(), ::testing::ExitedWithCode(0), "Exiting"); 82d201456903f3ecae1f7794edfab0d5678e64226shiqian// 83d201456903f3ecae1f7794edfab0d5678e64226shiqian// bool KilledBySIGHUP(int exit_code) { 84d201456903f3ecae1f7794edfab0d5678e64226shiqian// return WIFSIGNALED(exit_code) && WTERMSIG(exit_code) == SIGHUP; 85d201456903f3ecae1f7794edfab0d5678e64226shiqian// } 86d201456903f3ecae1f7794edfab0d5678e64226shiqian// 87d201456903f3ecae1f7794edfab0d5678e64226shiqian// ASSERT_EXIT(client.HangUpServer(), KilledBySIGHUP, "Hanging up!"); 88019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// 89c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// On the regular expressions used in death tests: 90c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 91c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// On POSIX-compliant systems (*nix), we use the <regex.h> library, 92c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// which uses the POSIX extended regex syntax. 93c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 94c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// On other platforms (e.g. Windows), we only support a simple regex 95c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// syntax implemented as part of Google Test. This limited 96c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// implementation should be enough most of the time when writing 97c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// death tests; though it lacks many features you can find in PCRE 98c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// or POSIX extended regex syntax. For example, we don't support 99c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// union ("x|y"), grouping ("(xy)"), brackets ("[xy]"), and 100c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// repetition count ("x{5,7}"), among others. 101c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 102c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// Below is the syntax that we do support. We chose it to be a 103c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// subset of both PCRE and POSIX extended regex, so it's easy to 104c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// learn wherever you come from. In the following: 'A' denotes a 105c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// literal character, period (.), or a single \\ escape sequence; 106c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 'x' and 'y' denote regular expressions; 'm' and 'n' are for 107c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// natural numbers. 108c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 109c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// c matches any literal character c 110c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\d matches any decimal digit 111c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\D matches any character that's not a decimal digit 112c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\f matches \f 113c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\n matches \n 114c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\r matches \r 115c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\s matches any ASCII whitespace, including \n 116c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\S matches any character that's not a whitespace 117c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\t matches \t 118c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\v matches \v 119c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\w matches any letter, _, or decimal digit 120c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\W matches any character that \\w doesn't match 121c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// \\c matches any literal character c, which must be a punctuation 122c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// . matches any single character except \n 123c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// A? matches 0 or 1 occurrences of A 124c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// A* matches 0 or many occurrences of A 125c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// A+ matches 1 or many occurrences of A 126c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// ^ matches the beginning of a string (not that of each line) 127c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// $ matches the end of a string (not that of each line) 128c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// xy matches x followed by y 129c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 130c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// If you accidentally use PCRE or POSIX extended regex features 131c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// not implemented by us, you will get a run-time failure. In that 132c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// case, please try to rewrite your regular expression within the 133c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// above syntax. 134c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 135c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// This implementation is *not* meant to be as highly tuned or robust 136c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// as a compiled regex library, but should perform well enough for a 137c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// death test, which already incurs significant overhead by launching 138c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// a child process. 139c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// 140019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// Known caveats: 141019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// 142019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// A "threadsafe" style death test obtains the path to the test 143019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// program from argv[0] and re-executes it in the sub-process. For 144019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// simplicity, the current implementation doesn't search the PATH 145019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// when launching the sub-process. This means that the user must 146019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// invoke the test program via a path that contains at least one 147019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// path separator (e.g. path/to/foo_test and 148019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// /absolute/path/to/bar_test are fine, but foo_test is not). This 149019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// is rarely a problem as people usually don't put the test binary 150019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// directory in PATH. 151019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// 152019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// TODO(wan@google.com): make thread-safe death tests search the PATH. 153d201456903f3ecae1f7794edfab0d5678e64226shiqian 154d201456903f3ecae1f7794edfab0d5678e64226shiqian// Asserts that a given statement causes the program to exit, with an 155d201456903f3ecae1f7794edfab0d5678e64226shiqian// integer exit status that satisfies predicate, and emitting error output 156d201456903f3ecae1f7794edfab0d5678e64226shiqian// that matches regex. 157d201456903f3ecae1f7794edfab0d5678e64226shiqian#define ASSERT_EXIT(statement, predicate, regex) \ 158e0865dd9199e8fffd5c2f95a68de6c1851f77c15shiqian GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_FATAL_FAILURE_) 159d201456903f3ecae1f7794edfab0d5678e64226shiqian 160d201456903f3ecae1f7794edfab0d5678e64226shiqian// Like ASSERT_EXIT, but continues on to successive tests in the 161d201456903f3ecae1f7794edfab0d5678e64226shiqian// test case, if any: 162d201456903f3ecae1f7794edfab0d5678e64226shiqian#define EXPECT_EXIT(statement, predicate, regex) \ 163e0865dd9199e8fffd5c2f95a68de6c1851f77c15shiqian GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_NONFATAL_FAILURE_) 164d201456903f3ecae1f7794edfab0d5678e64226shiqian 165d201456903f3ecae1f7794edfab0d5678e64226shiqian// Asserts that a given statement causes the program to exit, either by 166d201456903f3ecae1f7794edfab0d5678e64226shiqian// explicitly exiting with a nonzero exit code or being killed by a 167d201456903f3ecae1f7794edfab0d5678e64226shiqian// signal, and emitting error output that matches regex. 168d201456903f3ecae1f7794edfab0d5678e64226shiqian#define ASSERT_DEATH(statement, regex) \ 169d201456903f3ecae1f7794edfab0d5678e64226shiqian ASSERT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex) 170d201456903f3ecae1f7794edfab0d5678e64226shiqian 171d201456903f3ecae1f7794edfab0d5678e64226shiqian// Like ASSERT_DEATH, but continues on to successive tests in the 172d201456903f3ecae1f7794edfab0d5678e64226shiqian// test case, if any: 173d201456903f3ecae1f7794edfab0d5678e64226shiqian#define EXPECT_DEATH(statement, regex) \ 174d201456903f3ecae1f7794edfab0d5678e64226shiqian EXPECT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex) 175d201456903f3ecae1f7794edfab0d5678e64226shiqian 176d201456903f3ecae1f7794edfab0d5678e64226shiqian// Two predicate classes that can be used in {ASSERT,EXPECT}_EXIT*: 177d201456903f3ecae1f7794edfab0d5678e64226shiqian 178d201456903f3ecae1f7794edfab0d5678e64226shiqian// Tests that an exit code describes a normal exit with a given exit code. 179d201456903f3ecae1f7794edfab0d5678e64226shiqianclass ExitedWithCode { 180d201456903f3ecae1f7794edfab0d5678e64226shiqian public: 181d201456903f3ecae1f7794edfab0d5678e64226shiqian explicit ExitedWithCode(int exit_code); 182d201456903f3ecae1f7794edfab0d5678e64226shiqian bool operator()(int exit_status) const; 183d201456903f3ecae1f7794edfab0d5678e64226shiqian private: 184d201456903f3ecae1f7794edfab0d5678e64226shiqian const int exit_code_; 185d201456903f3ecae1f7794edfab0d5678e64226shiqian}; 186d201456903f3ecae1f7794edfab0d5678e64226shiqian 1874984c93490eeeb7d3d1979b30a39a21cad07cba5zhanyong.wan#if !GTEST_OS_WINDOWS 188d201456903f3ecae1f7794edfab0d5678e64226shiqian// Tests that an exit code describes an exit due to termination by a 189d201456903f3ecae1f7794edfab0d5678e64226shiqian// given signal. 190d201456903f3ecae1f7794edfab0d5678e64226shiqianclass KilledBySignal { 191d201456903f3ecae1f7794edfab0d5678e64226shiqian public: 192d201456903f3ecae1f7794edfab0d5678e64226shiqian explicit KilledBySignal(int signum); 193d201456903f3ecae1f7794edfab0d5678e64226shiqian bool operator()(int exit_status) const; 194d201456903f3ecae1f7794edfab0d5678e64226shiqian private: 195d201456903f3ecae1f7794edfab0d5678e64226shiqian const int signum_; 196d201456903f3ecae1f7794edfab0d5678e64226shiqian}; 1974984c93490eeeb7d3d1979b30a39a21cad07cba5zhanyong.wan#endif // !GTEST_OS_WINDOWS 198d201456903f3ecae1f7794edfab0d5678e64226shiqian 199d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_DEBUG_DEATH asserts that the given statements die in debug mode. 200d201456903f3ecae1f7794edfab0d5678e64226shiqian// The death testing framework causes this to have interesting semantics, 201d201456903f3ecae1f7794edfab0d5678e64226shiqian// since the sideeffects of the call are only visible in opt mode, and not 202d201456903f3ecae1f7794edfab0d5678e64226shiqian// in debug mode. 203d201456903f3ecae1f7794edfab0d5678e64226shiqian// 204d201456903f3ecae1f7794edfab0d5678e64226shiqian// In practice, this can be used to test functions that utilize the 205d201456903f3ecae1f7794edfab0d5678e64226shiqian// LOG(DFATAL) macro using the following style: 206d201456903f3ecae1f7794edfab0d5678e64226shiqian// 207d201456903f3ecae1f7794edfab0d5678e64226shiqian// int DieInDebugOr12(int* sideeffect) { 208d201456903f3ecae1f7794edfab0d5678e64226shiqian// if (sideeffect) { 209d201456903f3ecae1f7794edfab0d5678e64226shiqian// *sideeffect = 12; 210d201456903f3ecae1f7794edfab0d5678e64226shiqian// } 211d201456903f3ecae1f7794edfab0d5678e64226shiqian// LOG(DFATAL) << "death"; 212d201456903f3ecae1f7794edfab0d5678e64226shiqian// return 12; 213d201456903f3ecae1f7794edfab0d5678e64226shiqian// } 214d201456903f3ecae1f7794edfab0d5678e64226shiqian// 215d201456903f3ecae1f7794edfab0d5678e64226shiqian// TEST(TestCase, TestDieOr12WorksInDgbAndOpt) { 216d201456903f3ecae1f7794edfab0d5678e64226shiqian// int sideeffect = 0; 217d201456903f3ecae1f7794edfab0d5678e64226shiqian// // Only asserts in dbg. 218d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_DEBUG_DEATH(DieInDebugOr12(&sideeffect), "death"); 219d201456903f3ecae1f7794edfab0d5678e64226shiqian// 220d201456903f3ecae1f7794edfab0d5678e64226shiqian// #ifdef NDEBUG 221d201456903f3ecae1f7794edfab0d5678e64226shiqian// // opt-mode has sideeffect visible. 222d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_EQ(12, sideeffect); 223d201456903f3ecae1f7794edfab0d5678e64226shiqian// #else 224d201456903f3ecae1f7794edfab0d5678e64226shiqian// // dbg-mode no visible sideeffect. 225d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_EQ(0, sideeffect); 226d201456903f3ecae1f7794edfab0d5678e64226shiqian// #endif 227d201456903f3ecae1f7794edfab0d5678e64226shiqian// } 228d201456903f3ecae1f7794edfab0d5678e64226shiqian// 229d201456903f3ecae1f7794edfab0d5678e64226shiqian// This will assert that DieInDebugReturn12InOpt() crashes in debug 230d201456903f3ecae1f7794edfab0d5678e64226shiqian// mode, usually due to a DCHECK or LOG(DFATAL), but returns the 231d201456903f3ecae1f7794edfab0d5678e64226shiqian// appropriate fallback value (12 in this case) in opt mode. If you 232d201456903f3ecae1f7794edfab0d5678e64226shiqian// need to test that a function has appropriate side-effects in opt 233d201456903f3ecae1f7794edfab0d5678e64226shiqian// mode, include assertions against the side-effects. A general 234d201456903f3ecae1f7794edfab0d5678e64226shiqian// pattern for this is: 235d201456903f3ecae1f7794edfab0d5678e64226shiqian// 236d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_DEBUG_DEATH({ 237d201456903f3ecae1f7794edfab0d5678e64226shiqian// // Side-effects here will have an effect after this statement in 238d201456903f3ecae1f7794edfab0d5678e64226shiqian// // opt mode, but none in debug mode. 239d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_EQ(12, DieInDebugOr12(&sideeffect)); 240d201456903f3ecae1f7794edfab0d5678e64226shiqian// }, "death"); 241d201456903f3ecae1f7794edfab0d5678e64226shiqian// 242d201456903f3ecae1f7794edfab0d5678e64226shiqian#ifdef NDEBUG 243d201456903f3ecae1f7794edfab0d5678e64226shiqian 244d201456903f3ecae1f7794edfab0d5678e64226shiqian#define EXPECT_DEBUG_DEATH(statement, regex) \ 245d201456903f3ecae1f7794edfab0d5678e64226shiqian do { statement; } while (false) 246d201456903f3ecae1f7794edfab0d5678e64226shiqian 247d201456903f3ecae1f7794edfab0d5678e64226shiqian#define ASSERT_DEBUG_DEATH(statement, regex) \ 248d201456903f3ecae1f7794edfab0d5678e64226shiqian do { statement; } while (false) 249d201456903f3ecae1f7794edfab0d5678e64226shiqian 250d201456903f3ecae1f7794edfab0d5678e64226shiqian#else 251d201456903f3ecae1f7794edfab0d5678e64226shiqian 252d201456903f3ecae1f7794edfab0d5678e64226shiqian#define EXPECT_DEBUG_DEATH(statement, regex) \ 253d201456903f3ecae1f7794edfab0d5678e64226shiqian EXPECT_DEATH(statement, regex) 254d201456903f3ecae1f7794edfab0d5678e64226shiqian 255d201456903f3ecae1f7794edfab0d5678e64226shiqian#define ASSERT_DEBUG_DEATH(statement, regex) \ 256d201456903f3ecae1f7794edfab0d5678e64226shiqian ASSERT_DEATH(statement, regex) 257d201456903f3ecae1f7794edfab0d5678e64226shiqian 258d201456903f3ecae1f7794edfab0d5678e64226shiqian#endif // NDEBUG for EXPECT_DEBUG_DEATH 259d201456903f3ecae1f7794edfab0d5678e64226shiqian#endif // GTEST_HAS_DEATH_TEST 260ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan 261ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// EXPECT_DEATH_IF_SUPPORTED(statement, regex) and 262ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// ASSERT_DEATH_IF_SUPPORTED(statement, regex) expand to real death tests if 263ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// death tests are supported; otherwise they expand to empty. This is 264ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// useful when you are combining death test assertions with normal test 265ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// assertions in one test. 266ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#if GTEST_HAS_DEATH_TEST 267ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \ 268ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan EXPECT_DEATH(statement, regex) 269ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \ 270ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan ASSERT_DEATH(statement, regex) 271ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#else 272ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \ 273ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan GTEST_LOG_(WARNING, \ 274ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan "Death tests are not supported on this platform. The statement" \ 275ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan " '" #statement "' can not be verified") 276ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \ 277ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan GTEST_LOG_(WARNING, \ 278ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan "Death tests are not supported on this platform. The statement" \ 279ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan " '" #statement "' can not be verified") 280ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#endif 281ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan 282d201456903f3ecae1f7794edfab0d5678e64226shiqian} // namespace testing 283d201456903f3ecae1f7794edfab0d5678e64226shiqian 284d201456903f3ecae1f7794edfab0d5678e64226shiqian#endif // GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_ 285