Catch::TeamCityReporter Struct Reference

#include <catch_reporter_teamcity.hpp>

Inheritance diagram for Catch::TeamCityReporter:

Collaboration diagram for Catch::TeamCityReporter:

Public Member Functions
	TeamCityReporter (ReporterConfig const &_config)
	~TeamCityReporter () override
void	skipTest (TestCaseInfo const &) override
void	noMatchingTestCases (std::string const &) override
void	testGroupStarting (GroupInfo const &groupInfo) override
void	testGroupEnded (TestGroupStats const &testGroupStats) override
void	assertionStarting (AssertionInfo const &) override
bool	assertionEnded (AssertionStats const &assertionStats) override
void	sectionStarting (SectionInfo const &sectionInfo) override
void	testCaseStarting (TestCaseInfo const &testInfo) override
void	testCaseEnded (TestCaseStats const &testCaseStats) override
	TeamCityReporter (ReporterConfig const &_config)
	~TeamCityReporter () override
void	skipTest (TestCaseInfo const &) override
void	noMatchingTestCases (std::string const &) override
void	testGroupStarting (GroupInfo const &groupInfo) override
void	testGroupEnded (TestGroupStats const &testGroupStats) override
void	assertionStarting (AssertionInfo const &) override
bool	assertionEnded (AssertionStats const &assertionStats) override
void	sectionStarting (SectionInfo const &sectionInfo) override
void	testCaseStarting (TestCaseInfo const &testInfo) override
void	testCaseEnded (TestCaseStats const &testCaseStats) override
Public Member Functions inherited from Catch::StreamingReporterBase< TeamCityReporter >
	StreamingReporterBase (ReporterConfig const &_config)
ReporterPreferences	getPreferences () const override
	~StreamingReporterBase () override=default
void	testRunStarting (TestRunInfo const &_testRunInfo) override
void	sectionEnded (SectionStats const &) override
void	testRunEnded (TestRunStats 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	escape (std::string const &str)
static std::string	getDescription ()
static std::string	escape (std::string const &str)
static std::string	getDescription ()
Static Public Member Functions inherited from Catch::StreamingReporterBase< TeamCityReporter >
static std::set< Verbosity >	getSupportedVerbosities ()

Additional Inherited Members
Public Attributes inherited from Catch::StreamingReporterBase< TeamCityReporter >
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 26 of file catch_reporter_teamcity.hpp.

Constructor & Destructor Documentation

TeamCityReporter() [1/2]

Catch::TeamCityReporter::TeamCityReporter ( ReporterConfig const & _config )

inline

Definition at line 27 of file catch_reporter_teamcity.hpp.

        :   StreamingReporterBase( _config )
        {
            m_reporterPrefs.shouldRedirectStdOut = true;
        }

~TeamCityReporter() [1/2]

Catch::TeamCityReporter::~TeamCityReporter ( )

override

TeamCityReporter() [2/2]

Catch::TeamCityReporter::TeamCityReporter ( ReporterConfig const & _config )

inline

Definition at line 27 of file catch_reporter_teamcity.hpp.

        :   StreamingReporterBase( _config )
        {
            m_reporterPrefs.shouldRedirectStdOut = true;
        }

~TeamCityReporter() [2/2]

Catch::TeamCityReporter::~TeamCityReporter ( )

override

Member Function Documentation

assertionEnded() [1/2]

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

inlineoverridevirtual

Implements Catch::IStreamingReporter.

Definition at line 68 of file catch_reporter_teamcity.hpp.

                                                                             {
            AssertionResult const& result = assertionStats.assertionResult;
            if( !result.isOk() ) {
 
                ReusableStringStream msg;
                if( !m_headerPrintedForThisSection )
                    printSectionHeader( msg.get() );
                m_headerPrintedForThisSection = true;
 
                msg << result.getSourceInfo() << "\n";
 
                switch( result.getResultType() ) {
                    case ResultWas::ExpressionFailed:
                        msg << "expression failed";
                        break;
                    case ResultWas::ThrewException:
                        msg << "unexpected exception";
                        break;
                    case ResultWas::FatalErrorCondition:
                        msg << "fatal error condition";
                        break;
                    case ResultWas::DidntThrowException:
                        msg << "no exception was thrown where one was expected";
                        break;
                    case ResultWas::ExplicitFailure:
                        msg << "explicit failure";
                        break;
 
                    // We shouldn't get here because of the isOk() test
                    case ResultWas::Ok:
                    case ResultWas::Info:
                    case ResultWas::Warning:
                        CATCH_ERROR( "Internal error in TeamCity reporter" );
                    // These cases are here to prevent compiler warnings
                    case ResultWas::Unknown:
                    case ResultWas::FailureBit:
                    case ResultWas::Exception:
                        CATCH_ERROR( "Not implemented" );
                }
                if( assertionStats.infoMessages.size() == 1 )
                    msg << " with message:";
                if( assertionStats.infoMessages.size() > 1 )
                    msg << " with messages:";
                for( auto const& messageInfo : assertionStats.infoMessages )
                    msg << "\n  \"" << messageInfo.message << "\"";
 
 
                if( result.hasExpression() ) {
                    msg <<
                        "\n  " << result.getExpressionInMacro() << "\n"
                        "with expansion:\n" <<
                        "  " << result.getExpandedExpression() << "\n";
                }
 
                if( currentTestCaseInfo->okToFail() ) {
                    msg << "- failure ignore as test marked as 'ok to fail'\n";
                    stream << "##teamcity[testIgnored"
                           << " name='" << escape( currentTestCaseInfo->name )<< "'"
                           << " message='" << escape( msg.str() ) << "'"
                           << "]\n";
                }
                else {
                    stream << "##teamcity[testFailed"
                           << " name='" << escape( currentTestCaseInfo->name )<< "'"
                           << " message='" << escape( msg.str() ) << "'"
                           << "]\n";
                }
            }
            stream.flush();
            return true;
        }

Here is the call graph for this function:

assertionEnded() [2/2]

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

inlineoverridevirtual

Implements Catch::IStreamingReporter.

Definition at line 68 of file catch_reporter_teamcity.hpp.

                                                                             {
            AssertionResult const& result = assertionStats.assertionResult;
            if( !result.isOk() ) {
 
                ReusableStringStream msg;
                if( !m_headerPrintedForThisSection )
                    printSectionHeader( msg.get() );
                m_headerPrintedForThisSection = true;
 
                msg << result.getSourceInfo() << "\n";
 
                switch( result.getResultType() ) {
                    case ResultWas::ExpressionFailed:
                        msg << "expression failed";
                        break;
                    case ResultWas::ThrewException:
                        msg << "unexpected exception";
                        break;
                    case ResultWas::FatalErrorCondition:
                        msg << "fatal error condition";
                        break;
                    case ResultWas::DidntThrowException:
                        msg << "no exception was thrown where one was expected";
                        break;
                    case ResultWas::ExplicitFailure:
                        msg << "explicit failure";
                        break;
 
                    // We shouldn't get here because of the isOk() test
                    case ResultWas::Ok:
                    case ResultWas::Info:
                    case ResultWas::Warning:
                        CATCH_ERROR( "Internal error in TeamCity reporter" );
                    // These cases are here to prevent compiler warnings
                    case ResultWas::Unknown:
                    case ResultWas::FailureBit:
                    case ResultWas::Exception:
                        CATCH_ERROR( "Not implemented" );
                }
                if( assertionStats.infoMessages.size() == 1 )
                    msg << " with message:";
                if( assertionStats.infoMessages.size() > 1 )
                    msg << " with messages:";
                for( auto const& messageInfo : assertionStats.infoMessages )
                    msg << "\n  \"" << messageInfo.message << "\"";
 
 
                if( result.hasExpression() ) {
                    msg <<
                        "\n  " << result.getExpressionInMacro() << "\n"
                        "with expansion:\n" <<
                        "  " << result.getExpandedExpression() << "\n";
                }
 
                if( currentTestCaseInfo->okToFail() ) {
                    msg << "- failure ignore as test marked as 'ok to fail'\n";
                    stream << "##teamcity[testIgnored"
                           << " name='" << escape( currentTestCaseInfo->name )<< "'"
                           << " message='" << escape( msg.str() ) << "'"
                           << "]\n";
                }
                else {
                    stream << "##teamcity[testFailed"
                           << " name='" << escape( currentTestCaseInfo->name )<< "'"
                           << " message='" << escape( msg.str() ) << "'"
                           << "]\n";
                }
            }
            stream.flush();
            return true;
        }

Here is the call graph for this function:

assertionStarting() [1/2]

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

inlineoverridevirtual

Implements Catch::IStreamingReporter.

Definition at line 66 of file catch_reporter_teamcity.hpp.

{}

assertionStarting() [2/2]

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

inlineoverridevirtual

Implements Catch::IStreamingReporter.

Definition at line 66 of file catch_reporter_teamcity.hpp.

{}

escape() [1/2]

static std::string Catch::TeamCityReporter::escape ( std::string const & str )

inlinestatic

Definition at line 33 of file catch_reporter_teamcity.hpp.

                                                        {
            std::string escaped = str;
            replaceInPlace( escaped, "|", "||" );
            replaceInPlace( escaped, "'", "|'" );
            replaceInPlace( escaped, "\n", "|n" );
            replaceInPlace( escaped, "\r", "|r" );
            replaceInPlace( escaped, "[", "|[" );
            replaceInPlace( escaped, "]", "|]" );
            return escaped;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

escape() [2/2]

static std::string Catch::TeamCityReporter::escape ( std::string const & str )

inlinestatic

Definition at line 33 of file catch_reporter_teamcity.hpp.

                                                        {
            std::string escaped = str;
            replaceInPlace( escaped, "|", "||" );
            replaceInPlace( escaped, "'", "|'" );
            replaceInPlace( escaped, "\n", "|n" );
            replaceInPlace( escaped, "\r", "|r" );
            replaceInPlace( escaped, "[", "|[" );
            replaceInPlace( escaped, "]", "|]" );
            return escaped;
        }

Here is the call graph for this function:

getDescription() [1/2]

static std::string Catch::TeamCityReporter::getDescription ( )

inlinestatic

Definition at line 45 of file catch_reporter_teamcity.hpp.

                                          {
            return "Reports test results as TeamCity service messages";
        }

getDescription() [2/2]

static std::string Catch::TeamCityReporter::getDescription ( )

inlinestatic

Definition at line 45 of file catch_reporter_teamcity.hpp.

                                          {
            return "Reports test results as TeamCity service messages";
        }

noMatchingTestCases() [1/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 52 of file catch_reporter_teamcity.hpp.

{}

noMatchingTestCases() [2/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 52 of file catch_reporter_teamcity.hpp.

{}

sectionStarting() [1/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 140 of file catch_reporter_teamcity.hpp.

                                                                        {
            m_headerPrintedForThisSection = false;
            StreamingReporterBase::sectionStarting( sectionInfo );
        }

Here is the call graph for this function:

sectionStarting() [2/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 140 of file catch_reporter_teamcity.hpp.

                                                                        {
            m_headerPrintedForThisSection = false;
            StreamingReporterBase::sectionStarting( sectionInfo );
        }

Here is the call graph for this function:

skipTest() [1/2]

void Catch::TeamCityReporter::skipTest ( TestCaseInfo const & )

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 49 of file catch_reporter_teamcity.hpp.

                                                        {
        }

skipTest() [2/2]

void Catch::TeamCityReporter::skipTest ( TestCaseInfo const & )

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 49 of file catch_reporter_teamcity.hpp.

                                                        {
        }

testCaseEnded() [1/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 153 of file catch_reporter_teamcity.hpp.

                                                                          {
            StreamingReporterBase::testCaseEnded( testCaseStats );
            if( !testCaseStats.stdOut.empty() )
                stream << "##teamcity[testStdOut name='"
                    << escape( testCaseStats.testInfo.name )
                    << "' out='" << escape( testCaseStats.stdOut ) << "']\n";
            if( !testCaseStats.stdErr.empty() )
                stream << "##teamcity[testStdErr name='"
                    << escape( testCaseStats.testInfo.name )
                    << "' out='" << escape( testCaseStats.stdErr ) << "']\n";
            stream << "##teamcity[testFinished name='"
                    << escape( testCaseStats.testInfo.name ) << "' duration='"
                    << m_testTimer.getElapsedMilliseconds() << "']\n";
            stream.flush();
        }

Here is the call graph for this function:

testCaseEnded() [2/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 153 of file catch_reporter_teamcity.hpp.

                                                                          {
            StreamingReporterBase::testCaseEnded( testCaseStats );
            if( !testCaseStats.stdOut.empty() )
                stream << "##teamcity[testStdOut name='"
                    << escape( testCaseStats.testInfo.name )
                    << "' out='" << escape( testCaseStats.stdOut ) << "']\n";
            if( !testCaseStats.stdErr.empty() )
                stream << "##teamcity[testStdErr name='"
                    << escape( testCaseStats.testInfo.name )
                    << "' out='" << escape( testCaseStats.stdErr ) << "']\n";
            stream << "##teamcity[testFinished name='"
                    << escape( testCaseStats.testInfo.name ) << "' duration='"
                    << m_testTimer.getElapsedMilliseconds() << "']\n";
            stream.flush();
        }

Here is the call graph for this function:

testCaseStarting() [1/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 145 of file catch_reporter_teamcity.hpp.

                                                                       {
            m_testTimer.start();
            StreamingReporterBase::testCaseStarting( testInfo );
            stream << "##teamcity[testStarted name='"
                << escape( testInfo.name ) << "']\n";
            stream.flush();
        }

Here is the call graph for this function:

testCaseStarting() [2/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 145 of file catch_reporter_teamcity.hpp.

                                                                       {
            m_testTimer.start();
            StreamingReporterBase::testCaseStarting( testInfo );
            stream << "##teamcity[testStarted name='"
                << escape( testInfo.name ) << "']\n";
            stream.flush();
        }

Here is the call graph for this function:

testGroupEnded() [1/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 59 of file catch_reporter_teamcity.hpp.

                                                                             {
            StreamingReporterBase::testGroupEnded( testGroupStats );
            stream << "##teamcity[testSuiteFinished name='"
                << escape( testGroupStats.groupInfo.name ) << "']\n";
        }

Here is the call graph for this function:

testGroupEnded() [2/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 59 of file catch_reporter_teamcity.hpp.

                                                                             {
            StreamingReporterBase::testGroupEnded( testGroupStats );
            stream << "##teamcity[testSuiteFinished name='"
                << escape( testGroupStats.groupInfo.name ) << "']\n";
        }

Here is the call graph for this function:

testGroupStarting() [1/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 54 of file catch_reporter_teamcity.hpp.

                                                                      {
            StreamingReporterBase::testGroupStarting( groupInfo );
            stream << "##teamcity[testSuiteStarted name='"
                << escape( groupInfo.name ) << "']\n";
        }

Here is the call graph for this function:

testGroupStarting() [2/2]

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

inlineoverridevirtual

Reimplemented from Catch::StreamingReporterBase< TeamCityReporter >.

Definition at line 54 of file catch_reporter_teamcity.hpp.

                                                                      {
            StreamingReporterBase::testGroupStarting( groupInfo );
            stream << "##teamcity[testSuiteStarted name='"
                << escape( groupInfo.name ) << "']\n";
        }

Here is the call graph for this function:

---

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

• libraries/sys-vm/external/Catch2/include/reporters/catch_reporter_teamcity.hpp
• libraries/sys-vm/external/Catch2/single_include/catch2/catch_reporter_teamcity.hpp