Skip to content

Commit 9ed99c6

Browse files
Abseil Teammbxx
Abseil Team
authored and
mbxx
committed
Googletest export
Change googletest to notice failures during SetUpTestSuite() and TearDownTestSuite(). Previously, errors that occurred during those functions were logged but otherwise ignored. After this change, such failures will cause the test to fail and a brief summary will be printed at the bottom of the test log. See #2330. PiperOrigin-RevId: 284033342
1 parent 2002f26 commit 9ed99c6

File tree

6 files changed

+152
-31
lines changed

6 files changed

+152
-31
lines changed

‎googletest/include/gtest/gtest.h

+3-5
Original file line numberDiff line numberDiff line change
@@ -412,8 +412,6 @@ class GTEST_API_ Test {
412412
// test in test case Foo. Hence a sub-class can define its own
413413
// SetUpTestSuite() method to shadow the one defined in the super
414414
// class.
415-
// Failures that happen during SetUpTestSuite are logged but otherwise
416-
// ignored.
417415
static void SetUpTestSuite() {}
418416

419417
// Tears down the stuff shared by all tests in this test suite.
@@ -422,8 +420,6 @@ class GTEST_API_ Test {
422420
// test in test case Foo. Hence a sub-class can define its own
423421
// TearDownTestSuite() method to shadow the one defined in the super
424422
// class.
425-
// Failures that happen during TearDownTestSuite are logged but otherwise
426-
// ignored.
427423
static void TearDownTestSuite() {}
428424

429425
// Legacy API is deprecated but still available
@@ -889,7 +885,9 @@ class GTEST_API_ TestSuite {
889885
bool Passed() const { return !Failed(); }
890886

891887
// Returns true if and only if the test suite failed.
892-
bool Failed() const { return failed_test_count() > 0; }
888+
bool Failed() const {
889+
return failed_test_count() > 0 || ad_hoc_test_result().Failed();
890+
}
893891

894892
// Returns the elapsed time, in milliseconds.
895893
TimeInMillis elapsed_time() const { return elapsed_time_; }

‎googletest/src/gtest.cc

+29-10
Original file line numberDiff line numberDiff line change
@@ -3138,6 +3138,7 @@ class PrettyUnitTestResultPrinter : public TestEventListener {
31383138

31393139
private:
31403140
static void PrintFailedTests(const UnitTest& unit_test);
3141+
static void PrintFailedTestSuites(const UnitTest& unit_test);
31413142
static void PrintSkippedTests(const UnitTest& unit_test);
31423143
};
31433144

@@ -3290,9 +3291,8 @@ void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
32903291
// Internal helper for printing the list of failed tests.
32913292
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
32923293
const int failed_test_count = unit_test.failed_test_count();
3293-
if (failed_test_count == 0) {
3294-
return;
3295-
}
3294+
ColoredPrintf(COLOR_RED, "[ FAILED ] ");
3295+
printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
32963296

32973297
for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
32983298
const TestSuite& test_suite = *unit_test.GetTestSuite(i);
@@ -3310,6 +3310,30 @@ void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
33103310
printf("\n");
33113311
}
33123312
}
3313+
printf("\n%2d FAILED %s\n", failed_test_count,
3314+
failed_test_count == 1 ? "TEST" : "TESTS");
3315+
}
3316+
3317+
// Internal helper for printing the list of test suite failures not covered by
3318+
// PrintFailedTests.
3319+
void PrettyUnitTestResultPrinter::PrintFailedTestSuites(
3320+
const UnitTest& unit_test) {
3321+
int suite_failure_count = 0;
3322+
for (int i = 0; i < unit_test.total_test_suite_count(); ++i) {
3323+
const TestSuite& test_suite = *unit_test.GetTestSuite(i);
3324+
if (!test_suite.should_run()) {
3325+
continue;
3326+
}
3327+
if (test_suite.ad_hoc_test_result().Failed()) {
3328+
ColoredPrintf(COLOR_RED, "[ FAILED ] ");
3329+
printf("%s: SetUpTestSuite or TearDownTestSuite\n", test_suite.name());
3330+
++suite_failure_count;
3331+
}
3332+
}
3333+
if (suite_failure_count > 0) {
3334+
printf("\n%2d FAILED TEST %s\n", suite_failure_count,
3335+
suite_failure_count == 1 ? "SUITE" : "SUITES");
3336+
}
33133337
}
33143338

33153339
// Internal helper for printing the list of skipped tests.
@@ -3357,19 +3381,14 @@ void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
33573381
PrintSkippedTests(unit_test);
33583382
}
33593383

3360-
int num_failures = unit_test.failed_test_count();
33613384
if (!unit_test.Passed()) {
3362-
const int failed_test_count = unit_test.failed_test_count();
3363-
ColoredPrintf(COLOR_RED, "[ FAILED ] ");
3364-
printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
33653385
PrintFailedTests(unit_test);
3366-
printf("\n%2d FAILED %s\n", num_failures,
3367-
num_failures == 1 ? "TEST" : "TESTS");
3386+
PrintFailedTestSuites(unit_test);
33683387
}
33693388

33703389
int num_disabled = unit_test.reportable_disabled_test_count();
33713390
if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
3372-
if (!num_failures) {
3391+
if (unit_test.Passed()) {
33733392
printf("\n"); // Add a spacer if no FAILURE banner is displayed.
33743393
}
33753394
ColoredPrintf(COLOR_YELLOW,

‎googletest/test/BUILD.bazel

+16
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ cc_test(
6565
"googletest-output-test_.cc",
6666
"googletest-list-tests-unittest_.cc",
6767
"googletest-shuffle-test_.cc",
68+
"googletest-setuptestsuite-test_.cc",
6869
"googletest-uninitialized-test_.cc",
6970
"googletest-death-test_ex_test.cc",
7071
"googletest-param-test-test",
@@ -423,6 +424,21 @@ py_test(
423424
deps = [":gtest_test_utils"],
424425
)
425426

427+
cc_binary(
428+
name = "googletest-setuptestsuite-test_",
429+
testonly = 1,
430+
srcs = ["googletest-setuptestsuite-test_.cc"],
431+
deps = ["//:gtest_main"],
432+
)
433+
434+
py_test(
435+
name = "googletest-setuptestsuite-test",
436+
size = "medium",
437+
srcs = ["googletest-setuptestsuite-test.py"],
438+
data = [":googletest-setuptestsuite-test_"],
439+
deps = [":gtest_test_utils"],
440+
)
441+
426442
cc_binary(
427443
name = "googletest-uninitialized-test_",
428444
testonly = 1,

‎googletest/test/googletest-setuptestsuite-test.py

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
#!/usr/bin/env python
2+
#
3+
# Copyright 2019, Google Inc.
4+
# All rights reserved.
5+
#
6+
# Redistribution and use in source and binary forms, with or without
7+
# modification, are permitted provided that the following conditions are
8+
# met:
9+
#
10+
# * Redistributions of source code must retain the above copyright
11+
# notice, this list of conditions and the following disclaimer.
12+
# * Redistributions in binary form must reproduce the above
13+
# copyright notice, this list of conditions and the following disclaimer
14+
# in the documentation and/or other materials provided with the
15+
# distribution.
16+
# * Neither the name of Google Inc. nor the names of its
17+
# contributors may be used to endorse or promote products derived from
18+
# this software without specific prior written permission.
19+
#
20+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31+
32+
"""Verifies that SetUpTestSuite and TearDownTestSuite errors are noticed."""
33+
34+
import gtest_test_utils
35+
36+
COMMAND = gtest_test_utils.GetTestExecutablePath(
37+
'googletest-setuptestsuite-test_')
38+
39+
40+
class GTestSetUpTestSuiteTest(gtest_test_utils.TestCase):
41+
42+
def testSetupErrorAndTearDownError(self):
43+
p = gtest_test_utils.Subprocess(COMMAND)
44+
self.assertNotEqual(p.exit_code, 0, msg=p.output)
45+
46+
self.assertIn(
47+
'[ FAILED ] SetupFailTest: SetUpTestSuite or TearDownTestSuite\n'
48+
'[ FAILED ] TearDownFailTest: SetUpTestSuite or TearDownTestSuite\n'
49+
'\n'
50+
' 2 FAILED TEST SUITES\n',
51+
p.output)
52+
53+
if __name__ == '__main__':
54+
gtest_test_utils.Main()

‎googletest/test/googletest-setuptestsuite-test_.cc

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Copyright 2008, 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+
#include "gtest/gtest.h"
32+
33+
class SetupFailTest : public ::testing::Test {
34+
protected:
35+
static void SetUpTestSuite() {
36+
ASSERT_EQ("", "SET_UP_FAIL");
37+
}
38+
};
39+
40+
TEST_F(SetupFailTest, NoopPassingTest) {}
41+
42+
class TearDownFailTest : public ::testing::Test {
43+
protected:
44+
static void TearDownTestSuite() {
45+
ASSERT_EQ("", "TEAR_DOWN_FAIL");
46+
}
47+
};
48+
49+
TEST_F(TearDownFailTest, NoopPassingTest) {}

‎googletest/test/gtest_unittest.cc

+1-16
Original file line numberDiff line numberDiff line change
@@ -7446,22 +7446,7 @@ TEST(SkipPrefixTest, DoesNotSkipWhenPrefixDoesNotMatch) {
74467446
}
74477447

74487448
// Tests ad_hoc_test_result().
7449-
7450-
class AdHocTestResultTest : public testing::Test {
7451-
protected:
7452-
static void SetUpTestSuite() {
7453-
FAIL() << "A failure happened inside SetUpTestSuite().";
7454-
}
7455-
};
7456-
7457-
TEST_F(AdHocTestResultTest, AdHocTestResultForTestSuiteShowsFailure) {
7458-
const testing::TestResult& test_result = testing::UnitTest::GetInstance()
7459-
->current_test_suite()
7460-
->ad_hoc_test_result();
7461-
EXPECT_TRUE(test_result.Failed());
7462-
}
7463-
7464-
TEST_F(AdHocTestResultTest, AdHocTestResultTestForUnitTestDoesNotShowFailure) {
7449+
TEST(AdHocTestResultTest, AdHocTestResultForUnitTestDoesNotShowFailure) {
74657450
const testing::TestResult& test_result =
74667451
testing::UnitTest::GetInstance()->ad_hoc_test_result();
74677452
EXPECT_FALSE(test_result.Failed());

0 commit comments

Comments
 (0)