xtd 0.2.0
Loading...
Searching...
No Matches
List of all members
xtd::tunit::event_listener Class Reference
﹡ libraries » xtd.tunit | unit tests
Inheritance diagram for xtd::tunit::event_listener:
xtd::tunit::ostream_event_listener

Definition

Represent the event listener class. Unit test call theses events when unit tests are processing.

Namespace
xtd::tunit
Library
xtd.tunit
Remarks
Override this class for create your own event listener.
Examples
The follow example shows how to create your own listener event for simulate gtest output.
#include <xtd/xtd.tunit>
using namespace xtd;
using namespace xtd::tunit;
// Simulate gtest event listener test output
class gtest_event_listener final : public event_listener {
private:
void on_unit_test_start(const xtd::tunit::tunit_event_args& e) const override {
event_listener::on_unit_test_start(e);
console::out << "[==========] Running " << e.unit_test().test_count() << " tests from " << e.unit_test().test_cases_count() << " test case." << environment::new_line;
}
//void on_unit_test_initialize_start(const xtd::tunit::tunit_event_args& e) const override {
// event_listener::on_unit_test_initialize_start(e);
//}
void on_unit_test_initialize_end(const xtd::tunit::tunit_event_args& e) const override {
event_listener::on_unit_test_initialize_end(e);
console::out << "[----------] Global test environment set-up." << environment::new_line;
}
void on_class_start(const xtd::tunit::class_event_args& e) const override {
event_listener::on_class_start(e);
console::out << "[----------] " << e.test_class().test_count() << " tests from " << e.test_class().name() << environment::new_line;
}
//void on_class_initialize_start(const xtd::tunit::class_event_args& e) const override {
// event_listener::on_class_initialize_start(e);
//}
//void on_class_initialize_end(const xtd::tunit::class_event_args& e) const override {
// event_listener::on_class_initialize_end(e);
//}
//void on_test_initialize_start(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_initialize_start(e);
//}
//void on_test_initialize_end(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_initialize_end(e);
//}
void on_test_start(const xtd::tunit::test_event_args& e) const override {
event_listener::on_test_start(e);
console::out << "[ RUN ] " << e.test_class().name() << "." << e.test().name() << environment::new_line;
}
void on_test_succeed(const xtd::tunit::test_event_args& e) const override {
event_listener::on_test_succeed(e);
console::out << "[ OK ] " << e.test_class().name() << "." << e.test().name() << " (" << as<int>(e.test().elapsed_time().total_microseconds()) << " ms)" << environment::new_line;
}
//void on_test_aborted(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_aborted(e);
//}
void on_test_failed(const xtd::tunit::test_event_args& e) const override {
event_listener::on_test_failed(e);
console::out << e.test().stack_frame().get_file_name() << ":" << e.test().stack_frame().get_file_line_number() << ": Failure" << environment::new_line;
if (e.test().actual() != "") console::out << " Actual: " << e.test().actual() << environment::new_line;
if (e.test().expect() != "") console::out << "Expected: " << e.test().expect() << environment::new_line;
if (e.test().message() != "") console::out << e.test().message() << environment::new_line;
console::out << "[ FAILED ] " << e.test_class().name() << "." << e.test().name() << " (" << as<int>(e.test().elapsed_time().total_milliseconds()) << " ms)" << environment::new_line;
}
//void on_test_ignored(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_ignored(e);
//}
//void on_test_end(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_end(e);
//}
//void on_test_cleanup_start(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_cleanup_start(e);
//}
//void on_test_cleanup_end(const xtd::tunit::test_event_args& e) const override {
// event_listener::on_test_cleanup_end(e);
//}
//void on_class_cleanup_start(const xtd::tunit::class_event_args& e) const override {
// event_listener::on_class_cleanup_start(e);
//}
//void on_class_cleanup_end(const xtd::tunit::class_event_args& e) const override {
// event_listener::on_class_cleanup_end(e);
//}
void on_class_end(const xtd::tunit::class_event_args& e) const override {
event_listener::on_class_end(e);
console::out << "[----------] " << e.test_class().test_count() << " tests from " << e.test_class().name() << " (" << as<int>(e.test_class().elapsed_time().total_milliseconds()) << " ms)" << environment::new_line;
}
//void on_unit_test_cleanup_start(const xtd::tunit::tunit_event_args& e) const override {
// event_listener::on_unit_test_cleanup_start(e);
//}
void on_unit_test_cleanup_end(const xtd::tunit::tunit_event_args& e) const override {
event_listener::on_unit_test_cleanup_end(e);
console::out << environment::new_line << "[----------] Global test environment tear-down" << environment::new_line;
}
void on_unit_test_end(const xtd::tunit::tunit_event_args& e) const override {
event_listener::on_unit_test_end(e);
console::out << "[==========] " << e.unit_test().test_count() << " tests from " << e.unit_test().test_cases_count() << " test case ran. (" << as<int>(e.unit_test().elapsed_time().total_milliseconds()) << " ms total)" << environment::new_line;
console::out << "[ PASSED ] " << e.unit_test().succeed_test_count() << " tests." << environment::new_line;
if (e.unit_test().failed_test_count()) {
console::out << "[ FAILED ] " << e.unit_test().failed_test_count() << " test, listed below:" << environment::new_line;
for (string name : e.unit_test().failed_test_names())
console::out << "[ FAILED ] " << name << environment::new_line;
console::out << environment::new_line;
console::out << " " << e.unit_test().failed_test_count() << " FAILED TEST" << environment::new_line;
}
if (!e.unit_test().failed_test_count() && e.unit_test().ignored_test_count()) console::out << environment::new_line;
if (e.unit_test().ignored_test_count()) console::out << " YOU HAVE " << e.unit_test().ignored_test_count() << " DISABLED TESTS" << environment::new_line << environment::new_line;
}
};
// Simulate gtest unit test test output
class gtest_unit_test final : public unit_test {
public:
gtest_unit_test() : unit_test(new_uptr<gtest_event_listener>()) {}
};
namespace unit_tests {
class test_class_(test) {
void test_method_(test_case1) {
}
void test_method_(test_case2) {
}
void test_method_(test_case3) {
assert::is_true(false, "Your message...");
}
void ignore_test_method_(test_case4) {
}
};
}
auto main() -> int {
return gtest_unit_test().run();
// is same :
// return unit_test(std::new_uptr<gtest_event_listener>()).run();
}
// This code can produce the following output :
//
// [==========] Running 3 tests from 1 test case.
// [----------] Global test environment set-up.
// [----------] 3 tests from test
// [ RUN ] test.test_case1
// [ OK ] test.test_case1 (0 ms)
// [ RUN ] test.test_case2
// [ OK ] test.test_case2 (0 ms)
// [ RUN ] test.test_case3
// !---OMITTED---!/create_gtest_like_event_listener.cpp:139: Failure
// Actual: false
// Expected: true
// Your message...
// [ FAILED ] ManualTest.TestCase3 (0 ms)
// [----------] 3 tests from test (0 ms)
//
// [----------] Global test environment tear-down
// [==========] 3 tests from 1 test case ran. (0 ms total)
// [ PASSED ] 2 tests.
// [ FAILED ] 1 test, listed below:
// [ FAILED ] test.test_case3
//
// 1 FAILED TEST
// YOU HAVE 1 DISABLED TESTS
xtd::console::out
static std::ostream out
Gets the standard output stream. A std::basic_ostream<char_t> that represents the standard output str...
Definition console.hpp:52
xtd::environment::new_line
static xtd::string new_line() noexcept
Gets the newline string defined for this environment.
xtd::tunit::class_event_args
Provides data for the xtd::tunit::class_test events.
Definition class_event_args.hpp:18
xtd::tunit::event_listener
Represent the event listener class. Unit test call theses events when unit tests are processing.
Definition event_listener.hpp:23
xtd::tunit::event_listener::on_class_start
virtual void on_class_start(const xtd::tunit::class_event_args &e) const
Occurs when class is started.
Definition event_listener.hpp:54
xtd::tunit::event_listener::on_test_succeed
virtual void on_test_succeed(const xtd::tunit::test_event_args &e) const
Occurs when test is succeed.
Definition event_listener.hpp:94
xtd::tunit::event_listener::on_unit_test_start
virtual void on_unit_test_start(const xtd::tunit::tunit_event_args &e) const
Occurs when unit test cleanup is started.
Definition event_listener.hpp:118
xtd::tunit::event_listener::on_test_start
virtual void on_test_start(const xtd::tunit::test_event_args &e) const
Occurs when test initialize is started.
Definition event_listener.hpp:90
xtd::tunit::event_listener::on_unit_test_end
virtual void on_unit_test_end(const xtd::tunit::tunit_event_args &e) const
Occurs when unit test is ended.
Definition event_listener.hpp:106
xtd::tunit::event_listener::on_unit_test_cleanup_end
virtual void on_unit_test_cleanup_end(const xtd::tunit::tunit_event_args &e) const
Occurs when unit test cleanup is ended.
Definition event_listener.hpp:98
xtd::tunit::event_listener::on_class_end
virtual void on_class_end(const xtd::tunit::class_event_args &e) const
Occurs when class is ended.
Definition event_listener.hpp:42
xtd::tunit::event_listener::on_test_failed
virtual void on_test_failed(const xtd::tunit::test_event_args &e) const
Occurs when test is failed.
Definition event_listener.hpp:86
xtd::tunit::event_listener::on_unit_test_initialize_end
virtual void on_unit_test_initialize_end(const xtd::tunit::tunit_event_args &e) const
Occurs when unit test initialize is ended.
Definition event_listener.hpp:110
xtd::tunit::test_event_args
Provides data for the xtd::tunit::test events.
Definition test_event_args.hpp:19
xtd::tunit::tunit_event_args
tunit_event_args is the base class for classes containing event data.
Definition tunit_event_args.hpp:19
xtd::tunit::unit_test
The unit_test class is unit test base interface.
Definition unit_test.hpp:29
xtd::threading::this_thread::name
xtd::string name() noexcept
Gets the thread name of the current thread.
test_method_
#define test_method_(method_name)
Add test method to class test.
Definition test_method_attribute.hpp:72
ignore_test_method_
#define ignore_test_method_(method_name)
Add ignored test method to class test.
Definition test_method_attribute.hpp:57
xtd::new_uptr
uptr< type_t > new_uptr(args_t &&... args)
xtd::new_uptr operator. This operator creates a xtd::uptr object.
Definition new_uptr.hpp:24
xtd::as
type_t as(any_object &o)
Casts a type into another type.
Definition __as_any_object.hpp:59
xtd::console_key::e
@ e
The E key.
Definition console_key.hpp:96
xtd::tunit
The tunit namespace contains a unit test library.
Definition abort_error.hpp:10
xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8
Examples
create_gtest_like_event_listener.cpp.

Public Methods

virtual void on_class_cleanup_end (const xtd::tunit::class_event_args &e) const
 Occurs when class cleanup is ended.
 
virtual void on_class_cleanup_start (const xtd::tunit::class_event_args &e) const
 Occurs when class cleanup is started.
 
virtual void on_class_end (const xtd::tunit::class_event_args &e) const
 Occurs when class is ended.
 
virtual void on_class_initialize_end (const xtd::tunit::class_event_args &e) const
 Occurs when class initialize is ended.
 
virtual void on_class_initialize_start (const xtd::tunit::class_event_args &e) const
 Occurs when class initialize is started.
 
virtual void on_class_start (const xtd::tunit::class_event_args &e) const
 Occurs when class is started.
 
virtual void on_test_cleanup_end (const xtd::tunit::test_event_args &e) const
 Occurs when test cleanup is ended.
 
virtual void on_test_cleanup_start (const xtd::tunit::test_event_args &e) const
 Occurs when test cleanup is started.
 
virtual void on_test_initialize_end (const xtd::tunit::test_event_args &e) const
 Occurs when test initialize is ended.
 
virtual void on_test_initialize_start (const xtd::tunit::test_event_args &e) const
 Occurs when test initialize is ended.
 
virtual void on_test_aborted (const xtd::tunit::test_event_args &e) const
 Occurs when test is aborted.
 
virtual void on_test_end (const xtd::tunit::test_event_args &e) const
 Occurs when test is ended.
 
virtual void on_test_ignored (const xtd::tunit::test_event_args &e) const
 Occurs when test is ignored.
 
virtual void on_test_failed (const xtd::tunit::test_event_args &e) const
 Occurs when test is failed.
 
virtual void on_test_start (const xtd::tunit::test_event_args &e) const
 Occurs when test initialize is started.
 
virtual void on_test_succeed (const xtd::tunit::test_event_args &e) const
 Occurs when test is succeed.
 
virtual void on_unit_test_cleanup_end (const xtd::tunit::tunit_event_args &e) const
 Occurs when unit test cleanup is ended.
 
virtual void on_unit_test_cleanup_start (const xtd::tunit::tunit_event_args &e) const
 Occurs when unit test is started.
 
virtual void on_unit_test_end (const xtd::tunit::tunit_event_args &e) const
 Occurs when unit test is ended.
 
virtual void on_unit_test_initialize_end (const xtd::tunit::tunit_event_args &e) const
 Occurs when unit test initialize is ended.
 
virtual void on_unit_test_initialize_start (const xtd::tunit::tunit_event_args &e) const
 Occurs when unit test initialize is started.
 
virtual void on_unit_test_start (const xtd::tunit::tunit_event_args &e) const
 Occurs when unit test cleanup is started.
 

Member Function Documentation

◆ on_class_cleanup_end()

virtual void xtd::tunit::event_listener::on_class_cleanup_end ( const xtd::tunit::class_event_args & e) const
inlinevirtual

Occurs when class cleanup is ended.

Parameters
class_event_argsContains class event parameters.

◆ on_class_cleanup_start()

virtual void xtd::tunit::event_listener::on_class_cleanup_start ( const xtd::tunit::class_event_args & e) const
inlinevirtual

Occurs when class cleanup is started.

Parameters
class_event_argsContains class event parameters.

◆ on_class_end()

virtual void xtd::tunit::event_listener::on_class_end ( const xtd::tunit::class_event_args & e) const
inlinevirtual

Occurs when class is ended.

Parameters
class_event_argsContains class event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_class_initialize_end()

virtual void xtd::tunit::event_listener::on_class_initialize_end ( const xtd::tunit::class_event_args & e) const
inlinevirtual

Occurs when class initialize is ended.

Parameters
class_event_argsContains class event parameters.

◆ on_class_initialize_start()

virtual void xtd::tunit::event_listener::on_class_initialize_start ( const xtd::tunit::class_event_args & e) const
inlinevirtual

Occurs when class initialize is started.

Parameters
class_event_argsContains class event parameters.

◆ on_class_start()

virtual void xtd::tunit::event_listener::on_class_start ( const xtd::tunit::class_event_args & e) const
inlinevirtual

Occurs when class is started.

Parameters
class_event_argsContains class_event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_test_cleanup_end()

virtual void xtd::tunit::event_listener::on_test_cleanup_end ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test cleanup is ended.

Parameters
test_event_argsContains test event parameters.

◆ on_test_cleanup_start()

virtual void xtd::tunit::event_listener::on_test_cleanup_start ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test cleanup is started.

Parameters
test_event_argsContains test event parameters.

◆ on_test_initialize_end()

virtual void xtd::tunit::event_listener::on_test_initialize_end ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test initialize is ended.

Parameters
test_event_argsContains test event parameters.

◆ on_test_initialize_start()

virtual void xtd::tunit::event_listener::on_test_initialize_start ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test initialize is ended.

Parameters
test_event_argsContains test event parameters.

◆ on_test_aborted()

virtual void xtd::tunit::event_listener::on_test_aborted ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test is aborted.

Parameters
test_event_argsContains test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_test_end()

virtual void xtd::tunit::event_listener::on_test_end ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test is ended.

Parameters
test_event_argsContains test event parameters.

◆ on_test_ignored()

virtual void xtd::tunit::event_listener::on_test_ignored ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test is ignored.

Parameters
test_event_argsContains test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_test_failed()

virtual void xtd::tunit::event_listener::on_test_failed ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test is failed.

Parameters
test_event_argsContains test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_test_start()

virtual void xtd::tunit::event_listener::on_test_start ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test initialize is started.

Parameters
test_event_argsContains test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_test_succeed()

virtual void xtd::tunit::event_listener::on_test_succeed ( const xtd::tunit::test_event_args & e) const
inlinevirtual

Occurs when test is succeed.

Parameters
test_event_argsContains test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_unit_test_cleanup_end()

virtual void xtd::tunit::event_listener::on_unit_test_cleanup_end ( const xtd::tunit::tunit_event_args & e) const
inlinevirtual

Occurs when unit test cleanup is ended.

Parameters
tunit_event_argsContains unit test event parameters.

◆ on_unit_test_cleanup_start()

virtual void xtd::tunit::event_listener::on_unit_test_cleanup_start ( const xtd::tunit::tunit_event_args & e) const
inlinevirtual

Occurs when unit test is started.

Parameters
tunit_event_argsContains unit test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_unit_test_end()

virtual void xtd::tunit::event_listener::on_unit_test_end ( const xtd::tunit::tunit_event_args & e) const
inlinevirtual

Occurs when unit test is ended.

Parameters
tunit_event_argsContains unit test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_unit_test_initialize_end()

virtual void xtd::tunit::event_listener::on_unit_test_initialize_end ( const xtd::tunit::tunit_event_args & e) const
inlinevirtual

Occurs when unit test initialize is ended.

Parameters
tunit_event_argsContains unit test event parameters.

◆ on_unit_test_initialize_start()

virtual void xtd::tunit::event_listener::on_unit_test_initialize_start ( const xtd::tunit::tunit_event_args & e) const
inlinevirtual

Occurs when unit test initialize is started.

Parameters
tunit_event_argsContains unit test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

◆ on_unit_test_start()

virtual void xtd::tunit::event_listener::on_unit_test_start ( const xtd::tunit::tunit_event_args & e) const
inlinevirtual

Occurs when unit test cleanup is started.

Parameters
tunit_event_argsContains unit test event parameters.

Reimplemented in xtd::tunit::ostream_event_listener.

The documentation for this class was generated from the following file:
Generated on Sun May 18 2025 09:07:44 for xtd by Gammasoft. All rights reserved.