Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorPhil Nash2012-07-20 19:07:42 +0100
committerPhil Nash2012-07-20 19:07:42 +0100
commitd2553cdc641d8b7f051e977a41c4ab6891cdd69a (patch)
treecbfe2203cd6ccf601d856275c56639fd1715f916 /include
parentf606517376c5e3f94e9927afcf2bca0f0005237e (diff)
downloadcatch3-d2553cdc641d8b7f051e977a41c4ab6891cdd69a.tar.gz
Made ReportConfig a value type
Diffstat (limited to 'include')
-rw-r--r--include/catch_runner.hpp7
-rw-r--r--include/internal/catch_config.hpp2
-rw-r--r--include/internal/catch_interfaces_reporter.h24
-rw-r--r--include/internal/catch_reporter_registrars.hpp2
-rw-r--r--include/internal/catch_reporter_registry.hpp2
-rw-r--r--include/reporters/catch_reporter_basic.hpp88
-rw-r--r--include/reporters/catch_reporter_junit.hpp8
-rw-r--r--include/reporters/catch_reporter_xml.hpp12
8 files changed, 78 insertions, 67 deletions
diff --git a/include/catch_runner.hpp b/include/catch_runner.hpp
index 3c8025b3..5debda7c 100644
--- a/include/catch_runner.hpp
+++ b/include/catch_runner.hpp
@@ -25,13 +25,16 @@ namespace Catch {
INTERNAL_CATCH_REGISTER_REPORTER( "basic", BasicReporter )
INTERNAL_CATCH_REGISTER_REPORTER( "xml", XmlReporter )
INTERNAL_CATCH_REGISTER_REPORTER( "junit", JunitReporter )
-
+
inline int Main( Config& config ) {
std::string reporterName = config.data().reporter.empty()
? "basic"
: config.data().reporter;
- Ptr<IReporter> reporter = getCurrentContext().getReporterRegistry().create( reporterName, config );
+
+ ReporterConfig reporterConfig( config.getName(), config.stream(), config.includeSuccessfulResults() );
+
+ Ptr<IReporter> reporter = getCurrentContext().getReporterRegistry().create( reporterName, reporterConfig );
if( !config.data().stream.empty() ) {
if( config.data().stream[0] == '%' )
diff --git a/include/internal/catch_config.hpp b/include/internal/catch_config.hpp
index ee56c1f4..9bb53a07 100644
--- a/include/internal/catch_config.hpp
+++ b/include/internal/catch_config.hpp
@@ -60,7 +60,7 @@ namespace Catch {
};
- class Config : public IReporterConfig, public IConfig {
+ class Config : public IConfig {
private:
Config( const Config& other );
Config& operator = ( const Config& other );
diff --git a/include/internal/catch_interfaces_reporter.h b/include/internal/catch_interfaces_reporter.h
index 47cf1830..7d10f407 100644
--- a/include/internal/catch_interfaces_reporter.h
+++ b/include/internal/catch_interfaces_reporter.h
@@ -18,12 +18,20 @@
namespace Catch
{
- struct IReporterConfig {
- virtual ~IReporterConfig() {}
- virtual std::ostream& stream () const = 0;
- virtual bool includeSuccessfulResults () const = 0;
- virtual std::string getName () const = 0;
- };
+ struct ReporterConfig
+ {
+ ReporterConfig( const std::string& _name,
+ std::ostream& _stream,
+ bool _includeSuccessfulResults = false )
+ : name( _name ),
+ stream( _stream ),
+ includeSuccessfulResults( _includeSuccessfulResults )
+ {}
+
+ std::string name;
+ std::ostream& stream;
+ bool includeSuccessfulResults;
+ };
class TestCaseInfo;
class ResultInfo;
@@ -45,7 +53,7 @@ namespace Catch
struct IReporterFactory {
virtual ~IReporterFactory() {}
- virtual IReporter* create( const IReporterConfig& config ) const = 0;
+ virtual IReporter* create( const ReporterConfig& config ) const = 0;
virtual std::string getDescription() const = 0;
};
@@ -53,7 +61,7 @@ namespace Catch
typedef std::map<std::string, IReporterFactory*> FactoryMap;
virtual ~IReporterRegistry() {}
- virtual IReporter* create( const std::string& name, const IReporterConfig& config ) const = 0;
+ virtual IReporter* create( const std::string& name, const ReporterConfig& config ) const = 0;
virtual void registerReporter( const std::string& name, IReporterFactory* factory ) = 0;
virtual const FactoryMap& getFactories() const = 0;
};
diff --git a/include/internal/catch_reporter_registrars.hpp b/include/internal/catch_reporter_registrars.hpp
index e650cd0c..033f433a 100644
--- a/include/internal/catch_reporter_registrars.hpp
+++ b/include/internal/catch_reporter_registrars.hpp
@@ -17,7 +17,7 @@ namespace Catch {
class ReporterFactory : public IReporterFactory {
- virtual IReporter* create( const IReporterConfig& config ) const {
+ virtual IReporter* create( const ReporterConfig& config ) const {
return new T( config );
}
diff --git a/include/internal/catch_reporter_registry.hpp b/include/internal/catch_reporter_registry.hpp
index bfaffcd5..485cb3bf 100644
--- a/include/internal/catch_reporter_registry.hpp
+++ b/include/internal/catch_reporter_registry.hpp
@@ -22,7 +22,7 @@ namespace Catch {
deleteAllValues( m_factories );
}
- virtual IReporter* create( const std::string& name, const IReporterConfig& config ) const {
+ virtual IReporter* create( const std::string& name, const ReporterConfig& config ) const {
FactoryMap::const_iterator it = m_factories.find( name );
if( it == m_factories.end() )
return NULL;
diff --git a/include/reporters/catch_reporter_basic.hpp b/include/reporters/catch_reporter_basic.hpp
index 57d830a5..87769ee3 100644
--- a/include/reporters/catch_reporter_basic.hpp
+++ b/include/reporters/catch_reporter_basic.hpp
@@ -55,7 +55,7 @@ namespace Catch {
};
public:
- BasicReporter( const IReporterConfig& config )
+ BasicReporter( const ReporterConfig& config )
: m_config( config ),
m_firstSectionInTestCase( true ),
m_aborted( false )
@@ -69,27 +69,27 @@ namespace Catch {
void ReportCounts( const std::string& label, const Counts& counts, const std::string& allPrefix = "All " ) {
if( counts.passed )
- m_config.stream() << counts.failed << " of " << counts.total() << " " << label << "s failed";
+ m_config.stream << counts.failed << " of " << counts.total() << " " << label << "s failed";
else
- m_config.stream() << ( counts.failed > 1 ? allPrefix : "" ) << pluralise( counts.failed, label ) << " failed";
+ m_config.stream << ( counts.failed > 1 ? allPrefix : "" ) << pluralise( counts.failed, label ) << " failed";
}
void ReportCounts( const Totals& totals, const std::string& allPrefix = "All " ) {
if( totals.assertions.total() == 0 ) {
- m_config.stream() << "No tests ran";
+ m_config.stream << "No tests ran";
}
else if( totals.assertions.failed ) {
TextColour colour( TextColour::ResultError );
ReportCounts( "test case", totals.testCases, allPrefix );
if( totals.testCases.failed > 0 ) {
- m_config.stream() << " (";
+ m_config.stream << " (";
ReportCounts( "assertion", totals.assertions, allPrefix );
- m_config.stream() << ")";
+ m_config.stream << ")";
}
}
else {
TextColour colour( TextColour::ResultSuccess );
- m_config.stream() << allPrefix << "tests passed ("
+ m_config.stream << allPrefix << "tests passed ("
<< pluralise( totals.assertions.passed, "assertion" ) << " in "
<< pluralise( totals.testCases.passed, "test case" ) << ")";
}
@@ -112,14 +112,14 @@ namespace Catch {
virtual void EndTesting( const Totals& totals ) {
// Output the overall test results even if "Started Testing" was not emitted
if( m_aborted ) {
- m_config.stream() << "\n[Testing aborted. ";
+ m_config.stream << "\n[Testing aborted. ";
ReportCounts( totals, "The first " );
}
else {
- m_config.stream() << "\n[Testing completed. ";
+ m_config.stream << "\n[Testing completed. ";
ReportCounts( totals );
}
- m_config.stream() << "]\n" << std::endl;
+ m_config.stream << "]\n" << std::endl;
}
virtual void StartGroup( const std::string& groupName ) {
@@ -128,9 +128,9 @@ namespace Catch {
virtual void EndGroup( const std::string& groupName, const Totals& totals ) {
if( m_groupSpan.emitted && !groupName.empty() ) {
- m_config.stream() << "[End of group: '" << groupName << "'. ";
+ m_config.stream << "[End of group: '" << groupName << "'. ";
ReportCounts( totals );
- m_config.stream() << "]\n" << std::endl;
+ m_config.stream << "]\n" << std::endl;
m_groupSpan = SpanInfo();
}
}
@@ -146,7 +146,7 @@ namespace Catch {
virtual void EndSection( const std::string& sectionName, const Counts& assertions ) {
SpanInfo& sectionSpan = m_sectionSpans.back();
if( sectionSpan.emitted && !sectionSpan.name.empty() ) {
- m_config.stream() << "[End of section: '" << sectionName << "' ";
+ m_config.stream << "[End of section: '" << sectionName << "' ";
if( assertions.failed ) {
TextColour colour( TextColour::ResultError );
@@ -154,35 +154,35 @@ namespace Catch {
}
else {
TextColour colour( TextColour::ResultSuccess );
- m_config.stream() << ( assertions.passed > 1 ? "All " : "" )
+ m_config.stream << ( assertions.passed > 1 ? "All " : "" )
<< pluralise( assertions.passed, "assertion" ) << " passed" ;
}
- m_config.stream() << "]\n" << std::endl;
+ m_config.stream << "]\n" << std::endl;
}
m_sectionSpans.pop_back();
}
virtual void Result( const ResultInfo& resultInfo ) {
- if( !m_config.includeSuccessfulResults() && resultInfo.getResultType() == ResultWas::Ok )
+ if( !m_config.includeSuccessfulResults && resultInfo.getResultType() == ResultWas::Ok )
return;
StartSpansLazily();
if( !resultInfo.getFilename().empty() ) {
TextColour colour( TextColour::FileName );
- m_config.stream() << SourceLineInfo( resultInfo.getFilename(), resultInfo.getLine() );
+ m_config.stream << SourceLineInfo( resultInfo.getFilename(), resultInfo.getLine() );
}
if( resultInfo.hasExpression() ) {
TextColour colour( TextColour::OriginalExpression );
- m_config.stream() << resultInfo.getExpression();
+ m_config.stream << resultInfo.getExpression();
if( resultInfo.ok() ) {
TextColour successColour( TextColour::Success );
- m_config.stream() << " succeeded";
+ m_config.stream << " succeeded";
}
else {
TextColour errorColour( TextColour::Error );
- m_config.stream() << " failed";
+ m_config.stream << " failed";
}
}
switch( resultInfo.getResultType() ) {
@@ -190,31 +190,31 @@ namespace Catch {
{
TextColour colour( TextColour::Error );
if( resultInfo.hasExpression() )
- m_config.stream() << " with unexpected";
+ m_config.stream << " with unexpected";
else
- m_config.stream() << "Unexpected";
- m_config.stream() << " exception with message: '" << resultInfo.getMessage() << "'";
+ m_config.stream << "Unexpected";
+ m_config.stream << " exception with message: '" << resultInfo.getMessage() << "'";
}
break;
case ResultWas::DidntThrowException:
{
TextColour colour( TextColour::Error );
if( resultInfo.hasExpression() )
- m_config.stream() << " because no exception was thrown where one was expected";
+ m_config.stream << " because no exception was thrown where one was expected";
else
- m_config.stream() << "No exception thrown where one was expected";
+ m_config.stream << "No exception thrown where one was expected";
}
break;
case ResultWas::Info:
streamVariableLengthText( "info", resultInfo.getMessage() );
break;
case ResultWas::Warning:
- m_config.stream() << "warning:\n'" << resultInfo.getMessage() << "'";
+ m_config.stream << "warning:\n'" << resultInfo.getMessage() << "'";
break;
case ResultWas::ExplicitFailure:
{
TextColour colour( TextColour::Error );
- m_config.stream() << "failed with message: '" << resultInfo.getMessage() << "'";
+ m_config.stream << "failed with message: '" << resultInfo.getMessage() << "'";
}
break;
case ResultWas::Unknown: // These cases are here to prevent compiler warnings
@@ -226,22 +226,22 @@ namespace Catch {
if( !resultInfo.hasExpression() ) {
if( resultInfo.ok() ) {
TextColour colour( TextColour::Success );
- m_config.stream() << " succeeded";
+ m_config.stream << " succeeded";
}
else {
TextColour colour( TextColour::Error );
- m_config.stream() << " failed";
+ m_config.stream << " failed";
}
}
break;
}
if( resultInfo.hasExpandedExpression() ) {
- m_config.stream() << " for: ";
+ m_config.stream << " for: ";
TextColour colour( TextColour::ReconstructedExpression );
- m_config.stream() << resultInfo.getExpandedExpression();
+ m_config.stream << resultInfo.getExpandedExpression();
}
- m_config.stream() << std::endl;
+ m_config.stream << std::endl;
}
virtual void EndTestCase( const TestCaseInfo& testInfo,
@@ -259,9 +259,9 @@ namespace Catch {
}
if( m_testSpan.emitted ) {
- m_config.stream() << "[Finished: '" << testInfo.getName() << "' ";
+ m_config.stream << "[Finished: '" << testInfo.getName() << "' ";
ReportCounts( totals );
- m_config.stream() << "]" << std::endl;
+ m_config.stream << "]" << std::endl;
}
}
@@ -269,20 +269,20 @@ namespace Catch {
void StartSpansLazily() {
if( !m_testingSpan.emitted ) {
- if( m_config.getName().empty() )
- m_config.stream() << "[Started testing]" << std::endl;
+ if( m_config.name.empty() )
+ m_config.stream << "[Started testing]" << std::endl;
else
- m_config.stream() << "[Started testing: " << m_config.getName() << "]" << std::endl;
+ m_config.stream << "[Started testing: " << m_config.name << "]" << 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_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_config.stream << std::endl << "[Running: " << m_testSpan.name << "]" << std::endl;
m_testSpan.emitted = true;
}
@@ -290,7 +290,7 @@ namespace Catch {
SpanInfo& sectionSpan = m_sectionSpans.back();
if( !sectionSpan.emitted && !sectionSpan.name.empty() ) {
if( m_firstSectionInTestCase ) {
- m_config.stream() << "\n";
+ m_config.stream << "\n";
m_firstSectionInTestCase = false;
}
std::vector<SpanInfo>::iterator it = m_sectionSpans.begin();
@@ -298,7 +298,7 @@ namespace Catch {
for(; it != itEnd; ++it ) {
SpanInfo& prevSpan = *it;
if( !prevSpan.emitted && !prevSpan.name.empty() ) {
- m_config.stream() << "[Started section: '" << prevSpan.name << "']" << std::endl;
+ m_config.stream << "[Started section: '" << prevSpan.name << "']" << std::endl;
prevSpan.emitted = true;
}
}
@@ -309,16 +309,16 @@ namespace Catch {
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";
+ m_config.stream << "[" << prefix << ": " << trimmed << "]\n";
}
else {
- m_config.stream() << "\n[" << prefix << "] >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n" << trimmed
+ m_config.stream << "\n[" << prefix << "] >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n" << trimmed
<< "\n[end of " << prefix << "] <<<<<<<<<<<<<<<<<<<<<<<<\n";
}
}
private:
- const IReporterConfig& m_config;
+ ReporterConfig m_config;
bool m_firstSectionInTestCase;
SpanInfo m_testingSpan;
diff --git a/include/reporters/catch_reporter_junit.hpp b/include/reporters/catch_reporter_junit.hpp
index 0f9dbd93..12757620 100644
--- a/include/reporters/catch_reporter_junit.hpp
+++ b/include/reporters/catch_reporter_junit.hpp
@@ -57,7 +57,7 @@ namespace Catch {
};
public:
- JunitReporter( const IReporterConfig& config )
+ JunitReporter( const ReporterConfig& config )
: m_config( config ),
m_testSuiteStats( "AllTests" ),
m_currentStats( &m_testSuiteStats )
@@ -94,7 +94,7 @@ namespace Catch {
}
virtual void Result( const Catch::ResultInfo& resultInfo ) {
- if( resultInfo.getResultType() != ResultWas::Ok || m_config.includeSuccessfulResults() ) {
+ if( resultInfo.getResultType() != ResultWas::Ok || m_config.includeSuccessfulResults ) {
TestCaseStats& testCaseStats = m_currentStats->m_testCaseStats.back();
TestStats stats;
std::ostringstream oss;
@@ -151,7 +151,7 @@ namespace Catch {
}
virtual void EndTesting( const Totals& ) {
- std::ostream& str = m_config.stream();
+ std::ostream& str = m_config.stream;
{
XmlWriter xml( str );
@@ -212,7 +212,7 @@ namespace Catch {
}
private:
- const IReporterConfig& m_config;
+ ReporterConfig m_config;
bool m_currentTestSuccess;
Stats m_testSuiteStats;
diff --git a/include/reporters/catch_reporter_xml.hpp b/include/reporters/catch_reporter_xml.hpp
index 69243ba3..ed627e36 100644
--- a/include/reporters/catch_reporter_xml.hpp
+++ b/include/reporters/catch_reporter_xml.hpp
@@ -16,7 +16,7 @@
namespace Catch {
class XmlReporter : public SharedImpl<IReporter> {
public:
- XmlReporter( const IReporterConfig& config ) : m_config( config ) {}
+ XmlReporter( const ReporterConfig& config ) : m_config( config ) {}
static std::string getDescription() {
return "Reports test results as an XML document";
@@ -29,10 +29,10 @@ namespace Catch {
}
virtual void StartTesting() {
- m_xml = XmlWriter( m_config.stream() );
+ m_xml = XmlWriter( m_config.stream );
m_xml.startElement( "Catch" );
- if( !m_config.getName().empty() )
- m_xml.writeAttribute( "name", m_config.getName() );
+ if( !m_config.name.empty() )
+ m_xml.writeAttribute( "name", m_config.name );
}
virtual void EndTesting( const Totals& totals ) {
@@ -73,7 +73,7 @@ namespace Catch {
}
virtual void Result( const Catch::ResultInfo& resultInfo ) {
- if( !m_config.includeSuccessfulResults() && resultInfo.getResultType() == ResultWas::Ok )
+ if( !m_config.includeSuccessfulResults && resultInfo.getResultType() == ResultWas::Ok )
return;
if( resultInfo.hasExpression() ) {
@@ -133,7 +133,7 @@ namespace Catch {
}
private:
- const IReporterConfig& m_config;
+ ReporterConfig m_config;
bool m_currentTestSuccess;
XmlWriter m_xml;
};