Catch::JunitReporter Class Reference

#include <catch_reporter_junit.h>

Inheritance diagram for Catch::JunitReporter:

Collaboration diagram for Catch::JunitReporter:

Public Member Functions
	JunitReporter (ReporterConfig const &_config)
	~JunitReporter () override
void	noMatchingTestCases (std::string const &) override
void	testRunStarting (TestRunInfo const &runInfo) override
void	testGroupStarting (GroupInfo const &groupInfo) override
void	testCaseStarting (TestCaseInfo const &testCaseInfo) override
bool	assertionEnded (AssertionStats const &assertionStats) override
void	testCaseEnded (TestCaseStats const &testCaseStats) override
void	testGroupEnded (TestGroupStats const &testGroupStats) override
void	testRunEndedCumulative () override
void	writeGroup (TestGroupNode const &groupNode, double suiteTime)
void	writeTestCase (TestCaseNode const &testCaseNode)
void	writeSection (std::string const &className, std::string const &rootName, SectionNode const &sectionNode)
void	writeAssertions (SectionNode const &sectionNode)
void	writeAssertion (AssertionStats const &stats)
Public Member Functions inherited from Catch::CumulativeReporterBase< JunitReporter >
	CumulativeReporterBase (ReporterConfig const &_config)
	~CumulativeReporterBase () override=default
ReporterPreferences	getPreferences () const override
void	sectionStarting (SectionInfo const &sectionInfo) override
void	assertionStarting (AssertionInfo const &) override
void	sectionEnded (SectionStats const &sectionStats) override
void	testRunEnded (TestRunStats const &testRunStats) override
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::CumulativeReporterBase< JunitReporter >
static std::set< Verbosity >	getSupportedVerbosities ()

Public Attributes
XmlWriter	xml
Timer	suiteTimer
std::string	stdOutForSuite
std::string	stdErrForSuite
unsigned int	unexpectedExceptions = 0
bool	m_okToFail = false
Public Attributes inherited from Catch::CumulativeReporterBase< JunitReporter >
IConfigPtr	m_config
std::ostream &	stream
std::vector< AssertionStats >	m_assertions
std::vector< std::vector< std::shared_ptr< SectionNode > > >	m_sections
std::vector< std::shared_ptr< TestCaseNode > >	m_testCases
std::vector< std::shared_ptr< TestGroupNode > >	m_testGroups
std::vector< std::shared_ptr< TestRunNode > >	m_testRuns
std::shared_ptr< SectionNode >	m_rootSection
std::shared_ptr< SectionNode >	m_deepestSection
std::vector< std::shared_ptr< SectionNode > >	m_sectionStack
ReporterPreferences	m_reporterPrefs

Additional Inherited Members
Public Types inherited from Catch::CumulativeReporterBase< JunitReporter >
using	TestCaseNode
using	TestGroupNode
using	TestRunNode

Detailed Description

Definition at line 17 of file catch_reporter_junit.h.

Constructor & Destructor Documentation

JunitReporter()

Catch::JunitReporter::JunitReporter

(

ReporterConfig const &

_config

)

Definition at line 60 of file catch_reporter_junit.cpp.

        :   CumulativeReporterBase( _config ),
            xml( _config.stream() )
        {
            m_reporterPrefs.shouldRedirectStdOut = true;
            m_reporterPrefs.shouldReportAllAssertions = true;
        }

~JunitReporter()

Catch::JunitReporter::~JunitReporter ( )

override

Definition at line 68 of file catch_reporter_junit.cpp.

{}

Member Function Documentation

assertionEnded()

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

overridevirtual

Reimplemented from Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 93 of file catch_reporter_junit.cpp.

                                                                             {
        if( assertionStats.assertionResult.getResultType() == ResultWas::ThrewException && !m_okToFail )
            unexpectedExceptions++;
        return CumulativeReporterBase::assertionEnded( assertionStats );
    }

Here is the call graph for this function:

getDescription()

std::string Catch::JunitReporter::getDescription ( )

static

Definition at line 70 of file catch_reporter_junit.cpp.

                                            {
        return "Reports test results in an XML format that looks like Ant's junitreport target";
    }

noMatchingTestCases()

void Catch::JunitReporter::noMatchingTestCases ( std::string const & )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 74 of file catch_reporter_junit.cpp.

{}

testCaseEnded()

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

overridevirtual

Reimplemented from Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 99 of file catch_reporter_junit.cpp.

                                                                          {
        stdOutForSuite += testCaseStats.stdOut;
        stdErrForSuite += testCaseStats.stdErr;
        CumulativeReporterBase::testCaseEnded( testCaseStats );
    }

Here is the call graph for this function:

testCaseStarting()

void Catch::JunitReporter::testCaseStarting ( TestCaseInfo const & testCaseInfo )

overridevirtual

Reimplemented from Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 89 of file catch_reporter_junit.cpp.

                                                                           {
        m_okToFail = testCaseInfo.okToFail();
    }

Here is the call graph for this function:

testGroupEnded()

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

overridevirtual

Reimplemented from Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 105 of file catch_reporter_junit.cpp.

                                                                             {
        double suiteTime = suiteTimer.getElapsedSeconds();
        CumulativeReporterBase::testGroupEnded( testGroupStats );
        writeGroup( *m_testGroups.back(), suiteTime );
    }

Here is the call graph for this function:

testGroupStarting()

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

overridevirtual

Reimplemented from Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 81 of file catch_reporter_junit.cpp.

                                                                      {
        suiteTimer.start();
        stdOutForSuite.clear();
        stdErrForSuite.clear();
        unexpectedExceptions = 0;
        CumulativeReporterBase::testGroupStarting( groupInfo );
    }

Here is the call graph for this function:

testRunEndedCumulative()

void Catch::JunitReporter::testRunEndedCumulative ( )

overridevirtual

Implements Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 111 of file catch_reporter_junit.cpp.

                                               {
        xml.endElement();
    }

Here is the call graph for this function:

testRunStarting()

void Catch::JunitReporter::testRunStarting ( TestRunInfo const & runInfo )

overridevirtual

Reimplemented from Catch::CumulativeReporterBase< JunitReporter >.

Definition at line 76 of file catch_reporter_junit.cpp.

                                                                     {
        CumulativeReporterBase::testRunStarting( runInfo );
        xml.startElement( "testsuites" );
    }

Here is the call graph for this function:

writeAssertion()

void Catch::JunitReporter::writeAssertion

(

AssertionStats const &

stats

)

Definition at line 215 of file catch_reporter_junit.cpp.

                                                                    {
        AssertionResult const& result = stats.assertionResult;
        if( !result.isOk() ) {
            std::string elementName;
            switch( result.getResultType() ) {
                case ResultWas::ThrewException:
                case ResultWas::FatalErrorCondition:
                    elementName = "error";
                    break;
                case ResultWas::ExplicitFailure:
                    elementName = "failure";
                    break;
                case ResultWas::ExpressionFailed:
                    elementName = "failure";
                    break;
                case ResultWas::DidntThrowException:
                    elementName = "failure";
                    break;
 
                // We should never see these here:
                case ResultWas::Info:
                case ResultWas::Warning:
                case ResultWas::Ok:
                case ResultWas::Unknown:
                case ResultWas::FailureBit:
                case ResultWas::Exception:
                    elementName = "internalError";
                    break;
            }
 
            XmlWriter::ScopedElement e = xml.scopedElement( elementName );
 
            xml.writeAttribute( "message", result.getExpandedExpression() );
            xml.writeAttribute( "type", result.getTestMacroName() );
 
            ReusableStringStream rss;
            if( !result.getMessage().empty() )
                rss << result.getMessage() << '\n';
            for( auto const& msg : stats.infoMessages )
                if( msg.type == ResultWas::Info )
                    rss << msg.message << '\n';
 
            rss << "at " << result.getSourceInfo();
            xml.writeText( rss.str(), false );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeAssertions()

void Catch::JunitReporter::writeAssertions

(

SectionNode const &

sectionNode

)

Definition at line 210 of file catch_reporter_junit.cpp.

                                                                        {
        for( auto const& assertion : sectionNode.assertions )
            writeAssertion( assertion );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeGroup()

void Catch::JunitReporter::writeGroup	(	TestGroupNode const &	groupNode,
		double	suiteTime )

Definition at line 115 of file catch_reporter_junit.cpp.

                                                                                     {
        XmlWriter::ScopedElement e = xml.scopedElement( "testsuite" );
 
        TestGroupStats const& stats = groupNode.value;
        xml.writeAttribute( "name", stats.groupInfo.name );
        xml.writeAttribute( "errors", unexpectedExceptions );
        xml.writeAttribute( "failures", stats.totals.assertions.failed-unexpectedExceptions );
        xml.writeAttribute( "tests", stats.totals.assertions.total() );
        xml.writeAttribute( "hostname", "tbd" ); // !TBD
        if( m_config->showDurations() == ShowDurations::Never )
            xml.writeAttribute( "time", "" );
        else
            xml.writeAttribute( "time", suiteTime );
        xml.writeAttribute( "timestamp", getCurrentTimestamp() );
 
        // Write properties if there are any
        if (m_config->hasTestFilters() || m_config->rngSeed() != 0) {
            auto properties = xml.scopedElement("properties");
            if (m_config->hasTestFilters()) {
                xml.scopedElement("property")
                    .writeAttribute("name", "filters")
                    .writeAttribute("value", serializeFilters(m_config->getTestsOrTags()));
            }
            if (m_config->rngSeed() != 0) {
                xml.scopedElement("property")
                    .writeAttribute("name", "random-seed")
                    .writeAttribute("value", m_config->rngSeed());
            }
        }
 
        // Write test cases
        for( auto const& child : groupNode.children )
            writeTestCase( *child );
 
        xml.scopedElement( "system-out" ).writeText( trim( stdOutForSuite ), false );
        xml.scopedElement( "system-err" ).writeText( trim( stdErrForSuite ), false );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeSection()

void Catch::JunitReporter::writeSection	(	std::string const &	className,
		std::string const &	rootName,
		SectionNode const &	sectionNode )

Definition at line 175 of file catch_reporter_junit.cpp.

                                                         {
        std::string name = trim( sectionNode.stats.sectionInfo.name );
        if( !rootName.empty() )
            name = rootName + '/' + name;
 
        if( !sectionNode.assertions.empty() ||
            !sectionNode.stdOut.empty() ||
            !sectionNode.stdErr.empty() ) {
            XmlWriter::ScopedElement e = xml.scopedElement( "testcase" );
            if( className.empty() ) {
                xml.writeAttribute( "classname", name );
                xml.writeAttribute( "name", "root" );
            }
            else {
                xml.writeAttribute( "classname", className );
                xml.writeAttribute( "name", name );
            }
            xml.writeAttribute( "time", ::Catch::Detail::stringify( sectionNode.stats.durationInSeconds ) );
 
            writeAssertions( sectionNode );
 
            if( !sectionNode.stdOut.empty() )
                xml.scopedElement( "system-out" ).writeText( trim( sectionNode.stdOut ), false );
            if( !sectionNode.stdErr.empty() )
                xml.scopedElement( "system-err" ).writeText( trim( sectionNode.stdErr ), false );
        }
        for( auto const& childNode : sectionNode.childSections )
            if( className.empty() )
                writeSection( name, "", *childNode );
            else
                writeSection( className, name, *childNode );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeTestCase()

void Catch::JunitReporter::writeTestCase

(

TestCaseNode const &

testCaseNode

)

Definition at line 153 of file catch_reporter_junit.cpp.

                                                                        {
        TestCaseStats const& stats = testCaseNode.value;
 
        // All test cases have exactly one section - which represents the
        // test case itself. That section may have 0-n nested sections
        assert( testCaseNode.children.size() == 1 );
        SectionNode const& rootSection = *testCaseNode.children.front();
 
        std::string className = stats.testInfo.className;
 
        if( className.empty() ) {
            className = fileNameTag(stats.testInfo.tags);
            if ( className.empty() )
                className = "global";
        }
 
        if ( !m_config->name().empty() )
            className = m_config->name() + "." + className;
 
        writeSection( className, "", rootSection );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_okToFail

bool Catch::JunitReporter::m_okToFail = false

Definition at line 56 of file catch_reporter_junit.h.

stdErrForSuite

std::string Catch::JunitReporter::stdErrForSuite

Definition at line 54 of file catch_reporter_junit.h.

stdOutForSuite

std::string Catch::JunitReporter::stdOutForSuite

Definition at line 53 of file catch_reporter_junit.h.

suiteTimer

Timer Catch::JunitReporter::suiteTimer

Definition at line 52 of file catch_reporter_junit.h.

unexpectedExceptions

unsigned int Catch::JunitReporter::unexpectedExceptions = 0

Definition at line 55 of file catch_reporter_junit.h.

xml

XmlWriter Catch::JunitReporter::xml

Definition at line 51 of file catch_reporter_junit.h.

---

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

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