/* * 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 { struct ConsoleReporter : StreamingReporterBase { ConsoleReporter( ReporterConfig const& _config ) : StreamingReporterBase( _config ), m_atLeastOneTestCasePrinted( false ) {} 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; } virtual void assertionStarting( AssertionInfo const& ) { } virtual void assertionEnded( AssertionStats const& _assertionStats ) { AssertionResult const& result = _assertionStats.assertionResult; // Drop out if result was successful and we're not printing those if( !m_config.includeSuccessfulResults() && result.isOk() ) return; lazyPrint(); { TextColour colour( TextColour::FileName ); stream << result.getSourceInfo() << ":\n"; } ResultComponents components( result ); bool endsWithNewLine = false; if( _assertionStats.totals.assertions.total() > 0 ) { printOriginalExpression( result ); printResultType( components ); endsWithNewLine = printReconstructedExpression( result ); } endsWithNewLine |= printMessage( components ); if( !endsWithNewLine ) stream << "\n"; stream << std::endl; } struct ResultComponents { ResultComponents( AssertionResult const& _result ) : colour( TextColour::None ), message( _result.getMessage() ) { switch( _result.getResultType() ) { case ResultWas::Ok: colour = TextColour::Success; passOrFail = "passed"; if( _result.hasMessage() ) messageLabel = "with message"; break; case ResultWas::ExpressionFailed: if( _result.isOk() ) { colour = TextColour::Success; passOrFail = "failed - but was ok"; } else { colour = TextColour::Error; passOrFail = "failed"; } if( _result.hasMessage() ){ messageLabel = "with message"; } break; case ResultWas::ThrewException: colour = TextColour::Error; passOrFail = "failed"; messageLabel = "due to unexpected exception with message"; break; case ResultWas::DidntThrowException: colour = TextColour::Error; passOrFail = "failed"; messageLabel = "because no exception was thrown where one was expected"; break; case ResultWas::Info: messageLabel = "info"; break; case ResultWas::Warning: messageLabel = "warning"; break; case ResultWas::ExplicitFailure: passOrFail = "failed"; colour = TextColour::Error; messageLabel = "explicitly with message"; break; case ResultWas::Exception: passOrFail = "failed"; colour = TextColour::Error; if( _result.hasMessage() ) messageLabel = "with message"; break; // These cases are here to prevent compiler warnings case ResultWas::Unknown: case ResultWas::FailureBit: passOrFail = "** internal error **"; colour = TextColour::Error; break; } } TextColour::Colours colour; std::string passOrFail; std::string messageLabel; std::string message; }; void printResultType( ResultComponents const& _components ) { if( !_components.passOrFail.empty() ) { TextColour colour( _components.colour ); stream << _components.passOrFail << " "; } } 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() ) { stream << "with expansion:\n"; TextColour colour( TextColour::ReconstructedExpression ); stream << wrapLongStrings( _result.getExpandedExpression() ) << "\n"; return true; } return false; } bool printMessage( ResultComponents const& _components ) { bool endsWithNewLine = false; if( !_components.messageLabel.empty() ) { stream << _components.messageLabel << ":" << "\n"; endsWithNewLine = true; } if( !_components.message.empty() ) { stream << wrapLongStrings( _components.message ) << "\n"; endsWithNewLine = true; } return endsWithNewLine; } virtual void sectionEnded( SectionStats const& _sectionStats ) { if( _sectionStats.missingAssertions ) { lazyPrint(); TextColour colour( TextColour::ResultError ); stream << "\nNo assertions in section, '" << _sectionStats.sectionInfo.name << "'\n" << std::endl; } StreamingReporterBase::sectionEnded( _sectionStats ); } virtual void testCaseEnded( TestCaseStats const& _testCaseStats ) { if( _testCaseStats.missingAssertions ) { lazyPrint(); TextColour colour( TextColour::ResultError ); stream << "\nNo assertions in test case, '" << _testCaseStats.testInfo.name << "'\n" << std::endl; } StreamingReporterBase::testCaseEnded( _testCaseStats ); } virtual void testGroupEnded( TestGroupStats const& _testGroupStats ) { if( !unusedGroupInfo ) { printSummaryDivider(); stream << "Summary for group '" << _testGroupStats.groupInfo.name << "':\n"; printTotals( _testGroupStats.totals ); stream << "\n" << std::endl; } StreamingReporterBase::testGroupEnded( _testGroupStats ); } virtual void testRunEnded( TestRunStats const& _testRunStats ) { if( m_atLeastOneTestCasePrinted ) printTotalsDivider(); printTotals( _testRunStats.totals ); stream << "\n" << std::endl; StreamingReporterBase::testRunEnded( _testRunStats ); } private: std::string wrapLongStrings( std::string const& _string ) { return Catch::wrapLongStrings( _string, 70, 2 ); } void lazyPrint() { if( testRunInfo ) lazyPrintRunInfo(); if( unusedGroupInfo ) lazyPrintGroupInfo(); if( unusedTestCaseInfo ) lazyPrintTestCaseInfo(); if( unusedSectionInfo) lazyPrintSectionInfo(); m_atLeastOneTestCasePrinted = true; } 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() { if( !currentSectionInfo ) { printHeader( unusedTestCaseInfo->name ); stream << std::endl; unusedTestCaseInfo.reset(); } } void lazyPrintSectionInfo() { std::vector sections; for( ThreadedSectionInfo* section = unusedSectionInfo.get(); section; section = section->parent.get() ) sections.push_back( section ); // Sections if( !sections.empty() ) { printHeader( unusedTestCaseInfo->name, false ); typedef std::vector::const_reverse_iterator It; for( It it = sections.rbegin(), itEnd = sections.rend(); it != itEnd; ++it ) stream << " " << (*it)->name << "\n"; stream << getDashes() << "\n" << std::endl; unusedSectionInfo.reset(); } } void printHeader( std::string const& _name, bool closed = true ) { stream << getDashes() << "\n" << _name << "\n"; if( closed ) stream << getDashes() << "\n"; } void printTotals( const Totals& totals ) { if( totals.assertions.total() == 0 ) { stream << "No tests ran"; } else if( totals.assertions.failed ) { TextColour colour( TextColour::ResultError ); printCounts( "test case", totals.testCases ); if( totals.testCases.failed > 0 ) { stream << " ("; printCounts( "assertion", totals.assertions ); stream << ")"; } } else { TextColour colour( TextColour::ResultSuccess ); stream << "All tests passed (" << pluralise( totals.assertions.passed, "assertion" ) << " in " << pluralise( totals.testCases.passed, "test case" ) << ")"; } } void printCounts( std::string const& label, Counts const& counts ) { 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"; } } } void printTotalsDivider() { stream << getDoubleDashes() << "\n"; } void printSummaryDivider() { stream << getDashes() << "\n"; } static std::string const& getDashes() { static const std::string dashes = "-----------------------------------------------------------------"; return dashes; } static std::string const& getDoubleDashes() { static const std::string doubleDashes = "================================================================="; return doubleDashes; } private: bool m_atLeastOneTestCasePrinted; }; INTERNAL_CATCH_REGISTER_REPORTER( "console", ConsoleReporter ) } // end namespace Catch #endif // TWOBLUECUBES_CATCH_REPORTER_CONSOLE_HPP_INCLUDED