Orxonox  0.0.5 Codename: Arcturus
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),
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 { return file_name_.c_str(); }
77 
78  // Gets the line in the source file where the test part took place,
79  // or -1 if it's unknown.
80  int line_number() const { return line_number_; }
81 
82  // Gets the summary of the failure message.
83  const char* summary() const { return summary_.c_str(); }
84 
85  // Gets the message associated with the test part.
86  const char* message() const { return message_.c_str(); }
87 
88  // Returns true iff the test part passed.
89  bool passed() const { return type_ == kSuccess; }
90 
91  // Returns true iff the test part failed.
92  bool failed() const { return type_ != kSuccess; }
93 
94  // Returns true iff the test part non-fatally failed.
95  bool nonfatally_failed() const { return type_ == kNonFatalFailure; }
96 
97  // Returns true iff the test part fatally failed.
98  bool fatally_failed() const { return type_ == kFatalFailure; }
99  private:
101 
102  // Gets the summary of the failure message by omitting the stack
103  // trace in it.
104  static internal::String ExtractSummary(const char* message);
105 
106  // The name of the source file where the test part took place, or
107  // NULL if the source file is unknown.
109  // The line in the source file where the test part took place, or -1
110  // if the line number is unknown.
112  internal::String summary_; // The test failure summary.
113  internal::String message_; // The test failure message.
114 };
115 
116 // Prints a TestPartResult object.
117 std::ostream& operator<<(std::ostream& os, const TestPartResult& result);
118 
119 // An array of TestPartResult objects.
120 //
121 // Don't inherit from TestPartResultArray as its destructor is not
122 // virtual.
124  public:
126 
127  // Appends the given TestPartResult to the array.
128  void Append(const TestPartResult& result);
129 
130  // Returns the TestPartResult at the given index (0-based).
131  const TestPartResult& GetTestPartResult(int index) const;
132 
133  // Returns the number of TestPartResult objects in the array.
134  int size() const;
135 
136  private:
137  std::vector<TestPartResult> array_;
138 
140 };
141 
142 // This interface knows how to report a test part result.
144  public:
146 
147  virtual void ReportTestPartResult(const TestPartResult& result) = 0;
148 };
149 
150 namespace internal {
151 
152 // This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a
153 // statement generates new fatal failures. To do so it registers itself as the
154 // current test part result reporter. Besides checking if fatal failures were
155 // reported, it only delegates the reporting to the former result reporter.
156 // The original result reporter is restored in the destructor.
157 // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
160  public:
162  virtual ~HasNewFatalFailureHelper();
163  virtual void ReportTestPartResult(const TestPartResult& result);
164  bool has_new_fatal_failure() const { return has_new_fatal_failure_; }
165  private:
168 
170 };
171 
172 } // namespace internal
173 
174 } // namespace testing
175 
176 #endif // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_
Definition: gtest-test-part.h:143
const char * message() const
Definition: gtest-test-part.h:86
Definition: gmock-actions.h:49
const char * file_name() const
Definition: gtest-test-part.h:76
internal::String summary_
Definition: gtest-test-part.h:112
TestPartResultReporterInterface * original_reporter_
Definition: gtest-test-part.h:167
#define GTEST_API_
Definition: gtest-port.h:662
Definition: gtest-test-part.h:47
Output level, used for messages directed to the user (e.g. "Press any key to continue") ...
Definition: OutputDefinitions.h:89
std::ostream & operator<<(std::ostream &os, const Message &sb)
Definition: gtest-message.h:224
Definition: gtest-test-part.h:158
bool nonfatally_failed() const
Definition: gtest-test-part.h:95
bool passed() const
Definition: gtest-test-part.h:89
bool failed() const
Definition: gtest-test-part.h:92
bool has_new_fatal_failure_
Definition: gtest-test-part.h:166
Definition: gtest-string.h:81
const char * summary() const
Definition: gtest-test-part.h:83
virtual ~TestPartResultReporterInterface()
Definition: gtest-test-part.h:145
bool has_new_fatal_failure() const
Definition: gtest-test-part.h:164
Definition: gtest-test-part.h:52
Definition: gtest-test-part.h:53
bool fatally_failed() const
Definition: gtest-test-part.h:98
std::vector< TestPartResult > array_
Definition: gtest-test-part.h:137
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)
Definition: gtest-port.h:620
int line_number_
Definition: gtest-test-part.h:111
internal::String message_
Definition: gtest-test-part.h:113
TestPartResult(Type a_type, const char *a_file_name, int a_line_number, const char *a_message)
Definition: gtest-test-part.h:60
int line_number() const
Definition: gtest-test-part.h:80
Definition: gtest-test-part.h:123
internal::String file_name_
Definition: gtest-test-part.h:108
Type
Definition: gtest-test-part.h:51
Type type_
Definition: gtest-test-part.h:100
TestPartResultArray()
Definition: gtest-test-part.h:125
Type type() const
Definition: gtest-test-part.h:72