Class StreamingReporterBase

Inheritance Relationships

Base Type

Derived Types

Class Documentation

class StreamingReporterBase : public Catch::ReporterBase

Subclassed by Catch::AutomakeReporter, Catch::CompactReporter, Catch::ConsoleReporter

Public Functions

inline StreamingReporterBase(ReporterConfig &&_config)
~StreamingReporterBase() override
inline virtual void benchmarkPreparing(StringRef) override

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

inline virtual void benchmarkStarting(BenchmarkInfo const&) override

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

inline virtual void benchmarkEnded(BenchmarkStats<> const&) override

Called with the benchmark results if benchmark successfully finishes.

inline virtual void benchmarkFailed(StringRef) override

Called if running the benchmarks fails for any reason.

inline virtual void fatalErrorEncountered(StringRef) override

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

inline virtual void noMatchingTestCases(StringRef) override

Called when no test cases match provided test spec.

inline virtual void reportInvalidTestSpec(StringRef) override

Called for all invalid test specs from the cli.

virtual void testRunStarting(TestRunInfo const &_testRunInfo) override

Called once in a testing run before tests are started

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

inline virtual void testCaseStarting(TestCaseInfo const &_testInfo) override

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

inline virtual void testCasePartialStarting(TestCaseInfo const&, uint64_t) override

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

inline virtual void sectionStarting(SectionInfo const &_sectionInfo) override

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

inline virtual void assertionStarting(AssertionInfo const&) override

Called before assertion success/failure is evaluated.

inline virtual void assertionEnded(AssertionStats const&) override

Called after assertion was fully evaluated.

inline virtual void sectionEnded(SectionStats const&) override

Called after a SECTION has finished running.

inline virtual void testCasePartialEnded(TestCaseStats const&, uint64_t) override

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

inline virtual void testCaseEnded(TestCaseStats const&) override

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

virtual void testRunEnded(TestRunStats const&) override

Called once after all tests in a testing run are finished

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

inline virtual void skipTest(TestCaseInfo const&) override

Called with test cases that are skipped due to the test run aborting. NOT called for test cases that are explicitly skipped using the SKIP macro.

Deprecated - will be removed in the next major release.

Protected Attributes

TestRunInfo currentTestRunInfo = {"test run has not started yet"_sr}
TestCaseInfo const *currentTestCaseInfo = nullptr
std::vector<SectionInfo> m_sectionStack

Stack of all active sections in the current test case.