1 // Copyright 2006, 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 // Unit test for Google Test XML output.
31 //
32 // A user can specify XML output in a Google Test program to run via
33 // either the GTEST_OUTPUT environment variable or the --gtest_output
34 // flag.  This is used for testing such functionality.
35 //
36 // This program will be invoked from a Python unit test.  Don't run it
37 // directly.
38 // clang-format off
39 
40 #include <string>
41 
42 #include "gtest/gtest.h"
43 
44 using ::testing::InitGoogleTest;
45 using ::testing::Test;
46 using ::testing::TestEventListeners;
47 using ::testing::TestWithParam;
48 using ::testing::UnitTest;
49 using ::testing::Values;
50 
51 class SuccessfulTest : public Test {};
52 
53 TEST_F(SuccessfulTest, Succeeds) {
54   SUCCEED() << "This is a success.";
55   ASSERT_EQ(1, 1);
56 }
57 
58 class FailedTest : public Test {
59 };
60 
61 TEST_F(FailedTest, Fails) {
62   ASSERT_EQ(1, 2);
63 }
64 
65 class DisabledTest : public Test {
66 };
67 
68 TEST_F(DisabledTest, DISABLED_test_not_run) {
69   FAIL() << "Unexpected failure: Disabled test should not be run";
70 }
71 
72 class SkippedTest : public Test {
73 };
74 
75 TEST_F(SkippedTest, Skipped) {
76   GTEST_SKIP();
77 }
78 
79 TEST_F(SkippedTest, SkippedWithMessage) {
80   GTEST_SKIP() << "It is good practice to tell why you skip a test.";
81 }
82 
83 TEST_F(SkippedTest, SkippedAfterFailure) {
84   EXPECT_EQ(1, 2);
85   GTEST_SKIP() << "It is good practice to tell why you skip a test.";
86 }
87 
88 TEST(MixedResultTest, Succeeds) {
89   EXPECT_EQ(1, 1);
90   ASSERT_EQ(1, 1);
91 }
92 
93 TEST(MixedResultTest, Fails) {
94   EXPECT_EQ(1, 2);
95   ASSERT_EQ(2, 3);
96 }
97 
98 TEST(MixedResultTest, DISABLED_test) {
99   FAIL() << "Unexpected failure: Disabled test should not be run";
100 }
101 
102 TEST(XmlQuotingTest, OutputsCData) {
103   FAIL() << "XML output: "
104             "<?xml encoding=\"utf-8\"><top><![CDATA[cdata text]]></top>";
105 }
106 
107 // Helps to test that invalid characters produced by test code do not make
108 // it into the XML file.
109 TEST(InvalidCharactersTest, InvalidCharactersInMessage) {
110   FAIL() << "Invalid characters in brackets [\x1\x2]";
111 }
112 
113 class PropertyRecordingTest : public Test {
114  public:
115   static void SetUpTestSuite() { RecordProperty("SetUpTestSuite", "yes"); }
116   static void TearDownTestSuite() {
117     RecordProperty("TearDownTestSuite", "aye");
118   }
119 };
120 
121 TEST_F(PropertyRecordingTest, OneProperty) {
122   RecordProperty("key_1", "1");
123 }
124 
125 TEST_F(PropertyRecordingTest, IntValuedProperty) {
126   RecordProperty("key_int", 1);
127 }
128 
129 TEST_F(PropertyRecordingTest, ThreeProperties) {
130   RecordProperty("key_1", "1");
131   RecordProperty("key_2", "2");
132   RecordProperty("key_3", "3");
133 }
134 
135 TEST_F(PropertyRecordingTest, TwoValuesForOneKeyUsesLastValue) {
136   RecordProperty("key_1", "1");
137   RecordProperty("key_1", "2");
138 }
139 
140 TEST(NoFixtureTest, RecordProperty) {
141   RecordProperty("key", "1");
142 }
143 
144 void ExternalUtilityThatCallsRecordProperty(const std::string& key, int value) {
145   testing::Test::RecordProperty(key, value);
146 }
147 
148 void ExternalUtilityThatCallsRecordProperty(const std::string& key,
149                                             const std::string& value) {
150   testing::Test::RecordProperty(key, value);
151 }
152 
153 TEST(NoFixtureTest, ExternalUtilityThatCallsRecordIntValuedProperty) {
154   ExternalUtilityThatCallsRecordProperty("key_for_utility_int", 1);
155 }
156 
157 TEST(NoFixtureTest, ExternalUtilityThatCallsRecordStringValuedProperty) {
158   ExternalUtilityThatCallsRecordProperty("key_for_utility_string", "1");
159 }
160 
161 // Verifies that the test parameter value is output in the 'value_param'
162 // XML attribute for value-parameterized tests.
163 class ValueParamTest : public TestWithParam<int> {};
164 TEST_P(ValueParamTest, HasValueParamAttribute) {}
165 TEST_P(ValueParamTest, AnotherTestThatHasValueParamAttribute) {}
166 INSTANTIATE_TEST_SUITE_P(Single, ValueParamTest, Values(33, 42));
167 
168 // Verifies that the type parameter name is output in the 'type_param'
169 // XML attribute for typed tests.
170 template <typename T> class TypedTest : public Test {};
171 typedef testing::Types<int, long> TypedTestTypes;
172 TYPED_TEST_SUITE(TypedTest, TypedTestTypes);
173 TYPED_TEST(TypedTest, HasTypeParamAttribute) {}
174 
175 // Verifies that the type parameter name is output in the 'type_param'
176 // XML attribute for type-parameterized tests.
177 template <typename T>
178 class TypeParameterizedTestSuite : public Test {};
179 TYPED_TEST_SUITE_P(TypeParameterizedTestSuite);
180 TYPED_TEST_P(TypeParameterizedTestSuite, HasTypeParamAttribute) {}
181 REGISTER_TYPED_TEST_SUITE_P(TypeParameterizedTestSuite, HasTypeParamAttribute);
182 typedef testing::Types<int, long> TypeParameterizedTestSuiteTypes;  // NOLINT
183 INSTANTIATE_TYPED_TEST_SUITE_P(Single, TypeParameterizedTestSuite,
184                                TypeParameterizedTestSuiteTypes);
185 
186 int main(int argc, char** argv) {
187   InitGoogleTest(&argc, argv);
188 
189   if (argc > 1 && strcmp(argv[1], "--shut_down_xml") == 0) {
190     TestEventListeners& listeners = UnitTest::GetInstance()->listeners();
191     delete listeners.Release(listeners.default_xml_generator());
192   }
193   testing::Test::RecordProperty("ad_hoc_property", "42");
194   return RUN_ALL_TESTS();
195 }
196 
197 // clang-format on
198