Definition

Unit tests definitions.

Modules
	assertions
	Assertions definitions.

	assumptions
	Assumptions definitions.

	validations
	validations definitions

Classes
class	xtd::tunit::base_assert
	The base class for assert. More...

class	xtd::tunit::class_cleanup_attribute
	This attribute is use to add cleanup class method to class test attribute. More...

class	xtd::tunit::class_event_args
	Provides data for the xtd::tunit::class_test events. More...

class	xtd::tunit::class_initialize_attribute
	This attribute is use to add initialize class method to class test attribute. More...

class	xtd::tunit::console_unit_test
	The console_unit_test class is console unit test interface. More...

class	xtd::tunit::event_listener
	Represent the event listener class. Unit test call theses events when unit tests are processing. More...

class	xtd::tunit::ostream_event_listener
	The ostream_unit_test class is a specialisation of event_listener class for writing events in std::ostream. More...

class	xtd::tunit::ostream_unit_test
	The ostream_unit_test class is ostream unit test interface. More...

class	xtd::tunit::registered_test_class
	Represents the registered test class. More...

class	xtd::tunit::settings
	The settings class contains xtd.tunit settings. More...

class	xtd::tunit::test
	Represents a test method. More...

class	xtd::tunit::test_class
	Represents a test class. More...

class	xtd::tunit::test_event_args
	Provides data for the xtd::tunit::test events. More...

class	xtd::tunit::test_method_attribute
	Represents a test method attribute. More...

class	xtd::tunit::tunit_event_args
	tunit_event_args is the base class for classes containing event data. More...

class	xtd::tunit::unit_test
	The unit_test class is unit test base interface. More...

Macros
#define	abort_()
	Abort current test. This is used by the other assert functions.

#define	all_items_are_instances_of_(type_t, ...)
	Asserts that all collection items are of the type supplied or a derived type.

#define	all_items_are_not_null_(...)
	Asserts that all collection items are not null.

#define	all_items_are_unique_(...)
	Asserts that all collection items are unique.

#define	are_equal_(...)
	Asserts that two type are equal.

#define	are_equal_ignoring_case_(...)
	Asserts that two type are equal ignoring case.

#define	are_equivalent_(...)
	Asserts that all collection items are equivalent.

#define	are_not_equal_(...)
	Asserts that two type are not equal.

#define	are_not_equal_ignoring_case_(...)
	Asserts that two type are not equal ignoring case.

#define	are_not_equivalent_(...)
	Asserts that all collection items are equivalent.

#define	are_not_same_(...)
	Asserts that two objects do refer to differents objects.

#define	are_same_(...)
	Asserts that two objects do refer to same objects.

#define	class_cleanup_(method_name)
	Add class cleanup method to class test.

#define	class_initialize_(method_name)
	add initialize class method to class test.

#define	contains_(...)
	Asserts that collection contains an item.

#define	does_not_end_with_(...)
	Asserts that string starts with item.

#define	does_not_exist_(...)
	Asserts that file not exists.

#define	does_not_match_(...)
	Asserts that does not match regex pattern.

#define	does_not_start_with_(...)
	Asserts that string starts with item.

#define	does_not_throw_(...)
	Asserts that the staement does not throw an exception.

#define	ends_with_(...)
	Asserts that string starts with item.

#define	exists_(...)
	Asserts that directory exists.

#define	fail_(...)
	Throws an xtd::tunit::assert_error exception. This is used by the other assert functions.

#define	ignore_(...)
	Ignore current test. This is used by the other assert functions.

#define	ignore_test_method_(method_name)
	Add ignored test method to class test.

#define	is_empty_(...)
	Asserts that collection contains an item.

#define	is_false_(...)
	Asserts that a condition is false.

#define	is_greater_(...)
	Asserts that the first value is greater than the second value.

#define	is_greater_or_equal_(...)
	Asserts that the first value is greater than or equal to the second value.

#define	is_instance_of_(type_t, ...)
	Asserts that an object is of the type supplied or a derived type.

#define	is_less_(...)
	Asserts that the first value is is_less than the second value.

#define	is_less_or_equal_(...)
	Asserts that the first value is is_less than or equal to the second value.

#define	is_NaN_(...)
	Asserts that a value is NaN.

#define	is_negative_(...)
	Asserts that ta condition is negative.

#define	is_not_empty_(...)
	Asserts that collection does not contain any item.

#define	is_not_instance_of_(type_t, ...)
	Asserts that an object is not of the type supplied or a derived type.

#define	is_not_null_(...)
	Asserts that the pointer is not null.

#define	is_not_zero_(...)
	Asserts that ta condition is not zero.

#define	is_null_(...)
	Asserts that the pointer is null.

#define	is_ordered_(...)
	Asserts that collection is ordered.

#define	is_positive_(...)
	Asserts that ta condition is positive.

#define	is_true_(...)
	Asserts that a condition is true.

#define	is_zero_(...)
	Asserts that ta condition is zero.

#define	matches_(...)
	Asserts that matches regex pattern.

#define	starts_with_(...)
	Asserts that string starts with item.

#define	succeed_(...)
	Generates a success with a generic message. This is used by the other assert functions.

#define	test_class_(class_name)
	Helper to create a test_class in a test unit.

#define	test_class_from_(class_name, from_class_name)
	Helper to create a test_class in a test unit from a specified class base.

#define	test_cleanup_(method_name)
	Helper to create a test cleanup method in a test class.

#define	test_initialize_(method_name)
	Helper to create a test initialize method in a test class.

#define	test_method_(method_name)
	Add test method to class test.

#define	throws_(exception_t, ...)
	Asserts that the statement throws a particular exception when called.

#define	throws_any_(...)
	Asserts that the staement does not throw an exception.

#define	tunit_main_
	Defines the entry point to be called with startup_ for unit test application.

#define	tunit_main_with_gtest_compatibility_
	Defines the entry point to be called with startup_ for unit test application with Google test compatibility.

Enumerations
enum class	xtd::tunit::test_state { xtd::tunit::test_state::considered , xtd::tunit::test_state::ignored }
	Represent the test state enumeration used bu test. More...

Macro Definition Documentation

◆ abort_

#define abort_ ( )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Abort current test. This is used by the other assert functions.

Exceptions

xtd::tunit::assert_error If bad assertion.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::abort_(); // test throws an abort_error exception.

xtd::tunit::assume::abort_(); // test throws an abort_error exception.

xtd::tunit::valid::abort_(); // test throws an abort_error exception.

◆ all_items_are_instances_of_

#define all_items_are_instances_of_	(	type_t,
		...
	)

#include <xtd.tunit/include/xtd/tunit/collection_assert.h>

Asserts that all collection items are of the type supplied or a derived type.

Parameters

value	The object to verify
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::collection_assert, xtd::tunit::collection_assume and xtd::tunit::collection_valid classes.

Examples: std::vector<std::ios_base*> a = {&std::cout, &std::cerr, &std::cin};

xtd::tunit::collection_assert::all_items_are_instances_of_(std::ios_base*, a); // test ok.

xtd::tunit::collection_assert::all_items_are_instances_of_(std::basic_ostream<char>*, a, "User message..."); // test error.

xtd::tunit::collection_assume::all_items_are_instances_of_(std::ios_base*, a); // test ok.

xtd::tunit::collection_assume::all_items_are_instances_of_(std::basic_ostream<char>*, a, "User message..."); // test error.

xtd::tunit::collection_valid::all_items_are_instances_of_(std::ios_base*, a); // test ok.

xtd::tunit::collection_valid::all_items_are_instances_of_(std::basic_ostream<char>*, a, "User message..."); // test error.

◆ all_items_are_not_null_

#define all_items_are_not_null_ ( ... )

#include <xtd.tunit/include/xtd/tunit/collection_assert.h>

Asserts that all collection items are not null.

Parameters

value	The object to verify
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::collection_assert, xtd::tunit::collection_assume and xtd::tunit::collection_valid classes.

Examples: int i1 = 0, i2 = 3;

std::vector<int*> a1 = {&i1, &i2};

std::vector<int*> a2 = {&i1, &i2, nullptr};

xtd::tunit::collection_assert::all_items_are_not_null_(a1); // test ok.

xtd::tunit::collection_assert::all_items_are_not_null_(a2, "User message..."); // test error.

xtd::tunit::collection_assume::all_items_are_not_null_(a1); // test ok.

xtd::tunit::collection_assume::all_items_are_not_null_(a2, "User message..."); // test error.

xtd::tunit::collection_valid::all_items_are_not_null_(a1); // test ok.

xtd::tunit::collection_valid::all_items_are_not_null_(a2, "User message..."); // test error.

◆ all_items_are_unique_

#define all_items_are_unique_ ( ... )

#include <xtd.tunit/include/xtd/tunit/collection_assert.h>

Asserts that all collection items are unique.

Parameters

value	The object to verify
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::collection_assert, xtd::tunit::collection_assume and xtd::tunit::collection_valid classes.

Examples: std::vector<int> a1 = {1, 2, 3, 4};

std::vector<int> a2 = {1, 2, 3, 4, 1};

xtd::tunit::collection_assert::all_items_are_unique_(a1); // test ok.

xtd::tunit::collection_assert::all_items_are_unique_(a2, "User message..."); // test error.

xtd::tunit::collection_assume::all_items_are_unique_(a1); // test ok.

xtd::tunit::collection_assume::all_items_are_unique_(a2, "User message..."); // test error.

xtd::tunit::collection_valid::all_items_are_unique_(a1); // test ok.

xtd::tunit::collection_valid::all_items_are_unique_(a2, "User message..."); // test error.

◆ are_equal_

#define are_equal_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results .

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::are_equal_(24, int(24)); // test throws an abort_error exception.

xtd::tunit::assume::are_equal_(24, int(24), "User message"); // test throws an abort_error exception.

xtd::tunit::valid::are_equal_(24, int(24)); // test throws an abort_error exception.

◆ are_equal_ignoring_case_

#define are_equal_ignoring_case_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that two type are equal ignoring case.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::tunit::string_assert::are_equal_ignoring_case_("value", xtd::ustring("VALUE")); // test ok.

xtd::tunit::string_assert::are_equal_ignoring_case_("key", xtd::ustring("VALUE"), "User message..."); // test error.

xtd::tunit::string_assume::are_equal_ignoring_case_("value", xtd::ustring("VALUE")); // test ok.

xtd::tunit::string_assume::are_equal_ignoring_case_("key", xtd::ustring("VALUE"), "User message..."); // test error.

xtd::tunit::string_valid::are_equal_ignoring_case_("value", xtd::ustring("VALUE")); // test ok.

xtd::tunit::string_valid::are_equal_ignoring_case_("key", xtd::ustring("VALUE"), "User message..."); // test error.

xtd::ustring
Represents text as a sequence of UTF-8 code units.
Definition: ustring.h:48

◆ are_equivalent_

#define are_equivalent_ ( ... )

#include <xtd.tunit/include/xtd/tunit/collection_assert.h>

Asserts that all collection items are equivalent.

Parameters

value	The object to verify
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::collection_assert, xtd::tunit::collection_assume and xtd::tunit::collection_valid classes.

Examples: std::vector<int> a = {1, 2, 3, 4};

xtd::tunit::collection_assert::are_equivalent_({4, 3, 2, 1}, a; // test ok.

xtd::tunit::collection_assert::are_equivalent_({1, 2, 3, 5}, a, "User message..."); // test error.

xtd::tunit::collection_assume::are_equivalent_({4, 3, 2, 1}, a; // test ok.

xtd::tunit::collection_assume::are_equivalent_({1, 2, 3, 5}, a, "User message..."); // test error.

xtd::tunit::collection_valid::are_equivalent_({4, 3, 2, 1}, a; // test ok.

xtd::tunit::collection_valid::are_equivalent_({1, 2, 3, 5}, a, "User message..."); // test error.

xtd::console_key::a
@ a
The A key.

◆ are_not_equal_

#define are_not_equal_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results .

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::are_not_equal_(24, int(42)); // test throws an abort_error exception.

xtd::tunit::assume::are_not_equal_(24, int(42), "User message..."); // test throws an abort_error exception.

xtd::tunit::valid::are_not_equal_(24, int(42)); // test throws an abort_error exception.

◆ are_not_equal_ignoring_case_

#define are_not_equal_ignoring_case_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that two type are not equal ignoring case.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::tunit::string_assert::are_not_equal_ignoring_case_("key", xtd::ustring("VALUE")); // test ok.

xtd::tunit::string_assert::are_not_equal_ignoring_case_("value", xtd::ustring("VALUE"), "User message..."); // test error.

xtd::tunit::string_assume::are_not_equal_ignoring_case_("key", xtd::ustring("VALUE")); // test ok.

xtd::tunit::string_assume::are_not_equal_ignoring_case_("value", xtd::ustring("VALUE"), "User message..."); // test error.

xtd::tunit::string_valid::are_not_equal_ignoring_case_("key", xtd::ustring("VALUE")); // test ok.

xtd::tunit::string_valid::are_not_equal_ignoring_case_("value", xtd::ustring("VALUE"), "User message..."); // test error.

◆ are_not_equivalent_

#define are_not_equivalent_ ( ... )

#include <xtd.tunit/include/xtd/tunit/collection_assert.h>

Asserts that all collection items are equivalent.

Parameters

value	The object to verify
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::collection_assert, xtd::tunit::collection_assume and xtd::tunit::collection_valid classes.

Examples: std::vector<int> a = {1, 2, 3, 4};

xtd::tunit::collection_assert::are_equivalent_({4, 3, 2, 1}, a); // test ok.

xtd::tunit::collection_assert::are_equivalent_({1, 2, 3, 5}, a, "User message..."); // test error.

xtd::tunit::collection_assume::are_equivalent_({4, 3, 2, 1}, a); // test ok.

xtd::tunit::collection_assume::are_equivalent_({1, 2, 3, 5}, a, "User message..."); // test error.

xtd::tunit::collection_valid::are_equivalent_({4, 3, 2, 1}, a); // test ok.

xtd::tunit::collection_valid::are_equivalent_({1, 2, 3, 5}, a, "User message..."); // test error.

◆ are_not_same_

#define are_not_same_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: int a = 24;

int& b = a;

int c= 24;

xtd::tunit::assert::are_not_same_(c, a); // test ok.

xtd::tunit::assert::are_not_same_(b, a, "User message..."); // test error.

xtd::tunit::assume::are_not_same_(c, a); // test ok.

xtd::tunit::assume::are_not_same_(b, a, "User message..."); // test error.

xtd::tunit::valid::are_not_same_(c, a); // test ok.

xtd::tunit::valid::are_not_same_(b, a, "User message..."); // test error.

◆ are_same_

#define are_same_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that two objects do refer to same objects.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: int a = 24;

int& b = a;

int c= 24;

xtd::tunit::assert::are__same_(c, a, "User message..."); // test error.

xtd::tunit::assert::are_same_(b, a); // test ok.

xtd::tunit::assume::are_same_(c, a, "User message..."); // test error.

xtd::tunit::assume::are_same_(b, a); // test ok.

xtd::tunit::valid::are_same_(c, a, "User message..."); // test error.

xtd::tunit::valid::are_same_(b, a); // test ok.

◆ class_cleanup_

#define class_cleanup_ ( method_name )

#include <xtd.tunit/include/xtd/tunit/class_cleanup_attribute.h>

Add class cleanup method to class test.

Parameters

method_name The class cleanup method to add.

Library: xtd.tunit

Examples: The following example shows how to use class_cleanup_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

xtd::tunit::console_unit_test
The console_unit_test class is console unit test interface.
Definition: console_unit_test.h:23

xtd::tunit::unit_test::run
int32 run()
Runs all tests in this unit_test object and prints the result.

test_method_
#define test_method_(method_name)
Add test method to class test.
Definition: test_method_attribute.h:88

class_initialize_
#define class_initialize_(method_name)
add initialize class method to class test.
Definition: class_initialize_attribute.h:52

test_initialize_
#define test_initialize_(method_name)
Helper to create a test initialize method in a test class.
Definition: test_initialize_attribute.h:46

class_cleanup_
#define class_cleanup_(method_name)
Add class cleanup method to class test.
Definition: class_cleanup_attribute.h:52

test_cleanup_
#define test_cleanup_(method_name)
Helper to create a test cleanup method in a test class.
Definition: test_cleanup_attribute.h:46

ignore_test_method_
#define ignore_test_method_(method_name)
Add ignored test method to class test.
Definition: test_method_attribute.h:72

xtd::tunit
The tunit namespace contains a unit test library.
Definition: abort_error.h:10

Examples: test_class.cpp.

◆ class_initialize_

#define class_initialize_ ( method_name )

#include <xtd.tunit/include/xtd/tunit/class_initialize_attribute.h>

add initialize class method to class test.

Parameters

method_name The class initilize method to add.

Library: xtd.tunit

Examples: The following example shows how to use class_initialize_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

Examples: test_class.cpp.

◆ contains_

#define contains_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::vector<int> v1 = {0, 1, 2, 3};

xtd::tunit::assert::contains_(2, v1); // test ok.

xtd::tunit::assert::contains_(4, v1, "User message..."); // test error.

xtd::tunit::assume::contains_(2, v1); // test ok.

xtd::tunit::assume::contains_(4, v1, "User message..."); // test error.

xtd::tunit::valid::contains_(2, v1); // test ok.

xtd::tunit::valid::contains_(4, v1, "User message..."); // test error.

◆ does_not_end_with_

#define does_not_end_with_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::ustring s = "value";

xtd::tunit::string_assert::does_not_end_with_("law", s); // test ok.

xtd::tunit::string_assert::does_not_end_with_("lue", s, "User message..."); // test error.

xtd::tunit::string_assume::does_not_end_with_("law", s); // test ok.

xtd::tunit::string_assume::does_not_end_with_("lue", s, "User message..."); // test error.

xtd::tunit::string_valid::does_not_end_with_("law", s); // test ok.

xtd::tunit::string_valid::does_not_end_with_("lue", s, "User message..."); // test error.

◆ does_not_exist_

#define does_not_exist_ ( ... )

#include <xtd.tunit/include/xtd/tunit/directory_assert.h>

Asserts that file not exists.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::directory_assert, xtd::tunit::directory_assume and xtd::tunit::directory_valid classes.

Examples: std::ifstream f1("Test1.txt");

f1.close();

xtd::tunit::directory_assert::does_not_exist_("Test2.txt"); // test ok.

xtd::tunit::directory_assert::does_not_exist_("Test1.txt", "User message..."); // test error.

◆ does_not_match_

#define does_not_match_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that does not match regex pattern.

Parameters

regex_pattern	the regex pattern.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::tunit::string_assert::does_not_match_("^Salut", xtd::ustring("Hello, World!")); // test ok.

xtd::tunit::string_assert::does_not_match_("^Hello", xtd::ustring("Hello, World!"), "User message..."); // test error.

xtd::tunit::string_assume::does_not_match_("^Salut", xtd::ustring("Hello, World!")); // test ok.

xtd::tunit::string_assume::does_not_match_("^Hello", xtd::ustring("Hello, World!"), "User message..."); // test error.

xtd::tunit::string_valid::does_not_match_("^Salut", xtd::ustring("Hello, World!")); // test ok.

xtd::tunit::string_valid::does_not_match_("^Hello", xtd::ustring("Hello, World!"), "User message..."); // test error.

◆ does_not_start_with_

#define does_not_start_with_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::ustring s = "value";

xtd::tunit::string_assert::does_not_start_with_("zoe", s); // test ok.

xtd::tunit::string_assert::does_not_start_with_("val", s, "User message..."); // test error.

xtd::tunit::string_assume::does_not_start_with_("zoe", s); // test ok.

xtd::tunit::string_assume::does_not_start_with_("val", s, "User message..."); // test error.

xtd::tunit::string_valid::does_not_start_with_("zoe", s); // test ok.

xtd::tunit::string_valid::does_not_start_with_("val", s, "User message..."); // test error.

◆ does_not_throw_

#define does_not_throw_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::vector<int> v1 = {1, 2, 3, 4};

xtd::tunit::assert::does_not_throw_([&] {v1.at(2);}); // test ok.

xtd::tunit::assert::does_not_throw_([&] {v1.at(5);}, "User message..."); // test error.

xtd::tunit::assume::does_not_throw_([&] {v1.at(2);}); // test ok.

xtd::tunit::assume::does_not_throw_([&] {v1.at(5);}, "User message..."); // test error.

xtd::tunit::valid::does_not_throw_([&] {v1.at(2);}); // test ok.

xtd::tunit::valid::does_not_throw_([&] {v1.at(5);}, "User message..."); // test error.

◆ ends_with_

#define ends_with_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::ustring s = "value";

xtd::tunit::string_assert::ends_with_("val", s); // test ok.

xtd::tunit::string_assert::ends_with_("law", s, "User message..."); // test error.

xtd::tunit::string_assume::ends_with_("val", s); // test ok.

xtd::tunit::string_assume::ends_with_("law", s, "User message..."); // test error.

xtd::tunit::string_valid::ends_with_("val", s); // test ok.

xtd::tunit::string_valid::ends_with_("law", s, "User message..."); // test error.

◆ exists_

#define exists_ ( ... )

#include <xtd.tunit/include/xtd/tunit/directory_assert.h>

Asserts that directory exists.

Parameters

expected	the expected value.
actual	the actual value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::directory_assert, xtd::tunit::directory_assume and xtd::tunit::directory_valid classes.

Examples: std::ifstream f1("Test1.txt");

f1.close();

xtd::tunit::directory_assert::exists_("Test1.txt"); // test ok.

xtd::tunit::directory_assert::exists_("Test2.txt", "User message..."); // test error.

◆ fail_

#define fail_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Throws an xtd::tunit::assert_error exception. This is used by the other assert functions.

Parameters

message An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

xtd::tunit::assert_error If bad assertion.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::fail_("User message..."); // test throws an assert_error exception.

xtd::tunit::assume::fail_("User message..."); // test throws an assert_error exception.

xtd::tunit::valid::fail_("User message..."); // test throws an assert_error exception.

◆ ignore_

#define ignore_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Ignore current test. This is used by the other assert functions.

Parameters

message A user facultative message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::ignore_("User message..."); // test throws an ignore_error exception.

xtd::tunit::assume::ignore_("User message..."); // test throws an ignore_error exception.

xtd::tunit::valid::ignore_("User message..."); // test throws an ignore_error exception.

◆ ignore_test_method_

#define ignore_test_method_ ( method_name )

#include <xtd.tunit/include/xtd/tunit/test_method_attribute.h>

Add ignored test method to class test.

Parameters

method_name The ignored test method to add.

Library: xtd.tunit

Remarks: This helper is used to ingor a test method. You can use the xtd::tunit::assert::ignore method instead.

Examples: The following example shows how to use ignore_test_method_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

Examples: create_gtest_like_event_listener.cpp, and test_class.cpp.

◆ is_empty_

#define is_empty_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that collection contains an item.

Parameters

value	The value to check is empty.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::vector<int> v1;

std::vector<int> v2 = {0, 1, 2, 3};

xtd::tunit::assert::is_empty_(v1; // test ok.

xtd::tunit::assert::is_empty_(v2, "User message..."); // test error.

xtd::tunit::assume::is_empty_(v1); // test ok.

xtd::tunit::assume::is_empty_(v2, "User message..."); // test error.

xtd::tunit::valid::is_empty_(v1); // test ok.

xtd::tunit::valid::is_empty_(v2, "User message..."); // test error.

◆ is_false_

#define is_false_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that a condition is false.

Parameters

condition	The condition to check is false.
message	A facutative user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::string s1 = "Anything";

std::string s2;

xtd::tunit::assert::is_false_(std::empty(s1)); // test ok.

xtd::tunit::assert::is_false_(std::empty(s2), "User message..."); // test error.

xtd::tunit::assume::is_false_(std::empty(s1)); // test ok.

xtd::tunit::assume::is_false_(std::empty(s2), "User message..."); // test error.

xtd::tunit::valid::is_false_(std::empty(s1)); // test ok.

xtd::tunit::valid::is_false_(std::empty(s2), "User message..."); // test error.

◆ is_greater_

#define is_greater_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the first value is greater than the second value.

Parameters

val1	the first value.
val2	the second value.
message	A facutative user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::is_greater_(24, 12); // test ok.

xtd::tunit::assert::is_greater_(24, 48, "User message..."); // test error.

xtd::tunit::assume::is_greater_(24, 12); // test ok.

xtd::tunit::assume::is_greater_(24, 48, "User message..."); // test error.

xtd::tunit::valid::is_greater_(24, 12); // test ok.

xtd::tunit::valid::is_greater_(24, 48, "User message..."); // test error.

◆ is_greater_or_equal_

#define is_greater_or_equal_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the first value is greater than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
message	A facutative user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::is_greater_or_equal_(24, 12); // test ok.

xtd::tunit::assert::is_greater_or_equal_(24, 24); // test ok.

xtd::tunit::assert::is_greater_or_equal_(24, 48, "User message..."); // test error.

xtd::tunit::assume::is_greater_or_equal_(24, 12); // test ok.

xtd::tunit::assume::is_greater_or_equal_(24, 24); // test ok.

xtd::tunit::assume::is_greater_or_equal_(24, 48, "User message..."); // test error.

xtd::tunit::valid::is_greater_or_equal_(24, 12); // test ok.

xtd::tunit::valid::is_greater_or_equal_(24, 24); // test ok.

xtd::tunit::valid::is_greater_or_equal_(24, 48, "User message..."); // test error.

◆ is_instance_of_

#define is_instance_of_	(	type_t,
		...
	)

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that an object is of the type supplied or a derived type.

Parameters

value	The object to verify
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::invalid_argument except("invalid argument");

xtd::tunit::assert::is_instance_of_(std::logic_error, except; // test ok.

xtd::tunit::assert::is_instance_of_(std::bad_cast, except, "User message..."); // test error.

xtd::tunit::assume::is_instance_of_(std::logic_error, except; // test ok.

xtd::tunit::assume::is_instance_of_(std::bad_cast, except, "User message..."); // test error.

xtd::tunit::valid::is_instance_of_(std::logic_error, except; // test ok.

xtd::tunit::valid::is_instance_of_(std::bad_cast, except, "User message..."); // test error.

◆ is_less_

#define is_less_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the first value is is_less than the second value.

Parameters

val1	the first value.
val2	the second value.
message	A facutative user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::is_less_(24, 48); // test ok.

xtd::tunit::assert::is_less_(24, 12, "User message..."); // test error.

xtd::tunit::assume::is_less_(24, 48); // test ok.

xtd::tunit::assume::is_less_(24, 12, "User message..."); // test error.

xtd::tunit::valid::is_less_(24, 48); // test ok.

xtd::tunit::valid::is_less_(24, 12, "User message..."); // test error.

◆ is_less_or_equal_

#define is_less_or_equal_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the first value is is_less than or equal to the second value.

Parameters

val1	the first value.
val2	the second value.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::is_less_or_equal_(24, 48); // test ok.

xtd::tunit::assert::is_less_or_equal_(24, 24); // test ok.

xtd::tunit::assert::is_less_or_equal_(24, 12, "User message..."); // test error.

xtd::tunit::assume::is_less_or_equal_(24, 48); // test ok.

xtd::tunit::assume::is_less_or_equal_(24, 24); // test ok.

xtd::tunit::assume::is_less_or_equal_(24, 12, "User message..."); // test error.

xtd::tunit::valid::is_less_or_equal_(24, 48); // test ok.

xtd::tunit::valid::is_less_or_equal_(24, 24); // test ok.

xtd::tunit::valid::is_less_or_equal_(24, 12, "User message..."); // test error.

◆ is_NaN_

#define is_NaN_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that a value is NaN.

Parameters

value	The value to check is NaN.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: double v1 = std::numeric_limits<double>::quiet_NaN();

double v2 = 3.14159265358979323846;

xtd::tunit::assert::is_NaN_(v1); // test ok.

xtd::tunit::assert::is_NaN_(v2, "User message..."); // test error.

xtd::tunit::assume::is_NaN_(v1); // test ok.

xtd::tunit::assume::is_NaN_(v2, "User message..."); // test error.

xtd::tunit::valid::is_NaN_(v1); // test ok.

xtd::tunit::valid::is_NaN_(v2, "User message..."); // test error.

◆ is_negative_

#define is_negative_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that ta condition is negative.

Parameters

value	The value to check is negative.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: int i1 = -1;

int i2 = 1;

xtd::tunit::assert::is_negative_(i1); // test ok.

xtd::tunit::assert::is_negative_(i2, "User message..."); // test error.

xtd::tunit::assume::is_negative_(i1); // test ok.

xtd::tunit::assume::is_negative_(i2, "User message..."); // test error.

xtd::tunit::valid::is_negative_(i1); // test ok.

xtd::tunit::valid::is_negative_(i2, "User message..."); // test error.

◆ is_not_empty_

#define is_not_empty_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that collection does not contain any item.

Parameters

value	The value to check is empty.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::vector<int> v1 = {0, 1, 2, 3};

std::vector<int> v2;

xtd::tunit::assert::is_not_empty_(v1); // test ok.

xtd::tunit::assert::is_not_empty_(v2, "User message..."); // test error.

xtd::tunit::assume::is_not_empty_(v1); // test ok.

xtd::tunit::assume::is_not_empty_(v2, "User message..."); // test error.

xtd::tunit::valid::is_not_empty_(v1); // test ok.

xtd::tunit::valid::is_not_empty_(v2, "User message..."); // test error.

◆ is_not_instance_of_

#define is_not_instance_of_	(	type_t,
		...
	)

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that an object is not of the type supplied or a derived type.

Parameters

value	The object to verify
message	A facutative user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::invalid_argument except("invalid argument");

xtd::tunit::assert::is_not_instance_of_(std::bad_cast, except); // test ok.

xtd::tunit::assert::is_not_instance_of_(std::logic_error, except, "User message..."); // test error.

xtd::tunit::assume::is_not_instance_of_(std::bad_cast, except); // test ok.

xtd::tunit::assume::is_not_instance_of_(std::logic_error, except, "User message..."); // test error.

xtd::tunit::valid::is_not_instance_of_(std::bad_cast, except); // test ok.

xtd::tunit::valid::is_not_instance_of_(std::logic_error, except, "User message..."); // test error.

◆ is_not_null_

#define is_not_null_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::string str = "Anything";

std::string* s1 = &str;

std::string* s2 = nullptr;

xtd::tunit::assert::is_not_null_(s1); // test ok.

xtd::tunit::assert::is_not_null_(s2, "User message..."); // test error.

xtd::tunit::assume::is_not_null_(s1); // test ok.

xtd::tunit::assume::is_not_null_(s2, "User message..."); // test error.

xtd::tunit::valid::is_not_null_(s1); // test ok.

xtd::tunit::valid::is_not_null_(s2, "User message..."); // test error.

◆ is_not_zero_

#define is_not_zero_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that ta condition is not zero.

Parameters

value	The value to check is not zero.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: int i1 = 42;

int i2 = 0;

xtd::tunit::assert::is_not_zero_(i1); // test ok.

xtd::tunit::assert::is_not_zero_(i2, "User message..."); // test error.

xtd::tunit::assume::is_not_zero_(i1); // test ok.

xtd::tunit::assume::is_not_zero_(i2, "User message..."); // test error.

xtd::tunit::valid::is_not_zero_(i1); // test ok.

xtd::tunit::valid::is_not_zero_(i2, "User message..."); // test error.

◆ is_null_

#define is_null_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::string str = "Anything";

std::string* s1 = nullptr;

std::string* s2 = &str;

xtd::tunit::assert::is_null_(s1); // test ok.

xtd::tunit::assert::is_null_(s2, "User message..."); // test error.

xtd::tunit::assume::is_null_(s1); // test ok.

xtd::tunit::assume::is_null_(s2, "User message..."); // test error.

xtd::tunit::valid::is_null_(s1); // test ok.

xtd::tunit::valid::is_null_(s2, "User message..."); // test error.

◆ is_ordered_

#define is_ordered_ ( ... )

#include <xtd.tunit/include/xtd/tunit/collection_assert.h>

Asserts that collection is ordered.

Parameters

value	The value to check is empty.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::collection_assert, xtd::tunit::collection_assume and xtd::tunit::collection_valid classes.

Examples: std::vector<int> v1 = {1, 2, 3, 4};

std::vector<int> v2 = {1, 2, 4, 3};

xtd::tunit::collection_assert::is_ordered_(v1); // test ok.

xtd::tunit::collection_assert::is_ordered_(v2, "User message..."); // test error.

xtd::tunit::collection_assume::is_ordered_(v1); // test ok.

xtd::tunit::collection_assume::is_ordered_(v2, "User message..."); // test error.

xtd::tunit::collection_valid::is_ordered_(v1); // test ok.

xtd::tunit::collection_valid::is_ordered_(v2, "User message..."); // test error.

◆ is_positive_

#define is_positive_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that ta condition is positive.

Parameters

value	The value to check is positive.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: int i1 = 1;

int i2 = -1;

xtd::tunit::assert::is_positive_(i1); // test ok.

xtd::tunit::assert::is_positive_(i2, "User message..."); // test error.

xtd::tunit::assume::is_positive_(i1); // test ok.

xtd::tunit::assume::is_positive_(i2, "User message..."); // test error.

xtd::tunit::valid::is_positive_(i1); // test ok.

xtd::tunit::valid::is_positive_(i2, "User message..."); // test error.

◆ is_true_

#define is_true_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that a condition is true.

Parameters

condition	The condition to check is true.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::string s1;

std::string s2 = "Anything";

xtd::tunit::assert::is_false_(std::empty(s1)); // test ok.

xtd::tunit::assert::is_false_(std::empty(s2), "User message..."); // test error.

xtd::tunit::assume::is_false_(std::empty(s1)); // test ok.

xtd::tunit::assume::is_false_(std::empty(s2), "User message..."); // test error.

xtd::tunit::valid::is_false_(std::empty(s1)); // test ok.

xtd::tunit::valid::is_false_(std::empty(s2), "User message..."); // test error.

◆ is_zero_

#define is_zero_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that ta condition is zero.

Parameters

value	The value to check is zero.
message	A facutative user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: int i1 = 0;

int i2 = 42;

xtd::tunit::assert::is_zero_(i1); // test ok.

xtd::tunit::assert::is_zero_(i2, "User message..."); // test error.

xtd::tunit::assume::is_zero_(i1); // test ok.

xtd::tunit::assume::is_zero_(i2, "User message..."); // test error.

xtd::tunit::valid::is_zero_(i1); // test ok.

xtd::tunit::valid::is_zero_(i2, "User message..."); // test error.

◆ matches_

#define matches_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that matches regex pattern.

Parameters

regex_pattern	the regex pattern.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::tunit::string_assert::matches_("^Hello", xtd::ustring("Hello, World!")); // test ok.

xtd::tunit::string_assert::matches_("^Salut", xtd::ustring("Hello, World!"), "User message..."); // test error.

xtd::tunit::string_assume::matches_("^Hello", xtd::ustring("Hello, World!")); // test ok.

xtd::tunit::string_assume::matches_("^Salut", xtd::ustring("Hello, World!"), "User message..."); // test error.

xtd::tunit::string_valid::matches_("^Hello", xtd::ustring("Hello, World!")); // test ok.

xtd::tunit::string_valid::matches_("^Salut", xtd::ustring("Hello, World!"), "User message..."); // test error.

◆ starts_with_

#define starts_with_ ( ... )

#include <xtd.tunit/include/xtd/tunit/string_assert.h>

Asserts that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::string_assert, xtd::tunit::string_assume and xtd::tunit::string_valid classes.

Examples: xtd::ustring s = "value";

xtd::tunit::string_assert::starts_with_("val", s); // test ok.

xtd::tunit::string_assert::starts_with_("zoe", s, "User message..."); // test error.

xtd::tunit::string_assume::starts_with_("val", s); // test ok.

xtd::tunit::string_assume::starts_with_("zoe", s, "User message..."); // test error.

xtd::tunit::string_valid::starts_with_("val", s); // test ok.

xtd::tunit::string_valid::starts_with_("zoe", s, "User message..."); // test error.

◆ succeed_

#define succeed_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Generates a success with a generic message. This is used by the other assert functions.

Parameters

message An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: xtd::tunit::assert::succeed("User message..."); // test ok.

xtd::tunit::assume::succeed("User message..."); // test ok.

xtd::tunit::valid::succeed("User message..."); // test ok.

xtd::tunit::base_assert::succeed
static void succeed()
Generates a success with a generic message. This is used by the other assert functions.

◆ test_class_

#define test_class_ ( class_name )

#include <xtd.tunit/include/xtd/tunit/test_class_attribute.h>

Helper to create a test_class in a test unit.

Parameters

class_name The test class to add to unit test.

Examples: The following example shows how to use test_class_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

◆ test_class_from_

#define test_class_from_	(	class_name,
		from_class_name
	)

#include <xtd.tunit/include/xtd/tunit/test_class_attribute.h>

Helper to create a test_class in a test unit from a specified class base.

Parameters

class_name The name of the test class.

Examples: The following code show how to create a test class derived_class inherited from base_class :
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

test_class_(base_class) {

public:

void test_method_(test1) {

// Do test...

}

};

test_class_from_(derived_class, base_class) {

public:

void test_method_(test2) {

// Do test...

}

};

}

auto main()->int {

return console_unit_test().run();

}

test_class_
#define test_class_(class_name)
Helper to create a test_class in a test unit.
Definition: test_class_attribute.h:38

test_class_from_
#define test_class_from_(class_name, from_class_name)
Helper to create a test_class in a test unit from a specified class base.
Definition: test_class_attribute.h:73

◆ test_cleanup_

#define test_cleanup_ ( method_name )

#include <xtd.tunit/include/xtd/tunit/test_cleanup_attribute.h>

Helper to create a test cleanup method in a test class.

Parameters

method_name The test cleanup method to add.

Examples: The following example shows how to use test_cleanup_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

Examples: test_class.cpp.

◆ test_initialize_

#define test_initialize_ ( method_name )

#include <xtd.tunit/include/xtd/tunit/test_initialize_attribute.h>

Helper to create a test initialize method in a test class.

Parameters

method_name The name of the test initialize method.

Examples: The following example shows how to use test_initialize_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

Examples: test_class.cpp.

◆ test_method_

#define test_method_ ( method_name )

#include <xtd.tunit/include/xtd/tunit/test_method_attribute.h>

Add test method to class test.

Parameters

method_name The test method to add.

Library: xtd.tunit

Examples: The following example shows how to use test_method_ helper.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

// The class test must be declared with test_class_ helper.

class test_class_(test) {

public:

// This method is the method that is called just before the start of all tests. It is called only once.

static void class_initialize_(class_initialize) {

}

// This method is the method that is called just after all the tests are finished. It is called only once.

static void class_cleanup_(class_cleanup) {

}

// This method is the method that is called just before a test method starts. It is called for each test.

static void test_initialize_(test_initialize) {

}

// This method is the method that is called right after a test method is finished. It is called for each test.

static void test_cleanup_(test_cleanup) {

}

void test_method_(test_case1) {

}

void test_method_(test_case2) {

}

void ignore_test_method_(test_case3) {

}

};

}

auto main()->int {

return console_unit_test().run();

}

// This code can produce the following output:

//

// Start 3 tests from 1 test case

// Run tests:

// SUCCEED test.test_case1 (0 ms total)

// SUCCEED test.test_case2 (0 ms total)

// IGNORED test.test_case3 (0 ms total)

// Test ignored

//

// Test results:

// SUCCEED 2 tests.

// IGNORED 1 test.

// End 3 tests from 1 test case ran. (0 ms total)

Examples: all_items_are_instances_of.cpp, all_items_are_not_null.cpp, assert.cpp, assert_abort.cpp, assert_are_equal.cpp, assert_are_equal_with_tolerance.cpp, assert_are_not_equal.cpp, assert_are_not_same.cpp, assert_are_same.cpp, assert_contains.cpp, assert_does_not_throw.cpp, assert_fail.cpp, assert_ignore.cpp, assert_is_NaN.cpp, assert_is_empty.cpp, assert_is_false.cpp, assert_is_greater.cpp, assert_is_greater_or_equal.cpp, assert_is_instance_of.cpp, assert_is_less.cpp, assert_is_less_or_equal.cpp, assert_is_negative.cpp, assert_is_not_empty.cpp, assert_is_not_instance_of.cpp, assert_is_not_null.cpp, assert_is_not_zero.cpp, assert_is_null.cpp, assert_is_positive.cpp, assert_is_true.cpp, assert_is_zero.cpp, assert_succeed.cpp, assert_throws.cpp, assert_throws_any.cpp, class_with_insert_stream_operator.cpp, class_without_insert_stream_operator.cpp, console_unit_test.cpp, create_gtest_like_event_listener.cpp, generic_test_class.cpp, hello_world_tunit.cpp, many_asserts.cpp, many_valids_and_asserts.cpp, math_assert.cpp, ostream_unit_test.cpp, string_assert_are_equal_ignoring_case.cpp, string_assert_are_not_equal_ignoring_case.cpp, string_assert_contains.cpp, test_class.cpp, and tunit_config_main.cpp.

◆ throws_

#define throws_	(	exception_t,
		...
	)

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the statement throws a particular exception when called.

Template Parameters

exception_t The exception type that must be throw.

Parameters

statement	The statement that verify.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::vector<int> v1 = {1, 2, 3, 4};

xtd::tunit::assert::throws_(std::out_of_range, [&] {v1.at(5);}); // test ok.

xtd::tunit::assert::throws_(std::out_of_range, [&] {v1.at(2);}, "User message..."); // test error.

xtd::tunit::assume::throws_(std::out_of_range, [&] {v1.at(5);}); // test ok.

xtd::tunit::assume::throws_(std::out_of_range, [&] {v1.at(2);}, "User message..."); // test error.

xtd::tunit::valid::throws_(std::out_of_range, [&] {v1.at(5);}); // test ok.

xtd::tunit::valid::throws_(std::out_of_range, [&] {v1.at(2);}, "User message..."); // test error.

◆ throws_any_

#define throws_any_ ( ... )

#include <xtd.tunit/include/xtd/tunit/assert.h>

Asserts that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	An optional user message to display if the assertion fails. This message can be seen in the unit test results.

Remarks: Contains information about current file and current line.; Can be used with xtd::tunit::assert, xtd::tunit::assume and xtd::tunit::valid classes.

Examples: std::vector<int> v1 = {1, 2, 3, 4};

xtd::tunit::assert::throws_any_([&] {v1.at(5);}); // test ok.

xtd::tunit::assert::throws_any_([&] {v1.at(2);}, "User message..."); // test error.

xtd::tunit::assume::throws_any_([&] {v1.at(5);}); // test ok.

xtd::tunit::assume::throws_any_([&] {v1.at(2);}, "User message..."); // test error.

xtd::tunit::valid::throws_any_([&] {v1.at(5);}); // test ok.

xtd::tunit::valid::throws_any_([&] {v1.at(2);}, "User message..."); // test error.

◆ tunit_main_

#define tunit_main_

#include <xtd.tunit/include/xtd/tunit/tunit_main.h>

Defines the entry point to be called with startup_ for unit test application.

Library: xtd.tunit

Remarks: The tunit_main_ contains a main method and launch xtd::tunit::console_unit_test::run.

Examples: The followng code shows ho to use tunit_main_.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

test_class_(class_to_test) {

public:

void test_method_(test1) {

// Do test...

}

};

}

startup_(tunit_main_);

startup_
#define startup_(main_class)
Defines the entry point to be called when the application loads. Generally this is set either to the ...
Definition: startup.h:59

tunit_main_
#define tunit_main_
Defines the entry point to be called with startup_ for unit test application.
Definition: tunit_main.h:44

◆ tunit_main_with_gtest_compatibility_

#define tunit_main_with_gtest_compatibility_

#include <xtd.tunit/include/xtd/tunit/tunit_main.h>

Defines the entry point to be called with startup_ for unit test application with Google test compatibility.

Library: xtd.tunit

Remarks: The tunit_main_ contains main method, launch xtd::tunit::console_unit_test::run and set xtd::tunit::settings::gtest_compatibility to true.

Examples: The followng code shows ho to use tunit_main_with_gtest_compatibility_.
#include <xtd/xtd.tunit>

using namespace xtd::tunit;

namespace unit_tests {

test_class_(class_to_test) {

public:

void test_method_(test1) {

// Do test...

}

};

}

startup_(tunit_main_with_gtest_compatibility_);

tunit_main_with_gtest_compatibility_
#define tunit_main_with_gtest_compatibility_
Defines the entry point to be called with startup_ for unit test application with Google test compati...
Definition: tunit_main.h:70

Enumeration Type Documentation

◆ test_state

enum class xtd::tunit::test_state

strong

#include <xtd.tunit/include/xtd/tunit/test_state.h>

Represent the test state enumeration used bu test.

Namespace: xtd::tunit

Library: xtd.tunit

Enumerator
considered	Test is considered.
ignored	Test is ignored.

Definition

Modules

Classes

Macros

Enumerations

Macro Definition Documentation

◆ abort_

◆ all_items_are_instances_of_

◆ all_items_are_not_null_

◆ all_items_are_unique_

◆ are_equal_

◆ are_equal_ignoring_case_

◆ are_equivalent_

◆ are_not_equal_

◆ are_not_equal_ignoring_case_

◆ are_not_equivalent_

◆ are_not_same_

◆ are_same_

◆ class_cleanup_

◆ class_initialize_

◆ contains_

◆ does_not_end_with_

◆ does_not_exist_

◆ does_not_match_

◆ does_not_start_with_

◆ does_not_throw_

◆ ends_with_

◆ exists_

◆ fail_

◆ ignore_

◆ ignore_test_method_

◆ is_empty_

◆ is_false_

◆ is_greater_

◆ is_greater_or_equal_

◆ is_instance_of_

◆ is_less_

◆ is_less_or_equal_

◆ is_NaN_

◆ is_negative_

◆ is_not_empty_

◆ is_not_instance_of_

◆ is_not_null_

◆ is_not_zero_

◆ is_null_

◆ is_ordered_

◆ is_positive_

◆ is_true_

◆ is_zero_

◆ matches_

◆ starts_with_

◆ succeed_

◆ test_class_

◆ test_class_from_

◆ test_cleanup_

◆ test_initialize_

◆ test_method_

◆ throws_

◆ throws_any_

◆ tunit_main_

◆ tunit_main_with_gtest_compatibility_

Enumeration Type Documentation

◆ test_state