Inheritance diagram for xtd::tunit::directory_assume:

Definition

The directory_assume class contains a collection of static methods that implement the most directory 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;

using namespace xtd::io;

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) {

directory_assume::exists(path::get_temp_path());

}

void test_method_(test_case2) {

directory_assume::exists(path::combine("unknown root folder", "unknown sub folder", "unknown xtd example folder"));

}

void test_method_(test_case3) {

directory_assume::are_equal(directory_info {environment::get_folder_path(environment::special_folder::my_music)}, directory_info {environment::get_folder_path(environment::special_folder::my_videos)});

}

};

}

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)

// ABORTD test.test_case2 (0 ms total)

// Test aborted

// Expected: directory exists

// But was: "unknown root folder/unknown sub folder/unknown xtd example folder"

// Stack Trace: in |---OMITTED---|/directory_assume.cpp:16

// ABORTED test.test_case3 (0 ms total)

// Test aborted

// Expected: "|---OMITTED---|/Music"

// But was: "|---OMITTED---|/Movies"

// Stack Trace: in |---OMITTED---|/directory_assume.cpp:20

//

// Test results:

// SUCCEED 1 test.

// ABORTED 2 tests.

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

xtd::io::directory_info
Exposes instance methods for creating, moving, and enumerating through directories and subdirectories...
Definition directory_info.h:129

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

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

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

xtd::io
The xtd::io namespace contains types that allow reading and writing to files and data streams,...
Definition binary_reader.h:16

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

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10

Public Static Methods
static void	are_equal (const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two xtd::io::directory_info are equal.

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=xtd::diagnostics::stack_frame::current())
	Assumes that two xtd::io::directory_info are equal.

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

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=xtd::diagnostics::stack_frame::current())
	Assumes that two xtd::io::directory_info are not equal.

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

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

template<typename char_t >
static void	does_not_exist (const xtd::basic_string< char_t > &directory, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that file not exists.

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

static void	exists (const xtd::io::directory_info &directory, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that directory exists.

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

template<typename char_t >
static void	exists (const xtd::basic_string< char_t > &directory, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that directory exists.

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

Member Function Documentation

◆ are_equal() [1/2]

static void xtd::tunit::directory_assume::are_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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_assume::are_equal(d1, d2); // test ok.

xtd::tunit::directory_assume::are_equal(d1, d3); // test throws an assert_error exception.

xtd::tunit::directory_assume
The directory_assume class contains a collection of static methods that implement the most directory ...
Definition directory_assume.h:22

xtd::tunit::directory_assume::are_equal
static void are_equal(const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that two xtd::io::directory_info are equal.

xtd::console_key::d1
@ d1
The 1 key.

xtd::console_key::d2
@ d2
The 2 key.

xtd::console_key::d3
@ d3
The 3 key.

◆ are_equal() [2/2]

static void xtd::tunit::directory_assume::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 = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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_assume::are_equal(d1, d2, "User message..."); // test ok.

xtd::tunit::directory_assume::are_equal(d1, d3, "User message..."); // test throws an assert_error exception.

◆ are_not_equal() [1/2]

static void xtd::tunit::directory_assume::are_not_equal	(	const xtd::io::directory_info &	expected,
		const xtd::io::directory_info &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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_assume::are_not_equal(d1, d3, "User message..."); // test ok.

xtd::tunit::directory_assume::are_not_equal(d1, d2, "User message..."); // test throws an assert_error exception.

xtd::tunit::directory_assume::are_not_equal
static void are_not_equal(const xtd::io::directory_info &expected, const xtd::io::directory_info &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that two xtd::io::directory_info are not equal.

◆ are_not_equal() [2/2]

static void xtd::tunit::directory_assume::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 = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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_assume::are_not_equal(d1, d3, "User message..."); // test ok.

xtd::tunit::directory_assume::are_not_equal(d1, d2, "User message..."); // test throws an assert_error exception.

◆ does_not_exist() [1/4]

static void xtd::tunit::directory_assume::does_not_exist	(	const xtd::io::directory_info &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

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_assume::does_not_exist(d2); // test ok.

xtd::tunit::directory_assume::does_not_exist(d1); // test throws an assert_error exception.

xtd::environment::special_folder::common_application_data
@ common_application_data
The directory that serves as a common repository for application-specific data that is used by all us...

xtd::environment::get_folder_path
static xtd::string get_folder_path(environment::special_folder folder)
Gets the path to the system special folder that is identified by the specified enumeration.
Definition environment.h:607

xtd::io::path::combine
static xtd::string combine(const xtd::string &path1, const xtd::string &path2)
Combines two path strings.

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

◆ does_not_exist() [2/4]

static void xtd::tunit::directory_assume::does_not_exist	(	const xtd::io::directory_info &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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_assume::does_not_exist(d2); // test ok.

xtd::tunit::directory_assume::does_not_exist(d1); // test throws an assert_error exception.

◆ does_not_exist() [3/4]

template<typename char_t >

static void xtd::tunit::directory_assume::does_not_exist	(	const xtd::basic_string< char_t > &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that file not exists.

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: std::ifstream f1("Test1.txt");

f1.close();

xtd::tunit::directory_assume::does_not_exist("Test2.txt"); // test ok.

xtd::tunit::directory_assume::does_not_exist("Test1.txt"); // test throws an abort_error exception.

xtd::console_key::f1
@ f1
The F1 key.

◆ does_not_exist() [4/4]

template<typename char_t >

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

inlinestatic

Assumes that file 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::abort_error If bad assertion.

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

f1.close();

xtd::tunit::directory_assume::does_not_exist("Test2.txt" "User message..."); // test ok.

xtd::tunit::directory_assume::does_not_exist("Test1.txt", "User message..."); // test throws an abort_error exception.

◆ exists() [1/4]

static void xtd::tunit::directory_assume::exists	(	const xtd::io::directory_info &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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::string d1 = environment::get_folder_path(environment::special_folder::common_application_data);

xtd::utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");

xtd::tunit::directory_assume::exists(d1); // test ok.

xtd::tunit::directory_assume::exists(d2); // test throws an assert_error exception.

xtd::basic_string
Represents text as a sequence of character units.
Definition basic_string.h:79

xtd::tunit::directory_assume::exists
static void exists(const xtd::io::directory_info &directory, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that directory exists.

◆ exists() [2/4]

static void xtd::tunit::directory_assume::exists	(	const xtd::io::directory_info &	directory,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Assumes 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::string d1 = environment::get_folder_path(environment::special_folder::common_application_data);

xtd::utring d2 = xtd::io::path::combine(environment::get_folder_path(environment::special_folder::common_application_data), "__xtd_test_directory_not_found__");

xtd::tunit::directory_assume::exists(d1); // test ok.

xtd::tunit::directory_assume::exists(d2); // test throws an assert_error exception.

◆ exists() [3/4]

template<typename char_t >

static void xtd::tunit::directory_assume::exists	(	const xtd::basic_string< char_t > &	directory,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

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

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

f1.close();

xtd::tunit::directory_assume::exists("Test1.txt"); // test ok.

xtd::tunit::directory_assume::exists("Test2.txt"); // test throws an abort_error exception.

◆ exists() [4/4]

template<typename char_t >

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

inlinestatic

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

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

f1.close();

xtd::tunit::directory_assume::exists("Test1.txt" "User message..."); // test ok.

xtd::tunit::directory_assume::exists("Test2.txt", "User message..."); // test throws an abort_error exception.

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

xtd.tunit/include/xtd/tunit/directory_assume.h

Definition

Public Static Methods

Member Function Documentation

◆ are_equal() [1/2]

◆ are_equal() [2/2]

◆ are_not_equal() [1/2]

◆ are_not_equal() [2/2]

◆ does_not_exist() [1/4]

◆ does_not_exist() [2/4]

◆ does_not_exist() [3/4]

◆ does_not_exist() [4/4]

◆ exists() [1/4]

◆ exists() [2/4]

◆ exists() [3/4]

◆ exists() [4/4]