Inheritance diagram for xtd::tunit::string_valid:

Definition

The string_valid class contains a collection of static methods that implement the most string 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>

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 s = "A string value";

string_valid::are_equal_ignoring_case("A STRING VALUE", s);

}

void test_method_(test_case2) {

auto s = "A string value";

string_valid::contains("item", s);

}

void test_method_(test_case3) {

auto s = "A string value";

string_valid::matches("item$", s);

}

};

}

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)

// FAILED unit_tests::test.test_case2 (0 ms total)

// Expected: string containing "item"

// But was: "A string value"

// Stack Trace: in |---OMITTED---|/string_valid.cpp:17

// FAILED unit_tests::test.test_case3 (0 ms total)

// Expected: string matching "item$"

// But was: "A string value"

// Stack Trace: in |---OMITTED---|/string_valid.cpp:22

//

// Test results:

// SUCCEED 1 test.

// FAILED 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::console_key::s
@ s
The S key.

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
static void	are_equal_ignoring_case (const xtd::string &expected, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that two type are equal ignoring case.

static void	are_equal_ignoring_case (const xtd::string &expected, const xtd::string &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that two type are equal ignoring case.

static void	are_not_equal_ignoring_case (const xtd::string &expected, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that two type are not equal ignoring case.

static void	are_not_equal_ignoring_case (const xtd::string &expected, const xtd::string &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that two type are not equal ignoring case.

static void	contains (const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string contains an item.

static void	contains (const xtd::string &item, const xtd::string &string, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string contains an item.

static void	does_not_contain (const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string contains an item.

static void	does_not_contain (const xtd::string &item, const xtd::string &string, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string contains an item.

static void	does_not_end_with (const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	does_not_end_with (const xtd::string &item, const xtd::string &string, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	does_not_match (const xtd::string &regex_pattern, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that does not match regex pattern.

static void	does_not_match (const xtd::string &regex_pattern, const xtd::string &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that does not match regex pattern.

static void	does_not_start_with (const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	does_not_start_with (const xtd::string &item, const xtd::string &string, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	ends_with (const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	ends_with (const xtd::string &item, const xtd::string &string, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	matches (const xtd::string &regex_pattern, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that matches regex pattern.

static void	matches (const xtd::string &regex_pattern, const xtd::string &actual, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that matches regex pattern.

static void	starts_with (const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

static void	starts_with (const xtd::string &item, const xtd::string &string, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Validates that string starts with item.

Member Function Documentation

◆ are_equal_ignoring_case() [1/2]

static void xtd::tunit::string_valid::are_equal_ignoring_case	(	const xtd::string &	expected,
		const xtd::string &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that two type are equal ignoring case.

Parameters

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

Examples: xtd::tunit::string_valid::are_equal_ignoring_case("value", xtd::string("VALUE")); // test ok.

xtd::tunit::string_valid::are_equal_ignoring_case("key", xtd::string("VALUE")); // test fails.

xtd::basic_string
Represents text as a sequence of character units.
Definition basic_string.hpp:79

xtd::tunit::string_valid::are_equal_ignoring_case
static void are_equal_ignoring_case(const xtd::string &expected, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that two type are equal ignoring case.

◆ are_equal_ignoring_case() [2/2]

static void xtd::tunit::string_valid::are_equal_ignoring_case	(	const xtd::string &	expected,
		const xtd::string &	actual,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that two type are equal ignoring case.

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.

Examples: xtd::tunit::string_valid::are_equal_ignoring_case("value", xtd::string("VALUE"), "User message..."); // test ok.

xtd::tunit::string_valid::are_equal_ignoring_case("key", xtd::string("VALUE"), "User message..."); // test fails.

◆ are_not_equal_ignoring_case() [1/2]

static void xtd::tunit::string_valid::are_not_equal_ignoring_case	(	const xtd::string &	expected,
		const xtd::string &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that two type are not equal ignoring case.

Parameters

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

Examples: xtd::tunit::string_valid::are_not_equal_ignoring_case("key", xtd::string("VALUE")); // test ok.

xtd::tunit::string_valid::are_not_equal_ignoring_case("value", xtd::string("VALUE")); // test fails.

xtd::tunit::string_valid::are_not_equal_ignoring_case
static void are_not_equal_ignoring_case(const xtd::string &expected, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that two type are not equal ignoring case.

◆ are_not_equal_ignoring_case() [2/2]

static void xtd::tunit::string_valid::are_not_equal_ignoring_case	(	const xtd::string &	expected,
		const xtd::string &	actual,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that two type are not equal ignoring case.

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.

Examples: xtd::tunit::string_valid::are_not_equal_ignoring_case("key", xtd::string("VALUE"), "User message..."); // test ok.

xtd::tunit::string_valid::are_not_equal_ignoring_case("value", xtd::string("VALUE"), "User message..."); // test fails.

◆ contains() [1/2]

static void xtd::tunit::string_valid::contains	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string contains an item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::contains("a", s); // test ok.

xtd::tunit::string_valid::contains("z", s); // test fails.

xtd::tunit::string_valid::contains
static void contains(const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that string contains an item.

◆ contains() [2/2]

static void xtd::tunit::string_valid::contains	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string contains an item.

Parameters

item	object to verify.
collection	that contains object.
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.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::contains("a", s, "User message..."); // test ok.

xtd::tunit::string_valid::contains("z", s, "User message..."); // test fails.

◆ does_not_contain() [1/2]

static void xtd::tunit::string_valid::does_not_contain	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string contains an item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::contains("a", s); // test ok.

xtd::tunit::string_valid::contains("z", s); // test fails.

◆ does_not_contain() [2/2]

static void xtd::tunit::string_valid::does_not_contain	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string contains an item.

Parameters

item	object to verify.
collection	that contains object.
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.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::contains("a", s, "User message..."); // test ok.

xtd::tunit::string_valid::contains("z", s, "User message..."); // test fails.

◆ does_not_end_with() [1/2]

static void xtd::tunit::string_valid::does_not_end_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::does_not_end_with("law", s); // test ok.

xtd::tunit::string_valid::does_not_end_with("lue", s); // test fails.

xtd::tunit::string_valid::does_not_end_with
static void does_not_end_with(const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that string starts with item.

◆ does_not_end_with() [2/2]

static void xtd::tunit::string_valid::does_not_end_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
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.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::does_not_end_with("law", s, "User message..."); // test ok.

xtd::tunit::string_valid::does_not_end_with("lue", s, "User message..."); // test fails.

◆ does_not_match() [1/2]

static void xtd::tunit::string_valid::does_not_match	(	const xtd::string &	regex_pattern,
		const xtd::string &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that does not match regex pattern.

Parameters

regex_pattern	the regex pattern.
actual	the actual value.
stack_frame	Contains information about current file and current line.

Examples: xtd::tunit::string_valid::does_not_match("^Salut", xtd::string("Hello, World!")); // test ok.

xtd::tunit::string_valid::does_not_match("^Hello", xtd::string("Hello, World!")); // test fails.

xtd::tunit::string_valid::does_not_match
static void does_not_match(const xtd::string &regex_pattern, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that does not match regex pattern.

◆ does_not_match() [2/2]

static void xtd::tunit::string_valid::does_not_match	(	const xtd::string &	regex_pattern,
		const xtd::string &	actual,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that does not match regex pattern.

Parameters

regex_pattern	the regex pattern.
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.

Examples: xtd::tunit::string_valid::does_not_match("^Salut", "Hello, World!", xtd::string("User message...")); // test ok.

xtd::tunit::string_valid::does_not_match("^Hello", "Hello, World!", xtd::string("User message...")); // test fails.

◆ does_not_start_with() [1/2]

static void xtd::tunit::string_valid::does_not_start_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::does_not_start_with("zoe", s); // test ok.

xtd::tunit::string_valid::does_not_start_with("val", s); // test fails.

xtd::tunit::string_valid::does_not_start_with
static void does_not_start_with(const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that string starts with item.

◆ does_not_start_with() [2/2]

static void xtd::tunit::string_valid::does_not_start_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
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.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::does_not_start_with("zoe", s, "User message..."); // test ok.

xtd::tunit::string_valid::does_not_start_with("val", s, "User message..."); // test fails.

◆ ends_with() [1/2]

static void xtd::tunit::string_valid::ends_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::ends_with("val", s); // test ok.

xtd::tunit::string_valid::ends_with("law", s); // test fails.

xtd::tunit::string_valid::ends_with
static void ends_with(const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that string starts with item.

◆ ends_with() [2/2]

static void xtd::tunit::string_valid::ends_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
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.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::ends_with("lue", s, "User message..."); // test ok.

xtd::tunit::string_valid::ends_with("law", s, "User message..."); // test fails.

◆ matches() [1/2]

static void xtd::tunit::string_valid::matches	(	const xtd::string &	regex_pattern,
		const xtd::string &	actual,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that matches regex pattern.

Parameters

regex_pattern	the regex pattern.
actual	the actual value.
stack_frame	Contains information about current file and current line.

Examples: xtd::tunit::string_valid::matches("^Hello", xtd::string("Hello, World!")); // test ok.

xtd::tunit::string_valid::matches("^Salut", xtd::string("Hello, World!")); // test fails.

xtd::tunit::string_valid::matches
static void matches(const xtd::string &regex_pattern, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that matches regex pattern.

◆ matches() [2/2]

static void xtd::tunit::string_valid::matches	(	const xtd::string &	regex_pattern,
		const xtd::string &	actual,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that matches regex pattern.

Parameters

regex_pattern	the regex pattern.
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.

Examples: xtd::tunit::string_valid::matches("^Hello", "Hello, World!", xtd::string("User message...")); // test ok.

xtd::tunit::string_valid::matches("^Salut", "Hello, World!", xtd::string("User message...")); // test fails.

◆ starts_with() [1/2]

static void xtd::tunit::string_valid::starts_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
stack_frame	Contains information about current file and current line.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::starts_with("val", s); // test ok.

xtd::tunit::string_valid::starts_with("zoe", s); // test fails.

xtd::tunit::string_valid::starts_with
static void starts_with(const xtd::string &item, const xtd::string &string, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
Validates that string starts with item.

◆ starts_with() [2/2]

static void xtd::tunit::string_valid::starts_with	(	const xtd::string &	item,
		const xtd::string &	string,
		const xtd::string &	message,
		const xtd::diagnostics::stack_frame &	stack_frame = `xtd::diagnostics::stack_frame::current()`
	)

static

Validates that string starts with item.

Parameters

item	object to verify.
collection	that contains object.
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.

Examples: xtd::string s = "value";

xtd::tunit::string_valid::starts_with("val", s, "User message..."); // test ok.

xtd::tunit::string_valid::starts_with("zoe", s, "User message..."); // test fails.

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

xtd.tunit/include/xtd/tunit/string_valid.hpp

Definition

Public Static Methods

Member Function Documentation

◆ are_equal_ignoring_case() [1/2]

◆ are_equal_ignoring_case() [2/2]

◆ are_not_equal_ignoring_case() [1/2]

◆ are_not_equal_ignoring_case() [2/2]

◆ contains() [1/2]

◆ contains() [2/2]

◆ does_not_contain() [1/2]

◆ does_not_contain() [2/2]

◆ does_not_end_with() [1/2]

◆ does_not_end_with() [2/2]

◆ does_not_match() [1/2]

◆ does_not_match() [2/2]

◆ does_not_start_with() [1/2]

◆ does_not_start_with() [2/2]

◆ ends_with() [1/2]

◆ ends_with() [2/2]

◆ matches() [1/2]

◆ matches() [2/2]

◆ starts_with() [1/2]

◆ starts_with() [2/2]