kaycxx-test
C++ unit test framework
Loading...
Searching...
No Matches
Public Member Functions | List of all members
kaycxx::test::reporter Class Referenceabstract

Receives lifecycle events from the test runner. More...

#include <kaycxx/test/reporter.hpp>

Public Member Functions

virtual ~reporter ()=default
 Destroys the reporter.
 
virtual void before_test_suites (std::size_t num_suites, std::size_t num_tests)=0
 Called before the full test run starts.
 
virtual void before_test_suite (std::string_view description, std::size_t num_suites, std::size_t num_tests)=0
 Called before a test suite starts.
 
virtual void before_test_case (std::string_view description)=0
 Called before a test case starts.
 
virtual void after_test_case (std::string_view description)=0
 Called after a test case passed.
 
virtual void after_test_case (std::string_view description, skipped result)=0
 Called after a test case was skipped.
 
virtual void after_test_case (std::string_view description, failure result)=0
 Called after a test case failed.
 
virtual void after_test_suite ()=0
 Called after a test suite passed.
 
virtual void after_test_suite (failure result, std::size_t skipped_tests)=0
 Called after a test suite failed.
 
virtual void after_test_suites ()=0
 Called after the full test run finished.
 

Detailed Description

Receives lifecycle events from the test runner.

Member Function Documentation

◆ after_test_case() [1/3]

virtual void kaycxx::test::reporter::after_test_case ( std::string_view  description)
pure virtual

Called after a test case passed.

Parameters
descriptionTest case description.

◆ after_test_case() [2/3]

virtual void kaycxx::test::reporter::after_test_case ( std::string_view  description,
failure  result 
)
pure virtual

Called after a test case failed.

Parameters
descriptionTest case description.
resultFailure result.

◆ after_test_case() [3/3]

virtual void kaycxx::test::reporter::after_test_case ( std::string_view  description,
skipped  result 
)
pure virtual

Called after a test case was skipped.

Parameters
descriptionTest case description.
resultSkip result.

◆ after_test_suite()

virtual void kaycxx::test::reporter::after_test_suite ( failure  result,
std::size_t  skipped_tests 
)
pure virtual

Called after a test suite failed.

Parameters
resultFailure result.
skipped_testsNumber of tests skipped because the suite could not run.

◆ before_test_case()

virtual void kaycxx::test::reporter::before_test_case ( std::string_view  description)
pure virtual

Called before a test case starts.

This is also called for skipped tests so before/after test case events stay symmetric.

Parameters
descriptionTest case description.

◆ before_test_suite()

virtual void kaycxx::test::reporter::before_test_suite ( std::string_view  description,
std::size_t  num_suites,
std::size_t  num_tests 
)
pure virtual

Called before a test suite starts.

Parameters
descriptionSuite description.
num_suitesNumber of nested suites.
num_testsNumber of test cases in this suite and its nested suites.

◆ before_test_suites()

virtual void kaycxx::test::reporter::before_test_suites ( std::size_t  num_suites,
std::size_t  num_tests 
)
pure virtual

Called before the full test run starts.

Parameters
num_suitesNumber of registered test suites.
num_testsNumber of registered test cases.

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