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