unit tests

Definition

Contains unit tests definitions.

Modules
	assertions
	Contains assertions definitions.
	assumptions
	Contains assumptions definitions.
	validations
	Contains 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_class_attribute< test_class_t >
	Represents a test class attribute. More...
class	xtd::tunit::test_cleanup_attribute
	Represents a test cleanup attribute. 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	class_cleanup_(method_name)
	Add class cleanup method to class test.
#define	class_initialize_(method_name)
	add initialize class method to class test.
#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	ignore_test_method_(method_name)
	Add ignored test method to class test.
#define	test_method_(method_name)
	Add test method to class test.
#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

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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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.

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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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_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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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_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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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.

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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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.

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) {
    // 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 unit_tests::test.test_case1 (0 ms total)
//   SUCCEED unit_tests::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

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, assume.cpp, assume_are_equal.cpp, assume_are_equal_with_tolerance.cpp, assume_are_not_equal.cpp, assume_are_not_same.cpp, assume_are_same.cpp, assume_contains.cpp, assume_does_not_throw.cpp, assume_is_NaN.cpp, assume_is_empty.cpp, assume_is_false.cpp, assume_is_greater.cpp, assume_is_greater_or_equal.cpp, assume_is_instance_of.cpp, assume_is_less.cpp, assume_is_less_or_equal.cpp, assume_is_negative.cpp, assume_is_not_empty.cpp, assume_is_not_instance_of.cpp, assume_is_not_null.cpp, assume_is_not_zero.cpp, assume_is_null.cpp, assume_is_positive.cpp, assume_is_true.cpp, assume_is_zero.cpp, assume_throws.cpp, assume_throws_any.cpp, class_with_insert_stream_operator.cpp, class_without_insert_stream_operator.cpp, collection_assert.cpp, collection_assert_all_items_are_instances_of.cpp, collection_assert_all_items_are_not_null.cpp, collection_assert_all_items_are_unique.cpp, collection_assert_are_equal.cpp, collection_assert_are_equivalent.cpp, collection_assert_are_not_equal.cpp, collection_assert_are_not_equivalent.cpp, collection_assert_contains.cpp, collection_assert_does_not_contain.cpp, collection_assert_is_empty.cpp, collection_assert_is_not_empty.cpp, collection_assert_is_ordered.cpp, collection_assume.cpp, collection_assume_all_items_are_instances_of.cpp, collection_assume_all_items_are_not_null.cpp, collection_assume_all_items_are_unique.cpp, collection_assume_are_equal.cpp, collection_assume_are_equivalent.cpp, collection_assume_are_not_equal.cpp, collection_assume_are_not_equivalent.cpp, collection_assume_contains.cpp, collection_assume_does_not_contain.cpp, collection_assume_is_empty.cpp, collection_assume_is_not_empty.cpp, collection_assume_is_ordered.cpp, collection_valid.cpp, collection_valid_all_items_are_instances_of.cpp, collection_valid_all_items_are_not_null.cpp, collection_valid_all_items_are_unique.cpp, collection_valid_are_equal.cpp, collection_valid_are_equivalent.cpp, collection_valid_are_not_equal.cpp, collection_valid_are_not_equivalent.cpp, collection_valid_contains.cpp, collection_valid_does_not_contain.cpp, collection_valid_is_empty.cpp, collection_valid_is_not_empty.cpp, collection_valid_is_ordered.cpp, console_unit_test.cpp, create_gtest_like_event_listener.cpp, directory_assert.cpp, directory_assert_are_equal.cpp, directory_assert_are_not_equal.cpp, directory_assert_does_not_exist.cpp, directory_assert_exists.cpp, directory_assume.cpp, directory_assume_are_equal.cpp, directory_assume_are_not_equal.cpp, directory_assume_does_not_exist.cpp, directory_assume_exists.cpp, directory_valid.cpp, directory_valid_are_equal.cpp, directory_valid_are_not_equal.cpp, directory_valid_does_not_exist.cpp, directory_valid_exists.cpp, file_assert.cpp, file_assert_are_equal.cpp, file_assert_are_not_equal.cpp, file_assert_does_not_exist.cpp, file_assert_exists.cpp, file_assume.cpp, file_assume_are_equal.cpp, file_assume_are_not_equal.cpp, file_assume_does_not_exist.cpp, file_assume_exists.cpp, file_valid.cpp, file_valid_are_equal.cpp, file_valid_are_not_equal.cpp, file_valid_does_not_exist.cpp, file_valid_exists.cpp, generic_test_class.cpp, hello_world_tunit.cpp, many_asserts.cpp, many_valids_and_asserts.cpp, math_assert.cpp, math_assume.cpp, math_valid.cpp, ostream_unit_test.cpp, string_assert.cpp, string_assert_are_equal_ignoring_case.cpp, string_assert_are_not_equal_ignoring_case.cpp, string_assert_contains.cpp, string_assert_does_not_contain.cpp, string_assert_does_not_end_with.cpp, string_assert_does_not_match.cpp, string_assert_does_not_start_with.cpp, string_assert_ends_with.cpp, string_assert_matches.cpp, string_assert_starts_with.cpp, string_assume.cpp, string_assume_are_equal_ignoring_case.cpp, string_assume_are_not_equal_ignoring_case.cpp, string_assume_contains.cpp, string_assume_does_not_contain.cpp, string_assume_does_not_end_with.cpp, string_assume_does_not_match.cpp, string_assume_does_not_start_with.cpp, string_assume_ends_with.cpp, string_assume_matches.cpp, string_assume_starts_with.cpp, string_valid.cpp, string_valid_are_equal_ignoring_case.cpp, string_valid_are_not_equal_ignoring_case.cpp, string_valid_contains.cpp, string_valid_does_not_contain.cpp, string_valid_does_not_end_with.cpp, string_valid_does_not_match.cpp, string_valid_does_not_start_with.cpp, string_valid_ends_with.cpp, string_valid_matches.cpp, string_valid_starts_with.cpp, test_class.cpp, tunit_config_main.cpp, valid.cpp, valid_are_equal.cpp, valid_are_equal_with_tolerance.cpp, valid_are_not_equal.cpp, valid_are_not_same.cpp, valid_are_same.cpp, valid_contains.cpp, valid_does_not_throw.cpp, valid_is_NaN.cpp, valid_is_empty.cpp, valid_is_false.cpp, valid_is_greater.cpp, valid_is_greater_or_equal.cpp, valid_is_instance_of.cpp, valid_is_less.cpp, valid_is_less_or_equal.cpp, valid_is_negative.cpp, valid_is_not_empty.cpp, valid_is_not_instance_of.cpp, valid_is_not_null.cpp, valid_is_not_zero.cpp, valid_is_null.cpp, valid_is_positive.cpp, valid_is_true.cpp, valid_is_zero.cpp, valid_throws.cpp, and valid_throws_any.cpp.

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_::main);

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_::main);

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.