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