xtd::tunit::assume Class Reference

Inheritance diagram for xtd::tunit::assume:

Definition

The assume class contains a collection of static methods that implement the most common assertions used in xtd::tUnit.

Namespace

xtd::tunit

Library

xtd.tunit

Remarks

Assumptions are intended to express the state a test must be in to provide a meaningful result. They are functionally similar to assertions, however a unmet assumption will produce an aborted test result, as opposed to a failure.

Examples

This example show how to used some methods :

#include <xtd/xtd.tunit>
#include <stdexcept>
 
using namespace xtd::tunit;
 
namespace unit_tests {
  // The class test must be declared with test_class_ helper.
  class test_class_(test) {
    void test_method_(test_case1) {
      assume::is_true(true);
    }
    
    void test_method_(test_case2) {
      assume::is_false(true);
    }
    
    void test_method_(test_case3) {
      assume::does_not_throw([] {throw std::range_error("error");});
    }
  };
}
 
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)
//   ABORTED test.test_case2 (0 ms total)
//     Test aborted
//     Expected: false
//     But was:  true
//     Stack Trace: in |---OMITTED---|/assume.cpp:14
//   ABORTED test.test_case3 (0 ms total)
//     Test aborted
//     Expected: No Exception to be thrown
//     But was:  <std::range_error>
//     Stack Trace: in |---OMITTED---|/assume.cpp:18
//
// Test results:
//   SUCCEED 1 test.
//   ABORTED 2 tests.
// End 3 tests from 1 test case ran. (0 ms total)

Public Static Methods
template<typename expected_t , typename actual_t >
static void	are_equal (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
template<typename expected_t , typename actual_t >
static void	are_equal (const expected_t &expected, const actual_t &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
static void	are_equal (float expected, float actual, float tolerance, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
static void	are_equal (float expected, float actual, float tolerance, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
static void	are_equal (double expected, double actual, double tolerance, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
static void	are_equal (double expected, double actual, double tolerance, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
static void	are_equal (long double expected, long double actual, long double tolerance, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
static void	are_equal (long double expected, long double actual, long double tolerance, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are equal.
template<typename expected_t , typename actual_t >
static void	are_not_equal (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are not equal.
template<typename expected_t , typename actual_t >
static void	are_not_equal (const expected_t &expected, const actual_t &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two type are not equal.
template<typename expected_t , typename actual_t >
static void	are_not_same (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two objects do refer to differents objects.
template<typename expected_t , typename actual_t >
static void	are_not_same (const expected_t &expected, const actual_t &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two objects do refer to differents objects.
template<typename expected_t , typename actual_t >
static void	are_same (const expected_t &expected, const actual_t &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two objects do refer to differents objects.
template<typename expected_t , typename actual_t >
static void	are_same (const expected_t &expected, const actual_t &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two objects do refer to differents objects.
template<typename item_t , typename collection_t >
static void	contains (const item_t &item, const collection_t &collection, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that collection contains an item.
template<typename item_t , typename collection_t >
static void	contains (const item_t &item, const collection_t &collection, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that collection contains an item.
static void	does_not_throw (const std::function< void()> &statement, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the staement does not throw an exception.
static void	does_not_throw (const std::function< void()> &statement, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the staement does not throw an exception.
template<typename value_t >
static void	is_empty (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that collection contains an item.
template<typename value_t >
static void	is_empty (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that collection contains an item.
static void	is_false (bool condition, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a condition is false.
static void	is_false (bool condition, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a condition is false.
template<typename value1_t , typename value2_t >
static void	is_greater (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is greater than the second value.
template<typename value1_t , typename value2_t >
static void	is_greater (const value1_t &val1, const value2_t &val2, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is greater than the second value.
template<typename value1_t , typename value2_t >
static void	is_greater_or_equal (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is greater than or equal to the second value.
template<typename value1_t , typename value2_t >
static void	is_greater_or_equal (const value1_t &val1, const value2_t &val2, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is greater than or equal to the second value.
template<typename type_t , typename value_t >
static void	is_instance_of (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that an object is of the type supplied or a derived type.
template<typename type_t , typename value_t >
static void	is_instance_of (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that an object is of the type supplied or a derived type.
template<typename value1_t , typename value2_t >
static void	is_less (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is is_less than the second value.
template<typename value1_t , typename value2_t >
static void	is_less (const value1_t &val1, const value2_t &val2, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is is_less than the second value.
template<typename value1_t , typename value2_t >
static void	is_less_or_equal (const value1_t &val1, const value2_t &val2, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is is_less than or equal to the second value.
template<typename value1_t , typename value2_t >
static void	is_less_or_equal (const value1_t &val1, const value2_t &val2, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the first value is is_less than or equal to the second value.
static void	is_NaN (double value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	that a value is NaN.
static void	is_NaN (double value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a value is NaN.
static void	is_NaN (long double value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	that a value is NaN.
static void	is_NaN (long double value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a value is NaN.
static void	is_NaN (float value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	that a value is NaN.
static void	is_NaN (float value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a value is NaN.
template<typename value_t >
static void	is_negative (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is negative.
template<typename value_t >
static void	is_negative (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is negative.
template<typename value_t >
static void	is_not_empty (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that collection does not contain any item.
template<typename value_t >
static void	is_not_empty (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that collection does not contain any item.
template<typename type_t , typename value_t >
static void	is_not_instance_of (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that an object is not of the type supplied or a derived type.
template<typename type_t , typename value_t >
static void	is_not_instance_of (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that an object is not of the type supplied or a derived type.
template<typename pointer_t >
static void	is_not_null (const pointer_t *pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename pointer_t >
static void	is_not_null (const pointer_t *pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename optional_t >
static void	is_not_null (const std::optional< optional_t > &opt, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the optional is not std::nullopt.
template<typename optional_t >
static void	is_not_null (const std::optional< optional_t > &opt, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the optional is not std::nullopt.
template<typename pointer_t >
static void	is_not_null (const xtd::uptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename pointer_t >
static void	is_not_null (const xtd::uptr< pointer_t > &pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename pointer_t >
static void	is_not_null (const xtd::sptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename pointer_t >
static void	is_not_null (const xtd::sptr< pointer_t > &pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename pointer_t >
static void	is_not_null (const xtd::wptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename pointer_t >
static void	is_not_null (const xtd::wptr< pointer_t > &pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
static void	is_not_null (std::nullptr_t pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
static void	is_not_null (std::nullptr_t pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is not null.
template<typename value_t >
static void	is_not_zero (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is not zero.
template<typename value_t >
static void	is_not_zero (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is not zero.
template<typename pointer_t >
static void	is_null (const pointer_t *pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename pointer_t >
static void	is_null (const pointer_t *pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename optional_t >
static void	is_null (const std::optional< optional_t > &opt, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the optional is std::nullopt.
template<typename optional_t >
static void	is_null (const std::optional< optional_t > &opt, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the optional is std::nullopt.
template<typename pointer_t >
static void	is_null (const xtd::uptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename pointer_t >
static void	is_null (const xtd::uptr< pointer_t > &pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename pointer_t >
static void	is_null (const xtd::sptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename pointer_t >
static void	is_null (const xtd::sptr< pointer_t > &pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename pointer_t >
static void	is_null (const xtd::wptr< pointer_t > &pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename pointer_t >
static void	is_null (const xtd::wptr< pointer_t > &pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
static void	is_null (std::nullptr_t pointer, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
static void	is_null (std::nullptr_t pointer, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the pointer is null.
template<typename value_t >
static void	is_positive (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is positive.
template<typename value_t >
static void	is_positive (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is positive.
static void	is_true (bool condition, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a condition is true.
static void	is_true (bool condition, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that a condition is true.
template<typename value_t >
static void	is_zero (const value_t &value, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is zero.
template<typename value_t >
static void	is_zero (const value_t &value, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that ta condition is zero.
template<typename exception_t >
static void	throws (const std::function< void()> &statement, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the statement throws a particular exception when called.
template<typename exception_t >
static void	throws (const std::function< void()> &statement, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the statement throws a particular exception when called.
static void	throws_any (const std::function< void()> &statement, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the staement does not throw an exception.
static void	throws_any (const std::function< void()> &statement, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that the staement does not throw an exception.

Member Function Documentation

are_equal() [1/8]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_equal ( const expected_t &  expected, const actual_t &  actual, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::are_equal(24, int(24)); // test ok.
xtd::tunit::assume::are_equal(23, int(24)); // test throws an abort_error exception.

are_equal() [2/8]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_equal ( const expected_t &  expected, const actual_t &  actual, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

are_equal() [3/8]

static void xtd::tunit::assume::are_equal ( float  expected, float  actual, float  tolerance, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolerance	Indicates a tolerance within which they will be considered as equal.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

float f = 0.00007999999999f;
xtd::tunit::assume::are_equal_(0.00008f, f, 0.0000000000001f); // test ok.
xtd::tunit::assume::are_equal_(0.00008f, f, 0.00000000000001f); // test throws an abort_error exception.

are_equal() [4/8]

static void xtd::tunit::assume::are_equal ( float  expected, float  actual, float  tolerance, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

float f = 0.00007999999999f;
xtd::tunit::assume::are_equal_(0.00008f, f, 0.0000000000001f, "User message..."); // test ok.
xtd::tunit::assume::are_equal_(0.00008f, f, 0.00000000000001f, "User message..."); // test throws an abort_error exception.

are_equal() [5/8]

static void xtd::tunit::assume::are_equal ( double  expected, double  actual, double  tolerance, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolerance	Indicates a tolerance within which they will be considered as equal.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

double d = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008, d, 0.0000000000001); // test ok.
xtd::tunit::assume::are_equal_(0.00008, d, 0.00000000000001); // test throws an abort_error exception.

are_equal() [6/8]

static void xtd::tunit::assume::are_equal ( double  expected, double  actual, double  tolerance, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

double d = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008, d, 0.0000000000001, "User message..."); // test ok.
xtd::tunit::assume::are_equal_(0.00008, d, 0.00000000000001, "User message..."); // test throws an abort_error exception.

are_equal() [7/8]

static void xtd::tunit::assume::are_equal ( long double  expected, long double  actual, long double  tolerance, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolerance	Indicates a tolerance within which they will be considered as equal.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

long double ld = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.0000000000001l); // test ok.
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.00000000000001l); // test throws an abort_error exception.

are_equal() [8/8]

static void xtd::tunit::assume::are_equal ( long double  expected, long double  actual, long double  tolerance, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that two type are equal.

Parameters

expected	the expected value.
actual	the actual value.
tolerance	Indicates a tolerance within which they will be considered as equal.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

long double ld = 0.00007999999999;
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.0000000000001l, "User message..."); // test ok.
xtd::tunit::assume::are_equal_(0.00008l, ld, 0.00000000000001l, "User message..."); // test throws an abort_error exception.

are_not_equal() [1/2]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_not_equal ( const expected_t &  expected, const actual_t &  actual, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::are_not_equal(23, int(24)); // test ok.
xtd::tunit::assume::are_not_equal(24, int(24)); // test throws an abort_error exception.

are_not_equal() [2/2]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_not_equal ( const expected_t &  expected, const actual_t &  actual, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two type are not equal.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

are_not_same() [1/2]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_not_same ( const expected_t &  expected, const actual_t &  actual, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c = 24;
xtd::tunit::assume::are_not_same(c, a); // test ok.
xtd::tunit::assume::are_not_same(b, a, stack_frame); // test throws an abort_error exception.

are_not_same() [2/2]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_not_same ( const expected_t &  expected, const actual_t &  actual, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c = 24;
xtd::tunit::assume::are_not_same(c, a, "User message..."); // test ok.
xtd::tunit::assume::are_not_same(b, a, "User message...", stack_frame); // test throws an abort_error exception.

are_same() [1/2]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_same ( const expected_t &  expected, const actual_t &  actual, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c = 24;
xtd::tunit::assume::are_same(b, a); // test ok.
xtd::tunit::assume::are_same(c, a); // test throws an abort_error exception.

are_same() [2/2]

template<typename expected_t , typename actual_t >

static void xtd::tunit::assume::are_same ( const expected_t &  expected, const actual_t &  actual, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that two objects do refer to differents objects.

Parameters

expected	the expected value.
actual	the actual value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int a = 24;
int& b = a;
int c = 24;
xtd::tunit::assume::are_same(b, a, "User message..."); // test ok.
xtd::tunit::assume::are_same(c, a, "User message..."); // test throws an abort_error exception.

contains() [1/2]

template<typename item_t , typename collection_t >

static void xtd::tunit::assume::contains ( const item_t &  item, const collection_t &  collection, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
xtd::tunit::assume::contains(2, v1); // test ok.
xtd::tunit::assume::contains(4, v1); // test throws an abort_error exception.

contains() [2/2]

template<typename item_t , typename collection_t >

static void xtd::tunit::assume::contains ( const item_t &  item, const collection_t &  collection, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that collection contains an item.

Parameters

item	object to verify.
collection	that contains object.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
xtd::tunit::assume::contains(2, v1, "User message..."); // test ok.
xtd::tunit::assume::contains(4, v1, "User message..."); // test throws an abort_error exception.

does_not_throw() [1/2]

static void xtd::tunit::assume::does_not_throw ( const std::function< void()> &  statement, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the staement does not throw an exception.

Parameters

statement	The statement that verify.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::does_not_throw([&] {v1.at(2);}); // test ok.
xtd::tunit::assume::does_not_throw([&] {v1.at(5);}); // test throws an abort_error exception.

does_not_throw() [2/2]

static void xtd::tunit::assume::does_not_throw ( const std::function< void()> &  statement, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::does_not_throw([&] {v1.at(2);}, "User message..."); // test ok.
xtd::tunit::assume::does_not_throw([&] {v1.at(5);}, "User message..."); // test throws an abort_error exception.

is_empty() [1/2]

template<typename value_t >

static void xtd::tunit::assume::is_empty ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that collection contains an item.

Parameters

value	The value to check is empty.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
xtd::tunit::assume::is_empty(v1); // test ok.
xtd::tunit::assume::is_empty(v2); // test throws an abort_error exception.

is_empty() [2/2]

template<typename value_t >

static void xtd::tunit::assume::is_empty ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that collection contains an item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1;
std::vector<int> v2 = {0, 1, 2, 3};
xtd::tunit::assume::is_empty(v1, "User message..."); // test ok.
xtd::tunit::assume::is_empty(v2, "User message..."); // test throws an abort_error exception.

is_false() [1/2]

static void xtd::tunit::assume::is_false ( bool  condition, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a condition is false.

Parameters

condition	The condition to check is false.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string s1 = "Anything";
std::string s2;
xtd::tunit::assume::is_false(std::empty(s1)); // test ok.
xtd::tunit::assume::is_false(std::empty(s2)); // test throws an abort_error exception.

is_false() [2/2]

static void xtd::tunit::assume::is_false ( bool  condition, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a condition is false.

Parameters

condition	The condition to check is false.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string s1 = "Anything";
std::string s2;
xtd::tunit::assume::is_false(std::empty(s1), "User message..."); // test ok.
xtd::tunit::assume::is_false(std::empty(s2), "User message..."); // test throws an abort_error exception.

is_greater() [1/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_greater ( const value1_t &  val1, const value2_t &  val2, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_greater(24, 12); // test ok.
xtd::tunit::assume::is_greater(24, 48); // test throws an abort_error exception.

is_greater() [2/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_greater ( const value1_t &  val1, const value2_t &  val2, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_greater(24, 12, "User message..."); // test ok.
xtd::tunit::assume::is_greater(24, 48, "User message..."); // test throws an abort_error exception.

is_greater_or_equal() [1/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_greater_or_equal ( const value1_t &  val1, const value2_t &  val2, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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); // test throws an abort_error exception.

is_greater_or_equal() [2/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_greater_or_equal ( const value1_t &  val1, const value2_t &  val2, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_greater_or_equal(24, 12, "User message..."); // test ok.
xtd::tunit::assume::is_greater_or_equal(24, 24, "User message..."); // test ok.
xtd::tunit::assume::is_greater_or_equal(24, 48, "User message..."); // test throws an abort_error exception.

is_instance_of() [1/2]

template<typename type_t , typename value_t >

static void xtd::tunit::assume::is_instance_of ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

value	The object to verify
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_instance_of<std::logic_error>(except); // test ok.
xtd::tunit::assume::is_instance_of<std::bad_cast>(except); // test fails

is_instance_of() [2/2]

template<typename type_t , typename value_t >

static void xtd::tunit::assume::is_instance_of ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_instance_of<std::logic_error>(except, "User message..."); // test ok.
xtd::tunit::assume::is_instance_of<std::bad_cast>(except, "User message..."); // test fails

is_less() [1/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_less ( const value1_t &  val1, const value2_t &  val2, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_less(24, 48); // test ok.
xtd::tunit::assume::is_less(24, 12); // test throws an abort_error exception.

is_less() [2/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_less ( const value1_t &  val1, const value2_t &  val2, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_less(24, 48, "User message..."); // test ok.
xtd::tunit::assume::is_less(24, 12, "User message..."); // test throws an abort_error exception.

is_less_or_equal() [1/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_less_or_equal ( const value1_t &  val1, const value2_t &  val2, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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); // test throws an abort_error exception.

is_less_or_equal() [2/2]

template<typename value1_t , typename value2_t >

static void xtd::tunit::assume::is_less_or_equal ( const value1_t &  val1, const value2_t &  val2, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

val1	the first value.
val2	the second value.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_less_or_equal(24, 48, "User message..."); // test ok.
xtd::tunit::assume::is_less_or_equal(24, 24, "User message..."); // test ok.
xtd::tunit::assume::is_less_or_equal(24, 12, "User message..."); // test throws an abort_error exception.

is_NaN() [1/6]

static void xtd::tunit::assume::is_NaN ( double  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

that a value is NaN.

Parameters

value	The value to check is NaN.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1); // test ok.
xtd::tunit::assume::is_NaN(v2); // test throws an abort_error exception.

is_NaN() [2/6]

static void xtd::tunit::assume::is_NaN ( double  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

double v1 = std::numeric_limits<double>::quiet_NaN();
double v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1, "User message..."); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message..."); // test throws an abort_error exception.

is_NaN() [3/6]

static void xtd::tunit::assume::is_NaN ( long double  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

that a value is NaN.

Parameters

value	The value to check is NaN.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
xtd::tunit::assume::is_NaN(v1); // test ok.
xtd::tunit::assume::is_NaN(v2); // test throws an abort_error exception.

is_NaN() [4/6]

static void xtd::tunit::assume::is_NaN ( long double  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

long double v1 = std::numeric_limits<long double>::quiet_NaN();
long double v2 = 3.14159265358979323846l;
xtd::tunit::assume::is_NaN(v1, "User message..."); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message..."); // test throws an abort_error exception.

is_NaN() [5/6]

static void xtd::tunit::assume::is_NaN ( float  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

that a value is NaN.

Parameters

value	The value to check is NaN.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1); // test ok.
xtd::tunit::assume::is_NaN(v2); // test throws an abort_error exception.

is_NaN() [6/6]

static void xtd::tunit::assume::is_NaN ( float  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a value is NaN.

Parameters

value	The value to check is NaN.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

float v1 = std::numeric_limits<float>::quiet_NaN();
float v2 = 3.14159265358979323846;
xtd::tunit::assume::is_NaN(v1, "User message..."); // test ok.
xtd::tunit::assume::is_NaN(v2, "User message..."); // test throws an abort_error exception.

is_negative() [1/2]

template<typename value_t >

static void xtd::tunit::assume::is_negative ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is negative.

Parameters

value	The value to check is negative.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = -1;
int i2 = 1;
xtd::tunit::assume::is_negative(i1); // test ok.
xtd::tunit::assume::is_negative(i2); // test throws an abort_error exception.

is_negative() [2/2]

template<typename value_t >

static void xtd::tunit::assume::is_negative ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is negative.

Parameters

value	The value to check is negative.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = -1;
int i2 = 1;
xtd::tunit::assume::is_negative(i1, "User message..."); // test ok.
xtd::tunit::assume::is_negative(i2, "User message..."); // test throws an abort_error exception.

is_not_empty() [1/2]

template<typename value_t >

static void xtd::tunit::assume::is_not_empty ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that collection does not contain any item.

Parameters

value	The value to check is empty.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
xtd::tunit::assume::is_not_empty(v1); // test ok.
xtd::tunit::assume::is_not_empty(v2); // test throws an abort_error exception.

is_not_empty() [2/2]

template<typename value_t >

static void xtd::tunit::assume::is_not_empty ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that collection does not contain any item.

Parameters

value	The value to check is empty.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {0, 1, 2, 3};
std::vector<int> v2;
xtd::tunit::assume::is_not_empty(v1, "User message..."); // test ok.
xtd::tunit::assume::is_not_empty(v2, "User message..."); // test throws an abort_error exception.

is_not_instance_of() [1/2]

template<typename type_t , typename value_t >

static void xtd::tunit::assume::is_not_instance_of ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

value	The object to verify
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_not_instance_of<std::bad_cast>(except); // test ok.
xtd::tunit::assume::is_not_instance_of<std::logic_error>(except); // test fails

is_not_instance_of() [2/2]

template<typename type_t , typename value_t >

static void xtd::tunit::assume::is_not_instance_of ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

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

Parameters

value	The object to verify
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::inassume_argument except("inassume argument");
xtd::tunit::assume::is_not_instance_of<std::bad_cast>(except, "User message..."); // test ok.
xtd::tunit::assume::is_not_instance_of<std::logic_error>(except, "User message..."); // test fails

is_not_null() [1/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const pointer_t *  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
xtd::tunit::assume::is_not_null(s1); // test ok.
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.

is_not_null() [2/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const pointer_t *  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = &str;
std::string* s2 = nullptr;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

is_not_null() [3/12]

template<typename optional_t >

static void xtd::tunit::assume::is_not_null ( const std::optional< optional_t > &  opt, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the optional is not std::nullopt.

Parameters

opt	The optional to check is std::nullopt.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::optional<std::string> s1 = "Anything";
std::optional<std::string> s2;
xtd::tunit::assume::is_not_null(s1); // test ok.
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.

is_not_null() [4/12]

template<typename optional_t >

static void xtd::tunit::assume::is_not_null ( const std::optional< optional_t > &  opt, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the optional is not std::nullopt.

Parameters

opt	The optional to check is std::nullopt.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::optional<std::string> s1 = "Anything";
std::optional<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

is_not_null() [5/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const xtd::uptr< pointer_t > &  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::uptr<std::string> s1 = xtd::new_uptr<std::string>("Anything");
xtd::uptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1); // test ok.
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.

is_not_null() [6/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const xtd::uptr< pointer_t > &  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::uptr<std::string> s1 = xtd::new_uptr<std::string>("Anything");
xtd::uptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

is_not_null() [7/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const xtd::sptr< pointer_t > &  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s1 = xtd::new_sptr<std::string>("Anything");
xtd::sptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1); // test ok.
xtd::tunit::assume::is_not_null(s2); // test throws an abort_error exception.

is_not_null() [8/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const xtd::sptr< pointer_t > &  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s1 = xtd::new_sptr<std::string>("Anything");
xtd::sptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test throws an abort_error exception.

is_not_null() [9/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const xtd::wptr< pointer_t > &  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s = xtd::new_sptr<std::string>("Anything");
xtd::wptr<std::string> s1 = s;
xtd::wptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1); // test ok.
xtd::tunit::assume::is_not_null(s2); // test ok.

is_not_null() [10/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_not_null ( const xtd::wptr< pointer_t > &  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s = xtd::new_sptr<std::string>("Anything");
xtd::wptr<std::string> s1 = s;
xtd::wptr<std::string> s2;
xtd::tunit::assume::is_not_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_not_null(s2, "User message..."); // test ok.

is_not_null() [11/12]

static void xtd::tunit::assume::is_not_null ( std::nullptr_t  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Remarks

Always false, a std::nullptr_t is always equal to nullptr.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

is_not_null() [12/12]

static void xtd::tunit::assume::is_not_null ( std::nullptr_t  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the pointer is not null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Remarks

Always false, a std::nullptr_t is always equal to nullptr.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_not_null(nullptr, "User message..."); // test throws an abort_error exception.

is_not_zero() [1/2]

template<typename value_t >

static void xtd::tunit::assume::is_not_zero ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is not zero.

Parameters

value	The value to check is not zero.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = 42;
int i2 = 0;
xtd::tunit::assume::is_not_zero(i1); // test ok.
xtd::tunit::assume::is_not_zero(i2); // test throws an abort_error exception.

is_not_zero() [2/2]

template<typename value_t >

static void xtd::tunit::assume::is_not_zero ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is not zero.

Parameters

value	The value to check is not zero.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = 42;
int i2 = 0;
xtd::tunit::assume::is_not_zero(i1, "User message..."); // test ok.
xtd::tunit::assume::is_not_zero(i2, "User message..."); // test throws an abort_error exception.

is_null() [1/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const pointer_t *  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
xtd::tunit::assume::is_null(s1); // test ok.
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

is_null() [2/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const pointer_t *  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string str = "Anything";
std::string* s1 = nullptr;
std::string* s2 = &str;
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

is_null() [3/12]

template<typename optional_t >

static void xtd::tunit::assume::is_null ( const std::optional< optional_t > &  opt, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the optional is std::nullopt.

Parameters

opt	The optional to check is std::nullopt.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::optional<std::string> s1;
std::optional<std::string> s2 = "Anything";
xtd::tunit::assume::is_null(s1); // test ok.
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

is_null() [4/12]

template<typename optional_t >

static void xtd::tunit::assume::is_null ( const std::optional< optional_t > &  opt, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the optional is std::nullopt.

Parameters

pointer	The optional to check is std::nullopt.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::optional<std::string> s1;
std::optional<std::string> s2 = "Anything";
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

is_null() [5/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const xtd::uptr< pointer_t > &  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::uptr<std::string> s1;
xtd::uptr<std::string> s2 = xtd::new_uptr<std::string>("Anything");
xtd::tunit::assume::is_null(s1); // test ok.
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

is_null() [6/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const xtd::uptr< pointer_t > &  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::uptr<std::string> s1;
xtd::uptr<std::string> s2 = xtd::new_uptr<std::string>("Anything");
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

is_null() [7/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const xtd::sptr< pointer_t > &  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s1;
xtd::sptr<std::string> s2 = xtd::new_sptr<std::string>("Anything");
xtd::tunit::assume::is_null(s1); // test ok.
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

is_null() [8/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const xtd::sptr< pointer_t > &  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s1;
xtd::sptr<std::string> s2 = xtd::new_sptr<std::string>("Anything");
xtd::tunit::assume::is_null(s1, "User message..."); // test ok.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

is_null() [9/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const xtd::wptr< pointer_t > &  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Remarks

Always false, a weaptr can't be equal to nullptr by contruction or assignation.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s = xtd::new_sptr<std::string>("Anything");
xtd::wptr<std::string> s1;
xtd::wptr<std::string> s2 = s;
xtd::tunit::assume::is_null(s1); // test throws an abort_error exception.
xtd::tunit::assume::is_null(s2); // test throws an abort_error exception.

is_null() [10/12]

template<typename pointer_t >

static void xtd::tunit::assume::is_null ( const xtd::wptr< pointer_t > &  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Remarks

Always false, a weaptr can't be equal to nullptr by contruction or assignation.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::sptr<std::string> s = xtd::new_sptr<std::string>("Anything");
xtd::wptr<std::string> s1;
xtd::wptr<std::string> s2 = s;
xtd::tunit::assume::is_null(s1, "User message..."); // test throws an abort_error exception.
xtd::tunit::assume::is_null(s2, "User message..."); // test throws an abort_error exception.

is_null() [11/12]

static void xtd::tunit::assume::is_null ( std::nullptr_t  pointer, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
stack_frame	Contains information about current file and current line.

Remarks

Always false, a std::nullptr_t is always equal to nullptr.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_null(nullptr); // test ok.

is_null() [12/12]

static void xtd::tunit::assume::is_null ( std::nullptr_t  pointer, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the pointer is null.

Parameters

pointer	The pointer to check is null.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Remarks

Always false, a std::nullptr_t is always equal to nullptr.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

xtd::tunit::assume::is_null(nullptr, "User message..."); // test ok.

is_positive() [1/2]

template<typename value_t >

static void xtd::tunit::assume::is_positive ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is positive.

Parameters

value	The value to check is positive.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = 1;
int i2 = -1;
xtd::tunit::assume::is_positive(i1); // test ok.
xtd::tunit::assume::is_positive(i2); // test throws an abort_error exception.

is_positive() [2/2]

template<typename value_t >

static void xtd::tunit::assume::is_positive ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is positive.

Parameters

value	The value to check is positive.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = 1;
int i2 = -1;
xtd::tunit::assume::is_positive(i1, "User message..."); // test ok.
xtd::tunit::assume::is_positive(i2, "User message..."); // test throws an abort_error exception.

is_true() [1/2]

static void xtd::tunit::assume::is_true ( bool  condition, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a condition is true.

Parameters

condition	The condition to check is true.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string s1;
std::string s2 = "Anything";
xtd::tunit::assume::is_false(std::empty(s1)); // test ok.
xtd::tunit::assume::is_false(std::empty(s2)); // test throws an abort_error exception.

Examples

test_tunit.cpp.

is_true() [2/2]

static void xtd::tunit::assume::is_true ( bool  condition, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that a condition is true.

Parameters

condition	The condition to check is true.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::string s1;
std::string s2 = "Anything";
xtd::tunit::assume::is_false(std::empty(s1), "User message..."); // test ok.
xtd::tunit::assume::is_false(std::empty(s2), "User message..."); // test throws an abort_error exception.

is_zero() [1/2]

template<typename value_t >

static void xtd::tunit::assume::is_zero ( const value_t &  value, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is zero.

Parameters

value	The value to check is zero.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = 0;
int i2 = 42;
xtd::tunit::assume::is_zero(i1); // test ok.
xtd::tunit::assume::is_zero(i2); // test throws an abort_error exception.

is_zero() [2/2]

template<typename value_t >

static void xtd::tunit::assume::is_zero ( const value_t &  value, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes that ta condition is zero.

Parameters

value	The value to check is zero.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

int i1 = 0;
int i2 = 42;
xtd::tunit::assume::is_zero(i1, "User message..."); // test ok.
xtd::tunit::assume::is_zero(i2, "User message..."); // test throws an abort_error exception.

throws() [1/2]

template<typename exception_t >

static void xtd::tunit::assume::throws ( const std::function< void()> &  statement, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes 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.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(5);}); // test ok.
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(2);}); // test throws an abort_error exception.

throws() [2/2]

template<typename exception_t >

static void xtd::tunit::assume::throws ( const std::function< void()> &  statement, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

inlinestatic

Assumes 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	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(5);}, "User message..."); // test ok.
xtd::tunit::assume::throws<std::out_of_range>([&] {v1.at(2);}, "User message..."); // test throws an abort_error exception.

throws_any() [1/2]

static void xtd::tunit::assume::throws_any ( const std::function< void()> &  statement, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the staement does not throw an exception.

Parameters

statement	The statement that verify.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws_any([&] {v1.at(5);}); // test ok.
xtd::tunit::assume::throws_any([&] {v1.at(2);}); // test throws an abort_error exception.

throws_any() [2/2]

static void xtd::tunit::assume::throws_any ( const std::function< void()> &  statement, const xtd::string &  message, const xtd::diagnostics::stack_frame &  stack_frame = xtd::diagnostics::stack_frame::current()  )

static

Assumes that the staement does not throw an exception.

Parameters

statement	The statement that verify.
message	A user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frame	Contains information about current file and current line.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

std::vector<int> v1 = {1, 2, 3, 4};
xtd::tunit::assume::throws_any([&] {v1.at(5);}, "User message..."); // test ok.
xtd::tunit::assume::throws_any([&] {v1.at(2);}, "User message..."); // test throws an abort_error exception.

---

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

• xtd.tunit/include/xtd/tunit/assume.hpp