Catch::XmlReporter Class Reference

#include <catch_reporter_xml.h>

Inheritance diagram for Catch::XmlReporter:

Collaboration diagram for Catch::XmlReporter:

Public Member Functions
	XmlReporter (ReporterConfig const &_config)
	~XmlReporter () override
virtual std::string	getStylesheetRef () const
void	writeSourceInfo (SourceLineInfo const &sourceInfo)
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
Public Member Functions inherited from Catch::StreamingReporterBase< XmlReporter >
	StreamingReporterBase (ReporterConfig const &_config)
ReporterPreferences	getPreferences () const override
	~StreamingReporterBase () override=default
void	skipTest (TestCaseInfo const &) override
Public Member Functions inherited from Catch::IStreamingReporter
virtual	~IStreamingReporter ()=default
virtual void	benchmarkStarting (BenchmarkInfo const &)
virtual void	benchmarkEnded (BenchmarkStats const &)
virtual void	fatalErrorEncountered (StringRef name)
virtual bool	isMulti () const

Static Public Member Functions
static std::string	getDescription ()
Static Public Member Functions inherited from Catch::StreamingReporterBase< XmlReporter >
static std::set< Verbosity >	getSupportedVerbosities ()

Additional Inherited Members
Public Attributes inherited from Catch::StreamingReporterBase< XmlReporter >
IConfigPtr	m_config
std::ostream &	stream
LazyStat< TestRunInfo >	currentTestRunInfo
LazyStat< GroupInfo >	currentGroupInfo
LazyStat< TestCaseInfo >	currentTestCaseInfo
std::vector< SectionInfo >	m_sectionStack
ReporterPreferences	m_reporterPrefs

Detailed Description

Definition at line 17 of file catch_reporter_xml.h.

Constructor & Destructor Documentation

XmlReporter()

Catch::XmlReporter::XmlReporter

(

ReporterConfig const &

_config

)

Definition at line 22 of file catch_reporter_xml.cpp.

    :   StreamingReporterBase( _config ),
        m_xml(_config.stream())
    {
        m_reporterPrefs.shouldRedirectStdOut = true;
        m_reporterPrefs.shouldReportAllAssertions = true;
    }

~XmlReporter()

Catch::XmlReporter::~XmlReporter ( )

overridedefault

Member Function Documentation

assertionEnded()

bool Catch::XmlReporter::assertionEnded ( AssertionStats const & assertionStats )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 97 of file catch_reporter_xml.cpp.

                                                                           {
 
        AssertionResult const& result = assertionStats.assertionResult;
 
        bool includeResults = m_config->includeSuccessfulResults() || !result.isOk();
 
        if( includeResults || result.getResultType() == ResultWas::Warning ) {
            // Print any info messages in <Info> tags.
            for( auto const& msg : assertionStats.infoMessages ) {
                if( msg.type == ResultWas::Info && includeResults ) {
                    m_xml.scopedElement( "Info" )
                            .writeText( msg.message );
                } else if ( msg.type == ResultWas::Warning ) {
                    m_xml.scopedElement( "Warning" )
                            .writeText( msg.message );
                }
            }
        }
 
        // Drop out if result was successful but we're not printing them.
        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;
    }

Here is the call graph for this function:

assertionStarting()

void Catch::XmlReporter::assertionStarting ( AssertionInfo const & )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 95 of file catch_reporter_xml.cpp.

{ }

getDescription()

std::string Catch::XmlReporter::getDescription ( )

static

Definition at line 32 of file catch_reporter_xml.cpp.

                                          {
        return "Reports test results as an XML document";
    }

getStylesheetRef()

std::string Catch::XmlReporter::getStylesheetRef ( ) const

virtual

Definition at line 36 of file catch_reporter_xml.cpp.

                                                  {
        return std::string();
    }

Here is the caller graph for this function:

noMatchingTestCases()

void Catch::XmlReporter::noMatchingTestCases ( std::string const & s )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 46 of file catch_reporter_xml.cpp.

                                                              {
        StreamingReporterBase::noMatchingTestCases( s );
    }

Here is the call graph for this function:

sectionEnded()

void Catch::XmlReporter::sectionEnded ( SectionStats const & sectionStats )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 172 of file catch_reporter_xml.cpp.

                                                                     {
        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 )
                e.writeAttribute( "durationInSeconds", sectionStats.durationInSeconds );
 
            m_xml.endElement();
        }
    }

Here is the call graph for this function:

sectionStarting()

void Catch::XmlReporter::sectionStarting ( SectionInfo const & sectionInfo )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 85 of file catch_reporter_xml.cpp.

                                                                      {
        StreamingReporterBase::sectionStarting( sectionInfo );
        if( m_sectionDepth++ > 0 ) {
            m_xml.startElement( "Section" )
                .writeAttribute( "name", trim( sectionInfo.name ) );
            writeSourceInfo( sectionInfo.lineInfo );
            m_xml.ensureTagClosed();
        }
    }

Here is the call graph for this function:

testCaseEnded()

void Catch::XmlReporter::testCaseEnded ( TestCaseStats const & testCaseStats )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 187 of file catch_reporter_xml.cpp.

                                                                        {
        StreamingReporterBase::testCaseEnded( testCaseStats );
        XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResult" );
        e.writeAttribute( "success", testCaseStats.totals.assertions.allOk() );
 
        if ( m_config->showDurations() == ShowDurations::Always )
            e.writeAttribute( "durationInSeconds", m_testCaseTimer.getElapsedSeconds() );
 
        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();
    }

Here is the call graph for this function:

testCaseStarting()

void Catch::XmlReporter::testCaseStarting ( TestCaseInfo const & testInfo )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 71 of file catch_reporter_xml.cpp.

                                                                     {
        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();
    }

Here is the call graph for this function:

testGroupEnded()

void Catch::XmlReporter::testGroupEnded ( TestGroupStats const & testGroupStats )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 203 of file catch_reporter_xml.cpp.

                                                                           {
        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();
    }

Here is the call graph for this function:

testGroupStarting()

void Catch::XmlReporter::testGroupStarting ( GroupInfo const & groupInfo )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 65 of file catch_reporter_xml.cpp.

                                                                    {
        StreamingReporterBase::testGroupStarting( groupInfo );
        m_xml.startElement( "Group" )
            .writeAttribute( "name", groupInfo.name );
    }

Here is the call graph for this function:

testRunEnded()

void Catch::XmlReporter::testRunEnded ( TestRunStats const & testRunStats )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 213 of file catch_reporter_xml.cpp.

                                                                     {
        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();
    }

Here is the call graph for this function:

testRunStarting()

void Catch::XmlReporter::testRunStarting ( TestRunInfo const & testInfo )

overridevirtual

Reimplemented from Catch::StreamingReporterBase< XmlReporter >.

Definition at line 50 of file catch_reporter_xml.cpp.

                                                                   {
        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() );
        if (m_config->testSpec().hasFilters())
            m_xml.writeAttribute( "filters", serializeFilters( m_config->getTestsOrTags() ) );
        if( m_config->rngSeed() != 0 )
            m_xml.scopedElement( "Randomness" )
                .writeAttribute( "seed", m_config->rngSeed() );
    }

Here is the call graph for this function:

writeSourceInfo()

void Catch::XmlReporter::writeSourceInfo

(

SourceLineInfo const &

sourceInfo

)

Definition at line 40 of file catch_reporter_xml.cpp.

                                                                        {
        m_xml
            .writeAttribute( "filename", sourceInfo.file )
            .writeAttribute( "line", sourceInfo.line );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• libraries/sys-vm/external/Catch2/include/reporters/catch_reporter_xml.h
• libraries/sys-vm/external/Catch2/include/reporters/catch_reporter_xml.cpp