xtd - Reference Guide 0.2.0
xtd::tunit::directory_valid Class Referencefinal

#include <directory_valid.h>

Definition

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

Namespace
xtd::tunit
Library
xtd.tunit
Remarks
Validations are the same as assertions with the difference, no exception is thrown, but an error is generated.
If a validation fails, he test can be continued to the end or to an assertion is generated.
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) {
}
void test_method_(test_case2) {
}
void test_method_(test_case3) {
assert::does_not_throw([] {throw std::range_error("error");});
}
};
}
int main() {
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)

Static Public Member Functions

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

Member Function Documentation

◆ does_not_exist() [1/4]

template<typename Char >
static void xtd::tunit::directory_valid::does_not_exist ( const std::basic_string< Char > &  directory)
inlinestatic

Asserts that file not exists.

Parameters
expectedthe expected value.
actualthe actual value.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::does_not_exist("Test2.txt"); // test ok.
xtd::tunit::file_assert::does_not_exist("Test1.txt"); // test fails.

◆ does_not_exist() [2/4]

template<typename Char >
static void xtd::tunit::directory_valid::does_not_exist ( const std::basic_string< Char > &  directory,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Asserts that file not exists.

Parameters
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::does_not_exist("Test1.txt", csf_); // test fails.

◆ does_not_exist() [3/4]

template<typename Char >
static void xtd::tunit::directory_valid::does_not_exist ( const std::basic_string< Char > &  directory,
const std::string &  message 
)
inlinestatic

Asserts 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.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::does_not_exist("Test2.txt", "User message..."); // test ok.
xtd::tunit::file_assert::does_not_exist("Test1.txt", "User message..."); // test fails.

◆ does_not_exist() [4/4]

template<typename Char >
static void xtd::tunit::directory_valid::does_not_exist ( const std::basic_string< Char > &  directory,
const std::string &  message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Asserts 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.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::does_not_exist("Test2.txt" "User message...", csf_); // test ok.
xtd::tunit::file_assert::does_not_exist("Test1.txt", "User message...", csf_); // test fails.

◆ exists() [1/4]

template<typename Char >
static void xtd::tunit::directory_valid::exists ( const std::basic_string< Char > &  directory)
inlinestatic

Asserts that directory exists.

Parameters
expectedthe expected value.
actualthe actual value.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::exists("Test1.txt"); // test ok.
xtd::tunit::file_assert::exists("Test2.txt"); // test fails.

◆ exists() [2/4]

template<typename Char >
static void xtd::tunit::directory_valid::exists ( const std::basic_string< Char > &  directory,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Asserts that directory exists.

Parameters
expectedthe expected value.
actualthe actual value.
stack_frameContains information about current file and current line.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::exists("Test1.txt", csf_); // test ok.
xtd::tunit::file_assert::exists("Test2.txt", csf_); // test fails.

◆ exists() [3/4]

template<typename Char >
static void xtd::tunit::directory_valid::exists ( const std::basic_string< Char > &  directory,
const std::string &  message 
)
inlinestatic

Asserts that directory 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.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::exists("Test1.txt", "User message..."); // test ok.
xtd::tunit::file_assert::exists("Test2.txt", "User message..."); // test fails.

◆ exists() [4/4]

template<typename Char >
static void xtd::tunit::directory_valid::exists ( const std::basic_string< Char > &  directory,
const std::string &  message,
const xtd::diagnostics::stack_frame stack_frame 
)
inlinestatic

Asserts that directory 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.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::exists("Test1.txt" "User message...", csf_); // test ok.
xtd::tunit::file_assert::exists("Test2.txt", "User message...", csf_); // test fails.

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