113481Sgiacomo.travaglini@arm.com// Copyright 2008, Google Inc. 213481Sgiacomo.travaglini@arm.com// All rights reserved. 313481Sgiacomo.travaglini@arm.com// 413481Sgiacomo.travaglini@arm.com// Redistribution and use in source and binary forms, with or without 513481Sgiacomo.travaglini@arm.com// modification, are permitted provided that the following conditions are 613481Sgiacomo.travaglini@arm.com// met: 713481Sgiacomo.travaglini@arm.com// 813481Sgiacomo.travaglini@arm.com// * Redistributions of source code must retain the above copyright 913481Sgiacomo.travaglini@arm.com// notice, this list of conditions and the following disclaimer. 1013481Sgiacomo.travaglini@arm.com// * Redistributions in binary form must reproduce the above 1113481Sgiacomo.travaglini@arm.com// copyright notice, this list of conditions and the following disclaimer 1213481Sgiacomo.travaglini@arm.com// in the documentation and/or other materials provided with the 1313481Sgiacomo.travaglini@arm.com// distribution. 1413481Sgiacomo.travaglini@arm.com// * Neither the name of Google Inc. nor the names of its 1513481Sgiacomo.travaglini@arm.com// contributors may be used to endorse or promote products derived from 1613481Sgiacomo.travaglini@arm.com// this software without specific prior written permission. 1713481Sgiacomo.travaglini@arm.com// 1813481Sgiacomo.travaglini@arm.com// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1913481Sgiacomo.travaglini@arm.com// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2013481Sgiacomo.travaglini@arm.com// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2113481Sgiacomo.travaglini@arm.com// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2213481Sgiacomo.travaglini@arm.com// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2313481Sgiacomo.travaglini@arm.com// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2413481Sgiacomo.travaglini@arm.com// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2513481Sgiacomo.travaglini@arm.com// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2613481Sgiacomo.travaglini@arm.com// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2713481Sgiacomo.travaglini@arm.com// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2813481Sgiacomo.travaglini@arm.com// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2913481Sgiacomo.travaglini@arm.com// 3013481Sgiacomo.travaglini@arm.com// Author: mheule@google.com (Markus Heule) 3113481Sgiacomo.travaglini@arm.com// 3213481Sgiacomo.travaglini@arm.com 3313481Sgiacomo.travaglini@arm.com#ifndef GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 3413481Sgiacomo.travaglini@arm.com#define GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 3513481Sgiacomo.travaglini@arm.com 3613481Sgiacomo.travaglini@arm.com#include <iosfwd> 3713481Sgiacomo.travaglini@arm.com#include <vector> 3813481Sgiacomo.travaglini@arm.com#include "gtest/internal/gtest-internal.h" 3913481Sgiacomo.travaglini@arm.com#include "gtest/internal/gtest-string.h" 4013481Sgiacomo.travaglini@arm.com 4113481Sgiacomo.travaglini@arm.comnamespace testing { 4213481Sgiacomo.travaglini@arm.com 4313481Sgiacomo.travaglini@arm.com// A copyable object representing the result of a test part (i.e. an 4413481Sgiacomo.travaglini@arm.com// assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()). 4513481Sgiacomo.travaglini@arm.com// 4613481Sgiacomo.travaglini@arm.com// Don't inherit from TestPartResult as its destructor is not virtual. 4713481Sgiacomo.travaglini@arm.comclass GTEST_API_ TestPartResult { 4813481Sgiacomo.travaglini@arm.com public: 4913481Sgiacomo.travaglini@arm.com // The possible outcomes of a test part (i.e. an assertion or an 5013481Sgiacomo.travaglini@arm.com // explicit SUCCEED(), FAIL(), or ADD_FAILURE()). 5113481Sgiacomo.travaglini@arm.com enum Type { 5213481Sgiacomo.travaglini@arm.com kSuccess, // Succeeded. 5313481Sgiacomo.travaglini@arm.com kNonFatalFailure, // Failed but the test can continue. 5413481Sgiacomo.travaglini@arm.com kFatalFailure // Failed and the test should be terminated. 5513481Sgiacomo.travaglini@arm.com }; 5613481Sgiacomo.travaglini@arm.com 5713481Sgiacomo.travaglini@arm.com // C'tor. TestPartResult does NOT have a default constructor. 5813481Sgiacomo.travaglini@arm.com // Always use this constructor (with parameters) to create a 5913481Sgiacomo.travaglini@arm.com // TestPartResult object. 6013481Sgiacomo.travaglini@arm.com TestPartResult(Type a_type, 6113481Sgiacomo.travaglini@arm.com const char* a_file_name, 6213481Sgiacomo.travaglini@arm.com int a_line_number, 6313481Sgiacomo.travaglini@arm.com const char* a_message) 6413481Sgiacomo.travaglini@arm.com : type_(a_type), 6513481Sgiacomo.travaglini@arm.com file_name_(a_file_name == NULL ? "" : a_file_name), 6613481Sgiacomo.travaglini@arm.com line_number_(a_line_number), 6713481Sgiacomo.travaglini@arm.com summary_(ExtractSummary(a_message)), 6813481Sgiacomo.travaglini@arm.com message_(a_message) { 6913481Sgiacomo.travaglini@arm.com } 7013481Sgiacomo.travaglini@arm.com 7113481Sgiacomo.travaglini@arm.com // Gets the outcome of the test part. 7213481Sgiacomo.travaglini@arm.com Type type() const { return type_; } 7313481Sgiacomo.travaglini@arm.com 7413481Sgiacomo.travaglini@arm.com // Gets the name of the source file where the test part took place, or 7513481Sgiacomo.travaglini@arm.com // NULL if it's unknown. 7613481Sgiacomo.travaglini@arm.com const char* file_name() const { 7713481Sgiacomo.travaglini@arm.com return file_name_.empty() ? NULL : file_name_.c_str(); 7813481Sgiacomo.travaglini@arm.com } 7913481Sgiacomo.travaglini@arm.com 8013481Sgiacomo.travaglini@arm.com // Gets the line in the source file where the test part took place, 8113481Sgiacomo.travaglini@arm.com // or -1 if it's unknown. 8213481Sgiacomo.travaglini@arm.com int line_number() const { return line_number_; } 8313481Sgiacomo.travaglini@arm.com 8413481Sgiacomo.travaglini@arm.com // Gets the summary of the failure message. 8513481Sgiacomo.travaglini@arm.com const char* summary() const { return summary_.c_str(); } 8613481Sgiacomo.travaglini@arm.com 8713481Sgiacomo.travaglini@arm.com // Gets the message associated with the test part. 8813481Sgiacomo.travaglini@arm.com const char* message() const { return message_.c_str(); } 8913481Sgiacomo.travaglini@arm.com 9013481Sgiacomo.travaglini@arm.com // Returns true iff the test part passed. 9113481Sgiacomo.travaglini@arm.com bool passed() const { return type_ == kSuccess; } 9213481Sgiacomo.travaglini@arm.com 9313481Sgiacomo.travaglini@arm.com // Returns true iff the test part failed. 9413481Sgiacomo.travaglini@arm.com bool failed() const { return type_ != kSuccess; } 9513481Sgiacomo.travaglini@arm.com 9613481Sgiacomo.travaglini@arm.com // Returns true iff the test part non-fatally failed. 9713481Sgiacomo.travaglini@arm.com bool nonfatally_failed() const { return type_ == kNonFatalFailure; } 9813481Sgiacomo.travaglini@arm.com 9913481Sgiacomo.travaglini@arm.com // Returns true iff the test part fatally failed. 10013481Sgiacomo.travaglini@arm.com bool fatally_failed() const { return type_ == kFatalFailure; } 10113481Sgiacomo.travaglini@arm.com 10213481Sgiacomo.travaglini@arm.com private: 10313481Sgiacomo.travaglini@arm.com Type type_; 10413481Sgiacomo.travaglini@arm.com 10513481Sgiacomo.travaglini@arm.com // Gets the summary of the failure message by omitting the stack 10613481Sgiacomo.travaglini@arm.com // trace in it. 10713481Sgiacomo.travaglini@arm.com static std::string ExtractSummary(const char* message); 10813481Sgiacomo.travaglini@arm.com 10913481Sgiacomo.travaglini@arm.com // The name of the source file where the test part took place, or 11013481Sgiacomo.travaglini@arm.com // "" if the source file is unknown. 11113481Sgiacomo.travaglini@arm.com std::string file_name_; 11213481Sgiacomo.travaglini@arm.com // The line in the source file where the test part took place, or -1 11313481Sgiacomo.travaglini@arm.com // if the line number is unknown. 11413481Sgiacomo.travaglini@arm.com int line_number_; 11513481Sgiacomo.travaglini@arm.com std::string summary_; // The test failure summary. 11613481Sgiacomo.travaglini@arm.com std::string message_; // The test failure message. 11713481Sgiacomo.travaglini@arm.com}; 11813481Sgiacomo.travaglini@arm.com 11913481Sgiacomo.travaglini@arm.com// Prints a TestPartResult object. 12013481Sgiacomo.travaglini@arm.comstd::ostream& operator<<(std::ostream& os, const TestPartResult& result); 12113481Sgiacomo.travaglini@arm.com 12213481Sgiacomo.travaglini@arm.com// An array of TestPartResult objects. 12313481Sgiacomo.travaglini@arm.com// 12413481Sgiacomo.travaglini@arm.com// Don't inherit from TestPartResultArray as its destructor is not 12513481Sgiacomo.travaglini@arm.com// virtual. 12613481Sgiacomo.travaglini@arm.comclass GTEST_API_ TestPartResultArray { 12713481Sgiacomo.travaglini@arm.com public: 12813481Sgiacomo.travaglini@arm.com TestPartResultArray() {} 12913481Sgiacomo.travaglini@arm.com 13013481Sgiacomo.travaglini@arm.com // Appends the given TestPartResult to the array. 13113481Sgiacomo.travaglini@arm.com void Append(const TestPartResult& result); 13213481Sgiacomo.travaglini@arm.com 13313481Sgiacomo.travaglini@arm.com // Returns the TestPartResult at the given index (0-based). 13413481Sgiacomo.travaglini@arm.com const TestPartResult& GetTestPartResult(int index) const; 13513481Sgiacomo.travaglini@arm.com 13613481Sgiacomo.travaglini@arm.com // Returns the number of TestPartResult objects in the array. 13713481Sgiacomo.travaglini@arm.com int size() const; 13813481Sgiacomo.travaglini@arm.com 13913481Sgiacomo.travaglini@arm.com private: 14013481Sgiacomo.travaglini@arm.com std::vector<TestPartResult> array_; 14113481Sgiacomo.travaglini@arm.com 14213481Sgiacomo.travaglini@arm.com GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray); 14313481Sgiacomo.travaglini@arm.com}; 14413481Sgiacomo.travaglini@arm.com 14513481Sgiacomo.travaglini@arm.com// This interface knows how to report a test part result. 14613481Sgiacomo.travaglini@arm.comclass TestPartResultReporterInterface { 14713481Sgiacomo.travaglini@arm.com public: 14813481Sgiacomo.travaglini@arm.com virtual ~TestPartResultReporterInterface() {} 14913481Sgiacomo.travaglini@arm.com 15013481Sgiacomo.travaglini@arm.com virtual void ReportTestPartResult(const TestPartResult& result) = 0; 15113481Sgiacomo.travaglini@arm.com}; 15213481Sgiacomo.travaglini@arm.com 15313481Sgiacomo.travaglini@arm.comnamespace internal { 15413481Sgiacomo.travaglini@arm.com 15513481Sgiacomo.travaglini@arm.com// This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a 15613481Sgiacomo.travaglini@arm.com// statement generates new fatal failures. To do so it registers itself as the 15713481Sgiacomo.travaglini@arm.com// current test part result reporter. Besides checking if fatal failures were 15813481Sgiacomo.travaglini@arm.com// reported, it only delegates the reporting to the former result reporter. 15913481Sgiacomo.travaglini@arm.com// The original result reporter is restored in the destructor. 16013481Sgiacomo.travaglini@arm.com// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. 16113481Sgiacomo.travaglini@arm.comclass GTEST_API_ HasNewFatalFailureHelper 16213481Sgiacomo.travaglini@arm.com : public TestPartResultReporterInterface { 16313481Sgiacomo.travaglini@arm.com public: 16413481Sgiacomo.travaglini@arm.com HasNewFatalFailureHelper(); 16513481Sgiacomo.travaglini@arm.com virtual ~HasNewFatalFailureHelper(); 16613481Sgiacomo.travaglini@arm.com virtual void ReportTestPartResult(const TestPartResult& result); 16713481Sgiacomo.travaglini@arm.com bool has_new_fatal_failure() const { return has_new_fatal_failure_; } 16813481Sgiacomo.travaglini@arm.com private: 16913481Sgiacomo.travaglini@arm.com bool has_new_fatal_failure_; 17013481Sgiacomo.travaglini@arm.com TestPartResultReporterInterface* original_reporter_; 17113481Sgiacomo.travaglini@arm.com 17213481Sgiacomo.travaglini@arm.com GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper); 17313481Sgiacomo.travaglini@arm.com}; 17413481Sgiacomo.travaglini@arm.com 17513481Sgiacomo.travaglini@arm.com} // namespace internal 17613481Sgiacomo.travaglini@arm.com 17713481Sgiacomo.travaglini@arm.com} // namespace testing 17813481Sgiacomo.travaglini@arm.com 17913481Sgiacomo.travaglini@arm.com#endif // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ 180