The file_valid class contains a collection of static methods that implement the most file assertions used in tUnit. More...

#include <file_valid.h>

Inheritance diagram for tunit::file_valid:

[legend]

Collaboration diagram for tunit::file_valid:

[legend]

Static Public Member Functions
template<typename Char >
static void	are_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual, const tunit::line_info &line_info)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual, const std::string &message)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual, const tunit::line_info &line_info)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual, const std::string &message)
	Valids that two files are equal. More...

template<typename Char >
static void	are_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that two files are equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual, const tunit::line_info &line_info)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual, const std::string &message)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_istream< Char > &expected, const std::basic_istream< Char > &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual, const tunit::line_info &line_info)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual, const std::string &message)
	Valids that two files are not equal. More...

template<typename Char >
static void	are_not_equal (const std::basic_string< Char > &expected, const std::basic_string< Char > &actual, const std::string &message, const tunit::line_info &line_info)
	Valids that two files are not equal. More...

template<typename Char >
static void	does_not_exist (const std::basic_string< Char > &file)
	Valids that file not exists. More...

template<typename Char >
static void	does_not_exist (const std::basic_string< Char > &file, const tunit::line_info &line_info)
	Valids that file not exists. More...

template<typename Char >
static void	does_not_exist (const std::basic_string< Char > &file, const std::string &message)
	Valids that file not exists. More...

template<typename Char >
static void	does_not_exist (const std::basic_string< Char > &file, const std::string &message, const tunit::line_info &line_info)
	Valids that file not exists. More...

template<typename Char >
static void	exists (const std::basic_string< Char > &file)
	Valids that file exists. More...

template<typename Char >
static void	exists (const std::basic_string< Char > &file, const tunit::line_info &line_info)
	Valids that file exists. More...

template<typename Char >
static void	exists (const std::basic_string< Char > &file, const std::string &message)
	Valids that file exists. More...

template<typename Char >
static void	exists (const std::basic_string< Char > &file, const std::string &message, const tunit::line_info &line_info)
	Valids that file exists. More...

Static Private Member Functions
static void	abort ()
	Abort current test. More...

static void	abort (const tunit::line_info &line_info)
	Abort current test. More...

static void	abort (const std::string &message)
	Abort current test. More...

static void	abort (const std::string &message, const tunit::line_info &line_info)
	Abort current test. More...

static void	error ()

static void	error (const std::string &actual, const std::string &expected, const std::string &message, const tunit::line_info &line_info)

static void	fail ()
	Throws an tunit::assertion_error exception. More...

static void	fail (const tunit::line_info &line_info)
	Throws an tunit::assertion_error exception. More...

static void	fail (const std::string &message)
	Throws an tunit::assertion_error exception. More...

static void	fail (const std::string &message, const tunit::line_info &line_info)
	Throws an tunit::assertion_error exception. More...

static void	fail (const std::string &actual, const std::string &expected, const std::string &message, const tunit::line_info &line_info)

static void	ignore ()
	Ignore current test. More...

static void	ignore (const tunit::line_info &line_info)
	Ignore current test. More...

static void	ignore (const std::string &message)
	Ignore current test. More...

static void	ignore (const std::string &message, const tunit::line_info &line_info)
	Ignore current test. More...

template<typename TCollection >
static std::string	join_items (const TCollection &collection)

static std::string	join_items (const std::string &str)

static void	succeed ()
	Generates a success with a generic message. More...

static void	succeed (const tunit::line_info &line_info)
	Generates a success with a generic message. More...

static void	succeed (const std::string &message)
	Generates a success with a generic message. More...

static void	succeed (const std::string &message, const tunit::line_info &line_info)
	Generates a success with a generic message. More...

template<typename TValue >
static std::string	to_string (const TValue &value)

template<typename TValue >
static std::string	to_string (const TValue *value)

Detailed Description

The file_valid class contains a collection of static methods that implement the most file assertions used in tUnit.

Examples: This example show how to used some methods :

Member Function Documentation

◆ are_equal() [1/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual
	)

inlinestatic

Valids that two files are equal.

Parameters

expected	the expected value.
actual	the actual value.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1); // test fails

◆ are_equal() [2/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that two files are equal.

Parameters

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, line_info_); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, line_info_); // test fails

◆ are_equal() [3/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual,
		const std::string &	message
	)

inlinestatic

Valids 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.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message..."); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message..."); // test fails

◆ are_equal() [4/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message...", line_info_); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message...", line_info_); // test fails

◆ are_equal() [5/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual
	)

inlinestatic

Valids that two files are equal.

Parameters

expected	the expected value.
actual	the actual value.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1); // test fails

◆ are_equal() [6/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that two files are equal.

Parameters

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, line_info_); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, line_info_); // test fails

◆ are_equal() [7/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual,
		const std::string &	message
	)

inlinestatic

Valids 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.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message..."); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message..."); // test fails

◆ are_equal() [8/8]

template<typename Char >

static void tunit::file_valid::are_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message...", line_info_); // test ok.
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_equal(s2, s1, "User message...", line_info_); // test fails

◆ are_not_equal() [1/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual
	)

inlinestatic

Valids that two files are not equal.

Parameters

expected	the expected value.
actual	the actual value.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1); // test fails

◆ are_not_equal() [2/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that two files are not equal.

Parameters

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, line_info_); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, line_info_); // test fails

◆ are_not_equal() [3/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual,
		const std::string &	message
	)

inlinestatic

Valids 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.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message..."); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message..."); // test fails

◆ are_not_equal() [4/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_istream< Char > &	expected,
		const std::basic_istream< Char > &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message...", line_info_); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message...", line_info_); // test fails

◆ are_not_equal() [5/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual
	)

inlinestatic

Valids that two files are not equal.

Parameters

expected	the expected value.
actual	the actual value.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1); // test fails

◆ are_not_equal() [6/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that two files are not equal.

Parameters

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, line_info_); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, line_info_); // test fails

◆ are_not_equal() [7/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual,
		const std::string &	message
	)

inlinestatic

Valids 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.

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message..."); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message..."); // test fails

◆ are_not_equal() [8/8]

template<typename Char >

static void tunit::file_valid::are_not_equal	(	const std::basic_string< Char > &	expected,
		const std::basic_string< Char > &	actual,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

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

Examples: std::stringstream s1;
s1 << "Test";
s1.seekg(0, std::ios::beg);
std::stringstream s2;
s2 << "Test2";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message...", line_info_); // test ok.
s2 << "Test";
s2.seekg(0, std::ios::beg);
tunit::file_valid::are_not_equal(s2, s1, "User message...", line_info_); // test fails

◆ does_not_exist() [1/4]

template<typename Char >

static void tunit::file_valid::does_not_exist ( const std::basic_string< Char > & file )

inlinestatic

Valids that file not exists.

Parameters

expected	the expected value.
actual	the actual value.

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::does_not_exist("Test2.txt"); // test ok.
tunit::file_valid::does_not_exist("Test1.txt"); // test fails

◆ does_not_exist() [2/4]

template<typename Char >

static void tunit::file_valid::does_not_exist	(	const std::basic_string< Char > &	file,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that file not exists.

Parameters

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

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::does_not_exist("Test2.txt", line_info_); // test ok.
tunit::file_valid::does_not_exist("Test1.txt", line_info_); // test fails

◆ does_not_exist() [3/4]

template<typename Char >

static void tunit::file_valid::does_not_exist	(	const std::basic_string< Char > &	file,
		const std::string &	message
	)

inlinestatic

Valids 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.

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::does_not_exist("Test2.txt", "User message..."); // test ok.
tunit::file_valid::does_not_exist("Test1.txt", "User message..."); // test fails

◆ does_not_exist() [4/4]

template<typename Char >

static void tunit::file_valid::does_not_exist	(	const std::basic_string< Char > &	file,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

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

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::does_not_exist("Test2.txt" "User message...", line_info_); // test ok.
tunit::file_valid::does_not_exist("Test1.txt", "User message...", line_info_); // test fails

◆ exists() [1/4]

template<typename Char >

static void tunit::file_valid::exists ( const std::basic_string< Char > & file )

inlinestatic

Valids that file exists.

Parameters

expected	the expected value.
actual	the actual value.

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::exists("Test1.txt"); // test ok.
tunit::file_valid::exists("Test2.txt"); // test fails

◆ exists() [2/4]

template<typename Char >

static void tunit::file_valid::exists	(	const std::basic_string< Char > &	file,
		const tunit::line_info &	line_info
	)

inlinestatic

Valids that file exists.

Parameters

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

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::exists("Test1.txt", line_info_); // test ok.
tunit::file_valid::exists("Test2.txt", line_info_); // test fails

◆ exists() [3/4]

template<typename Char >

static void tunit::file_valid::exists	(	const std::basic_string< Char > &	file,
		const std::string &	message
	)

inlinestatic

Valids 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.

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::exists("Test1.txt", "User message..."); // test ok.
tunit::file_valid::exists("Test2.txt", "User message..."); // test fails

◆ exists() [4/4]

template<typename Char >

static void tunit::file_valid::exists	(	const std::basic_string< Char > &	file,
		const std::string &	message,
		const tunit::line_info &	line_info
	)

inlinestatic

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

Examples: std::ifstream f1("Test1.txt");
f1.close();
tunit::file_valid::exists("Test1.txt" "User message...", line_info_); // test ok.
tunit::file_valid::exists("Test2.txt", "User message...", line_info_); // test fails

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

file_valid.h

Static Public Member Functions

Static Private Member Functions

Detailed Description

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/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]