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