tesseract v5.3.3.20231005
gtest_xml_output_unittest_.cc
Go to the documentation of this file.
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
39#include "gtest/gtest.h"
40
42using ::testing::TestEventListeners;
43using ::testing::TestWithParam;
44using ::testing::UnitTest;
45using ::testing::Test;
47
48class SuccessfulTest : public Test {
49};
50
52 SUCCEED() << "This is a success.";
53 ASSERT_EQ(1, 1);
54}
55
56class FailedTest : public Test {
57};
58
60 ASSERT_EQ(1, 2);
61}
62
63class DisabledTest : public Test {
64};
65
66TEST_F(DisabledTest, DISABLED_test_not_run) {
67 FAIL() << "Unexpected failure: Disabled test should not be run";
68}
69
70class SkippedTest : public Test {
71};
72
74 GTEST_SKIP();
75}
76
77TEST_F(SkippedTest, SkippedWithMessage) {
78 GTEST_SKIP() << "It is good practice to tell why you skip a test.";
79}
80
81TEST_F(SkippedTest, SkippedAfterFailure) {
82 EXPECT_EQ(1, 2);
83 GTEST_SKIP() << "It is good practice to tell why you skip a test.";
84}
85
86TEST(MixedResultTest, Succeeds) {
87 EXPECT_EQ(1, 1);
88 ASSERT_EQ(1, 1);
89}
90
91TEST(MixedResultTest, Fails) {
92 EXPECT_EQ(1, 2);
93 ASSERT_EQ(2, 3);
94}
95
96TEST(MixedResultTest, DISABLED_test) {
97 FAIL() << "Unexpected failure: Disabled test should not be run";
98}
99
100TEST(XmlQuotingTest, OutputsCData) {
101 FAIL() << "XML output: "
102 "<?xml encoding=\"utf-8\"><top><![CDATA[cdata text]]></top>";
103}
104
105// Helps to test that invalid characters produced by test code do not make
106// it into the XML file.
107TEST(InvalidCharactersTest, InvalidCharactersInMessage) {
108 FAIL() << "Invalid characters in brackets [\x1\x2]";
109}
110
111class PropertyRecordingTest : public Test {
112 public:
113 static void SetUpTestSuite() { RecordProperty("SetUpTestSuite", "yes"); }
114 static void TearDownTestSuite() {
115 RecordProperty("TearDownTestSuite", "aye");
116 }
117};
118
120 RecordProperty("key_1", "1");
121}
122
123TEST_F(PropertyRecordingTest, IntValuedProperty) {
124 RecordProperty("key_int", 1);
125}
126
127TEST_F(PropertyRecordingTest, ThreeProperties) {
128 RecordProperty("key_1", "1");
129 RecordProperty("key_2", "2");
130 RecordProperty("key_3", "3");
131}
132
133TEST_F(PropertyRecordingTest, TwoValuesForOneKeyUsesLastValue) {
134 RecordProperty("key_1", "1");
135 RecordProperty("key_1", "2");
136}
137
138TEST(NoFixtureTest, RecordProperty) {
139 RecordProperty("key", "1");
140}
141
142void ExternalUtilityThatCallsRecordProperty(const std::string& key, int value) {
144}
145
146void ExternalUtilityThatCallsRecordProperty(const std::string& key,
147 const std::string& value) {
149}
150
151TEST(NoFixtureTest, ExternalUtilityThatCallsRecordIntValuedProperty) {
152 ExternalUtilityThatCallsRecordProperty("key_for_utility_int", 1);
153}
154
155TEST(NoFixtureTest, ExternalUtilityThatCallsRecordStringValuedProperty) {
156 ExternalUtilityThatCallsRecordProperty("key_for_utility_string", "1");
157}
158
159// Verifies that the test parameter value is output in the 'value_param'
160// XML attribute for value-parameterized tests.
161class ValueParamTest : public TestWithParam<int> {};
162TEST_P(ValueParamTest, HasValueParamAttribute) {}
163TEST_P(ValueParamTest, AnotherTestThatHasValueParamAttribute) {}
165
166// Verifies that the type parameter name is output in the 'type_param'
167// XML attribute for typed tests.
168template <typename T> class TypedTest : public Test {};
171TYPED_TEST(TypedTest, HasTypeParamAttribute) {}
172
173// Verifies that the type parameter name is output in the 'type_param'
174// XML attribute for type-parameterized tests.
175template <typename T>
176class TypeParameterizedTestSuite : public Test {};
178TYPED_TEST_P(TypeParameterizedTestSuite, HasTypeParamAttribute) {}
183
184int main(int argc, char** argv) {
185 InitGoogleTest(&argc, argv);
186
187 if (argc > 1 && strcmp(argv[1], "--shut_down_xml") == 0) {
188 TestEventListeners& listeners = UnitTest::GetInstance()->listeners();
189 delete listeners.Release(listeners.default_xml_generator());
190 }
191 testing::Test::RecordProperty("ad_hoc_property", "42");
192 return RUN_ALL_TESTS();
193}
int value
#define ASSERT_EQ(val1, val2)
Definition: gtest.h:2073
#define GTEST_SKIP()
Definition: gtest.h:1889
#define FAIL()
Definition: gtest.h:1928
#define EXPECT_EQ(val1, val2)
Definition: gtest.h:2043
#define SUCCEED()
Definition: gtest.h:1937
int RUN_ALL_TESTS() GTEST_MUST_USE_RESULT_
Definition: gtest.h:2489
REGISTER_TYPED_TEST_SUITE_P(TypeParameterizedTestSuite, HasTypeParamAttribute)
testing::Types< int, long > TypedTestTypes
INSTANTIATE_TEST_SUITE_P(Single, ValueParamTest, Values(33, 42))
TYPED_TEST_SUITE_P(TypeParameterizedTestSuite)
TEST(MixedResultTest, Succeeds)
int main(int argc, char **argv)
TYPED_TEST_SUITE(TypedTest, TypedTestTypes)
TEST_P(ValueParamTest, HasValueParamAttribute)
TYPED_TEST_P(TypeParameterizedTestSuite, HasTypeParamAttribute)
TYPED_TEST(TypedTest, HasTypeParamAttribute)
void ExternalUtilityThatCallsRecordProperty(const std::string &key, int value)
testing::Types< int, long > TypeParameterizedTestSuiteTypes
TEST_F(SuccessfulTest, Succeeds)
INSTANTIATE_TYPED_TEST_SUITE_P(Single, TypeParameterizedTestSuite, TypeParameterizedTestSuiteTypes)
internal::ValueArray< T... > Values(T... v)
GTEST_API_ void InitGoogleTest(int *argc, char **argv)
Definition: gtest.cc:6660
static void RecordProperty(const std::string &key, const std::string &value)
Definition: gtest.cc:2442