xtd 0.2.0
Loading...
Searching...
No Matches
List of all members
xtd::tunit::file_assume Class Referencefinal
﹡ libraries » xtd.tunit | unit tests » assumptions
Inheritance diagram for xtd::tunit::file_assume:
xtd::tunit::base_assert

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::io::file::remove
static void remove(const xtd::string &path)
Deletes the specified file.
xtd::io::path::get_temp_file_name
static xtd::string get_temp_file_name()
Creates a uniquely named, zero-byte temporary file on disk and returns the full path of that file.
xtd::io::path::get_random_file_name
static xtd::string get_random_file_name()
Returns a random folder name or file name.
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
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
test_method_
#define test_method_(method_name)
Add test method to class test.
Definition test_method_attribute.hpp:72
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:17
xtd::tunit
The tunit namespace contains a unit test library.
Definition abort_error.hpp:10

Public Static Methods

template<class 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<class 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<class 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<class 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<class 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<class 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<class 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<class 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<class 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<class 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<class 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<class 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<class 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
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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() [2/4]

template<class 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
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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.
Definition console_key.hpp:180

◆ does_not_exist() [2/2]

template<class 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
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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<class 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
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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.

◆ exists() [2/2]

template<class 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
expectedthe expected value.
actualthe actual value.
messageA user message to display if the assertion fails. This message can be seen in the unit test results.
stack_frameContains information about current file and current line.
Exceptions
xtd::tunit::abort_errorIf 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:
Generated on Tue May 13 2025 19:46:15 for xtd by Gammasoft. All rights reserved.