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