3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-22 21:36:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Provide XmlReporter declaration with EXTERNAL_INTERFACES

Browse Source 
Related to #991
This commit is contained in:
Martin Hořeňovský 2017-11-14 17:56:27 +01:00
parent 4b3730de8a
commit a096e4b3f2
4 changed files with 223 additions and 173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CMakeLists.txt
View File

@ -252,6 +252,7 @@ set(REPORTER_HEADERS
${HEADER_DIR}/reporters/catch_reporter_multi.h ${HEADER_DIR}/reporters/catch_reporter_multi.h
${HEADER_DIR}/reporters/catch_reporter_tap.hpp ${HEADER_DIR}/reporters/catch_reporter_tap.hpp
${HEADER_DIR}/reporters/catch_reporter_teamcity.hpp ${HEADER_DIR}/reporters/catch_reporter_teamcity.hpp
${HEADER_DIR}/reporters/catch_reporter_xml.h
) )
set(REPORTER_SOURCES set(REPORTER_SOURCES
${HEADER_DIR}/reporters/catch_reporter_bases.cpp ${HEADER_DIR}/reporters/catch_reporter_bases.cpp

1
include/internal/catch_external_interfaces.h
View File

@ -14,5 +14,6 @@
// Allow users to base their work off existing reporters // Allow users to base their work off existing reporters
#include "../reporters/catch_reporter_compact.h" #include "../reporters/catch_reporter_compact.h"
#include "../reporters/catch_reporter_junit.h" #include "../reporters/catch_reporter_junit.h"
#include "../reporters/catch_reporter_xml.h"
#endif // TWOBLUECUBES_CATCH_EXTERNAL_INTERFACES_H_INCLUDED #endif // TWOBLUECUBES_CATCH_EXTERNAL_INTERFACES_H_INCLUDED

333
include/reporters/catch_reporter_xml.cpp
View File

@ -6,12 +6,10 @@
* file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
*/ */
#include "catch_reporter_bases.hpp" #include "catch_reporter_xml.h"
#include "../internal/catch_capture.hpp" #include "../internal/catch_capture.hpp"
#include "../internal/catch_reporter_registrars.hpp" #include "../internal/catch_reporter_registrars.hpp"
#include "internal/catch_xmlwriter.h"
#include "../internal/catch_timer.h"
#if defined(_MSC_VER) #if defined(_MSC_VER)
#pragma warning(push) #pragma warning(push)
@ -21,212 +19,201 @@
#endif #endif
namespace Catch { namespace Catch {
class XmlReporter : public StreamingReporterBase<XmlReporter> { XmlReporter::XmlReporter( ReporterConfig const& _config )
public: : StreamingReporterBase( _config ),
XmlReporter( ReporterConfig const& _config ) m_xml(_config.stream())
: StreamingReporterBase( _config ), {
m_xml(_config.stream()) m_reporterPrefs.shouldRedirectStdOut = true;
{ }
m_reporterPrefs.shouldRedirectStdOut = true;
}
~XmlReporter() override; XmlReporter::~XmlReporter() {};
static std::string getDescription() { std::string XmlReporter::getDescription() {
return "Reports test results as an XML document"; return "Reports test results as an XML document";
} }
virtual std::string getStylesheetRef() const { std::string XmlReporter::getStylesheetRef() const {
return std::string(); return std::string();
} }
void writeSourceInfo( SourceLineInfo const& sourceInfo ) { void XmlReporter::writeSourceInfo( SourceLineInfo const& sourceInfo ) {
m_xml m_xml
.writeAttribute( "filename", sourceInfo.file ) .writeAttribute( "filename", sourceInfo.file )
.writeAttribute( "line", sourceInfo.line ); .writeAttribute( "line", sourceInfo.line );
} }
public: // StreamingReporterBase void XmlReporter::noMatchingTestCases( std::string const& s ) {
StreamingReporterBase::noMatchingTestCases( s );
}
void noMatchingTestCases( std::string const& s ) override { void XmlReporter::testRunStarting( TestRunInfo const& testInfo ) {
StreamingReporterBase::noMatchingTestCases( s ); StreamingReporterBase::testRunStarting( testInfo );
} std::string stylesheetRef = getStylesheetRef();
if( !stylesheetRef.empty() )
m_xml.writeStylesheetRef( stylesheetRef );
m_xml.startElement( "Catch" );
if( !m_config->name().empty() )
m_xml.writeAttribute( "name", m_config->name() );
}
void testRunStarting( TestRunInfo const& testInfo ) override { void XmlReporter::testGroupStarting( GroupInfo const& groupInfo ) {
StreamingReporterBase::testRunStarting( testInfo ); StreamingReporterBase::testGroupStarting( groupInfo );
std::string stylesheetRef = getStylesheetRef(); m_xml.startElement( "Group" )
if( !stylesheetRef.empty() ) .writeAttribute( "name", groupInfo.name );
m_xml.writeStylesheetRef( stylesheetRef ); }
m_xml.startElement( "Catch" );
if( !m_config->name().empty() )
m_xml.writeAttribute( "name", m_config->name() );
}
void testGroupStarting( GroupInfo const& groupInfo ) override { void XmlReporter::testCaseStarting( TestCaseInfo const& testInfo ) {
StreamingReporterBase::testGroupStarting( groupInfo ); StreamingReporterBase::testCaseStarting(testInfo);
m_xml.startElement( "Group" ) m_xml.startElement( "TestCase" )
.writeAttribute( "name", groupInfo.name ); .writeAttribute( "name", trim( testInfo.name ) )
} .writeAttribute( "description", testInfo.description )
.writeAttribute( "tags", testInfo.tagsAsString() );
void testCaseStarting( TestCaseInfo const& testInfo ) override { writeSourceInfo( testInfo.lineInfo );
StreamingReporterBase::testCaseStarting(testInfo);
m_xml.startElement( "TestCase" )
.writeAttribute( "name", trim( testInfo.name ) )
.writeAttribute( "description", testInfo.description )
.writeAttribute( "tags", testInfo.tagsAsString() );
writeSourceInfo( testInfo.lineInfo ); if ( m_config->showDurations() == ShowDurations::Always )
m_testCaseTimer.start();
m_xml.ensureTagClosed();
}
if ( m_config->showDurations() == ShowDurations::Always ) void XmlReporter::sectionStarting( SectionInfo const& sectionInfo ) {
m_testCaseTimer.start(); StreamingReporterBase::sectionStarting( sectionInfo );
if( m_sectionDepth++ > 0 ) {
m_xml.startElement( "Section" )
.writeAttribute( "name", trim( sectionInfo.name ) )
.writeAttribute( "description", sectionInfo.description );
writeSourceInfo( sectionInfo.lineInfo );
m_xml.ensureTagClosed(); m_xml.ensureTagClosed();
} }
}
void sectionStarting( SectionInfo const& sectionInfo ) override { void XmlReporter::assertionStarting( AssertionInfo const& ) { }
StreamingReporterBase::sectionStarting( sectionInfo );
if( m_sectionDepth++ > 0 ) {
m_xml.startElement( "Section" )
.writeAttribute( "name", trim( sectionInfo.name ) )
.writeAttribute( "description", sectionInfo.description );
writeSourceInfo( sectionInfo.lineInfo );
m_xml.ensureTagClosed();
}
}
void assertionStarting( AssertionInfo const& ) override { } bool XmlReporter::assertionEnded( AssertionStats const& assertionStats ) {
bool assertionEnded( AssertionStats const& assertionStats ) override { AssertionResult const& result = assertionStats.assertionResult;
AssertionResult const& result = assertionStats.assertionResult; bool includeResults = m_config->includeSuccessfulResults() || !result.isOk();
bool includeResults = m_config->includeSuccessfulResults() || !result.isOk(); if( includeResults ) {
// Print any info messages in <Info> tags.
if( includeResults ) { for( auto const& msg : assertionStats.infoMessages ) {
// Print any info messages in <Info> tags. if( msg.type == ResultWas::Info ) {
for( auto const& msg : assertionStats.infoMessages ) { m_xml.scopedElement( "Info" )
if( msg.type == ResultWas::Info ) { .writeText( msg.message );
m_xml.scopedElement( "Info" ) } else if ( msg.type == ResultWas::Warning ) {
.writeText( msg.message ); m_xml.scopedElement( "Warning" )
} else if ( msg.type == ResultWas::Warning ) { .writeText( msg.message );
m_xml.scopedElement( "Warning" )
.writeText( msg.message );
}
} }
} }
}
// Drop out if result was successful but we're not printing them. // Drop out if result was successful but we're not printing them.
if( !includeResults && result.getResultType() != ResultWas::Warning ) if( !includeResults && result.getResultType() != ResultWas::Warning )
return true;
// Print the expression if there is one.
if( result.hasExpression() ) {
m_xml.startElement( "Expression" )
.writeAttribute( "success", result.succeeded() )
.writeAttribute( "type", result.getTestMacroName() );
writeSourceInfo( result.getSourceInfo() );
m_xml.scopedElement( "Original" )
.writeText( result.getExpression() );
m_xml.scopedElement( "Expanded" )
.writeText( result.getExpandedExpression() );
}
// And... Print a result applicable to each result type.
switch( result.getResultType() ) {
case ResultWas::ThrewException:
m_xml.startElement( "Exception" );
writeSourceInfo( result.getSourceInfo() );
m_xml.writeText( result.getMessage() );
m_xml.endElement();
break;
case ResultWas::FatalErrorCondition:
m_xml.startElement( "FatalErrorCondition" );
writeSourceInfo( result.getSourceInfo() );
m_xml.writeText( result.getMessage() );
m_xml.endElement();
break;
case ResultWas::Info:
m_xml.scopedElement( "Info" )
.writeText( result.getMessage() );
break;
case ResultWas::Warning:
// Warning will already have been written
break;
case ResultWas::ExplicitFailure:
m_xml.startElement( "Failure" );
writeSourceInfo( result.getSourceInfo() );
m_xml.writeText( result.getMessage() );
m_xml.endElement();
break;
default:
break;
}
if( result.hasExpression() )
m_xml.endElement();
return true; return true;
// Print the expression if there is one.
if( result.hasExpression() ) {
m_xml.startElement( "Expression" )
.writeAttribute( "success", result.succeeded() )
.writeAttribute( "type", result.getTestMacroName() );
writeSourceInfo( result.getSourceInfo() );
m_xml.scopedElement( "Original" )
.writeText( result.getExpression() );
m_xml.scopedElement( "Expanded" )
.writeText( result.getExpandedExpression() );
} }
void sectionEnded( SectionStats const& sectionStats ) override { // And... Print a result applicable to each result type.
StreamingReporterBase::sectionEnded( sectionStats ); switch( result.getResultType() ) {
if( --m_sectionDepth > 0 ) { case ResultWas::ThrewException:
XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResults" ); m_xml.startElement( "Exception" );
e.writeAttribute( "successes", sectionStats.assertions.passed ); writeSourceInfo( result.getSourceInfo() );
e.writeAttribute( "failures", sectionStats.assertions.failed ); m_xml.writeText( result.getMessage() );
e.writeAttribute( "expectedFailures", sectionStats.assertions.failedButOk );
if ( m_config->showDurations() == ShowDurations::Always )
e.writeAttribute( "durationInSeconds", sectionStats.durationInSeconds );
m_xml.endElement(); m_xml.endElement();
} break;
case ResultWas::FatalErrorCondition:
m_xml.startElement( "FatalErrorCondition" );
writeSourceInfo( result.getSourceInfo() );
m_xml.writeText( result.getMessage() );
m_xml.endElement();
break;
case ResultWas::Info:
m_xml.scopedElement( "Info" )
.writeText( result.getMessage() );
break;
case ResultWas::Warning:
// Warning will already have been written
break;
case ResultWas::ExplicitFailure:
m_xml.startElement( "Failure" );
writeSourceInfo( result.getSourceInfo() );
m_xml.writeText( result.getMessage() );
m_xml.endElement();
break;
default:
break;
} }
void testCaseEnded( TestCaseStats const& testCaseStats ) override { if( result.hasExpression() )
StreamingReporterBase::testCaseEnded( testCaseStats ); m_xml.endElement();
XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResult" );
e.writeAttribute( "success", testCaseStats.totals.assertions.allOk() ); return true;
}
void XmlReporter::sectionEnded( SectionStats const& sectionStats ) {
StreamingReporterBase::sectionEnded( sectionStats );
if( --m_sectionDepth > 0 ) {
XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResults" );
e.writeAttribute( "successes", sectionStats.assertions.passed );
e.writeAttribute( "failures", sectionStats.assertions.failed );
e.writeAttribute( "expectedFailures", sectionStats.assertions.failedButOk );
if ( m_config->showDurations() == ShowDurations::Always ) if ( m_config->showDurations() == ShowDurations::Always )
e.writeAttribute( "durationInSeconds", m_testCaseTimer.getElapsedSeconds() ); e.writeAttribute( "durationInSeconds", sectionStats.durationInSeconds );
if( !testCaseStats.stdOut.empty() )
m_xml.scopedElement( "StdOut" ).writeText( trim( testCaseStats.stdOut ), false );
if( !testCaseStats.stdErr.empty() )
m_xml.scopedElement( "StdErr" ).writeText( trim( testCaseStats.stdErr ), false );
m_xml.endElement(); m_xml.endElement();
} }
}
void testGroupEnded( TestGroupStats const& testGroupStats ) override { void XmlReporter::testCaseEnded( TestCaseStats const& testCaseStats ) {
StreamingReporterBase::testGroupEnded( testGroupStats ); StreamingReporterBase::testCaseEnded( testCaseStats );
// TODO: Check testGroupStats.aborting and act accordingly. XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResult" );
m_xml.scopedElement( "OverallResults" ) e.writeAttribute( "success", testCaseStats.totals.assertions.allOk() );
.writeAttribute( "successes", testGroupStats.totals.assertions.passed )
.writeAttribute( "failures", testGroupStats.totals.assertions.failed )
.writeAttribute( "expectedFailures", testGroupStats.totals.assertions.failedButOk );
m_xml.endElement();
}
void testRunEnded( TestRunStats const& testRunStats ) override { if ( m_config->showDurations() == ShowDurations::Always )
StreamingReporterBase::testRunEnded( testRunStats ); e.writeAttribute( "durationInSeconds", m_testCaseTimer.getElapsedSeconds() );
m_xml.scopedElement( "OverallResults" )
.writeAttribute( "successes", testRunStats.totals.assertions.passed )
.writeAttribute( "failures", testRunStats.totals.assertions.failed )
.writeAttribute( "expectedFailures", testRunStats.totals.assertions.failedButOk );
m_xml.endElement();
}
private: if( !testCaseStats.stdOut.empty() )
Timer m_testCaseTimer; m_xml.scopedElement( "StdOut" ).writeText( trim( testCaseStats.stdOut ), false );
XmlWriter m_xml; if( !testCaseStats.stdErr.empty() )
int m_sectionDepth = 0; m_xml.scopedElement( "StdErr" ).writeText( trim( testCaseStats.stdErr ), false );
};
m_xml.endElement();
}
void XmlReporter::testGroupEnded( TestGroupStats const& testGroupStats ) {
StreamingReporterBase::testGroupEnded( testGroupStats );
// TODO: Check testGroupStats.aborting and act accordingly.
m_xml.scopedElement( "OverallResults" )
.writeAttribute( "successes", testGroupStats.totals.assertions.passed )
.writeAttribute( "failures", testGroupStats.totals.assertions.failed )
.writeAttribute( "expectedFailures", testGroupStats.totals.assertions.failedButOk );
m_xml.endElement();
}
void XmlReporter::testRunEnded( TestRunStats const& testRunStats ) {
StreamingReporterBase::testRunEnded( testRunStats );
m_xml.scopedElement( "OverallResults" )
.writeAttribute( "successes", testRunStats.totals.assertions.passed )
.writeAttribute( "failures", testRunStats.totals.assertions.failed )
.writeAttribute( "expectedFailures", testRunStats.totals.assertions.failedButOk );
m_xml.endElement();
}
XmlReporter::~XmlReporter() {}
CATCH_REGISTER_REPORTER( "xml", XmlReporter ) CATCH_REGISTER_REPORTER( "xml", XmlReporter )
} // end namespace Catch } // end namespace Catch

61
include/reporters/catch_reporter_xml.h Normal file
View File

@ -0,0 +1,61 @@
/*
* Created by Martin on 14/11/2017.
*
* 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_XML_H_INCLUDED
#define TWOBLUECUBES_CATCH_REPORTER_XML_H_INCLUDED
#include "catch_reporter_bases.hpp"
#include "../internal/catch_xmlwriter.h"
#include "../internal/catch_timer.h"
namespace Catch {
class XmlReporter : public StreamingReporterBase<XmlReporter> {
public:
XmlReporter(ReporterConfig const& _config);
~XmlReporter() override;
static std::string getDescription();
virtual std::string getStylesheetRef() const;
void writeSourceInfo(SourceLineInfo const& sourceInfo);
public: // StreamingReporterBase
void noMatchingTestCases(std::string const& s) override;
void testRunStarting(TestRunInfo const& testInfo) override;
void testGroupStarting(GroupInfo const& groupInfo) override;
void testCaseStarting(TestCaseInfo const& testInfo) override;
void sectionStarting(SectionInfo const& sectionInfo) override;
void assertionStarting(AssertionInfo const&) override;
bool assertionEnded(AssertionStats const& assertionStats) override;
void sectionEnded(SectionStats const& sectionStats) override;
void testCaseEnded(TestCaseStats const& testCaseStats) override;
void testGroupEnded(TestGroupStats const& testGroupStats) override;
void testRunEnded(TestRunStats const& testRunStats) override;
private:
Timer m_testCaseTimer;
XmlWriter m_xml;
int m_sectionDepth = 0;
};
} // end namespace Catch
#endif // TWOBLUECUBES_CATCH_REPORTER_XML_H_INCLUDED