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 // GOOGLETEST_CM0001 DO NOT DELETE 31 32 #ifndef GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 33 #define GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 34 35 #include <iosfwd> 36 #include <vector> 37 #include "gtest/internal/gtest-internal.h" 38 #include "gtest/internal/gtest-string.h" 39 40 GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \ 41 /* class A needs to have dll-interface to be used by clients of class B */) 42 43 namespace testing { 44 45 // A copyable object representing the result of a test part (i.e. an 46 // assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()). 47 // 48 // Don't inherit from TestPartResult as its destructor is not virtual. 49 class GTEST_API_ TestPartResult { 50 public: 51 // The possible outcomes of a test part (i.e. an assertion or an 52 // explicit SUCCEED(), FAIL(), or ADD_FAILURE()). 53 enum Type { 54 kSuccess, // Succeeded. 55 kNonFatalFailure, // Failed but the test can continue. 56 kFatalFailure, // Failed and the test should be terminated. 57 kSkip // Skipped. 58 }; 59 60 // C'tor. TestPartResult does NOT have a default constructor. 61 // Always use this constructor (with parameters) to create a 62 // TestPartResult object. 63 TestPartResult(Type a_type, 64 const char* a_file_name, 65 int a_line_number, 66 const char* a_message) 67 : type_(a_type), 68 file_name_(a_file_name == NULL ? "" : a_file_name), 69 line_number_(a_line_number), 70 summary_(ExtractSummary(a_message)), 71 message_(a_message) { 72 } 73 74 // Gets the outcome of the test part. 75 Type type() const { return type_; } 76 77 // Gets the name of the source file where the test part took place, or 78 // NULL if it's unknown. 79 const char* file_name() const { 80 return file_name_.empty() ? NULL : file_name_.c_str(); 81 } 82 83 // Gets the line in the source file where the test part took place, 84 // or -1 if it's unknown. 85 int line_number() const { return line_number_; } 86 87 // Gets the summary of the failure message. 88 const char* summary() const { return summary_.c_str(); } 89 90 // Gets the message associated with the test part. 91 const char* message() const { return message_.c_str(); } 92 93 // Returns true iff the test part was skipped. 94 bool skipped() const { return type_ == kSkip; } 95 96 // Returns true iff the test part passed. 97 bool passed() const { return type_ == kSuccess; } 98 99 // Returns true iff the test part non-fatally failed. 100 bool nonfatally_failed() const { return type_ == kNonFatalFailure; } 101 102 // Returns true iff the test part fatally failed. 103 bool fatally_failed() const { return type_ == kFatalFailure; } 104 105 // Returns true iff the test part failed. 106 bool failed() const { return fatally_failed() || nonfatally_failed(); } 107 108 private: 109 Type type_; 110 111 // Gets the summary of the failure message by omitting the stack 112 // trace in it. 113 static std::string ExtractSummary(const char* message); 114 115 // The name of the source file where the test part took place, or 116 // "" if the source file is unknown. 117 std::string file_name_; 118 // The line in the source file where the test part took place, or -1 119 // if the line number is unknown. 120 int line_number_; 121 std::string summary_; // The test failure summary. 122 std::string message_; // The test failure message. 123 }; 124 125 // Prints a TestPartResult object. 126 std::ostream& operator<<(std::ostream& os, const TestPartResult& result); 127 128 // An array of TestPartResult objects. 129 // 130 // Don't inherit from TestPartResultArray as its destructor is not 131 // virtual. 132 class GTEST_API_ TestPartResultArray { 133 public: 134 TestPartResultArray() {} 135 136 // Appends the given TestPartResult to the array. 137 void Append(const TestPartResult& result); 138 139 // Returns the TestPartResult at the given index (0-based). 140 const TestPartResult& GetTestPartResult(int index) const; 141 142 // Returns the number of TestPartResult objects in the array. 143 int size() const; 144 145 private: 146 std::vector<TestPartResult> array_; 147 148 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray); 149 }; 150 151 // This interface knows how to report a test part result. 152 class GTEST_API_ TestPartResultReporterInterface { 153 public: 154 virtual ~TestPartResultReporterInterface() {} 155 156 virtual void ReportTestPartResult(const TestPartResult& result) = 0; 157 }; 158 159 namespace internal { 160 161 // This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a 162 // statement generates new fatal failures. To do so it registers itself as the 163 // current test part result reporter. Besides checking if fatal failures were 164 // reported, it only delegates the reporting to the former result reporter. 165 // The original result reporter is restored in the destructor. 166 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. 167 class GTEST_API_ HasNewFatalFailureHelper 168 : public TestPartResultReporterInterface { 169 public: 170 HasNewFatalFailureHelper(); 171 virtual ~HasNewFatalFailureHelper(); 172 virtual void ReportTestPartResult(const TestPartResult& result); 173 bool has_new_fatal_failure() const { return has_new_fatal_failure_; } 174 private: 175 bool has_new_fatal_failure_; 176 TestPartResultReporterInterface* original_reporter_; 177 178 GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper); 179 }; 180 181 } // namespace internal 182 183 } // namespace testing 184 185 GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251 186 187 #endif // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 188