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
41dac3e879c56a50696a36f53e1e5e353e48fa665fzhanyong.wan#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
54829402edcffe712ed4c79412ca020525cd8295advladlosevnamespace internal {
55829402edcffe712ed4c79412ca020525cd8295advladlosev
56829402edcffe712ed4c79412ca020525cd8295advladlosev// Returns a Boolean value indicating whether the caller is currently
57829402edcffe712ed4c79412ca020525cd8295advladlosev// executing in the context of the death test child process.  Tools such as
58829402edcffe712ed4c79412ca020525cd8295advladlosev// Valgrind heap checkers may need this to modify their behavior in death
59829402edcffe712ed4c79412ca020525cd8295advladlosev// tests.  IMPORTANT: This is an internal utility.  Using it may break the
60829402edcffe712ed4c79412ca020525cd8295advladlosev// implementation of death tests.  User code MUST NOT use it.
61829402edcffe712ed4c79412ca020525cd8295advladlosevGTEST_API_ bool InDeathTestChild();
62829402edcffe712ed4c79412ca020525cd8295advladlosev
63829402edcffe712ed4c79412ca020525cd8295advladlosev}  // namespace internal
64829402edcffe712ed4c79412ca020525cd8295advladlosev
65d201456903f3ecae1f7794edfab0d5678e64226shiqian// The following macros are useful for writing death tests.
66d201456903f3ecae1f7794edfab0d5678e64226shiqian
67d201456903f3ecae1f7794edfab0d5678e64226shiqian// Here's what happens when an ASSERT_DEATH* or EXPECT_DEATH* is
68d201456903f3ecae1f7794edfab0d5678e64226shiqian// executed:
69d201456903f3ecae1f7794edfab0d5678e64226shiqian//
70019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   1. It generates a warning if there is more than one active
71019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   thread.  This is because it's safe to fork() or clone() only
72019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   when there is a single thread.
73d201456903f3ecae1f7794edfab0d5678e64226shiqian//
74019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   2. The parent process clone()s a sub-process and runs the death
75019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   test in it; the sub-process exits with code 0 at the end of the
76019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   death test, if it hasn't exited already.
77d201456903f3ecae1f7794edfab0d5678e64226shiqian//
78d201456903f3ecae1f7794edfab0d5678e64226shiqian//   3. The parent process waits for the sub-process to terminate.
79d201456903f3ecae1f7794edfab0d5678e64226shiqian//
80d201456903f3ecae1f7794edfab0d5678e64226shiqian//   4. The parent process checks the exit code and error message of
81d201456903f3ecae1f7794edfab0d5678e64226shiqian//   the sub-process.
82d201456903f3ecae1f7794edfab0d5678e64226shiqian//
83d201456903f3ecae1f7794edfab0d5678e64226shiqian// Examples:
84d201456903f3ecae1f7794edfab0d5678e64226shiqian//
85d201456903f3ecae1f7794edfab0d5678e64226shiqian//   ASSERT_DEATH(server.SendMessage(56, "Hello"), "Invalid port number");
86d201456903f3ecae1f7794edfab0d5678e64226shiqian//   for (int i = 0; i < 5; i++) {
87d201456903f3ecae1f7794edfab0d5678e64226shiqian//     EXPECT_DEATH(server.ProcessRequest(i),
88d201456903f3ecae1f7794edfab0d5678e64226shiqian//                  "Invalid request .* in ProcessRequest()")
89f0b86fc3b0f625e1db84f3632cb37bd9eae6ae19jgm//                  << "Failed to die on request " << i;
90d201456903f3ecae1f7794edfab0d5678e64226shiqian//   }
91d201456903f3ecae1f7794edfab0d5678e64226shiqian//
92d201456903f3ecae1f7794edfab0d5678e64226shiqian//   ASSERT_EXIT(server.ExitNow(), ::testing::ExitedWithCode(0), "Exiting");
93d201456903f3ecae1f7794edfab0d5678e64226shiqian//
94d201456903f3ecae1f7794edfab0d5678e64226shiqian//   bool KilledBySIGHUP(int exit_code) {
95d201456903f3ecae1f7794edfab0d5678e64226shiqian//     return WIFSIGNALED(exit_code) && WTERMSIG(exit_code) == SIGHUP;
96d201456903f3ecae1f7794edfab0d5678e64226shiqian//   }
97d201456903f3ecae1f7794edfab0d5678e64226shiqian//
98d201456903f3ecae1f7794edfab0d5678e64226shiqian//   ASSERT_EXIT(client.HangUpServer(), KilledBySIGHUP, "Hanging up!");
99019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//
100c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan// On the regular expressions used in death tests:
101c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
102c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   On POSIX-compliant systems (*nix), we use the <regex.h> library,
103c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   which uses the POSIX extended regex syntax.
104c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
105c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   On other platforms (e.g. Windows), we only support a simple regex
106c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   syntax implemented as part of Google Test.  This limited
107c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   implementation should be enough most of the time when writing
108c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   death tests; though it lacks many features you can find in PCRE
109c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   or POSIX extended regex syntax.  For example, we don't support
110c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   union ("x|y"), grouping ("(xy)"), brackets ("[xy]"), and
111c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   repetition count ("x{5,7}"), among others.
112c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
113c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   Below is the syntax that we do support.  We chose it to be a
114c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   subset of both PCRE and POSIX extended regex, so it's easy to
115c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   learn wherever you come from.  In the following: 'A' denotes a
116c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   literal character, period (.), or a single \\ escape sequence;
117c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   'x' and 'y' denote regular expressions; 'm' and 'n' are for
118c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   natural numbers.
119c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
120c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     c     matches any literal character c
121c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\d   matches any decimal digit
122c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\D   matches any character that's not a decimal digit
123c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\f   matches \f
124c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\n   matches \n
125c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\r   matches \r
126c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\s   matches any ASCII whitespace, including \n
127c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\S   matches any character that's not a whitespace
128c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\t   matches \t
129c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\v   matches \v
130c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\w   matches any letter, _, or decimal digit
131c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\W   matches any character that \\w doesn't match
132c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     \\c   matches any literal character c, which must be a punctuation
133c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     .     matches any single character except \n
134c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     A?    matches 0 or 1 occurrences of A
135c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     A*    matches 0 or many occurrences of A
136c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     A+    matches 1 or many occurrences of A
137c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     ^     matches the beginning of a string (not that of each line)
138c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     $     matches the end of a string (not that of each line)
139c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//     xy    matches x followed by y
140c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
141c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   If you accidentally use PCRE or POSIX extended regex features
142c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   not implemented by us, you will get a run-time failure.  In that
143c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   case, please try to rewrite your regular expression within the
144c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   above syntax.
145c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
146c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   This implementation is *not* meant to be as highly tuned or robust
147c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   as a compiled regex library, but should perform well enough for a
148c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   death test, which already incurs significant overhead by launching
149c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//   a child process.
150c946ae60194727ede9d3ef44754839f48541a981zhanyong.wan//
151019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// Known caveats:
152019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//
153019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   A "threadsafe" style death test obtains the path to the test
154019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   program from argv[0] and re-executes it in the sub-process.  For
155019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   simplicity, the current implementation doesn't search the PATH
156019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   when launching the sub-process.  This means that the user must
157019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   invoke the test program via a path that contains at least one
158019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   path separator (e.g. path/to/foo_test and
159019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   /absolute/path/to/bar_test are fine, but foo_test is not).  This
160019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   is rarely a problem as people usually don't put the test binary
161019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//   directory in PATH.
162019d19af978f05b774407e0d46a3bda2c18c67c6shiqian//
163019d19af978f05b774407e0d46a3bda2c18c67c6shiqian// TODO(wan@google.com): make thread-safe death tests search the PATH.
164d201456903f3ecae1f7794edfab0d5678e64226shiqian
165d201456903f3ecae1f7794edfab0d5678e64226shiqian// Asserts that a given statement causes the program to exit, with an
166d201456903f3ecae1f7794edfab0d5678e64226shiqian// integer exit status that satisfies predicate, and emitting error output
167d201456903f3ecae1f7794edfab0d5678e64226shiqian// that matches regex.
168ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define ASSERT_EXIT(statement, predicate, regex) \
169ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan    GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_FATAL_FAILURE_)
170d201456903f3ecae1f7794edfab0d5678e64226shiqian
171d201456903f3ecae1f7794edfab0d5678e64226shiqian// Like ASSERT_EXIT, but continues on to successive tests in the
172d201456903f3ecae1f7794edfab0d5678e64226shiqian// test case, if any:
173ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define EXPECT_EXIT(statement, predicate, regex) \
174ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan    GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_NONFATAL_FAILURE_)
175d201456903f3ecae1f7794edfab0d5678e64226shiqian
176d201456903f3ecae1f7794edfab0d5678e64226shiqian// Asserts that a given statement causes the program to exit, either by
177d201456903f3ecae1f7794edfab0d5678e64226shiqian// explicitly exiting with a nonzero exit code or being killed by a
178d201456903f3ecae1f7794edfab0d5678e64226shiqian// signal, and emitting error output that matches regex.
179ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define ASSERT_DEATH(statement, regex) \
180ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan    ASSERT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex)
181d201456903f3ecae1f7794edfab0d5678e64226shiqian
182d201456903f3ecae1f7794edfab0d5678e64226shiqian// Like ASSERT_DEATH, but continues on to successive tests in the
183d201456903f3ecae1f7794edfab0d5678e64226shiqian// test case, if any:
184ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define EXPECT_DEATH(statement, regex) \
185ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan    EXPECT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex)
186d201456903f3ecae1f7794edfab0d5678e64226shiqian
187d201456903f3ecae1f7794edfab0d5678e64226shiqian// Two predicate classes that can be used in {ASSERT,EXPECT}_EXIT*:
188d201456903f3ecae1f7794edfab0d5678e64226shiqian
189d201456903f3ecae1f7794edfab0d5678e64226shiqian// Tests that an exit code describes a normal exit with a given exit code.
19083589cca345d2f03d93b0555437aa480e0ed6699zhanyong.wanclass GTEST_API_ ExitedWithCode {
191d201456903f3ecae1f7794edfab0d5678e64226shiqian public:
192d201456903f3ecae1f7794edfab0d5678e64226shiqian  explicit ExitedWithCode(int exit_code);
193d201456903f3ecae1f7794edfab0d5678e64226shiqian  bool operator()(int exit_status) const;
194d201456903f3ecae1f7794edfab0d5678e64226shiqian private:
1959f894c2b36e83e9414b3369f9a4974644d843d8dzhanyong.wan  // No implementation - assignment is unsupported.
1969f894c2b36e83e9414b3369f9a4974644d843d8dzhanyong.wan  void operator=(const ExitedWithCode& other);
1979f894c2b36e83e9414b3369f9a4974644d843d8dzhanyong.wan
198d201456903f3ecae1f7794edfab0d5678e64226shiqian  const int exit_code_;
199d201456903f3ecae1f7794edfab0d5678e64226shiqian};
200d201456903f3ecae1f7794edfab0d5678e64226shiqian
201ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# if !GTEST_OS_WINDOWS
202d201456903f3ecae1f7794edfab0d5678e64226shiqian// Tests that an exit code describes an exit due to termination by a
203d201456903f3ecae1f7794edfab0d5678e64226shiqian// given signal.
20483589cca345d2f03d93b0555437aa480e0ed6699zhanyong.wanclass GTEST_API_ KilledBySignal {
205d201456903f3ecae1f7794edfab0d5678e64226shiqian public:
206d201456903f3ecae1f7794edfab0d5678e64226shiqian  explicit KilledBySignal(int signum);
207d201456903f3ecae1f7794edfab0d5678e64226shiqian  bool operator()(int exit_status) const;
208d201456903f3ecae1f7794edfab0d5678e64226shiqian private:
209d201456903f3ecae1f7794edfab0d5678e64226shiqian  const int signum_;
210d201456903f3ecae1f7794edfab0d5678e64226shiqian};
211ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# endif  // !GTEST_OS_WINDOWS
212d201456903f3ecae1f7794edfab0d5678e64226shiqian
213d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_DEBUG_DEATH asserts that the given statements die in debug mode.
214d201456903f3ecae1f7794edfab0d5678e64226shiqian// The death testing framework causes this to have interesting semantics,
215d201456903f3ecae1f7794edfab0d5678e64226shiqian// since the sideeffects of the call are only visible in opt mode, and not
216d201456903f3ecae1f7794edfab0d5678e64226shiqian// in debug mode.
217d201456903f3ecae1f7794edfab0d5678e64226shiqian//
218d201456903f3ecae1f7794edfab0d5678e64226shiqian// In practice, this can be used to test functions that utilize the
219d201456903f3ecae1f7794edfab0d5678e64226shiqian// LOG(DFATAL) macro using the following style:
220d201456903f3ecae1f7794edfab0d5678e64226shiqian//
221d201456903f3ecae1f7794edfab0d5678e64226shiqian// int DieInDebugOr12(int* sideeffect) {
222d201456903f3ecae1f7794edfab0d5678e64226shiqian//   if (sideeffect) {
223d201456903f3ecae1f7794edfab0d5678e64226shiqian//     *sideeffect = 12;
224d201456903f3ecae1f7794edfab0d5678e64226shiqian//   }
225d201456903f3ecae1f7794edfab0d5678e64226shiqian//   LOG(DFATAL) << "death";
226d201456903f3ecae1f7794edfab0d5678e64226shiqian//   return 12;
227d201456903f3ecae1f7794edfab0d5678e64226shiqian// }
228d201456903f3ecae1f7794edfab0d5678e64226shiqian//
229d201456903f3ecae1f7794edfab0d5678e64226shiqian// TEST(TestCase, TestDieOr12WorksInDgbAndOpt) {
230d201456903f3ecae1f7794edfab0d5678e64226shiqian//   int sideeffect = 0;
231d201456903f3ecae1f7794edfab0d5678e64226shiqian//   // Only asserts in dbg.
232d201456903f3ecae1f7794edfab0d5678e64226shiqian//   EXPECT_DEBUG_DEATH(DieInDebugOr12(&sideeffect), "death");
233d201456903f3ecae1f7794edfab0d5678e64226shiqian//
234d201456903f3ecae1f7794edfab0d5678e64226shiqian// #ifdef NDEBUG
235d201456903f3ecae1f7794edfab0d5678e64226shiqian//   // opt-mode has sideeffect visible.
236d201456903f3ecae1f7794edfab0d5678e64226shiqian//   EXPECT_EQ(12, sideeffect);
237d201456903f3ecae1f7794edfab0d5678e64226shiqian// #else
238d201456903f3ecae1f7794edfab0d5678e64226shiqian//   // dbg-mode no visible sideeffect.
239d201456903f3ecae1f7794edfab0d5678e64226shiqian//   EXPECT_EQ(0, sideeffect);
240d201456903f3ecae1f7794edfab0d5678e64226shiqian// #endif
241d201456903f3ecae1f7794edfab0d5678e64226shiqian// }
242d201456903f3ecae1f7794edfab0d5678e64226shiqian//
243d201456903f3ecae1f7794edfab0d5678e64226shiqian// This will assert that DieInDebugReturn12InOpt() crashes in debug
244d201456903f3ecae1f7794edfab0d5678e64226shiqian// mode, usually due to a DCHECK or LOG(DFATAL), but returns the
245d201456903f3ecae1f7794edfab0d5678e64226shiqian// appropriate fallback value (12 in this case) in opt mode. If you
246d201456903f3ecae1f7794edfab0d5678e64226shiqian// need to test that a function has appropriate side-effects in opt
247d201456903f3ecae1f7794edfab0d5678e64226shiqian// mode, include assertions against the side-effects.  A general
248d201456903f3ecae1f7794edfab0d5678e64226shiqian// pattern for this is:
249d201456903f3ecae1f7794edfab0d5678e64226shiqian//
250d201456903f3ecae1f7794edfab0d5678e64226shiqian// EXPECT_DEBUG_DEATH({
251d201456903f3ecae1f7794edfab0d5678e64226shiqian//   // Side-effects here will have an effect after this statement in
252d201456903f3ecae1f7794edfab0d5678e64226shiqian//   // opt mode, but none in debug mode.
253d201456903f3ecae1f7794edfab0d5678e64226shiqian//   EXPECT_EQ(12, DieInDebugOr12(&sideeffect));
254d201456903f3ecae1f7794edfab0d5678e64226shiqian// }, "death");
255d201456903f3ecae1f7794edfab0d5678e64226shiqian//
256ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# ifdef NDEBUG
257d201456903f3ecae1f7794edfab0d5678e64226shiqian
258ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan#  define EXPECT_DEBUG_DEATH(statement, regex) \
259f0b86fc3b0f625e1db84f3632cb37bd9eae6ae19jgm  GTEST_EXECUTE_STATEMENT_(statement, regex)
260d201456903f3ecae1f7794edfab0d5678e64226shiqian
261ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan#  define ASSERT_DEBUG_DEATH(statement, regex) \
262f0b86fc3b0f625e1db84f3632cb37bd9eae6ae19jgm  GTEST_EXECUTE_STATEMENT_(statement, regex)
263d201456903f3ecae1f7794edfab0d5678e64226shiqian
264ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# else
265d201456903f3ecae1f7794edfab0d5678e64226shiqian
266ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan#  define EXPECT_DEBUG_DEATH(statement, regex) \
267d201456903f3ecae1f7794edfab0d5678e64226shiqian  EXPECT_DEATH(statement, regex)
268d201456903f3ecae1f7794edfab0d5678e64226shiqian
269ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan#  define ASSERT_DEBUG_DEATH(statement, regex) \
270d201456903f3ecae1f7794edfab0d5678e64226shiqian  ASSERT_DEATH(statement, regex)
271d201456903f3ecae1f7794edfab0d5678e64226shiqian
272ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# endif  // NDEBUG for EXPECT_DEBUG_DEATH
273d201456903f3ecae1f7794edfab0d5678e64226shiqian#endif  // GTEST_HAS_DEATH_TEST
274ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan
275ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// EXPECT_DEATH_IF_SUPPORTED(statement, regex) and
276ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// ASSERT_DEATH_IF_SUPPORTED(statement, regex) expand to real death tests if
277b2ee82ebf9b8f1be859d08611b768ae6c0700090zhanyong.wan// death tests are supported; otherwise they just issue a warning.  This is
278ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// useful when you are combining death test assertions with normal test
279ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan// assertions in one test.
280ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#if GTEST_HAS_DEATH_TEST
281ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \
282ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan    EXPECT_DEATH(statement, regex)
283ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \
284ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan    ASSERT_DEATH(statement, regex)
285ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#else
286ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \
287b2ee82ebf9b8f1be859d08611b768ae6c0700090zhanyong.wan    GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, )
288ffeb11d14a890b902dbb26ff2296cda7bf2d31dfzhanyong.wan# define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \
289b2ee82ebf9b8f1be859d08611b768ae6c0700090zhanyong.wan    GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, return)
290ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan#endif
291ed8500b341c473ecf46acd13951ae5b4e3acc780zhanyong.wan
292d201456903f3ecae1f7794edfab0d5678e64226shiqian}  // namespace testing
293d201456903f3ecae1f7794edfab0d5678e64226shiqian
294d201456903f3ecae1f7794edfab0d5678e64226shiqian#endif  // GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_
295