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

The console_unit_test class is console unit test interface. More...

#include <console_unit_test.hpp>

Inheritance diagram for xtd::tunit::console_unit_test:
xtd::tunit::ostream_unit_test xtd::tunit::unit_test

Public Member Functions

 console_unit_test ()
 Create a new console unit test. More...
 
 console_unit_test (char *argv[], int argc)
 Create a new console unit test with 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
 
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 console_unit_test class is console unit test interface.

Remarks
All messages are displayed on the console.
Examples
This example sho how to instanciate and launch tests witn console unit test.
#include <xtd/xtd.tunit>
#include <sstream>
using namespace std;
using namespace xtd::tunit;
namespace unit_tests {
class test_class_(test) {
public:
void test_method_(test_case1) {
}
};
}
// The main entry point for the application.
int main() {
return console_unit_test().run();
// is same :
// return unit_test(std::make_unique<ostream_event_listener>(cout)).run();
}
// This code can produce the following output:
//
// Start 1 test from 1 test case
// Run tests:
// SUCCEED test.test_case1 (0 ms total)
//
// Test results:
// SUCCEED 1 test.
// End 1 test from 1 test case ran. (0 ms total)

Constructor & Destructor Documentation

§ console_unit_test() [1/2]

xtd::tunit::console_unit_test::console_unit_test ( )
inline

Create a new console unit test.

§ console_unit_test() [2/2]

xtd::tunit::console_unit_test::console_unit_test ( char *  argv[],
int  argc 
)
inline

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

Parameters
argvArguments array from main method.
argcArgument count from main method.

Member Function Documentation

§ run()

int xtd::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: