catch2/include/reporters/catch_reporter_basic.hpp

437 lines
15 KiB
C++
Raw Normal View History

2010-11-10 00:24:00 +01:00
/*
* catch_reporter_basic.hpp
* Catch
*
* Created by Phil on 28/10/2010.
* Copyright 2010 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_BASIC_HPP_INCLUDED
#define TWOBLUECUBES_CATCH_REPORTER_BASIC_HPP_INCLUDED
#include "../internal/catch_capture.hpp"
#include "../internal/catch_interfaces_reporter.h"
#include "../internal/catch_reporter_registrars.hpp"
#include "../internal/catch_console_colour.hpp"
2010-11-10 00:24:00 +01:00
namespace Catch
{
struct pluralise
{
pluralise( std::size_t count, const std::string& label )
: m_count( count ),
m_label( label )
{}
friend std::ostream& operator << ( std::ostream& os, const pluralise& pluraliser )
{
os << pluraliser.m_count << " " << pluraliser.m_label;
if( pluraliser.m_count != 1 )
os << "s";
return os;
}
std::size_t m_count;
std::string m_label;
};
class BasicReporter : public IReporter
2010-11-10 00:24:00 +01:00
{
struct SpanInfo
{
SpanInfo()
: emitted( false )
{}
SpanInfo( const std::string& spanName )
: name( spanName ),
emitted( false )
{}
SpanInfo( const SpanInfo& other )
: name( other.name ),
emitted( other.emitted )
{}
std::string name;
bool emitted;
};
2010-11-10 00:24:00 +01:00
public:
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
BasicReporter
(
const IReporterConfig& config
)
: m_config( config ),
m_firstSectionInTestCase( true )
2010-11-10 00:24:00 +01:00
{
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
static std::string getDescription
()
2010-11-10 00:24:00 +01:00
{
return "Reports test results as lines of text";
}
private:
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
void ReportCounts
(
const std::string& label,
const Counts& counts
2011-01-14 09:30:17 +01:00
)
{
if( counts.passed )
m_config.stream() << counts.failed << " of " << counts.total() << " " << label << "s failed";
else
m_config.stream() << ( counts.failed > 1 ? "All " : "" ) << pluralise( counts.failed, label ) << " failed";
}
///////////////////////////////////////////////////////////////////////////
void ReportCounts
(
const Totals& totals
)
{
if( totals.assertions.total() == 0 )
{
m_config.stream() << "No tests ran";
}
else if( totals.assertions.failed )
{
TextColour colour( TextColour::ResultError );
ReportCounts( "test case", totals.testCases );
if( totals.testCases.failed > 0 )
{
m_config.stream() << " (";
ReportCounts( "assertion", totals.assertions );
m_config.stream() << ")";
}
}
else
{
TextColour colour( TextColour::ResultSuccess );
m_config.stream() << "All tests passed ("
<< pluralise( totals.assertions.passed, "assertion" ) << " in "
<< pluralise( totals.testCases.passed, "test case" ) << ")";
}
}
private: // IReporter
///////////////////////////////////////////////////////////////////////////
virtual bool shouldRedirectStdout
()
const
{
return false;
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void StartTesting
()
{
m_testingSpan = SpanInfo();
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void EndTesting
(
const Totals& totals
2011-01-14 09:30:17 +01:00
)
{
// Output the overall test results even if "Started Testing" was not emitted
m_config.stream() << "\n[Testing completed. ";
ReportCounts( totals);
2011-03-25 20:09:41 +01:00
m_config.stream() << "]\n" << std::endl;
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void StartGroup
(
const std::string& groupName
)
{
m_groupSpan = groupName;
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void EndGroup
(
const std::string& groupName,
const Totals& totals
2011-01-14 09:30:17 +01:00
)
{
if( m_groupSpan.emitted && !groupName.empty() )
{
m_config.stream() << "[End of group: '" << groupName << "'. ";
ReportCounts( totals );
m_config.stream() << "]\n" << std::endl;
m_groupSpan = SpanInfo();
}
}
2010-11-10 00:24:00 +01:00
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void StartTestCase
(
const TestCaseInfo& testInfo
)
2010-11-10 00:24:00 +01:00
{
m_testSpan = testInfo.getName();
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void StartSection
(
const std::string& sectionName,
const std::string /*description*/
)
{
m_sectionSpans.push_back( SpanInfo( sectionName ) );
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void EndSection
(
const std::string& sectionName,
const Counts& assertions
2011-01-14 09:30:17 +01:00
)
{
SpanInfo& sectionSpan = m_sectionSpans.back();
if( sectionSpan.emitted && !sectionSpan.name.empty() )
{
m_config.stream() << "[End of section: '" << sectionName << "'";
if( assertions.failed )
{
TextColour colour( TextColour::ResultError );
ReportCounts( "assertion", assertions);
}
else
{
TextColour colour( TextColour::ResultSuccess );
m_config.stream() << ( assertions.passed > 1 ? "All " : "" )
<< pluralise( assertions.passed, "assertion" ) << "passed" ;
}
m_config.stream() << "]\n" << std::endl;
}
m_sectionSpans.pop_back();
2010-11-10 00:24:00 +01:00
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void Result
(
const ResultInfo& resultInfo
)
2010-11-10 00:24:00 +01:00
{
2010-12-27 23:05:13 +01:00
if( !m_config.includeSuccessfulResults() && resultInfo.getResultType() == ResultWas::Ok )
2010-11-10 00:24:00 +01:00
return;
StartSpansLazily();
2010-11-10 00:24:00 +01:00
if( !resultInfo.getFilename().empty() )
{
TextColour colour( TextColour::FileName );
m_config.stream() << SourceLineInfo( resultInfo.getFilename(), resultInfo.getLine() );
}
2010-11-10 00:24:00 +01:00
if( resultInfo.hasExpression() )
{
TextColour colour( TextColour::OriginalExpression );
2010-11-10 00:24:00 +01:00
m_config.stream() << resultInfo.getExpression();
if( resultInfo.ok() )
{
TextColour colour( TextColour::Success );
2010-11-10 00:24:00 +01:00
m_config.stream() << " succeeded";
}
2010-11-10 00:24:00 +01:00
else
{
TextColour colour( TextColour::Error );
2010-11-10 00:24:00 +01:00
m_config.stream() << " failed";
}
2010-11-10 00:24:00 +01:00
}
switch( resultInfo.getResultType() )
{
case ResultWas::ThrewException:
{
TextColour colour( TextColour::Error );
2010-11-10 00:24:00 +01:00
if( resultInfo.hasExpression() )
m_config.stream() << " with unexpected";
else
m_config.stream() << "Unexpected";
m_config.stream() << " exception with message: '" << resultInfo.getMessage() << "'";
}
2010-11-10 00:24:00 +01:00
break;
2011-03-14 20:21:35 +01:00
case ResultWas::DidntThrowException:
{
TextColour colour( TextColour::Error );
2011-03-14 20:21:35 +01:00
if( resultInfo.hasExpression() )
m_config.stream() << " because no exception was thrown where one was expected";
else
m_config.stream() << "No exception thrown where one was expected";
}
2011-03-14 20:21:35 +01:00
break;
2010-11-10 00:24:00 +01:00
case ResultWas::Info:
2011-04-11 09:30:47 +02:00
streamVariableLengthText( "info", resultInfo.getMessage() );
2010-11-10 00:24:00 +01:00
break;
case ResultWas::Warning:
m_config.stream() << "warning:\n'" << resultInfo.getMessage() << "'";
2010-11-10 00:24:00 +01:00
break;
case ResultWas::ExplicitFailure:
{
TextColour colour( TextColour::Error );
2010-11-10 00:24:00 +01:00
m_config.stream() << "failed with message: '" << resultInfo.getMessage() << "'";
}
2010-11-10 00:24:00 +01:00
break;
2011-09-29 09:58:40 +02:00
case ResultWas::Unknown: // These cases are here to prevent compiler warnings
case ResultWas::Ok:
case ResultWas::FailureBit:
case ResultWas::ExpressionFailed:
case ResultWas::Exception:
default:
2011-03-14 20:21:35 +01:00
if( !resultInfo.hasExpression() )
{
if( resultInfo.ok() )
{
TextColour colour( TextColour::Success );
2011-03-14 20:21:35 +01:00
m_config.stream() << " succeeded";
}
2011-03-14 20:21:35 +01:00
else
{
TextColour colour( TextColour::Error );
2011-03-14 20:21:35 +01:00
m_config.stream() << " failed";
}
2011-03-14 20:21:35 +01:00
}
break;
2010-11-10 00:24:00 +01:00
}
if( resultInfo.hasExpression() && resultInfo.getExpression() != resultInfo.getExpandedExpression() )
2010-11-10 00:24:00 +01:00
{
m_config.stream() << " for: ";
TextColour colour( TextColour::ReconstructedExpression );
m_config.stream() << resultInfo.getExpandedExpression();
2010-11-10 00:24:00 +01:00
}
m_config.stream() << std::endl;
}
///////////////////////////////////////////////////////////////////////////
2011-01-14 09:30:17 +01:00
virtual void EndTestCase
(
const TestCaseInfo& testInfo,
const Totals& totals,
2011-01-14 09:30:17 +01:00
const std::string& stdOut,
const std::string& stdErr
)
2010-11-10 00:24:00 +01:00
{
if( !stdOut.empty() )
{
StartSpansLazily();
2011-04-11 09:30:47 +02:00
streamVariableLengthText( "stdout", stdOut );
}
if( !stdErr.empty() )
{
StartSpansLazily();
2011-04-11 09:30:47 +02:00
streamVariableLengthText( "stderr", stdErr );
}
if( m_testSpan.emitted )
{
m_config.stream() << "[Finished: '" << testInfo.getName() << "' ";
ReportCounts( totals );
m_config.stream() << "]" << std::endl;
}
2010-11-10 00:24:00 +01:00
}
private: // helpers
///////////////////////////////////////////////////////////////////////////
void StartSpansLazily()
{
if( !m_testingSpan.emitted )
{
if( m_config.getName().empty() )
m_config.stream() << "[Started testing]" << std::endl;
else
m_config.stream() << "[Started testing: " << m_config.getName() << "]" << std::endl;
m_testingSpan.emitted = true;
}
if( !m_groupSpan.emitted && !m_groupSpan.name.empty() )
{
m_config.stream() << "[Started group: '" << m_groupSpan.name << "']" << std::endl;
m_groupSpan.emitted = true;
}
if( !m_testSpan.emitted )
{
m_config.stream() << std::endl << "[Running: " << m_testSpan.name << "]" << std::endl;
m_testSpan.emitted = true;
}
if( !m_sectionSpans.empty() )
{
SpanInfo& sectionSpan = m_sectionSpans.back();
if( !sectionSpan.emitted && !sectionSpan.name.empty() )
{
if( m_firstSectionInTestCase )
{
m_config.stream() << "\n";
m_firstSectionInTestCase = false;
}
std::vector<SpanInfo>::iterator it = m_sectionSpans.begin();
std::vector<SpanInfo>::iterator itEnd = m_sectionSpans.end();
for(; it != itEnd; ++it )
{
SpanInfo& prevSpan = *it;
if( !prevSpan.emitted && !prevSpan.name.empty() )
{
m_config.stream() << "[Started section: '" << prevSpan.name << "']" << std::endl;
prevSpan.emitted = true;
}
}
}
}
}
2011-04-11 09:30:47 +02:00
///////////////////////////////////////////////////////////////////////////
void streamVariableLengthText
(
const std::string& prefix,
const std::string& text
)
{
std::string trimmed = trim( text );
if( trimmed.find_first_of( "\r\n" ) == std::string::npos )
{
m_config.stream() << "[" << prefix << ": " << trimmed << "]\n";
}
else
{
m_config.stream() << "\n[" << prefix << "] >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n" << trimmed
<< "\n[end of " << prefix << "] <<<<<<<<<<<<<<<<<<<<<<<<\n";
2011-04-11 09:30:47 +02:00
}
}
2010-11-10 00:24:00 +01:00
private:
const IReporterConfig& m_config;
bool m_firstSectionInTestCase;
SpanInfo m_testingSpan;
SpanInfo m_groupSpan;
SpanInfo m_testSpan;
std::vector<SpanInfo> m_sectionSpans;
2010-11-10 00:24:00 +01:00
};
INTERNAL_CATCH_REGISTER_REPORTER( "basic", BasicReporter )
2010-11-10 00:24:00 +01:00
} // end namespace Catch
#endif // TWOBLUECUBES_CATCH_REPORTER_BASIC_HPP_INCLUDED