1f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// Copyright 2008, Google Inc. 2f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// All rights reserved. 3f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 4f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// Redistribution and use in source and binary forms, with or without 5f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// modification, are permitted provided that the following conditions are 6f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// met: 7f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 8f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// * Redistributions of source code must retain the above copyright 9f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// notice, this list of conditions and the following disclaimer. 10f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// * Redistributions in binary form must reproduce the above 11f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// copyright notice, this list of conditions and the following disclaimer 12f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// in the documentation and/or other materials provided with the 13f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// distribution. 14f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// * Neither the name of Google Inc. nor the names of its 15f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// contributors may be used to endorse or promote products derived from 16f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// this software without specific prior written permission. 17f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 18f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 30f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// Author: mheule@google.com (Markus Heule) 31f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 32f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 33f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#ifndef GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 34f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#define GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 35f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 36f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#include <iosfwd> 37f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#include <vector> 38f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#include "gtest/internal/gtest-internal.h" 39f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#include "gtest/internal/gtest-string.h" 40f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 41f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochnamespace testing { 42f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 43f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// A copyable object representing the result of a test part (i.e. an 44f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()). 45f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 46f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// Don't inherit from TestPartResult as its destructor is not virtual. 47f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochclass GTEST_API_ TestPartResult { 48f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch public: 49f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // The possible outcomes of a test part (i.e. an assertion or an 50f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // explicit SUCCEED(), FAIL(), or ADD_FAILURE()). 51f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch enum Type { 52f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch kSuccess, // Succeeded. 53f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch kNonFatalFailure, // Failed but the test can continue. 54f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch kFatalFailure // Failed and the test should be terminated. 55f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch }; 56f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 57f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // C'tor. TestPartResult does NOT have a default constructor. 58f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Always use this constructor (with parameters) to create a 59f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // TestPartResult object. 60f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch TestPartResult(Type a_type, 61f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch const char* a_file_name, 62f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch int a_line_number, 63f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch const char* a_message) 64f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch : type_(a_type), 65f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch file_name_(a_file_name == NULL ? "" : a_file_name), 66f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch line_number_(a_line_number), 67f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch summary_(ExtractSummary(a_message)), 68f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch message_(a_message) { 69f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch } 70f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 71f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Gets the outcome of the test part. 72f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch Type type() const { return type_; } 73f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 74f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Gets the name of the source file where the test part took place, or 75f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // NULL if it's unknown. 76f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch const char* file_name() const { 77f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch return file_name_.empty() ? NULL : file_name_.c_str(); 78f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch } 79f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 80f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Gets the line in the source file where the test part took place, 81f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // or -1 if it's unknown. 82f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch int line_number() const { return line_number_; } 83f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 84f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Gets the summary of the failure message. 85f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch const char* summary() const { return summary_.c_str(); } 86f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 87f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Gets the message associated with the test part. 88f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch const char* message() const { return message_.c_str(); } 89f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 90f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Returns true iff the test part passed. 91f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch bool passed() const { return type_ == kSuccess; } 92f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 93f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Returns true iff the test part failed. 94f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch bool failed() const { return type_ != kSuccess; } 95f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 96f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Returns true iff the test part non-fatally failed. 97f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch bool nonfatally_failed() const { return type_ == kNonFatalFailure; } 98f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 99f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Returns true iff the test part fatally failed. 100f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch bool fatally_failed() const { return type_ == kFatalFailure; } 101f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 102f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch private: 103f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch Type type_; 104f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 105f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Gets the summary of the failure message by omitting the stack 106f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // trace in it. 107f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch static std::string ExtractSummary(const char* message); 108f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 109f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // The name of the source file where the test part took place, or 110f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // "" if the source file is unknown. 111f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch std::string file_name_; 112f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // The line in the source file where the test part took place, or -1 113f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // if the line number is unknown. 114f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch int line_number_; 115f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch std::string summary_; // The test failure summary. 116f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch std::string message_; // The test failure message. 117f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch}; 118f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 119f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// Prints a TestPartResult object. 120f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochstd::ostream& operator<<(std::ostream& os, const TestPartResult& result); 121f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 122f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// An array of TestPartResult objects. 123f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// 124f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// Don't inherit from TestPartResultArray as its destructor is not 125f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// virtual. 126f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochclass GTEST_API_ TestPartResultArray { 127f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch public: 128f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch TestPartResultArray() {} 129f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 130f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Appends the given TestPartResult to the array. 131f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch void Append(const TestPartResult& result); 132f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 133f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Returns the TestPartResult at the given index (0-based). 134f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch const TestPartResult& GetTestPartResult(int index) const; 135f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 136f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch // Returns the number of TestPartResult objects in the array. 137f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch int size() const; 138f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 139f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch private: 140f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch std::vector<TestPartResult> array_; 141f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 142f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray); 143f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch}; 144f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 145f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// This interface knows how to report a test part result. 146f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochclass TestPartResultReporterInterface { 147f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch public: 148f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch virtual ~TestPartResultReporterInterface() {} 149f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 150f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch virtual void ReportTestPartResult(const TestPartResult& result) = 0; 151f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch}; 152f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 153f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochnamespace internal { 154f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 155f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a 156f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// statement generates new fatal failures. To do so it registers itself as the 157f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// current test part result reporter. Besides checking if fatal failures were 158f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// reported, it only delegates the reporting to the former result reporter. 159f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// The original result reporter is restored in the destructor. 160f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. 161f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdochclass GTEST_API_ HasNewFatalFailureHelper 162f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch : public TestPartResultReporterInterface { 163f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch public: 164f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch HasNewFatalFailureHelper(); 165f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch virtual ~HasNewFatalFailureHelper(); 166f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch virtual void ReportTestPartResult(const TestPartResult& result); 167f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch bool has_new_fatal_failure() const { return has_new_fatal_failure_; } 168f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch private: 169f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch bool has_new_fatal_failure_; 170f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch TestPartResultReporterInterface* original_reporter_; 171f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 172f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper); 173f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch}; 174f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 175f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch} // namespace internal 176f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 177f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch} // namespace testing 178f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch 179f91f0611dbaf29ca0f1d4aecb357ce243a19d2faBen Murdoch#endif // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 180