Catch::ConsoleReporter Struct Reference

#include <catch_reporter_console.h>

Inheritance diagram for Catch::ConsoleReporter:

Collaboration diagram for Catch::ConsoleReporter:

Public Member Functions
	ConsoleReporter (ReporterConfig const &config)
	~ConsoleReporter () override
void	noMatchingTestCases (std::string const &spec) override
void	assertionStarting (AssertionInfo const &) override
bool	assertionEnded (AssertionStats const &_assertionStats) override
void	sectionStarting (SectionInfo const &_sectionInfo) override
void	sectionEnded (SectionStats const &_sectionStats) override
void	benchmarkStarting (BenchmarkInfo const &info) override
void	benchmarkEnded (BenchmarkStats const &stats) override
void	testCaseEnded (TestCaseStats const &_testCaseStats) override
void	testGroupEnded (TestGroupStats const &_testGroupStats) override
void	testRunEnded (TestRunStats const &_testRunStats) override
void	testRunStarting (TestRunInfo const &_testRunInfo) override
Public Member Functions inherited from Catch::StreamingReporterBase< ConsoleReporter >
	StreamingReporterBase (ReporterConfig const &_config)
ReporterPreferences	getPreferences () const override
	~StreamingReporterBase () override=default
void	noMatchingTestCases (std::string const &) override
void	testRunStarting (TestRunInfo const &_testRunInfo) override
void	testGroupStarting (GroupInfo const &_groupInfo) override
void	testCaseStarting (TestCaseInfo const &_testInfo) override
void	sectionStarting (SectionInfo const &_sectionInfo) override
void	sectionEnded (SectionStats const &) override
void	testCaseEnded (TestCaseStats const &) override
void	testGroupEnded (TestGroupStats const &) override
void	testRunEnded (TestRunStats const &) override
void	skipTest (TestCaseInfo const &) override
Public Member Functions inherited from Catch::IStreamingReporter
virtual	~IStreamingReporter ()=default
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< ConsoleReporter >
static std::set< Verbosity >	getSupportedVerbosities ()

Public Attributes
std::unique_ptr< TablePrinter >	m_tablePrinter
Public Attributes inherited from Catch::StreamingReporterBase< ConsoleReporter >
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_console.h.

Constructor & Destructor Documentation

ConsoleReporter()

Catch::ConsoleReporter::ConsoleReporter

(

ReporterConfig const &

config

)

Definition at line 338 of file catch_reporter_console.cpp.

    : StreamingReporterBase(config),
    m_tablePrinter(new TablePrinter(config.stream(),
    {
        { "benchmark name", CATCH_CONFIG_CONSOLE_WIDTH - 32, ColumnInfo::Left },
        { "iters", 8, ColumnInfo::Right },
        { "elapsed ns", 14, ColumnInfo::Right },
        { "average", 14, ColumnInfo::Right }
    })) {}

~ConsoleReporter()

Catch::ConsoleReporter::~ConsoleReporter ( )

overridedefault

Member Function Documentation

assertionEnded()

bool Catch::ConsoleReporter::assertionEnded ( AssertionStats const & _assertionStats )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 359 of file catch_reporter_console.cpp.

                                                                          {
    AssertionResult const& result = _assertionStats.assertionResult;
 
    bool includeResults = m_config->includeSuccessfulResults() || !result.isOk();
 
    // Drop out if result was successful but we're not printing them.
    if (!includeResults && result.getResultType() != ResultWas::Warning)
        return false;
 
    lazyPrint();
 
    ConsoleAssertionPrinter printer(stream, _assertionStats, includeResults);
    printer.print();
    stream << std::endl;
    return true;
}

assertionStarting()

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

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 357 of file catch_reporter_console.cpp.

{}

benchmarkEnded()

void Catch::ConsoleReporter::benchmarkEnded ( BenchmarkStats const & stats )

overridevirtual

Reimplemented from Catch::IStreamingReporter.

Definition at line 416 of file catch_reporter_console.cpp.

                                                                {
    Duration average(stats.elapsedTimeInNanoseconds / stats.iterations);
    (*m_tablePrinter)
        << stats.iterations << ColumnBreak()
        << stats.elapsedTimeInNanoseconds << ColumnBreak()
        << average << ColumnBreak();
}

benchmarkStarting()

void Catch::ConsoleReporter::benchmarkStarting ( BenchmarkInfo const & info )

overridevirtual

Reimplemented from Catch::IStreamingReporter.

Definition at line 401 of file catch_reporter_console.cpp.

                                                                 {
    lazyPrintWithoutClosingBenchmarkTable();
 
    auto nameCol = Column( info.name ).width( static_cast<std::size_t>( m_tablePrinter->columnInfos()[0].width - 2 ) );
 
    bool firstLine = true;
    for (auto line : nameCol) {
        if (!firstLine)
            (*m_tablePrinter) << ColumnBreak() << ColumnBreak() << ColumnBreak();
        else
            firstLine = false;
 
        (*m_tablePrinter) << line << ColumnBreak();
    }
}

Here is the call graph for this function:

getDescription()

std::string Catch::ConsoleReporter::getDescription ( )

static

Definition at line 349 of file catch_reporter_console.cpp.

                                          {
    return "Reports test results as plain lines of text";
}

noMatchingTestCases()

void Catch::ConsoleReporter::noMatchingTestCases ( std::string const & spec )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 353 of file catch_reporter_console.cpp.

                                                               {
    stream << "No test cases matched '" << spec << '\'' << std::endl;
}

sectionEnded()

void Catch::ConsoleReporter::sectionEnded ( SectionStats const & _sectionStats )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 380 of file catch_reporter_console.cpp.

                                                                    {
    m_tablePrinter->close();
    if (_sectionStats.missingAssertions) {
        lazyPrint();
        Colour colour(Colour::ResultError);
        if (m_sectionStack.size() > 1)
            stream << "\nNo assertions in section";
        else
            stream << "\nNo assertions in test case";
        stream << " '" << _sectionStats.sectionInfo.name << "'\n" << std::endl;
    }
    if (m_config->showDurations() == ShowDurations::Always) {
        stream << getFormattedDuration(_sectionStats.durationInSeconds) << " s: " << _sectionStats.sectionInfo.name << std::endl;
    }
    if (m_headerPrinted) {
        m_headerPrinted = false;
    }
    StreamingReporterBase::sectionEnded(_sectionStats);
}

Here is the call graph for this function:

sectionStarting()

void Catch::ConsoleReporter::sectionStarting ( SectionInfo const & _sectionInfo )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 376 of file catch_reporter_console.cpp.

                                                                     {
    m_headerPrinted = false;
    StreamingReporterBase::sectionStarting(_sectionInfo);
}

Here is the call graph for this function:

testCaseEnded()

void Catch::ConsoleReporter::testCaseEnded ( TestCaseStats const & _testCaseStats )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 424 of file catch_reporter_console.cpp.

                                                                       {
    m_tablePrinter->close();
    StreamingReporterBase::testCaseEnded(_testCaseStats);
    m_headerPrinted = false;
}

Here is the call graph for this function:

testGroupEnded()

void Catch::ConsoleReporter::testGroupEnded ( TestGroupStats const & _testGroupStats )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 429 of file catch_reporter_console.cpp.

                                                                          {
    if (currentGroupInfo.used) {
        printSummaryDivider();
        stream << "Summary for group '" << _testGroupStats.groupInfo.name << "':\n";
        printTotals(_testGroupStats.totals);
        stream << '\n' << std::endl;
    }
    StreamingReporterBase::testGroupEnded(_testGroupStats);
}

Here is the call graph for this function:

testRunEnded()

void Catch::ConsoleReporter::testRunEnded ( TestRunStats const & _testRunStats )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 438 of file catch_reporter_console.cpp.

                                                                    {
    printTotalsDivider(_testRunStats.totals);
    printTotals(_testRunStats.totals);
    stream << std::endl;
    StreamingReporterBase::testRunEnded(_testRunStats);
}

Here is the call graph for this function:

testRunStarting()

void Catch::ConsoleReporter::testRunStarting ( TestRunInfo const & _testRunInfo )

overridevirtual

Implements Catch::IStreamingReporter.

Definition at line 444 of file catch_reporter_console.cpp.

                                                                  {
    StreamingReporterBase::testRunStarting(_testInfo);
    printTestFilters();
}

Here is the call graph for this function:

Member Data Documentation

m_tablePrinter

std::unique_ptr<TablePrinter> Catch::ConsoleReporter::m_tablePrinter

Definition at line 27 of file catch_reporter_console.h.

---

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

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