Horizon
Loading...
Searching...
No Matches
Catch::TAPReporter Class Referencefinal
Inheritance diagram for Catch::TAPReporter:
Catch::StreamingReporterBase Catch::ReporterBase Catch::IEventListener

Public Member Functions

 TAPReporter (ReporterConfig &&config)
void testRunStarting (TestRunInfo const &testInfo) override
 Called once in a testing run before tests are started.
void noMatchingTestCases (StringRef unmatchedSpec) override
 Called when no test cases match provided test spec.
void assertionEnded (AssertionStats const &_assertionStats) override
 Called after assertion was fully evaluated.
void testRunEnded (TestRunStats const &_testRunStats) override
 Called once after all tests in a testing run are finished.
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 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 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

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

Called after assertion was fully evaluated.

Reimplemented from Catch::StreamingReporterBase.

◆ noMatchingTestCases()

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

Called when no test cases match provided test spec.

Reimplemented from Catch::StreamingReporterBase.

◆ testRunEnded()

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