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

Public Member Functions

 ConsoleReporter (ReporterConfig &&config)
 
void noMatchingTestCases (StringRef unmatchedSpec) override
 Called when no test cases match provided test spec. More...
 
void reportInvalidTestSpec (StringRef arg) override
 Called for all invalid test specs from the cli. More...
 
void assertionStarting (AssertionInfo const &) override
 Called before assertion success/failure is evaluated. More...
 
void assertionEnded (AssertionStats const &_assertionStats) override
 Called after assertion was fully evaluated. More...
 
void sectionStarting (SectionInfo const &_sectionInfo) override
 Called when a SECTION is being entered. Not called for skipped sections. More...
 
void sectionEnded (SectionStats const &_sectionStats) override
 Called after a SECTION has finished running. More...
 
void benchmarkPreparing (StringRef name) override
 Called when user-code is being probed before the actual benchmark runs. More...
 
void benchmarkStarting (BenchmarkInfo const &info) override
 Called after probe but before the user-code is being benchmarked. More...
 
void benchmarkEnded (BenchmarkStats<> const &stats) override
 Called with the benchmark results if benchmark successfully finishes. More...
 
void benchmarkFailed (StringRef error) override
 Called if running the benchmarks fails for any reason. More...
 
void testCaseEnded (TestCaseStats const &_testCaseStats) override
 Called once for each TEST_CASE, no matter how many times it is entered. More...
 
void testRunEnded (TestRunStats const &_testRunStats) override
 Called once after all tests in a testing run are finished. More...
 
void testRunStarting (TestRunInfo const &_testRunInfo) override
 Called once in a testing run before tests are started. More...
 
- Public Member Functions inherited from Catch::StreamingReporterBase
void benchmarkPreparing (StringRef) override
 Called when user-code is being probed before the actual benchmark runs. More...
 
void benchmarkStarting (BenchmarkInfo const &) override
 Called after probe but before the user-code is being benchmarked. More...
 
void benchmarkEnded (BenchmarkStats<> const &) override
 Called with the benchmark results if benchmark successfully finishes. More...
 
void benchmarkFailed (StringRef) override
 Called if running the benchmarks fails for any reason. More...
 
void fatalErrorEncountered (StringRef) override
 Called if a fatal error (signal/structured exception) occured. More...
 
void noMatchingTestCases (StringRef) override
 Called when no test cases match provided test spec. More...
 
void reportInvalidTestSpec (StringRef) override
 Called for all invalid test specs from the cli. More...
 
void testRunStarting (TestRunInfo const &_testRunInfo) override
 Called once in a testing run before tests are started. More...
 
void testCaseStarting (TestCaseInfo const &_testInfo) override
 Called once for each TEST_CASE, no matter how many times it is entered. More...
 
void testCasePartialStarting (TestCaseInfo const &, uint64_t) override
 Called every time a TEST_CASE is entered, including repeats (due to sections) More...
 
void sectionStarting (SectionInfo const &_sectionInfo) override
 Called when a SECTION is being entered. Not called for skipped sections. More...
 
void assertionStarting (AssertionInfo const &) override
 Called before assertion success/failure is evaluated. More...
 
void assertionEnded (AssertionStats const &) override
 Called after assertion was fully evaluated. More...
 
void sectionEnded (SectionStats const &) override
 Called after a SECTION has finished running. More...
 
void testCasePartialEnded (TestCaseStats const &, uint64_t) override
 Called every time a TEST_CASE is entered, including repeats (due to sections) More...
 
void testCaseEnded (TestCaseStats const &) override
 Called once for each TEST_CASE, no matter how many times it is entered. More...
 
void testRunEnded (TestRunStats const &) override
 Called once after all tests in a testing run are finished. More...
 
void skipTest (TestCaseInfo const &) override
 Called with test cases that are skipped due to the test run aborting. More...
 
 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
 
virtual void noMatchingTestCases (StringRef unmatchedSpec)=0
 Called when no test cases match provided test spec. More...
 
virtual void reportInvalidTestSpec (StringRef invalidArgument)=0
 Called for all invalid test specs from the cli. More...
 
virtual void testRunStarting (TestRunInfo const &testRunInfo)=0
 Called once in a testing run before tests are started. More...
 
virtual void testCaseStarting (TestCaseInfo const &testInfo)=0
 Called once for each TEST_CASE, no matter how many times it is entered. More...
 
virtual void testCasePartialStarting (TestCaseInfo const &testInfo, uint64_t partNumber)=0
 Called every time a TEST_CASE is entered, including repeats (due to sections) More...
 
virtual void sectionStarting (SectionInfo const &sectionInfo)=0
 Called when a SECTION is being entered. Not called for skipped sections. More...
 
virtual void benchmarkPreparing (StringRef benchmarkName)=0
 Called when user-code is being probed before the actual benchmark runs. More...
 
virtual void benchmarkStarting (BenchmarkInfo const &benchmarkInfo)=0
 Called after probe but before the user-code is being benchmarked. More...
 
virtual void benchmarkEnded (BenchmarkStats<> const &benchmarkStats)=0
 Called with the benchmark results if benchmark successfully finishes. More...
 
virtual void benchmarkFailed (StringRef benchmarkName)=0
 Called if running the benchmarks fails for any reason. More...
 
virtual void assertionStarting (AssertionInfo const &assertionInfo)=0
 Called before assertion success/failure is evaluated. More...
 
virtual void assertionEnded (AssertionStats const &assertionStats)=0
 Called after assertion was fully evaluated. More...
 
virtual void sectionEnded (SectionStats const &sectionStats)=0
 Called after a SECTION has finished running. More...
 
virtual void testCasePartialEnded (TestCaseStats const &testCaseStats, uint64_t partNumber)=0
 Called every time a TEST_CASE is entered, including repeats (due to sections) More...
 
virtual void testCaseEnded (TestCaseStats const &testCaseStats)=0
 Called once for each TEST_CASE, no matter how many times it is entered. More...
 
virtual void testRunEnded (TestRunStats const &testRunStats)=0
 Called once after all tests in a testing run are finished. More...
 
virtual void skipTest (TestCaseInfo const &testInfo)=0
 Called with test cases that are skipped due to the test run aborting. More...
 
virtual void fatalErrorEncountered (StringRef error)=0
 Called if a fatal error (signal/structured exception) occured. More...
 
virtual void listReporters (std::vector< ReporterDescription > const &descriptions)=0
 Writes out information about provided reporters using reporter-specific format. More...
 
virtual void listListeners (std::vector< ListenerDescription > const &descriptions)=0
 Writes out the provided listeners descriptions using reporter-specific format. More...
 
virtual void listTests (std::vector< TestCaseHandle > const &tests)=0
 Writes out information about provided tests using reporter-specific format. More...
 
virtual void listTags (std::vector< TagInfo > const &tags)=0
 Writes out information about the provided tags using reporter-specific format. More...
 

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

◆ assertionEnded()

void Catch::ConsoleReporter::assertionEnded ( AssertionStats const &  assertionStats)
overridevirtual

Called after assertion was fully evaluated.

Reimplemented from Catch::StreamingReporterBase.

◆ assertionStarting()

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

Called before assertion success/failure is evaluated.

Reimplemented from Catch::StreamingReporterBase.

◆ benchmarkEnded()

void Catch::ConsoleReporter::benchmarkEnded ( BenchmarkStats<> const &  benchmarkStats)
overridevirtual

Called with the benchmark results if benchmark successfully finishes.

Reimplemented from Catch::StreamingReporterBase.

◆ benchmarkFailed()

void Catch::ConsoleReporter::benchmarkFailed ( StringRef  benchmarkName)
overridevirtual

Called if running the benchmarks fails for any reason.

Reimplemented from Catch::StreamingReporterBase.

◆ benchmarkPreparing()

void Catch::ConsoleReporter::benchmarkPreparing ( StringRef  benchmarkName)
overridevirtual

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

Reimplemented from Catch::StreamingReporterBase.

◆ benchmarkStarting()

void Catch::ConsoleReporter::benchmarkStarting ( BenchmarkInfo const &  benchmarkInfo)
overridevirtual

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

Reimplemented from Catch::StreamingReporterBase.

◆ noMatchingTestCases()

void Catch::ConsoleReporter::noMatchingTestCases ( StringRef  unmatchedSpec)
overridevirtual

Called when no test cases match provided test spec.

Reimplemented from Catch::StreamingReporterBase.

◆ reportInvalidTestSpec()

void Catch::ConsoleReporter::reportInvalidTestSpec ( StringRef  invalidArgument)
overridevirtual

Called for all invalid test specs from the cli.

Reimplemented from Catch::StreamingReporterBase.

◆ sectionEnded()

void Catch::ConsoleReporter::sectionEnded ( SectionStats const &  sectionStats)
overridevirtual

Called after a SECTION has finished running.

Reimplemented from Catch::StreamingReporterBase.

◆ sectionStarting()

void Catch::ConsoleReporter::sectionStarting ( SectionInfo const &  sectionInfo)
overridevirtual

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

Reimplemented from Catch::StreamingReporterBase.

◆ testCaseEnded()

void Catch::ConsoleReporter::testCaseEnded ( TestCaseStats const &  testCaseStats)
overridevirtual

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

Reimplemented from Catch::StreamingReporterBase.

◆ testRunEnded()

void Catch::ConsoleReporter::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::ConsoleReporter::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: