Horizon
Public Member Functions | Static Public Member Functions | List of all members
Catch::CompactReporter Class Referencefinal
Inheritance diagram for Catch::CompactReporter:
Catch::StreamingReporterBase Catch::ReporterBase Catch::IEventListener

Public Member Functions

void noMatchingTestCases (StringRef unmatchedSpec) override
 Called when no test cases match provided test spec.
 
void testRunStarting (TestRunInfo const &_testInfo) override
 Called once in a testing run before tests are started. More...
 
void assertionEnded (AssertionStats const &_assertionStats) override
 Called after assertion was fully evaluated.
 
void sectionEnded (SectionStats const &_sectionStats) override
 Called after a SECTION has finished running.
 
void testRunEnded (TestRunStats const &_testRunStats) override
 Called once after all tests in a testing run are finished. More...
 
- Public Member Functions inherited from Catch::StreamingReporterBase
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 reportInvalidTestSpec (StringRef) override
 Called for all invalid test specs from the cli.
 
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 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 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. More...
 
void listListeners (std::vector< ListenerDescription > const &descriptions) override
 Provides a simple default listing of listeners. More...
 
void listTests (std::vector< TestCaseHandle > const &tests) override
 Provides a simple default listing of tests. More...
 
void listTags (std::vector< TagInfo > const &tags) override
 Provides a simple default listing of tags. More...
 
- Public Member Functions inherited from Catch::IEventListener
 IEventListener (IConfig const *config)
 
ReporterPreferences const & getPreferences () const
 

Static Public Member Functions

static std::string getDescription ()
 

Additional Inherited Members

- Protected Attributes inherited from Catch::StreamingReporterBase
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< ColourImplm_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

◆ testRunEnded()

void Catch::CompactReporter::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)

Reimplemented from Catch::StreamingReporterBase.

◆ testRunStarting()

void Catch::CompactReporter::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)

Reimplemented from Catch::StreamingReporterBase.


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