tunit - Reference Guide  1.0.0
Modern c++17 unit testing framework on Windows, macOS, Linux, iOS and android.
tunit::ostream_unit_test Class Reference

The ostream_unit_test class is ostream unit test interface. More...

#include <ostream_unit_test.h>

Inheritance diagram for tunit::ostream_unit_test:
Collaboration diagram for tunit::ostream_unit_test:

Public Member Functions

 ostream_unit_test (std::ostream &os) noexcept
 Create a new console unit test with ostream specified. More...
 
 ostream_unit_test (std::ostream &os, char *argv[], int argc)
 Create a new console unit test with ostream specified, argv specified and argc specified. More...
 
size_t aborted_test_count () const noexcept
 
std::vector< std::string > aborted_test_names () const noexcept
 
std::chrono::milliseconds elapsed_time () const noexcept
 
size_t failed_test_count () const noexcept
 
std::vector< std::string > failed_test_names () const noexcept
 
size_t ignored_test_count () const noexcept
 
std::vector< std::string > ignored_test_names () const noexcept
 
int list_tests (const std::vector< std::string > &tests) override
 
std::ostream & ostream ()
 Gets the ostream used by this instance. More...
 
bool parse_arguments (const std::vector< std::string > &args) override
 
int repeat_iteration () const noexcept
 
int repeat_iteration_count () const noexcept
 
bool repeat_tests () const noexcept
 
int run ()
 Runs all tests in this UnitTest object and prints the result. More...
 
size_t succeed_test_count () const noexcept
 
std::vector< std::string > succeed_test_names () const noexcept
 
size_t test_cases_count () const noexcept
 
size_t test_count () const noexcept
 
void write_help ()
 

Detailed Description

The ostream_unit_test class is ostream unit test interface.

Remarks
All messages are writting on the specified ostream.

Constructor & Destructor Documentation

◆ ostream_unit_test() [1/2]

tunit::ostream_unit_test::ostream_unit_test ( std::ostream &  os)
inlineexplicitnoexcept

Create a new console unit test with ostream specified.

Parameters
osThe ostream to write events.

◆ ostream_unit_test() [2/2]

tunit::ostream_unit_test::ostream_unit_test ( std::ostream &  os,
char *  argv[],
int  argc 
)
inline

Create a new console unit test with ostream specified, argv specified and argc specified.

Parameters
osThe ostream to write events.
argvArguments array from main method.
argcArgument count from main method.

Member Function Documentation

◆ ostream()

std::ostream& tunit::ostream_unit_test::ostream ( )
inline

Gets the ostream used by this instance.

Returns
The ostream used by this instance.
Warning
Used it only if you need to write specific user messages. If you change or redirect it when tests running, the unit test output result will be indeterminate.

◆ run()

int tunit::unit_test::run ( )
inlineinherited

Runs all tests in this UnitTest object and prints the result.

Returns
EXIT_SUCCESS (0) if succeed; otherwise return EXIT_FAILURE (1).

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