Horizon
Public Member Functions | List of all members
Catch::MultiReporter Class Referencefinal
Inheritance diagram for Catch::MultiReporter:
Catch::IEventListener

Public Member Functions

void addListener (IEventListenerPtr &&listener)
 
void addReporter (IEventListenerPtr &&reporter)
 
void noMatchingTestCases (StringRef unmatchedSpec) override
 Called when no test cases match provided test spec. More...
 
void fatalErrorEncountered (StringRef error) override
 Called if a fatal error (signal/structured exception) occured. More...
 
void reportInvalidTestSpec (StringRef arg) override
 Called for all invalid test specs from the cli. More...
 
void benchmarkPreparing (StringRef name) override
 Called when user-code is being probed before the actual benchmark runs. More...
 
void benchmarkStarting (BenchmarkInfo const &benchmarkInfo) override
 Called after probe but before the user-code is being benchmarked. More...
 
void benchmarkEnded (BenchmarkStats<> const &benchmarkStats) 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 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 &testInfo, uint64_t partNumber) 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 &assertionInfo) override
 Called before assertion success/failure is evaluated. More...
 
void assertionEnded (AssertionStats const &assertionStats) override
 Called after assertion was fully evaluated. More...
 
void sectionEnded (SectionStats const &sectionStats) override
 Called after a SECTION has finished running. More...
 
void testCasePartialEnded (TestCaseStats const &testInfo, uint64_t partNumber) override
 Called every time a TEST_CASE is entered, including repeats (due to sections) 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 skipTest (TestCaseInfo const &testInfo) override
 Called with test cases that are skipped due to the test run aborting. More...
 
void listReporters (std::vector< ReporterDescription > const &descriptions) override
 Writes out information about provided reporters using reporter-specific format. More...
 
void listListeners (std::vector< ListenerDescription > const &descriptions) override
 Writes out the provided listeners descriptions using reporter-specific format. More...
 
void listTests (std::vector< TestCaseHandle > const &tests) override
 Writes out information about provided tests using reporter-specific format. More...
 
void listTags (std::vector< TagInfo > const &tags) override
 Writes out information about the provided tags using reporter-specific format. More...
 
 IEventListener (IConfig const *config)
 
- 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...
 

Additional Inherited Members

- 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::MultiReporter::assertionEnded ( AssertionStats const &  assertionStats)
overridevirtual

Called after assertion was fully evaluated.

Implements Catch::IEventListener.

◆ assertionStarting()

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

Called before assertion success/failure is evaluated.

Implements Catch::IEventListener.

◆ benchmarkEnded()

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

Called with the benchmark results if benchmark successfully finishes.

Implements Catch::IEventListener.

◆ benchmarkFailed()

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

Called if running the benchmarks fails for any reason.

Implements Catch::IEventListener.

◆ benchmarkPreparing()

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

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

Implements Catch::IEventListener.

◆ benchmarkStarting()

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

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

Implements Catch::IEventListener.

◆ fatalErrorEncountered()

void Catch::MultiReporter::fatalErrorEncountered ( StringRef  error)
overridevirtual

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

Implements Catch::IEventListener.

◆ listListeners()

void Catch::MultiReporter::listListeners ( std::vector< ListenerDescription > const &  descriptions)
overridevirtual

Writes out the provided listeners descriptions using reporter-specific format.

Implements Catch::IEventListener.

◆ listReporters()

void Catch::MultiReporter::listReporters ( std::vector< ReporterDescription > const &  descriptions)
overridevirtual

Writes out information about provided reporters using reporter-specific format.

Implements Catch::IEventListener.

◆ listTags()

void Catch::MultiReporter::listTags ( std::vector< TagInfo > const &  tags)
overridevirtual

Writes out information about the provided tags using reporter-specific format.

Implements Catch::IEventListener.

◆ listTests()

void Catch::MultiReporter::listTests ( std::vector< TestCaseHandle > const &  tests)
overridevirtual

Writes out information about provided tests using reporter-specific format.

Implements Catch::IEventListener.

◆ noMatchingTestCases()

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

Called when no test cases match provided test spec.

Implements Catch::IEventListener.

◆ reportInvalidTestSpec()

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

Called for all invalid test specs from the cli.

Implements Catch::IEventListener.

◆ sectionEnded()

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

Called after a SECTION has finished running.

Implements Catch::IEventListener.

◆ sectionStarting()

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

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

Implements Catch::IEventListener.

◆ skipTest()

void Catch::MultiReporter::skipTest ( TestCaseInfo const &  testInfo)
overridevirtual

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

Implements Catch::IEventListener.

◆ testCaseEnded()

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

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

Implements Catch::IEventListener.

◆ testCasePartialEnded()

void Catch::MultiReporter::testCasePartialEnded ( TestCaseStats const &  testCaseStats,
uint64_t  partNumber 
)
overridevirtual

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

Implements Catch::IEventListener.

◆ testCasePartialStarting()

void Catch::MultiReporter::testCasePartialStarting ( TestCaseInfo const &  testInfo,
uint64_t  partNumber 
)
overridevirtual

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

Implements Catch::IEventListener.

◆ testCaseStarting()

void Catch::MultiReporter::testCaseStarting ( TestCaseInfo const &  testInfo)
overridevirtual

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

Implements Catch::IEventListener.

◆ testRunEnded()

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