#include <directory_assert.h>

Definition

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

Namespace: xtd::tunit

Library: xtd.tunit

Remarks: Assertions are central to unit testing in any of the xUnit frameworks, and xtd.tunit is no exception. xtd.tunit provides a rich set of assertions as static methods of the Assert class.; If an assertion fails, the method call does not return and an error is reported. If a test contains multiple assertions, any that follow the one that failed will not be executed. For this reason, it's usually best to try for one assertion per test.; Each method may be called without a message, with a simple text message or with a message and arguments. In the last case the message is formatted using the provided text and arguments.

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) {
public:
void test_method_(test_case1) {
assert::is_true(true);
}

void test_method_(test_case2) {
assert::is_false(true);
}

void test_method_(test_case3) {
assert::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 test.test_case1 (0 ms total)
// FAILED test.test_case2 (0 ms total)
// Expected: false
// But was: true
// Stack Trace: in |---OMITTED---|/assert.cpp:14
// FAILED test.test_case3 (0 ms total)
// Expected: No Exception to be thrown
// But was: <std::range_error>
// Stack Trace: in |---OMITTED---|/assert.cpp:18
//
// Test results:
// SUCCEED 1 test.
// FAILED 2 tests.
// End 3 tests from 1 test case ran. (0 ms total)

Methods
static void	are_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual)
	Asserts that two std::filesystem::directory_entry are equal. More...

static void	are_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two std::filesystem::directory_entry are equal. More...

static void	are_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual, const std::string &message)
	Asserts that two std::filesystem::directory_entry are equal. More...

static void	are_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two std::filesystem::directory_entry are equal. More...

static void	are_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual)
	Asserts that two xtd::io::directory_info are equal. More...

static void	are_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two xtd::io::directory_info are equal. More...

static void	are_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const std::string &message)
	Asserts that two xtd::io::directory_info are equal. More...

static void	are_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two xtd::io::directory_info are equal. More...

static void	are_not_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual)
	Asserts that two std::filesystem::directory_entry are not equal. More...

static void	are_not_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two std::filesystem::directory_entry are not equal. More...

static void	are_not_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual, const std::string &message)
	Asserts that two std::filesystem::directory_entry are not equal. More...

static void	are_not_equal (const std::filesystem::directory_entry &expected, const std::filesystem::directory_entry &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two std::filesystem::directory_entry are not equal. More...

static void	are_not_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual)
	Asserts that two xtd::io::directory_info are not equal. More...

static void	are_not_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two xtd::io::directory_info are not equal. More...

static void	are_not_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const std::string &message)
	Asserts that two xtd::io::directory_info are not equal. More...

static void	are_not_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that two xtd::io::directory_info are not equal. More...

static void	does_not_exist (const std::filesystem::directory_entry &directory)
	Asserts that directory not exists. More...

static void	does_not_exist (const std::filesystem::directory_entry &directory, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory not exists. More...

static void	does_not_exist (const std::filesystem::directory_entry &directory, const std::string &message)
	Asserts that directory not exists. More...

static void	does_not_exist (const std::filesystem::directory_entry &directory, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory not exists. More...

static void	does_not_exist (const xtd::io::directory_info &directory)
	Asserts that directory not exists. More...

static void	does_not_exist (const xtd::io::directory_info &directory, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory not exists. More...

static void	does_not_exist (const xtd::io::directory_info &directory, const std::string &message)
	Asserts that directory not exists. More...

static void	does_not_exist (const xtd::io::directory_info &directory, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory not exists. More...

template<typename char_t >
static void	does_not_exist (const std::basic_string< char_t > &directory)
	Asserts that directory not exists. More...

template<typename char_t >
static void	does_not_exist (const std::basic_string< char_t > &directory, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory not exists. More...

template<typename char_t >
static void	does_not_exist (const std::basic_string< char_t > &directory, const std::string &message)
	Asserts that directory not exists. More...

template<typename char_t >
static void	does_not_exist (const std::basic_string< char_t > &directory, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory not exists. More...

static void	exists (const std::filesystem::directory_entry &directory)
	Asserts that directory exists. More...

static void	exists (const std::filesystem::directory_entry &directory, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory exists. More...

static void	exists (const std::filesystem::directory_entry &directory, const std::string &message)
	Asserts that directory exists. More...

static void	exists (const std::filesystem::directory_entry &directory, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory exists. More...

static void	exists (const xtd::io::directory_info &directory)
	Asserts that directory exists. More...

static void	exists (const xtd::io::directory_info &directory, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory exists. More...

static void	exists (const xtd::io::directory_info &directory, const std::string &message)
	Asserts that directory exists. More...

static void	exists (const xtd::io::directory_info &directory, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory exists. More...

template<typename char_t >
static void	exists (const std::basic_string< char_t > &directory)
	Asserts that directory exists. More...

template<typename char_t >
static void	exists (const std::basic_string< char_t > &directory, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory exists. More...

template<typename char_t >
static void	exists (const std::basic_string< char_t > &directory, const std::string &message)
	Asserts that directory exists. More...

template<typename char_t >
static void	exists (const std::basic_string< char_t > &directory, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame)
	Asserts that directory exists. More...

Member Function Documentation

◆ are_equal() [1/8]

static void xtd::tunit::directory_assert::are_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual
	)

static

Asserts that two std::filesystem::directory_entry are equal.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_equal(d1, d2); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3); // test throws an assert_error exception.

◆ are_equal() [2/8]

static void xtd::tunit::directory_assert::are_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two std::filesystem::directory_entry are equal.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_equal(d1, d2, csf_); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3, csf_); // test throws an assert_error exception.

◆ are_equal() [3/8]

static void xtd::tunit::directory_assert::are_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual,
		const std::string &	message
	)

static

Asserts that two std::filesystem::directory_entry 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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_equal(d1, d2, "User message..."); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3, "User message..."); // test throws an assert_error exception.

◆ are_equal() [4/8]

static void xtd::tunit::directory_assert::are_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two std::filesystem::directory_entry 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::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_equal(d1, d2, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3, "User message...", csf_); // test throws an assert_error exception.

◆ are_equal() [5/8]

static void xtd::tunit::directory_assert::are_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual
	)

static

Asserts that two xtd::io::directory_info are equal.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_equal(d1, d2); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3); // test throws an assert_error exception.

◆ are_equal() [6/8]

static void xtd::tunit::directory_assert::are_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two xtd::io::directory_info are equal.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_equal(d1, d2, csf_); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3, csf_); // test throws an assert_error exception.

◆ are_equal() [7/8]

static void xtd::tunit::directory_assert::are_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const std::string &	message
	)

static

Asserts that two xtd::io::directory_info 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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_equal(d1, d2, "User message..."); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3, "User message..."); // test throws an assert_error exception.

◆ are_equal() [8/8]

static void xtd::tunit::directory_assert::are_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two xtd::io::directory_info 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::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_equal(d1, d2, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_equal(d1, d3, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [1/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual
	)

static

Asserts that two std::filesystem::directory_entry are not equal.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [2/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two std::filesystem::directory_entry 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::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [3/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual,
		const std::string &	message
	)

static

Asserts that two std::filesystem::directory_entry 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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [4/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const std::filesystem::directory_entry &	expected,
		const std::filesystem::directory_entry &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two std::filesystem::directory_entry 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::assert_error If bad assertion.

Examples: std::filesystem::directory_entry d1(std::filesystem::path("."));
std::filesystem::directory_entry d2(std::filesystem::path("."));
std::filesystem::directory_entry d3(std::filesystem::path(".."));
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [5/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual
	)

static

Asserts that two xtd::io::directory_info are not equal.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [6/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two xtd::io::directory_info 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::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [7/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const std::string &	message
	)

static

Asserts that two xtd::io::directory_info 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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ are_not_equal() [8/8]

static void xtd::tunit::directory_assert::are_not_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that two xtd::io::directory_info 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::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(".");
xtd::io::directory_info d2(".")
xtd::io::directory_info d3("..")
xtd::tunit::directory_assert::are_not_equal(d1, d3, "User message...", csf_); // test ok.
xtd::tunit::directory_assert::are_not_equal(d1, d2, "User message...", csf_); // test throws an assert_error exception.

◆ does_not_exist() [1/12]

static void xtd::tunit::directory_assert::does_not_exist ( const std::filesystem::directory_entry & directory )

static

Asserts that directory not exists.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [2/12]

static void xtd::tunit::directory_assert::does_not_exist	(	const std::filesystem::directory_entry &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory not exists.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [3/12]

static void xtd::tunit::directory_assert::does_not_exist	(	const std::filesystem::directory_entry &	directory,
		const std::string &	message
	)

static

Asserts that directory not exists.

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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [4/12]

static void xtd::tunit::directory_assert::does_not_exist	(	const std::filesystem::directory_entry &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory not exists.

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::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [5/12]

static void xtd::tunit::directory_assert::does_not_exist ( const xtd::io::directory_info & directory )

static

Asserts that directory not exists.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(environment::get_folder_path(environment::special_folder::common_application_data));
xtd::io::directory_info d2(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__"));
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [6/12]

static void xtd::tunit::directory_assert::does_not_exist	(	const xtd::io::directory_info &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory not exists.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(environment::get_folder_path(environment::special_folder::common_application_data));
xtd::io::directory_info d2(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__"));
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [7/12]

static void xtd::tunit::directory_assert::does_not_exist	(	const xtd::io::directory_info &	directory,
		const std::string &	message
	)

static

Asserts that directory not exists.

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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(environment::get_folder_path(environment::special_folder::common_application_data));
xtd::io::directory_info d2(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__"));
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [8/12]

static void xtd::tunit::directory_assert::does_not_exist	(	const xtd::io::directory_info &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory not exists.

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::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(environment::get_folder_path(environment::special_folder::common_application_data));
xtd::io::directory_info d2(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__"));
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [9/12]

template<typename char_t >

static void xtd::tunit::directory_assert::does_not_exist ( const std::basic_string< char_t > & directory )

inlinestatic

Asserts that directory not exists.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [10/12]

template<typename char_t >

static void xtd::tunit::directory_assert::does_not_exist	(	const std::basic_string< char_t > &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

inlinestatic

Asserts that directory not exists.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [11/12]

template<typename char_t >

static void xtd::tunit::directory_assert::does_not_exist	(	const std::basic_string< char_t > &	directory,
		const std::string &	message
	)

inlinestatic

Asserts that directory not exists.

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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [12/12]

template<typename char_t >

static void xtd::tunit::directory_assert::does_not_exist	(	const std::basic_string< char_t > &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

inlinestatic

Asserts that directory not exists.

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::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::does_not_exist(d2); // test ok.
xtd::tunit::directory_assert::does_not_exist(d1); // test throws an assert_error exception.

◆ exists() [1/12]

static void xtd::tunit::directory_assert::exists ( const std::filesystem::directory_entry & directory )

static

Asserts that directory exists.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [2/12]

static void xtd::tunit::directory_assert::exists	(	const std::filesystem::directory_entry &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory exists.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [3/12]

static void xtd::tunit::directory_assert::exists	(	const std::filesystem::directory_entry &	directory,
		const std::string &	message
	)

static

Asserts that directory exists.

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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [4/12]

static void xtd::tunit::directory_assert::exists	(	const std::filesystem::directory_entry &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory exists.

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::assert_error If bad assertion.

Examples: xtd::io::directory_info d1(std::filesystem::directory_entry d1(std::filesystem::path(environment::get_folder_path(environment::special_folder::common_application_data)));
xtd::io::directory_info d2(std::filesystem::directory_entry d1(std::filesystem::path(xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data)) / "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [5/12]

static void xtd::tunit::directory_assert::exists ( const xtd::io::directory_info & directory )

static

Asserts that directory exists.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [6/12]

static void xtd::tunit::directory_assert::exists	(	const xtd::io::directory_info &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory exists.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [7/12]

static void xtd::tunit::directory_assert::exists	(	const xtd::io::directory_info &	directory,
		const std::string &	message
	)

static

Asserts that directory exists.

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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [8/12]

static void xtd::tunit::directory_assert::exists	(	const xtd::io::directory_info &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

static

Asserts that directory exists.

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::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [9/12]

template<typename char_t >

static void xtd::tunit::directory_assert::exists ( const std::basic_string< char_t > & directory )

inlinestatic

Asserts that directory exists.

Parameters

expected	the expected value.
actual	the actual value.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [10/12]

template<typename char_t >

static void xtd::tunit::directory_assert::exists	(	const std::basic_string< char_t > &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

inlinestatic

Asserts that directory exists.

Parameters

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

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [11/12]

template<typename char_t >

static void xtd::tunit::directory_assert::exists	(	const std::basic_string< char_t > &	directory,
		const std::string &	message
	)

inlinestatic

Asserts that directory exists.

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.

Exceptions

xtd::tunit::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

◆ exists() [12/12]

template<typename char_t >

static void xtd::tunit::directory_assert::exists	(	const std::basic_string< char_t > &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame
	)

inlinestatic

Asserts that directory exists.

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::assert_error If bad assertion.

Examples: xtd::ustring d1 = environment::get_folder_path(environment::special_folder::common_application_data);
xtdd;;utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");
xtd::tunit::directory_assert::exists(d1); // test ok.
xtd::tunit::directory_assert::exists(d2); // test throws an assert_error exception.

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

xtd.tunit/include/xtd/tunit/directory_assert.h

Definition

Methods

Member Function Documentation

◆ are_equal() [1/8]

◆ are_equal() [2/8]

◆ are_equal() [3/8]

◆ are_equal() [4/8]

◆ are_equal() [5/8]

◆ are_equal() [6/8]

◆ are_equal() [7/8]

◆ are_equal() [8/8]

◆ are_not_equal() [1/8]

◆ are_not_equal() [2/8]

◆ are_not_equal() [3/8]

◆ are_not_equal() [4/8]

◆ are_not_equal() [5/8]

◆ are_not_equal() [6/8]

◆ are_not_equal() [7/8]

◆ are_not_equal() [8/8]

◆ does_not_exist() [1/12]

◆ does_not_exist() [2/12]

◆ does_not_exist() [3/12]

◆ does_not_exist() [4/12]

◆ does_not_exist() [5/12]

◆ does_not_exist() [6/12]

◆ does_not_exist() [7/12]

◆ does_not_exist() [8/12]

◆ does_not_exist() [9/12]

◆ does_not_exist() [10/12]

◆ does_not_exist() [11/12]

◆ does_not_exist() [12/12]

◆ exists() [1/12]

◆ exists() [2/12]

◆ exists() [3/12]

◆ exists() [4/12]

◆ exists() [5/12]

◆ exists() [6/12]

◆ exists() [7/12]

◆ exists() [8/12]

◆ exists() [9/12]

◆ exists() [10/12]

◆ exists() [11/12]

◆ exists() [12/12]