2012-12-05 09:40:53 +01:00
|
|
|
/*
|
|
|
|
* Created by Phil on 5/12/2012.
|
|
|
|
* Copyright 2012 Two Blue Cubes Ltd. All rights reserved.
|
|
|
|
*
|
|
|
|
* Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
|
|
* file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
|
|
*/
|
|
|
|
#ifndef TWOBLUECUBES_CATCH_REPORTER_CONSOLE_HPP_INCLUDED
|
|
|
|
#define TWOBLUECUBES_CATCH_REPORTER_CONSOLE_HPP_INCLUDED
|
|
|
|
|
|
|
|
#include "../internal/catch_interfaces_reporter.h"
|
|
|
|
#include "../internal/catch_reporter_registrars.hpp"
|
|
|
|
#include "../internal/catch_console_colour.hpp"
|
|
|
|
|
|
|
|
namespace Catch {
|
|
|
|
|
2013-01-03 10:04:46 +01:00
|
|
|
struct ConsoleReporter : StreamingReporterBase {
|
2012-12-05 09:40:53 +01:00
|
|
|
ConsoleReporter( ReporterConfig const& _config )
|
2013-01-03 10:04:46 +01:00
|
|
|
: StreamingReporterBase( _config ),
|
2012-12-13 13:46:47 +01:00
|
|
|
m_atLeastOneTestCasePrinted( false )
|
2012-12-05 09:40:53 +01:00
|
|
|
{}
|
|
|
|
|
|
|
|
virtual ~ConsoleReporter();
|
|
|
|
static std::string getDescription() {
|
|
|
|
return "Reports test results as plain lines of text";
|
|
|
|
}
|
|
|
|
virtual ReporterPreferences getPreferences() const {
|
|
|
|
ReporterPreferences prefs;
|
|
|
|
prefs.shouldRedirectStdOut = false;
|
|
|
|
return prefs;
|
|
|
|
|
|
|
|
}
|
2012-12-13 13:46:47 +01:00
|
|
|
|
|
|
|
static std::string const& getDashes() {
|
|
|
|
static const std::string dashes = "----------------------------------------------------------------";
|
|
|
|
return dashes;
|
|
|
|
}
|
|
|
|
static std::string const& getDoubleDashes() {
|
|
|
|
static const std::string doubleDashes = "================================================================";
|
|
|
|
return doubleDashes;
|
|
|
|
}
|
2012-12-14 08:49:18 +01:00
|
|
|
static std::string const& getSpaces() {
|
|
|
|
static const std::string spaces = " ";
|
|
|
|
return spaces;
|
|
|
|
}
|
|
|
|
static std::string getSpaces( int spaces ) {
|
|
|
|
return getSpaces().substr( 0, spaces > 0 ? static_cast<std::size_t>( spaces ) : 0 );
|
|
|
|
}
|
|
|
|
|
2012-12-13 13:46:47 +01:00
|
|
|
void printHeader( std::string const& _type, std::string const& _name ) {
|
2013-01-13 22:51:44 +01:00
|
|
|
stream << getDashes() << "\n"
|
|
|
|
<< _type << ": '" << _name << "'\n"
|
|
|
|
<< getDashes() << std::endl;
|
2012-12-13 13:46:47 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
|
2012-12-05 09:40:53 +01:00
|
|
|
void lazyPrint() {
|
2013-01-13 22:51:44 +01:00
|
|
|
bool needsNewline = unusedTestCaseInfo || ( currentSectionInfo && !currentSectionInfo->printed );
|
|
|
|
if( m_lazyTestCaseStats )
|
|
|
|
lazyPrintTestCaseStats();
|
2012-12-05 09:40:53 +01:00
|
|
|
if( testRunInfo )
|
|
|
|
lazyPrintRunInfo();
|
|
|
|
if( unusedGroupInfo )
|
|
|
|
lazyPrintGroupInfo();
|
|
|
|
if( unusedTestCaseInfo )
|
|
|
|
lazyPrintTestCaseInfo();
|
2012-12-09 12:20:46 +01:00
|
|
|
if( currentSectionInfo && !currentSectionInfo->printed )
|
2012-12-10 09:54:57 +01:00
|
|
|
lazyPrintSectionInfo();
|
2013-01-13 22:51:44 +01:00
|
|
|
if( needsNewline )
|
|
|
|
stream << "\n";
|
|
|
|
|
2012-12-05 09:40:53 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
void lazyPrintTestCaseStats() {
|
|
|
|
printTestCaseStats( *m_lazyTestCaseStats );
|
|
|
|
m_lazyTestCaseStats.reset();
|
|
|
|
}
|
|
|
|
void lazyPrintRunInfo() {
|
|
|
|
stream << "\n" << testRunInfo->name
|
|
|
|
<< " is a CATCH v" << libraryVersion.majorVersion << "."
|
|
|
|
<< libraryVersion.minorVersion << " b"
|
|
|
|
<< libraryVersion.buildNumber;
|
|
|
|
if( libraryVersion.branchName != "master" )
|
|
|
|
stream << " (" << libraryVersion.branchName << ")";
|
|
|
|
stream << " host application.\n"
|
|
|
|
<< "Run with -? for options\n\n";
|
|
|
|
|
|
|
|
testRunInfo.reset();
|
|
|
|
}
|
|
|
|
void lazyPrintGroupInfo() {
|
|
|
|
if( !unusedGroupInfo->name.empty() && unusedGroupInfo->groupsCounts > 1 ) {
|
|
|
|
printHeader( "Group", unusedGroupInfo->name );
|
|
|
|
unusedGroupInfo.reset();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
void lazyPrintTestCaseInfo() {
|
|
|
|
printHeader( "Test case", unusedTestCaseInfo->name );
|
|
|
|
unusedTestCaseInfo.reset();
|
|
|
|
}
|
|
|
|
void lazyPrintSectionInfo() {
|
|
|
|
std::vector<ThreadedSectionInfo*> sections;
|
|
|
|
for( ThreadedSectionInfo* section = unusedSectionInfo.get();
|
|
|
|
section && !section->printed;
|
|
|
|
section = section->parent.get() )
|
|
|
|
sections.push_back( section );
|
|
|
|
|
|
|
|
typedef std::vector<ThreadedSectionInfo*>::const_reverse_iterator It;
|
|
|
|
for( It it = sections.rbegin(), itEnd = sections.rend(); it != itEnd; ++it ) {
|
|
|
|
printHeader( "Section", (*it)->name );
|
|
|
|
(*it)->printed = true;
|
|
|
|
}
|
|
|
|
unusedSectionInfo.reset();
|
|
|
|
}
|
|
|
|
|
2012-12-09 12:20:46 +01:00
|
|
|
virtual void assertionStarting( AssertionInfo const& ) {
|
2012-12-05 09:40:53 +01:00
|
|
|
}
|
|
|
|
|
2013-01-13 22:51:44 +01:00
|
|
|
virtual void assertionEnded( AssertionStats const& _assertionStats ) {
|
2013-01-03 10:04:46 +01:00
|
|
|
AssertionResult const& result = _assertionStats.assertionResult;
|
2012-12-09 12:20:46 +01:00
|
|
|
|
|
|
|
// Drop out if result was successful and we're not printing those
|
|
|
|
if( !m_config.includeSuccessfulResults() && result.isOk() )
|
|
|
|
return;
|
2013-01-13 22:51:44 +01:00
|
|
|
|
2012-12-09 12:20:46 +01:00
|
|
|
lazyPrint();
|
|
|
|
|
2013-01-13 22:51:44 +01:00
|
|
|
{
|
|
|
|
TextColour colour( TextColour::FileName );
|
|
|
|
stream << result.getSourceInfo() << ":\n";
|
2012-12-09 12:20:46 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
|
2013-01-14 09:34:50 +01:00
|
|
|
bool endsWithNewLine = false;
|
2013-01-13 22:51:44 +01:00
|
|
|
if( _assertionStats.totals.assertions.total() > 0 ) {
|
2013-01-14 09:34:50 +01:00
|
|
|
endsWithNewLine = printOriginalExpression( result );
|
|
|
|
endsWithNewLine = printResultType( result );
|
|
|
|
endsWithNewLine |= printReconstructedExpression( result );
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
2013-01-14 09:34:50 +01:00
|
|
|
endsWithNewLine |= printMessage( result );
|
|
|
|
if( !endsWithNewLine )
|
|
|
|
stream << "\n";
|
2013-01-13 22:51:44 +01:00
|
|
|
stream << std::endl;
|
|
|
|
}
|
|
|
|
|
2013-01-14 09:34:50 +01:00
|
|
|
bool printResultType( AssertionResult const& _result ) {
|
2013-01-14 19:36:25 +01:00
|
|
|
if( _result.getResultType() == ResultWas::Info ||
|
|
|
|
_result.getResultType() == ResultWas::Warning ) {
|
|
|
|
}
|
|
|
|
else if( _result.succeeded() ) {
|
2013-01-13 22:51:44 +01:00
|
|
|
TextColour successColour( TextColour::Success );
|
2013-01-14 19:36:25 +01:00
|
|
|
stream << "passed ";
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
|
|
|
else if( _result.isOk() ) {
|
|
|
|
TextColour okAnywayColour( TextColour::Success );
|
2013-01-14 19:36:25 +01:00
|
|
|
stream << "failed - but was ok ";
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
|
|
|
else {
|
|
|
|
TextColour errorColour( TextColour::Error );
|
2013-01-14 19:36:25 +01:00
|
|
|
stream << "failed ";
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
2013-01-14 09:34:50 +01:00
|
|
|
return false;
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
2013-01-14 09:34:50 +01:00
|
|
|
bool printOriginalExpression( AssertionResult const& _result ) {
|
|
|
|
if( _result.hasExpression() ) {
|
|
|
|
TextColour colour( TextColour::OriginalExpression );
|
|
|
|
stream << " ";
|
|
|
|
if( !_result.getTestMacroName().empty() )
|
|
|
|
stream << _result.getTestMacroName() << "( ";
|
|
|
|
stream << _result.getExpression();
|
|
|
|
if( !_result.getTestMacroName().empty() )
|
|
|
|
stream << " )";
|
|
|
|
stream << "\n";
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
bool printReconstructedExpression( AssertionResult const& _result ) {
|
|
|
|
if( _result.hasExpandedExpression() ) {
|
2013-01-14 19:36:25 +01:00
|
|
|
stream << "with expansion:\n";
|
2013-01-14 09:34:50 +01:00
|
|
|
TextColour colour( TextColour::ReconstructedExpression );
|
|
|
|
stream << wrapLongStrings( _result.getExpandedExpression() ) << "\n";
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
bool printMessage( AssertionResult const& _result ) {
|
2013-01-13 22:51:44 +01:00
|
|
|
std::pair<std::string, std::string> message = getMessage( _result );
|
2013-01-14 09:34:50 +01:00
|
|
|
bool endsWithNewLine = false;
|
|
|
|
if( !message.first.empty() ) {
|
2013-01-14 19:36:25 +01:00
|
|
|
stream << message.first << ":" << "\n";
|
2013-01-14 09:34:50 +01:00
|
|
|
endsWithNewLine = true;
|
|
|
|
}
|
|
|
|
if( !message.second.empty() ) {
|
|
|
|
stream << wrapLongStrings( message.second ) << "\n";
|
|
|
|
endsWithNewLine = true;
|
|
|
|
}
|
|
|
|
return endsWithNewLine;
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
|
|
|
std::pair<std::string, std::string> getMessage( AssertionResult const& _result ) {
|
|
|
|
switch( _result.getResultType() ) {
|
2012-12-09 12:20:46 +01:00
|
|
|
case ResultWas::ThrewException:
|
2013-01-13 22:51:44 +01:00
|
|
|
return std::make_pair( "due to unexpected exception with message", _result.getMessage() );
|
2012-12-09 12:20:46 +01:00
|
|
|
case ResultWas::DidntThrowException:
|
2013-01-13 22:51:44 +01:00
|
|
|
return std::make_pair( "because no exception was thrown where one was expected", "" );
|
2012-12-09 12:20:46 +01:00
|
|
|
case ResultWas::Info:
|
2013-01-14 19:36:25 +01:00
|
|
|
return std::make_pair( "info", _result.getMessage() );
|
2012-12-09 12:20:46 +01:00
|
|
|
case ResultWas::Warning:
|
2013-01-14 19:36:25 +01:00
|
|
|
return std::make_pair( "warning", _result.getMessage() );
|
2012-12-09 12:20:46 +01:00
|
|
|
case ResultWas::ExplicitFailure:
|
2013-01-13 22:51:44 +01:00
|
|
|
return std::make_pair( "explicitly with message", _result.getMessage() );
|
|
|
|
|
2012-12-09 12:20:46 +01:00
|
|
|
case ResultWas::Unknown: // These cases are here to prevent compiler warnings
|
|
|
|
case ResultWas::Ok:
|
|
|
|
case ResultWas::FailureBit:
|
|
|
|
case ResultWas::ExpressionFailed:
|
|
|
|
case ResultWas::Exception:
|
2013-01-13 22:51:44 +01:00
|
|
|
if( _result.hasMessage() )
|
|
|
|
return std::make_pair( "with message", _result.getMessage() );
|
|
|
|
else
|
|
|
|
return std::make_pair( "", "" );
|
2012-12-09 12:20:46 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
}
|
2012-12-09 12:20:46 +01:00
|
|
|
|
2013-01-13 22:51:44 +01:00
|
|
|
std::string wrapLongStrings( std::string const& _string ) {
|
|
|
|
return Catch::wrapLongStrings( _string, 70, 2 );
|
2012-12-09 12:20:46 +01:00
|
|
|
}
|
|
|
|
|
2013-01-13 22:51:44 +01:00
|
|
|
void printCounts( std::string const& label, Counts const& counts ) {
|
2012-12-11 09:27:21 +01:00
|
|
|
if( counts.total() == 1 ) {
|
|
|
|
stream << "1 " << label << " - ";
|
|
|
|
if( counts.failed )
|
|
|
|
stream << "failed";
|
|
|
|
else
|
|
|
|
stream << "passed";
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
stream << counts.total() << " " << label << "s ";
|
|
|
|
if( counts.passed ) {
|
|
|
|
if( counts.failed )
|
|
|
|
stream << "- " << counts.failed << " failed";
|
|
|
|
else if( counts.passed == 2 )
|
|
|
|
stream << "- both passed";
|
|
|
|
else
|
|
|
|
stream << "- all passed";
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
if( counts.failed == 2 )
|
|
|
|
stream << "- both failed";
|
|
|
|
else
|
|
|
|
stream << "- all failed";
|
|
|
|
}
|
|
|
|
}
|
2012-12-06 09:44:51 +01:00
|
|
|
}
|
|
|
|
|
2012-12-11 09:27:21 +01:00
|
|
|
void printTotals( const Totals& totals ) {
|
2012-12-06 09:44:51 +01:00
|
|
|
if( totals.assertions.total() == 0 ) {
|
|
|
|
stream << "No tests ran";
|
|
|
|
}
|
|
|
|
else if( totals.assertions.failed ) {
|
|
|
|
TextColour colour( TextColour::ResultError );
|
2013-01-13 22:51:44 +01:00
|
|
|
printCounts( "test case", totals.testCases );
|
2012-12-06 09:44:51 +01:00
|
|
|
if( totals.testCases.failed > 0 ) {
|
|
|
|
stream << " (";
|
2013-01-13 22:51:44 +01:00
|
|
|
printCounts( "assertion", totals.assertions );
|
2012-12-06 09:44:51 +01:00
|
|
|
stream << ")";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
TextColour colour( TextColour::ResultSuccess );
|
2012-12-11 09:27:21 +01:00
|
|
|
stream << "All tests passed ("
|
2012-12-06 09:44:51 +01:00
|
|
|
<< pluralise( totals.assertions.passed, "assertion" ) << " in "
|
|
|
|
<< pluralise( totals.testCases.passed, "test case" ) << ")";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-01-03 10:04:46 +01:00
|
|
|
virtual void sectionEnded( SectionStats const& _sectionStats ) {
|
|
|
|
if( _sectionStats.missingAssertions ) {
|
2012-12-09 12:20:46 +01:00
|
|
|
lazyPrint();
|
|
|
|
TextColour colour( TextColour::ResultError );
|
2013-01-03 10:04:46 +01:00
|
|
|
stream << "\nNo assertions in section, '" << _sectionStats.sectionInfo.name << "'\n" << std::endl;
|
2012-12-09 12:20:46 +01:00
|
|
|
}
|
2013-01-03 10:04:46 +01:00
|
|
|
StreamingReporterBase::sectionEnded( _sectionStats );
|
2012-12-05 09:40:53 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
void printTestCaseStats( TestCaseStats const& _testCaseStats ) {
|
|
|
|
m_atLeastOneTestCasePrinted = true;
|
|
|
|
}
|
|
|
|
|
2013-01-03 10:04:46 +01:00
|
|
|
virtual void testCaseEnded( TestCaseStats const& _testCaseStats ) {
|
2013-01-13 22:51:44 +01:00
|
|
|
|
2013-01-03 10:04:46 +01:00
|
|
|
if( _testCaseStats.missingAssertions ) {
|
2012-12-09 12:20:46 +01:00
|
|
|
lazyPrint();
|
|
|
|
TextColour colour( TextColour::ResultError );
|
2013-01-03 10:04:46 +01:00
|
|
|
stream << "\nNo assertions in test case, '" << _testCaseStats.testInfo.name << "'\n" << std::endl;
|
2012-12-09 12:20:46 +01:00
|
|
|
}
|
2012-12-05 09:40:53 +01:00
|
|
|
if( !unusedTestCaseInfo ) {
|
2013-01-13 22:51:44 +01:00
|
|
|
if( m_atLeastOneTestCasePrinted )
|
|
|
|
printTestCaseStats( _testCaseStats );
|
|
|
|
else
|
|
|
|
m_lazyTestCaseStats = _testCaseStats;
|
2012-12-05 09:40:53 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
|
2013-01-03 10:04:46 +01:00
|
|
|
StreamingReporterBase::testCaseEnded( _testCaseStats );
|
2012-12-05 09:40:53 +01:00
|
|
|
}
|
2013-01-03 10:04:46 +01:00
|
|
|
virtual void testGroupEnded( TestGroupStats const& _testGroupStats ) {
|
2012-12-09 12:20:46 +01:00
|
|
|
if( !unusedGroupInfo ) {
|
2013-01-13 22:51:44 +01:00
|
|
|
printSummaryDivider();
|
2013-01-03 10:04:46 +01:00
|
|
|
stream << "Summary for group '" << _testGroupStats.groupInfo.name << "':\n";
|
|
|
|
printTotals( _testGroupStats.totals );
|
2012-12-13 13:46:47 +01:00
|
|
|
stream << "\n" << std::endl;
|
2012-12-09 12:20:46 +01:00
|
|
|
}
|
2013-01-03 10:04:46 +01:00
|
|
|
StreamingReporterBase::testGroupEnded( _testGroupStats );
|
2012-12-06 09:44:51 +01:00
|
|
|
}
|
2013-01-03 10:04:46 +01:00
|
|
|
virtual void testRunEnded( TestRunStats const& _testRunStats ) {
|
2012-12-13 13:46:47 +01:00
|
|
|
if( m_atLeastOneTestCasePrinted )
|
|
|
|
printTotalsDivider();
|
2013-01-13 22:51:44 +01:00
|
|
|
// stream << "Summary for all tests in '" << _testRunStats.runInfo.name << "':\n";
|
2013-01-03 10:04:46 +01:00
|
|
|
printTotals( _testRunStats.totals );
|
2012-12-13 13:46:47 +01:00
|
|
|
stream << "\n" << std::endl;
|
2013-01-03 10:04:46 +01:00
|
|
|
StreamingReporterBase::testRunEnded( _testRunStats );
|
2012-12-06 09:44:51 +01:00
|
|
|
}
|
|
|
|
|
2012-12-13 13:46:47 +01:00
|
|
|
private:
|
|
|
|
void printTotalsDivider() {
|
2013-01-13 22:51:44 +01:00
|
|
|
stream << getDoubleDashes() << "\n";
|
2012-12-13 13:46:47 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
void printSummaryDivider() {
|
|
|
|
stream << getDashes() << "\n";
|
2012-12-11 10:02:31 +01:00
|
|
|
}
|
2013-01-13 22:51:44 +01:00
|
|
|
|
|
|
|
private:
|
2012-12-13 13:46:47 +01:00
|
|
|
bool m_atLeastOneTestCasePrinted;
|
2013-01-13 22:51:44 +01:00
|
|
|
Option<TestCaseStats> m_lazyTestCaseStats;
|
2012-12-11 10:02:31 +01:00
|
|
|
|
2012-12-05 09:40:53 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
INTERNAL_CATCH_REGISTER_REPORTER( "console", ConsoleReporter )
|
|
|
|
|
|
|
|
} // end namespace Catch
|
|
|
|
|
|
|
|
#endif // TWOBLUECUBES_CATCH_REPORTER_CONSOLE_HPP_INCLUDED
|