3 # Copyright 2010 Google Inc. All Rights Reserved.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are
9 # * Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # * Redistributions in binary form must reproduce the above
12 # copyright notice, this list of conditions and the following disclaimer
13 # in the documentation and/or other materials provided with the
15 # * Neither the name of Google Inc. nor the names of its
16 # contributors may be used to endorse or promote products derived from
17 # this software without specific prior written permission.
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 """Tests Google Test's exception catching behavior.
33 This script invokes googletest-catch-exceptions-test_ and
34 googletest-catch-exceptions-ex-test_ (programs written with
35 Google Test) and verifies their output.
38 import gtest_test_utils
41 FLAG_PREFIX = '--gtest_'
42 LIST_TESTS_FLAG = FLAG_PREFIX + 'list_tests'
43 NO_CATCH_EXCEPTIONS_FLAG = FLAG_PREFIX + 'catch_exceptions=0'
44 FILTER_FLAG = FLAG_PREFIX + 'filter'
46 # Path to the googletest-catch-exceptions-ex-test_ binary, compiled with
48 EX_EXE_PATH = gtest_test_utils.GetTestExecutablePath(
49 'googletest-catch-exceptions-ex-test_')
51 # Path to the googletest-catch-exceptions-test_ binary, compiled with
52 # exceptions disabled.
53 EXE_PATH = gtest_test_utils.GetTestExecutablePath(
54 'googletest-catch-exceptions-no-ex-test_')
56 environ = gtest_test_utils.environ
57 SetEnvVar = gtest_test_utils.SetEnvVar
59 # Tests in this file run a Google-Test-based test program and expect it
60 # to terminate prematurely. Therefore they are incompatible with
61 # the premature-exit-file protocol by design. Unset the
62 # premature-exit filepath to prevent Google Test from creating
64 SetEnvVar(gtest_test_utils.PREMATURE_EXIT_FILE_ENV_VAR, None)
66 TEST_LIST = gtest_test_utils.Subprocess(
67 [EXE_PATH, LIST_TESTS_FLAG], env=environ).output
69 SUPPORTS_SEH_EXCEPTIONS = 'ThrowsSehException' in TEST_LIST
71 if SUPPORTS_SEH_EXCEPTIONS:
72 BINARY_OUTPUT = gtest_test_utils.Subprocess([EXE_PATH], env=environ).output
74 EX_BINARY_OUTPUT = gtest_test_utils.Subprocess(
75 [EX_EXE_PATH], env=environ).output
79 if SUPPORTS_SEH_EXCEPTIONS:
80 # pylint:disable-msg=C6302
81 class CatchSehExceptionsTest(gtest_test_utils.TestCase):
82 """Tests exception-catching behavior."""
85 def TestSehExceptions(self, test_output):
86 self.assert_('SEH exception with code 0x2a thrown '
87 'in the test fixture\'s constructor'
89 self.assert_('SEH exception with code 0x2a thrown '
90 'in the test fixture\'s destructor'
92 self.assert_('SEH exception with code 0x2a thrown in SetUpTestSuite()'
94 self.assert_('SEH exception with code 0x2a thrown in TearDownTestSuite()'
96 self.assert_('SEH exception with code 0x2a thrown in SetUp()'
98 self.assert_('SEH exception with code 0x2a thrown in TearDown()'
100 self.assert_('SEH exception with code 0x2a thrown in the test body'
103 def testCatchesSehExceptionsWithCxxExceptionsEnabled(self):
104 self.TestSehExceptions(EX_BINARY_OUTPUT)
106 def testCatchesSehExceptionsWithCxxExceptionsDisabled(self):
107 self.TestSehExceptions(BINARY_OUTPUT)
110 class CatchCxxExceptionsTest(gtest_test_utils.TestCase):
111 """Tests C++ exception-catching behavior.
113 Tests in this test case verify that:
114 * C++ exceptions are caught and logged as C++ (not SEH) exceptions
115 * Exception thrown affect the remainder of the test work flow in the
119 def testCatchesCxxExceptionsInFixtureConstructor(self):
121 'C++ exception with description '
122 '"Standard C++ exception" thrown '
123 'in the test fixture\'s constructor' in EX_BINARY_OUTPUT,
125 self.assert_('unexpected' not in EX_BINARY_OUTPUT,
126 'This failure belongs in this test only if '
127 '"CxxExceptionInConstructorTest" (no quotes) '
128 'appears on the same line as words "called unexpectedly"')
130 if ('CxxExceptionInDestructorTest.ThrowsExceptionInDestructor' in
133 def testCatchesCxxExceptionsInFixtureDestructor(self):
135 'C++ exception with description '
136 '"Standard C++ exception" thrown '
137 'in the test fixture\'s destructor' in EX_BINARY_OUTPUT,
140 'CxxExceptionInDestructorTest::TearDownTestSuite() '
141 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
143 def testCatchesCxxExceptionsInSetUpTestCase(self):
145 'C++ exception with description "Standard C++ exception"'
146 ' thrown in SetUpTestSuite()' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
148 'CxxExceptionInConstructorTest::TearDownTestSuite() '
149 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
151 'CxxExceptionInSetUpTestSuiteTest constructor '
152 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
154 'CxxExceptionInSetUpTestSuiteTest destructor '
155 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
157 'CxxExceptionInSetUpTestSuiteTest::SetUp() '
158 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
160 'CxxExceptionInSetUpTestSuiteTest::TearDown() '
161 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
163 'CxxExceptionInSetUpTestSuiteTest test body '
164 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
166 def testCatchesCxxExceptionsInTearDownTestCase(self):
168 'C++ exception with description "Standard C++ exception"'
169 ' thrown in TearDownTestSuite()' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
171 def testCatchesCxxExceptionsInSetUp(self):
173 'C++ exception with description "Standard C++ exception"'
174 ' thrown in SetUp()' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
176 'CxxExceptionInSetUpTest::TearDownTestSuite() '
177 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
179 'CxxExceptionInSetUpTest destructor '
180 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
182 'CxxExceptionInSetUpTest::TearDown() '
183 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
184 self.assert_('unexpected' not in EX_BINARY_OUTPUT,
185 'This failure belongs in this test only if '
186 '"CxxExceptionInSetUpTest" (no quotes) '
187 'appears on the same line as words "called unexpectedly"')
189 def testCatchesCxxExceptionsInTearDown(self):
191 'C++ exception with description "Standard C++ exception"'
192 ' thrown in TearDown()' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
194 'CxxExceptionInTearDownTest::TearDownTestSuite() '
195 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
197 'CxxExceptionInTearDownTest destructor '
198 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
200 def testCatchesCxxExceptionsInTestBody(self):
202 'C++ exception with description "Standard C++ exception"'
203 ' thrown in the test body' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
205 'CxxExceptionInTestBodyTest::TearDownTestSuite() '
206 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
208 'CxxExceptionInTestBodyTest destructor '
209 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
211 'CxxExceptionInTestBodyTest::TearDown() '
212 'called as expected.' in EX_BINARY_OUTPUT, EX_BINARY_OUTPUT)
214 def testCatchesNonStdCxxExceptions(self):
216 'Unknown C++ exception thrown in the test body' in EX_BINARY_OUTPUT,
219 def testUnhandledCxxExceptionsAbortTheProgram(self):
220 # Filters out SEH exception tests on Windows. Unhandled SEH exceptions
221 # cause tests to show pop-up windows there.
222 FITLER_OUT_SEH_TESTS_FLAG = FILTER_FLAG + '=-*Seh*'
223 # By default, Google Test doesn't catch the exceptions.
224 uncaught_exceptions_ex_binary_output = gtest_test_utils.Subprocess(
226 NO_CATCH_EXCEPTIONS_FLAG,
227 FITLER_OUT_SEH_TESTS_FLAG],
230 self.assert_('Unhandled C++ exception terminating the program'
231 in uncaught_exceptions_ex_binary_output)
232 self.assert_('unexpected' not in uncaught_exceptions_ex_binary_output)
235 if __name__ == '__main__':
236 gtest_test_utils.Main()