xtd::tunit::base_assert Class Reference

#include <base_assert.h>

Definition

The base class for assert.

Namespace

xtd::tunit

Library

xtd.tunit

Inherited by xtd::tunit::assert, xtd::tunit::assume [private], xtd::tunit::collection_assert [private], xtd::tunit::collection_assume [private], xtd::tunit::collection_valid [private], xtd::tunit::directory_assert [private], xtd::tunit::directory_assume [private], xtd::tunit::directory_valid [private], xtd::tunit::file_assert [private], xtd::tunit::file_assume [private], xtd::tunit::file_valid [private], xtd::tunit::string_assert [private], xtd::tunit::string_assume [private], xtd::tunit::string_valid [private], and xtd::tunit::valid [private].

Static Public Member Functions
static void	abort ()
	Abort current test. This is used by the other Assert functions.
static void	abort (const std::string &message)
	Abort current test. This is used by the other Assert functions.
static void	abort (const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Abort current test. This is used by the other Assert functions.
static void	abort (const xtd::diagnostics::stack_frame &stack_frame)
	Abort current test. This is used by the other Assert functions.
static void	fail ()
	Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.
static void	fail (const std::string &message)
	Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.
static void	fail (const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.
static void	fail (const xtd::diagnostics::stack_frame &stack_frame)
	Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.
static void	ignore ()
	Ignore current test. This is used by the other Assert functions.
static void	ignore (const std::string &message)
	Ignore current test. This is used by the other Assert functions.
static void	ignore (const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Ignore current test. This is used by the other Assert functions.
static void	ignore (const xtd::diagnostics::stack_frame &stack_frame)
	Ignore current test. This is used by the other Assert functions.
static void	succeed ()
	Generates a success with a generic message. This is used by the other Assert functions.
static void	succeed (const std::string &message)
	Generates a success with a generic message. This is used by the other Assert functions.
static void	succeed (const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Generates a success with a generic message. This is used by the other Assert functions.
static void	succeed (const xtd::diagnostics::stack_frame &stack_frame)
	Generates a success with a generic message. This is used by the other Assert functions.

Static Protected Member Functions
static void	error ()
static void	error (const std::string &actual, const std::string &expected, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
static void	fail (const std::string &actual, const std::string &expected, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
template<typename collection_t >
static std::string	join_items (const collection_t &collection)
static std::string	join_items (const std::string &str)
template<typename value_t >
static std::string	to_string (const value_t &value)
template<typename value_t >
static std::string	to_string (const value_t *value)

Member Function Documentation

abort() [1/4]

static void xtd::tunit::base_assert::abort ( )

inlinestatic

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

Examples

xtd::tunit::assert::abort("User message...", csf_); // test throws an abort_error exception.

abort() [2/4]

static void xtd::tunit::base_assert::abort ( const std::string &  message )

inlinestatic

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

Parameters

message

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

Examples

xtd::tunit::assert::abort("User message...", csf_); // test throws an abort_error exception.

abort() [3/4]

static void xtd::tunit::base_assert::abort ( const std::string &  message, const xtd::diagnostics::stack_frame &  stack_frame  )

static

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

Parameters

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.

Examples

xtd::tunit::assert::abort("User message...", csf_); // test throws an abort_error exception.

abort() [4/4]

static void xtd::tunit::base_assert::abort ( const xtd::diagnostics::stack_frame &  stack_frame )

inlinestatic

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

Parameters

stack_frame

Contains information about current file and current line.

Exceptions

xtd::tunit::assertion_error

If bad assertion.

Examples

xtd::tunit::assert::abort("User message...", csf_); // test throws an abort_error exception.

fail() [1/4]

static void xtd::tunit::base_assert::fail ( )

inlinestatic

Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.

Exceptions

xtd::tunit::assertion_error

If bad assertion.

Examples

xtd::tunit::assert::fail("User message...", csf_); // test throws an assertion_error exception.

fail() [2/4]

static void xtd::tunit::base_assert::fail ( const std::string &  message )

inlinestatic

Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.

Parameters

message

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

Exceptions

xtd::tunit::assertion_error

If bad assertion.

Examples

xtd::tunit::assert::fail("User message...", csf_); // test throws an assertion_error exception.

fail() [3/4]

static void xtd::tunit::base_assert::fail ( const std::string &  message, const xtd::diagnostics::stack_frame &  stack_frame  )

inlinestatic

Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.

Parameters

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::assertion_error

If bad assertion.

Examples

xtd::tunit::assert::fail("User message...", csf_); // test throws an assertion_error exception.

fail() [4/4]

static void xtd::tunit::base_assert::fail ( const xtd::diagnostics::stack_frame &  stack_frame )

inlinestatic

Throws an xtd::tunit::assertion_error exception. This is used by the other Assert functions.

Parameters

stack_frame

Contains information about current file and current line.

Exceptions

xtd::tunit::assertion_error

If bad assertion.

Examples

xtd::tunit::assert::fail("User message...", csf_); // test throws an assertion_error exception.

ignore() [1/4]

static void xtd::tunit::base_assert::ignore ( )

inlinestatic

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

Examples

xtd::tunit::assert::ignore("User message...", csf_); // test throws an ignore_error exception.

ignore() [2/4]

static void xtd::tunit::base_assert::ignore ( const std::string &  message )

inlinestatic

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

Parameters

message

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

Examples

xtd::tunit::assert::ignore("User message...", csf_); // test throws an ignore_error exception.

ignore() [3/4]

static void xtd::tunit::base_assert::ignore ( const std::string &  message, const xtd::diagnostics::stack_frame &  stack_frame  )

static

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

Parameters

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.

Examples

xtd::tunit::assert::ignore("User message...", csf_); // test throws an ignore_error exception.

ignore() [4/4]

static void xtd::tunit::base_assert::ignore ( const xtd::diagnostics::stack_frame &  stack_frame )

inlinestatic

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

Parameters

stack_frame

Contains information about current file and current line.

Exceptions

xtd::tunit::assertion_error

If bad assertion.

Examples

xtd::tunit::assert::ignore("User message...", csf_); // test throws an ignore_error exception.

succeed() [1/4]

static void xtd::tunit::base_assert::succeed ( )

inlinestatic

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

Examples

xtd::tunit::assert::succeed(); // test ok.

succeed() [2/4]

static void xtd::tunit::base_assert::succeed ( const std::string &  message )

inlinestatic

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

Parameters

message

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

Examples

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

succeed() [3/4]

static void xtd::tunit::base_assert::succeed ( const std::string &  message, const xtd::diagnostics::stack_frame &  stack_frame  )

static

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

Parameters

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.

Examples

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

succeed() [4/4]

static void xtd::tunit::base_assert::succeed ( const xtd::diagnostics::stack_frame &  stack_frame )

inlinestatic

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

Parameters

message

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

Examples

xtd::tunit::assert::succeed(csf_); // test ok.

---

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

• xtd.tunit/include/xtd/tunit/base_assert.h