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 <gtest/internal/gtest-internal.h>
38#include <gtest/internal/gtest-string.h>
39
40namespace testing {
41
42// A copyable object representing the result of a test part (i.e. an
43// assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()).
44//
45// Don't inherit from TestPartResult as its destructor is not virtual.
46class TestPartResult {
47 public:
48  // The possible outcomes of a test part (i.e. an assertion or an
49  // explicit SUCCEED(), FAIL(), or ADD_FAILURE()).
50  enum Type {
51    kSuccess,          // Succeeded.
52    kNonFatalFailure,  // Failed but the test can continue.
53    kFatalFailure      // Failed and the test should be terminated.
54  };
55
56  // C'tor.  TestPartResult does NOT have a default constructor.
57  // Always use this constructor (with parameters) to create a
58  // TestPartResult object.
59  TestPartResult(Type type,
60                 const char* file_name,
61                 int line_number,
62                 const char* message)
63      : type_(type),
64        file_name_(file_name),
65        line_number_(line_number),
66        summary_(ExtractSummary(message)),
67        message_(message) {
68  }
69
70  // Gets the outcome of the test part.
71  Type type() const { return type_; }
72
73  // Gets the name of the source file where the test part took place, or
74  // NULL if it's unknown.
75  const char* file_name() const { return file_name_.c_str(); }
76
77  // Gets the line in the source file where the test part took place,
78  // or -1 if it's unknown.
79  int line_number() const { return line_number_; }
80
81  // Gets the summary of the failure message.
82  const char* summary() const { return summary_.c_str(); }
83
84  // Gets the message associated with the test part.
85  const char* message() const { return message_.c_str(); }
86
87  // Returns true iff the test part passed.
88  bool passed() const { return type_ == kSuccess; }
89
90  // Returns true iff the test part failed.
91  bool failed() const { return type_ != kSuccess; }
92
93  // Returns true iff the test part non-fatally failed.
94  bool nonfatally_failed() const { return type_ == kNonFatalFailure; }
95
96  // Returns true iff the test part fatally failed.
97  bool fatally_failed() const { return type_ == kFatalFailure; }
98 private:
99  Type type_;
100
101  // Gets the summary of the failure message by omitting the stack
102  // trace in it.
103  static internal::String ExtractSummary(const char* message);
104
105  // The name of the source file where the test part took place, or
106  // NULL if the source file is unknown.
107  internal::String file_name_;
108  // The line in the source file where the test part took place, or -1
109  // if the line number is unknown.
110  int line_number_;
111  internal::String summary_;  // The test failure summary.
112  internal::String message_;  // The test failure message.
113};
114
115// Prints a TestPartResult object.
116std::ostream& operator<<(std::ostream& os, const TestPartResult& result);
117
118// An array of TestPartResult objects.
119//
120// We define this class as we cannot use STL containers when compiling
121// Google Test with MSVC 7.1 and exceptions disabled.
122//
123// Don't inherit from TestPartResultArray as its destructor is not
124// virtual.
125class TestPartResultArray {
126 public:
127  TestPartResultArray();
128  ~TestPartResultArray();
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 private:
139  // Internally we use a Vector to implement the array.
140  internal::Vector<TestPartResult>* const array_;
141
142  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray);
143};
144
145// This interface knows how to report a test part result.
146class TestPartResultReporterInterface {
147 public:
148  virtual ~TestPartResultReporterInterface() {}
149
150  virtual void ReportTestPartResult(const TestPartResult& result) = 0;
151};
152
153namespace 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.
161class HasNewFatalFailureHelper : public TestPartResultReporterInterface {
162 public:
163  HasNewFatalFailureHelper();
164  virtual ~HasNewFatalFailureHelper();
165  virtual void ReportTestPartResult(const TestPartResult& result);
166  bool has_new_fatal_failure() const { return has_new_fatal_failure_; }
167 private:
168  bool has_new_fatal_failure_;
169  TestPartResultReporterInterface* original_reporter_;
170
171  GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper);
172};
173
174}  // namespace internal
175
176}  // namespace testing
177
178#endif  // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_
179