Inheritance diagram for xtd::tunit::file_assume:

Definition

The file_assume class contains a collection of static methods that implement the most file 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::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) {

auto fn = path::get_temp_file_name();

file_assume::exists(fn);

file::remove(fn);

}

void test_method_(test_case2) {

auto fn = path::get_random_file_name();

file_assume::exists(fn);

// No need to remove fn because the file does not exist.

}

void test_method_(test_case3) {

auto is = std::istringstream {"xtd::tunit::file_assume::are_equal example."};

file_assume::are_equal(std::istringstream {"xtd::tunit::file_assume::are_equel example."}, is);

}

};

}

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: file exists

// But was: "t35uk5my.8v2"

// Stack Trace: in |---OMITTED---|/file_assume.cpp:18

// ABORTED test.test_case3 (0 ms total)

// Test aborted

// Expected: istream at offset 32 value e

// But was: a

// Stack Trace: in |---OMITTED---|/file_assume.cpp:24

//

// Test results:

// SUCCEED 1 test.

// ABORTED 2 tests.

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

xtd::tunit::console_unit_test
The console_unit_test class is console unit test interface.
Definition console_unit_test.hpp: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.hpp:73

xtd::is
bool is(std::any value)
Checks if the result of an expression is compatible with a given type.
Definition is.hpp:365

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

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

Public Static Methods
template<typename char_t >
static void	are_equal (const std::basic_istream< char_t > &expected, const std::basic_istream< char_t > &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are equal.

template<typename char_t >
static void	are_equal (const std::basic_istream< char_t > &expected, const std::basic_istream< char_t > &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are equal.

template<typename char_t >
static void	are_equal (const xtd::basic_string< char_t > &expected, const xtd::basic_string< char_t > &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are equal.

template<typename char_t >
static void	are_equal (const xtd::basic_string< char_t > &expected, const xtd::basic_string< char_t > &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are equal.

template<typename char_t >
static void	are_not_equal (const std::basic_istream< char_t > &expected, const std::basic_istream< char_t > &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are not equal.

template<typename char_t >
static void	are_not_equal (const std::basic_istream< char_t > &expected, const std::basic_istream< char_t > &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are not equal.

template<typename char_t >
static void	are_not_equal (const xtd::basic_string< char_t > &expected, const xtd::basic_string< char_t > &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are not equal.

template<typename char_t >
static void	are_not_equal (const xtd::basic_string< char_t > &expected, const xtd::basic_string< char_t > &actual, const std::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Assumes that two files are not equal.

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

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

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

Member Function Documentation

◆ are_equal() [1/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_equal	(	const std::basic_istream< char_t > &	expected,
		const std::basic_istream< char_t > &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1); // test ok.

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1);// test throws an abort_error exception.

xtd::tunit::file_assume::are_equal
static void are_equal(const std::basic_istream< char_t > &expected, const std::basic_istream< char_t > &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that two files are equal.
Definition file_assume.hpp:50

◆ are_equal() [2/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_equal	(	const std::basic_istream< char_t > &	expected,
		const std::basic_istream< char_t > &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1, "User message..."); // test ok.

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1, "User message...");// test throws an abort_error exception.

◆ are_equal() [3/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_equal	(	const xtd::basic_string< char_t > &	expected,
		const xtd::basic_string< char_t > &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1); // test ok.

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1);// test throws an abort_error exception.

◆ are_equal() [4/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_equal	(	const xtd::basic_string< char_t > &	expected,
		const xtd::basic_string< char_t > &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1, "User message..."); // test ok.

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_equal(s2, s1, "User message...");// test throws an abort_error exception.

◆ are_not_equal() [1/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_not_equal	(	const std::basic_istream< char_t > &	expected,
		const std::basic_istream< char_t > &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1); // test ok.

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1);// test throws an abort_error exception.

xtd::tunit::file_assume::are_not_equal
static void are_not_equal(const std::basic_istream< char_t > &expected, const std::basic_istream< char_t > &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that two files are not equal.
Definition file_assume.hpp:154

◆ are_not_equal() [2/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_not_equal	(	const std::basic_istream< char_t > &	expected,
		const std::basic_istream< char_t > &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1, "User message..."); // test ok.

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1, "User message...");// test throws an abort_error exception.

◆ are_not_equal() [3/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_not_equal	(	const xtd::basic_string< char_t > &	expected,
		const xtd::basic_string< char_t > &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1); // test ok.

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1);// test throws an abort_error exception.

◆ are_not_equal() [4/4]

template<typename char_t >

static void xtd::tunit::file_assume::are_not_equal	(	const xtd::basic_string< char_t > &	expected,
		const xtd::basic_string< char_t > &	actual,
		const std::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

inlinestatic

Assumes that two files 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: std::stringstream s1;

s1 << "Test";

s1.seekg(0, std::ios::beg);

std::stringstream s2;

s2 << "Test2";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1, "User message..."); // test ok.

s2 << "Test";

s2.seekg(0, std::ios::beg);

xtd::tunit::file_assume::are_not_equal(s2, s1, "User message...");// test throws an abort_error exception.

◆ does_not_exist() [1/2]

template<typename char_t >

static void xtd::tunit::file_assume::does_not_exist	(	const xtd::basic_string< char_t > &	file,
		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::file_assume::does_not_exist("Test2.txt"); // test ok.

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

xtd::tunit::file_assume::does_not_exist
static void does_not_exist(const xtd::basic_string< char_t > &file, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that file not exists.
Definition file_assume.hpp:252

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

◆ does_not_exist() [2/2]

template<typename char_t >

static void xtd::tunit::file_assume::does_not_exist	(	const xtd::basic_string< char_t > &	file,
		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::file_assume::does_not_exist("Test2.txt" "User message..."); // test ok.

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

◆ exists() [1/2]

template<typename char_t >

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

inlinestatic

Assumes that file 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::file_assume::exists("Test1.txt"); // test ok.

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

xtd::tunit::file_assume::exists
static void exists(const xtd::basic_string< char_t > &file, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Assumes that file exists.
Definition file_assume.hpp:295

◆ exists() [2/2]

template<typename char_t >

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

inlinestatic

Assumes that file 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::file_assume::exists("Test1.txt" "User message..."); // test ok.

xtd::tunit::file_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/file_assume.hpp

Definition

Public Static Methods

Member Function Documentation

◆ are_equal() [1/4]

◆ are_equal() [2/4]

◆ are_equal() [3/4]

◆ are_equal() [4/4]

◆ are_not_equal() [1/4]

◆ are_not_equal() [2/4]

◆ are_not_equal() [3/4]

◆ are_not_equal() [4/4]

◆ does_not_exist() [1/2]

◆ does_not_exist() [2/2]

◆ exists() [1/2]

◆ exists() [2/2]