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


fcl
Author(s):
autogenerated on Fri Apr 2 2021 02:38:00