Horizon
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Catch::StreamingReporterBase Class Reference
Inheritance diagram for Catch::StreamingReporterBase:
Catch::ReporterBase Catch::IEventListener Catch::AutomakeReporter Catch::CompactReporter Catch::ConsoleReporter

Public Member Functions

void benchmarkPreparing (StringRef) override
 Called when user-code is being probed before the actual benchmark runs.
 
void benchmarkStarting (BenchmarkInfo const &) override
 Called after probe but before the user-code is being benchmarked.
 
void benchmarkEnded (BenchmarkStats<> const &) override
 Called with the benchmark results if benchmark successfully finishes.
 
void benchmarkFailed (StringRef) override
 Called if running the benchmarks fails for any reason.
 
void fatalErrorEncountered (StringRef) override
 Called if a fatal error (signal/structured exception) occured.
 
void noMatchingTestCases (StringRef) override
 Called when no test cases match provided test spec.
 
void reportInvalidTestSpec (StringRef) override
 Called for all invalid test specs from the cli.
 
void testRunStarting (TestRunInfo const &_testRunInfo) override
 Called once in a testing run before tests are started.
 
void testCaseStarting (TestCaseInfo const &_testInfo) override
 Called once for each TEST_CASE, no matter how many times it is entered.
 
void testCasePartialStarting (TestCaseInfo const &, uint64_t) override
 Called every time a TEST_CASE is entered, including repeats (due to sections)
 
void sectionStarting (SectionInfo const &_sectionInfo) override
 Called when a SECTION is being entered. Not called for skipped sections.
 
void assertionStarting (AssertionInfo const &) override
 Called before assertion success/failure is evaluated.
 
void assertionEnded (AssertionStats const &) override
 Called after assertion was fully evaluated.
 
void sectionEnded (SectionStats const &) override
 Called after a SECTION has finished running.
 
void testCasePartialEnded (TestCaseStats const &, uint64_t) override
 Called every time a TEST_CASE is entered, including repeats (due to sections)
 
void testCaseEnded (TestCaseStats const &) override
 Called once for each TEST_CASE, no matter how many times it is entered.
 
void testRunEnded (TestRunStats const &) override
 Called once after all tests in a testing run are finished.
 
void skipTest (TestCaseInfo const &) override
 Called with test cases that are skipped due to the test run aborting.
 
 ReporterBase (ReporterConfig &&config)
 
- Public Member Functions inherited from Catch::ReporterBase
 ReporterBase (ReporterConfig &&config)
 
void listReporters (std::vector< ReporterDescription > const &descriptions) override
 Provides a simple default listing of reporters.
 
void listListeners (std::vector< ListenerDescription > const &descriptions) override
 Provides a simple default listing of listeners.
 
void listTests (std::vector< TestCaseHandle > const &tests) override
 Provides a simple default listing of tests.
 
void listTags (std::vector< TagInfo > const &tags) override
 Provides a simple default listing of tags.
 
- Public Member Functions inherited from Catch::IEventListener
 IEventListener (IConfig const *config)
 
ReporterPreferences const & getPreferences () const
 

Protected Attributes

TestRunInfo currentTestRunInfo { "test run has not started yet"_sr }
 
TestCaseInfo const * currentTestCaseInfo = nullptr
 
std::vector< SectionInfom_sectionStack
 Stack of all active sections in the current test case.
 
- Protected Attributes inherited from Catch::ReporterBase
Detail::unique_ptr< IStreamm_wrapped_stream
 The stream wrapper as passed to us by outside code.
 
std::ostream & m_stream
 Cached output stream from m_wrapped_stream to reduce number of indirect calls needed to write output.
 
Detail::unique_ptr< ColourImpl > m_colour
 Colour implementation this reporter was configured for.
 
std::map< std::string, std::string > m_customOptions
 The custom reporter options user passed down to the reporter.
 
- Protected Attributes inherited from Catch::IEventListener
ReporterPreferences m_preferences
 Derived classes can set up their preferences here.
 
IConfig const * m_config
 The test run's config as filled in from CLI and defaults.
 

Member Function Documentation

◆ assertionEnded()

void Catch::StreamingReporterBase::assertionEnded ( AssertionStats const &  assertionStats)
inlineoverridevirtual

Called after assertion was fully evaluated.

Implements Catch::IEventListener.

◆ assertionStarting()

void Catch::StreamingReporterBase::assertionStarting ( AssertionInfo const &  assertionInfo)
inlineoverridevirtual

Called before assertion success/failure is evaluated.

Implements Catch::IEventListener.

◆ benchmarkEnded()

void Catch::StreamingReporterBase::benchmarkEnded ( BenchmarkStats<> const &  benchmarkStats)
inlineoverridevirtual

Called with the benchmark results if benchmark successfully finishes.

Implements Catch::IEventListener.

◆ benchmarkFailed()

void Catch::StreamingReporterBase::benchmarkFailed ( StringRef  benchmarkName)
inlineoverridevirtual

Called if running the benchmarks fails for any reason.

Implements Catch::IEventListener.

◆ benchmarkPreparing()

void Catch::StreamingReporterBase::benchmarkPreparing ( StringRef  benchmarkName)
inlineoverridevirtual

Called when user-code is being probed before the actual benchmark runs.

Implements Catch::IEventListener.

◆ benchmarkStarting()

void Catch::StreamingReporterBase::benchmarkStarting ( BenchmarkInfo const &  benchmarkInfo)
inlineoverridevirtual

Called after probe but before the user-code is being benchmarked.

Implements Catch::IEventListener.

◆ fatalErrorEncountered()

void Catch::StreamingReporterBase::fatalErrorEncountered ( StringRef  error)
inlineoverridevirtual

Called if a fatal error (signal/structured exception) occured.

Implements Catch::IEventListener.

◆ noMatchingTestCases()

void Catch::StreamingReporterBase::noMatchingTestCases ( StringRef  unmatchedSpec)
inlineoverridevirtual

Called when no test cases match provided test spec.

Implements Catch::IEventListener.

◆ reportInvalidTestSpec()

void Catch::StreamingReporterBase::reportInvalidTestSpec ( StringRef  invalidArgument)
inlineoverridevirtual

Called for all invalid test specs from the cli.

Implements Catch::IEventListener.

◆ sectionEnded()

void Catch::StreamingReporterBase::sectionEnded ( SectionStats const &  sectionStats)
inlineoverridevirtual

Called after a SECTION has finished running.

Implements Catch::IEventListener.

◆ sectionStarting()

void Catch::StreamingReporterBase::sectionStarting ( SectionInfo const &  sectionInfo)
inlineoverridevirtual

Called when a SECTION is being entered. Not called for skipped sections.

Implements Catch::IEventListener.

◆ skipTest()

void Catch::StreamingReporterBase::skipTest ( TestCaseInfo const &  testInfo)
inlineoverridevirtual

Called with test cases that are skipped due to the test run aborting.

Implements Catch::IEventListener.

◆ testCaseEnded()

void Catch::StreamingReporterBase::testCaseEnded ( TestCaseStats const &  testCaseStats)
inlineoverridevirtual

Called once for each TEST_CASE, no matter how many times it is entered.

Implements Catch::IEventListener.

◆ testCasePartialEnded()

void Catch::StreamingReporterBase::testCasePartialEnded ( TestCaseStats const &  testCaseStats,
uint64_t  partNumber 
)
inlineoverridevirtual

Called every time a TEST_CASE is entered, including repeats (due to sections)

Implements Catch::IEventListener.

◆ testCasePartialStarting()

void Catch::StreamingReporterBase::testCasePartialStarting ( TestCaseInfo const &  testInfo,
uint64_t  partNumber 
)
inlineoverridevirtual

Called every time a TEST_CASE is entered, including repeats (due to sections)

Implements Catch::IEventListener.

◆ testCaseStarting()

void Catch::StreamingReporterBase::testCaseStarting ( TestCaseInfo const &  testInfo)
inlineoverridevirtual

Called once for each TEST_CASE, no matter how many times it is entered.

Implements Catch::IEventListener.

◆ testRunEnded()

void Catch::StreamingReporterBase::testRunEnded ( TestRunStats const &  testRunStats)
overridevirtual

Called once after all tests in a testing run are finished.

Not called if tests weren't run (e.g. only listings happened)

Implements Catch::IEventListener.

◆ testRunStarting()

void Catch::StreamingReporterBase::testRunStarting ( TestRunInfo const &  testRunInfo)
overridevirtual

Called once in a testing run before tests are started.

Not called if tests won't be run (e.g. only listing will happen)

Implements Catch::IEventListener.


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