contrib/googletest/googletest/test/gtest_xml_output_unittest_.cc

   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
  41 using ::testing::InitGoogleTest;
  42 using ::testing::TestEventListeners;
  43 using ::testing::TestWithParam;
  44 using ::testing::UnitTest;
  45 using ::testing::Test;
  46 using ::testing::Values;
  47
  48 class SuccessfulTest : public Test {
  49 };
  50
  51 TEST_F(SuccessfulTest, Succeeds) {
  52   SUCCEED() << "This is a success.";
  53   ASSERT_EQ(1, 1);
  54 }
  55
  56 class FailedTest : public Test {
  57 };
  58
  59 TEST_F(FailedTest, Fails) {
  60   ASSERT_EQ(1, 2);
  61 }
  62
  63 class DisabledTest : public Test {
  64 };
  65
  66 TEST_F(DisabledTest, DISABLED_test_not_run) {
  67   FAIL() << "Unexpected failure: Disabled test should not be run";
  68 }
  69
  70 TEST(MixedResultTest, Succeeds) {
  71   EXPECT_EQ(1, 1);
  72   ASSERT_EQ(1, 1);
  73 }
  74
  75 TEST(MixedResultTest, Fails) {
  76   EXPECT_EQ(1, 2);
  77   ASSERT_EQ(2, 3);
  78 }
  79
  80 TEST(MixedResultTest, DISABLED_test) {
  81   FAIL() << "Unexpected failure: Disabled test should not be run";
  82 }
  83
  84 TEST(XmlQuotingTest, OutputsCData) {
  85   FAIL() << "XML output: "
  86             "<?xml encoding=\"utf-8\"><top><![CDATA[cdata text]]></top>";
  87 }
  88
  89 // Helps to test that invalid characters produced by test code do not make
  90 // it into the XML file.
  91 TEST(InvalidCharactersTest, InvalidCharactersInMessage) {
  92   FAIL() << "Invalid characters in brackets [\x1\x2]";
  93 }
  94
  95 class PropertyRecordingTest : public Test {
  96  public:
  97   static void SetUpTestCase() { RecordProperty("SetUpTestCase", "yes"); }
  98   static void TearDownTestCase() { RecordProperty("TearDownTestCase", "aye"); }
  99 };
 100
 101 TEST_F(PropertyRecordingTest, OneProperty) {
 102   RecordProperty("key_1", "1");
 103 }
 104
 105 TEST_F(PropertyRecordingTest, IntValuedProperty) {
 106   RecordProperty("key_int", 1);
 107 }
 108
 109 TEST_F(PropertyRecordingTest, ThreeProperties) {
 110   RecordProperty("key_1", "1");
 111   RecordProperty("key_2", "2");
 112   RecordProperty("key_3", "3");
 113 }
 114
 115 TEST_F(PropertyRecordingTest, TwoValuesForOneKeyUsesLastValue) {
 116   RecordProperty("key_1", "1");
 117   RecordProperty("key_1", "2");
 118 }
 119
 120 TEST(NoFixtureTest, RecordProperty) {
 121   RecordProperty("key", "1");
 122 }
 123
 124 void ExternalUtilityThatCallsRecordProperty(const std::string& key, int value) {
 125   testing::Test::RecordProperty(key, value);
 126 }
 127
 128 void ExternalUtilityThatCallsRecordProperty(const std::string& key,
 129                                             const std::string& value) {
 130   testing::Test::RecordProperty(key, value);
 131 }
 132
 133 TEST(NoFixtureTest, ExternalUtilityThatCallsRecordIntValuedProperty) {
 134   ExternalUtilityThatCallsRecordProperty("key_for_utility_int", 1);
 135 }
 136
 137 TEST(NoFixtureTest, ExternalUtilityThatCallsRecordStringValuedProperty) {
 138   ExternalUtilityThatCallsRecordProperty("key_for_utility_string", "1");
 139 }
 140
 141 // Verifies that the test parameter value is output in the 'value_param'
 142 // XML attribute for value-parameterized tests.
 143 class ValueParamTest : public TestWithParam<int> {};
 144 TEST_P(ValueParamTest, HasValueParamAttribute) {}
 145 TEST_P(ValueParamTest, AnotherTestThatHasValueParamAttribute) {}
 146 INSTANTIATE_TEST_CASE_P(Single, ValueParamTest, Values(33, 42));
 147
 148 #if GTEST_HAS_TYPED_TEST
 149 // Verifies that the type parameter name is output in the 'type_param'
 150 // XML attribute for typed tests.
 151 template <typename T> class TypedTest : public Test {};
 152 typedef testing::Types<int, long> TypedTestTypes;
 153 TYPED_TEST_CASE(TypedTest, TypedTestTypes);
 154 TYPED_TEST(TypedTest, HasTypeParamAttribute) {}
 155 #endif
 156
 157 #if GTEST_HAS_TYPED_TEST_P
 158 // Verifies that the type parameter name is output in the 'type_param'
 159 // XML attribute for type-parameterized tests.
 160 template <typename T> class TypeParameterizedTestCase : public Test {};
 161 TYPED_TEST_CASE_P(TypeParameterizedTestCase);
 162 TYPED_TEST_P(TypeParameterizedTestCase, HasTypeParamAttribute) {}
 163 REGISTER_TYPED_TEST_CASE_P(TypeParameterizedTestCase, HasTypeParamAttribute);
 164 typedef testing::Types<int, long> TypeParameterizedTestCaseTypes;
 165 INSTANTIATE_TYPED_TEST_CASE_P(Single,
 166                               TypeParameterizedTestCase,
 167                               TypeParameterizedTestCaseTypes);
 168 #endif
 169
 170 int main(int argc, char** argv) {
 171   InitGoogleTest(&argc, argv);
 172
 173   if (argc > 1 && strcmp(argv[1], "--shut_down_xml") == 0) {
 174     TestEventListeners& listeners = UnitTest::GetInstance()->listeners();
 175     delete listeners.Release(listeners.default_xml_generator());
 176   }
 177   testing::Test::RecordProperty("ad_hoc_property", "42");
 178   return RUN_ALL_TESTS();
 179 }