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// The Google C++ Testing and Mocking Framework (Google Test)
31//
32// This header file defines internal utilities needed for implementing
33// death tests. They are subject to change without notice.
34
35// IWYU pragma: private, include "gtest/gtest.h"
36// IWYU pragma: friend gtest/.*
37// IWYU pragma: friend gmock/.*
38
39#ifndef GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_
40#define GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_
41
42#include <stdio.h>
43
44#include <memory>
45#include <string>
46
47#include "gtest/gtest-matchers.h"
48#include "gtest/internal/gtest-internal.h"
49#include "gtest/internal/gtest-port.h"
50
51GTEST_DECLARE_string_(internal_run_death_test);
52
53namespace testing {
54namespace internal {
55
56// Name of the flag (needed for parsing Google Test flag).
57const char kInternalRunDeathTestFlag[] = "internal_run_death_test";
58
59// A string passed to EXPECT_DEATH (etc.) is caught by one of these overloads
60// and interpreted as a regex (rather than an Eq matcher) for legacy
61// compatibility.
62inline Matcher<const ::std::string&> MakeDeathTestMatcher(
63 ::testing::internal::RE regex) {
64 return ContainsRegex(regex: regex.pattern());
65}
66inline Matcher<const ::std::string&> MakeDeathTestMatcher(const char* regex) {
67 return ContainsRegex(regex);
68}
69inline Matcher<const ::std::string&> MakeDeathTestMatcher(
70 const ::std::string& regex) {
71 return ContainsRegex(regex);
72}
73
74// If a Matcher<const ::std::string&> is passed to EXPECT_DEATH (etc.), it's
75// used directly.
76inline Matcher<const ::std::string&> MakeDeathTestMatcher(
77 Matcher<const ::std::string&> matcher) {
78 return matcher;
79}
80
81#ifdef GTEST_HAS_DEATH_TEST
82
83GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
84/* class A needs to have dll-interface to be used by clients of class B */)
85
86// DeathTest is a class that hides much of the complexity of the
87// GTEST_DEATH_TEST_ macro. It is abstract; its static Create method
88// returns a concrete class that depends on the prevailing death test
89// style, as defined by the --gtest_death_test_style and/or
90// --gtest_internal_run_death_test flags.
91
92// In describing the results of death tests, these terms are used with
93// the corresponding definitions:
94//
95// exit status: The integer exit information in the format specified
96// by wait(2)
97// exit code: The integer code passed to exit(3), _Exit(2), or
98// returned from main()
99class GTEST_API_ DeathTest {
100 public:
101 // Create returns false if there was an error determining the
102 // appropriate action to take for the current death test; for example,
103 // if the gtest_death_test_style flag is set to an invalid value.
104 // The LastMessage method will return a more detailed message in that
105 // case. Otherwise, the DeathTest pointer pointed to by the "test"
106 // argument is set. If the death test should be skipped, the pointer
107 // is set to NULL; otherwise, it is set to the address of a new concrete
108 // DeathTest object that controls the execution of the current test.
109 static bool Create(const char* statement, Matcher<const std::string&> matcher,
110 const char* file, int line, DeathTest** test);
111 DeathTest();
112 virtual ~DeathTest() = default;
113
114 // A helper class that aborts a death test when it's deleted.
115 class ReturnSentinel {
116 public:
117 explicit ReturnSentinel(DeathTest* test) : test_(test) {}
118 ~ReturnSentinel() { test_->Abort(reason: TEST_ENCOUNTERED_RETURN_STATEMENT); }
119
120 private:
121 DeathTest* const test_;
122 ReturnSentinel(const ReturnSentinel&) = delete;
123 ReturnSentinel& operator=(const ReturnSentinel&) = delete;
124 };
125
126 // An enumeration of possible roles that may be taken when a death
127 // test is encountered. EXECUTE means that the death test logic should
128 // be executed immediately. OVERSEE means that the program should prepare
129 // the appropriate environment for a child process to execute the death
130 // test, then wait for it to complete.
131 enum TestRole { OVERSEE_TEST, EXECUTE_TEST };
132
133 // An enumeration of the three reasons that a test might be aborted.
134 enum AbortReason {
135 TEST_ENCOUNTERED_RETURN_STATEMENT,
136 TEST_THREW_EXCEPTION,
137 TEST_DID_NOT_DIE
138 };
139
140 // Assumes one of the above roles.
141 virtual TestRole AssumeRole() = 0;
142
143 // Waits for the death test to finish and returns its status.
144 virtual int Wait() = 0;
145
146 // Returns true if the death test passed; that is, the test process
147 // exited during the test, its exit status matches a user-supplied
148 // predicate, and its stderr output matches a user-supplied regular
149 // expression.
150 // The user-supplied predicate may be a macro expression rather
151 // than a function pointer or functor, or else Wait and Passed could
152 // be combined.
153 virtual bool Passed(bool exit_status_ok) = 0;
154
155 // Signals that the death test did not die as expected.
156 virtual void Abort(AbortReason reason) = 0;
157
158 // Returns a human-readable outcome message regarding the outcome of
159 // the last death test.
160 static const char* LastMessage();
161
162 static void set_last_death_test_message(const std::string& message);
163
164 private:
165 // A string containing a description of the outcome of the last death test.
166 static std::string last_death_test_message_;
167
168 DeathTest(const DeathTest&) = delete;
169 DeathTest& operator=(const DeathTest&) = delete;
170};
171
172GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251
173
174// Factory interface for death tests. May be mocked out for testing.
175class DeathTestFactory {
176 public:
177 virtual ~DeathTestFactory() = default;
178 virtual bool Create(const char* statement,
179 Matcher<const std::string&> matcher, const char* file,
180 int line, DeathTest** test) = 0;
181};
182
183// A concrete DeathTestFactory implementation for normal use.
184class DefaultDeathTestFactory : public DeathTestFactory {
185 public:
186 bool Create(const char* statement, Matcher<const std::string&> matcher,
187 const char* file, int line, DeathTest** test) override;
188};
189
190// Returns true if exit_status describes a process that was terminated
191// by a signal, or exited normally with a nonzero exit code.
192GTEST_API_ bool ExitedUnsuccessfully(int exit_status);
193
194// Traps C++ exceptions escaping statement and reports them as test
195// failures. Note that trapping SEH exceptions is not implemented here.
196#if GTEST_HAS_EXCEPTIONS
197#define GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, death_test) \
198 try { \
199 GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
200 } catch (const ::std::exception& gtest_exception) { \
201 fprintf( \
202 stderr, \
203 "\n%s: Caught std::exception-derived exception escaping the " \
204 "death test statement. Exception message: %s\n", \
205 ::testing::internal::FormatFileLocation(__FILE__, __LINE__).c_str(), \
206 gtest_exception.what()); \
207 fflush(stderr); \
208 death_test->Abort(::testing::internal::DeathTest::TEST_THREW_EXCEPTION); \
209 } catch (...) { \
210 death_test->Abort(::testing::internal::DeathTest::TEST_THREW_EXCEPTION); \
211 }
212
213#else
214#define GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, death_test) \
215 GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement)
216
217#endif
218
219// This macro is for implementing ASSERT_DEATH*, EXPECT_DEATH*,
220// ASSERT_EXIT*, and EXPECT_EXIT*.
221#define GTEST_DEATH_TEST_(statement, predicate, regex_or_matcher, fail) \
222 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
223 if (::testing::internal::AlwaysTrue()) { \
224 ::testing::internal::DeathTest* gtest_dt; \
225 if (!::testing::internal::DeathTest::Create( \
226 #statement, \
227 ::testing::internal::MakeDeathTestMatcher(regex_or_matcher), \
228 __FILE__, __LINE__, &gtest_dt)) { \
229 goto GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__); \
230 } \
231 if (gtest_dt != nullptr) { \
232 std::unique_ptr< ::testing::internal::DeathTest> gtest_dt_ptr(gtest_dt); \
233 switch (gtest_dt->AssumeRole()) { \
234 case ::testing::internal::DeathTest::OVERSEE_TEST: \
235 if (!gtest_dt->Passed(predicate(gtest_dt->Wait()))) { \
236 goto GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__); \
237 } \
238 break; \
239 case ::testing::internal::DeathTest::EXECUTE_TEST: { \
240 const ::testing::internal::DeathTest::ReturnSentinel gtest_sentinel( \
241 gtest_dt); \
242 GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, gtest_dt); \
243 gtest_dt->Abort(::testing::internal::DeathTest::TEST_DID_NOT_DIE); \
244 break; \
245 } \
246 } \
247 } \
248 } else \
249 GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__) \
250 : fail(::testing::internal::DeathTest::LastMessage())
251// The symbol "fail" here expands to something into which a message
252// can be streamed.
253
254// This macro is for implementing ASSERT/EXPECT_DEBUG_DEATH when compiled in
255// NDEBUG mode. In this case we need the statements to be executed and the macro
256// must accept a streamed message even though the message is never printed.
257// The regex object is not evaluated, but it is used to prevent "unused"
258// warnings and to avoid an expression that doesn't compile in debug mode.
259#define GTEST_EXECUTE_STATEMENT_(statement, regex_or_matcher) \
260 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
261 if (::testing::internal::AlwaysTrue()) { \
262 GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
263 } else if (!::testing::internal::AlwaysTrue()) { \
264 ::testing::internal::MakeDeathTestMatcher(regex_or_matcher); \
265 } else \
266 ::testing::Message()
267
268// A class representing the parsed contents of the
269// --gtest_internal_run_death_test flag, as it existed when
270// RUN_ALL_TESTS was called.
271class InternalRunDeathTestFlag {
272 public:
273 InternalRunDeathTestFlag(const std::string& a_file, int a_line, int an_index,
274 int a_write_fd)
275 : file_(a_file), line_(a_line), index_(an_index), write_fd_(a_write_fd) {}
276
277 ~InternalRunDeathTestFlag() {
278 if (write_fd_ >= 0) posix::Close(fd: write_fd_);
279 }
280
281 const std::string& file() const { return file_; }
282 int line() const { return line_; }
283 int index() const { return index_; }
284 int write_fd() const { return write_fd_; }
285
286 private:
287 std::string file_;
288 int line_;
289 int index_;
290 int write_fd_;
291
292 InternalRunDeathTestFlag(const InternalRunDeathTestFlag&) = delete;
293 InternalRunDeathTestFlag& operator=(const InternalRunDeathTestFlag&) = delete;
294};
295
296// Returns a newly created InternalRunDeathTestFlag object with fields
297// initialized from the GTEST_FLAG(internal_run_death_test) flag if
298// the flag is specified; otherwise returns NULL.
299InternalRunDeathTestFlag* ParseInternalRunDeathTestFlag();
300
301#endif // GTEST_HAS_DEATH_TEST
302
303} // namespace internal
304} // namespace testing
305
306#endif // GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_
307