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