xtd - Reference Guide  0.1.1
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Static Public Member Functions | List of all members
xtd::tunit::directory_assert Class Referencefinal
libraries » xtd.tunit

#include <directory_assert.h>

Definition

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

Namespace
xtd::tunit
Library
xtd.tunit
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) {
assert::is_true(true);
}
void test_method_(test_case2) {
assert::is_false(true);
}
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)
xtd::tunit::assert::is_false
static void is_false(bool condition)
Asserts that ta condition is false.
Definition: assert.h:884
xtd::tunit::assert::is_true
static void is_true(bool condition)
Asserts that ta condition is true.
Definition: assert.h:2489
xtd::tunit::assert::does_not_throw
static void does_not_throw(const std::function< void()> &statement)
Asserts that the staement does not throw an exception.
Definition: assert.h:709
xtd::tunit
The tunit namespace contains a unit test library.
Definition: abort_error.h:11

Inherits xtd::tunit::base_assert.

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 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 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 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 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...
 
template<typename Char >
static void exists (const std::basic_string< Char > &directory, 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_assert::does_not_exist ( const std::basic_string< Char > &  directory)
inlinestatic

Asserts that file not exists.

Parameters
expectedthe expected value.
actualthe actual value.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.
xtd::tunit::file_assert::does_not_exist
static void does_not_exist(const std::basic_string< Char > &file)
Asserts that file not exists.
Definition: file_assert.h:552
xtd::console_key::f1
@ f1
The F1 key.

◆ does_not_exist() [2/4]

template<typename Char >
static void xtd::tunit::directory_assert::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.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.

◆ does_not_exist() [3/4]

template<typename Char >
static void xtd::tunit::directory_assert::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.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.
csf_
#define csf_
Provides information about the current stack frame.
Definition: stack_frame.h:213

◆ does_not_exist() [4/4]

template<typename Char >
static void xtd::tunit::directory_assert::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.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
Examples
std::ifstream f1("Test1.txt");
f1.close();
xtd::tunit::file_assert::does_not_exist("Test2.txt", csf_); // test ok.
xtd::tunit::file_assert::does_not_exist("Test1.txt", csf_); // test throws an assertion_error exception.

◆ exists() [1/4]

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

Asserts that directory exists.

Parameters
expectedthe expected value.
actualthe actual value.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.
xtd::tunit::file_assert::exists
static void exists(const std::basic_string< Char > &file)
Asserts that file exists.
Definition: file_assert.h:476

◆ exists() [2/4]

template<typename Char >
static void xtd::tunit::directory_assert::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.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.

◆ exists() [3/4]

template<typename Char >
static void xtd::tunit::directory_assert::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.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.

◆ exists() [4/4]

template<typename Char >
static void xtd::tunit::directory_assert::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.
Exceptions
xtd::tunit::assertion_errorIf bad assertion.
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 throws an assertion_error exception.
The documentation for this class was generated from the following file:
Generated on Mon Jul 17 2023 23:13:11 for xtd - Reference Guide by Gammasoft. All rights reserved.