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