Mercurial > embed

annotate libgtest/include/gtest/gtest-death-test.h @ 92:35c644a88d1b

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