xtd::tunit::string_assert Class Reference

Inheritance diagram for xtd::tunit::string_assert:

Definition

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

Namespace

xtd::tunit

Library

xtd.tunit

Remarks

Assertions are central to unit testing in any of the xUnit frameworks, and xtd.tunit is no exception. xtd.tunit provides a rich set of assertions as static methods of the Assert class.

If an assertion fails, the method call does not return and an error is reported. If a test contains multiple assertions, any that follow the one that failed will not be executed. For this reason, it's usually best to try for one assertion per test.

Each method may be called without a message, with a simple text message or with a message and arguments. In the last case the message is formatted using the provided text and arguments.

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_assert::are_equal_ignoring_case("A STRING VALUE", s);
    }
    
    void test_method_(test_case2) {
      auto s = "A string value";
      string_assert::contains("item", s);
    }
    
    void test_method_(test_case3) {
      auto s = "A string value";
      string_assert::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_assert.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_assert.cpp:22
//
// Test results:
//   SUCCEED 1 test.
//   FAILED  2 tests.
// End 3 tests from 1 test case ran. (0 ms total)

Public Static Methods
static auto	are_equal_ignoring_case (const xtd::string &expected, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that two type are equal ignoring case.
static auto	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()) -> void
	Asserts that two type are equal ignoring case.
static auto	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()) -> void
	Asserts that two type are not equal ignoring case.
static auto	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()) -> void
	Asserts that two type are not equal ignoring case.
static auto	contains (const xtd::string &item, const xtd::string &stringstring, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string contains an item.
static auto	contains (const xtd::string &item, const xtd::string &stringstring, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string contains an item.
static auto	does_not_contain (const xtd::string &item, const xtd::string &stringstring, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string contains an item.
static auto	does_not_contain (const xtd::string &item, const xtd::string &stringstring, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string contains an item.
static auto	does_not_end_with (const xtd::string &item, const xtd::string &stringstring, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string ends with item.
static auto	does_not_end_with (const xtd::string &item, const xtd::string &stringstring, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string ends with item.
static auto	does_not_match (const xtd::string &regex_pattern, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that does not match regex pattern.
static auto	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()) -> void
	Asserts that does not match regex pattern.
static auto	does_not_start_with (const xtd::string &item, const xtd::string &stringstring, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string starts with item.
static auto	does_not_start_with (const xtd::string &item, const xtd::string &stringstring, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string starts with item.
static auto	ends_with (const xtd::string &item, const xtd::string &stringstring, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string ends with item.
static auto	ends_with (const xtd::string &item, const xtd::string &stringstring, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string ends with item.
static auto	matches (const xtd::string &regex_pattern, const xtd::string &actual, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that matches regex pattern.
static auto	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()) -> void
	Asserts that matches regex pattern.
static auto	starts_with (const xtd::string &item, const xtd::string &stringstring, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string starts with item.
static auto	starts_with (const xtd::string &item, const xtd::string &stringstring, const xtd::string &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current()) -> void
	Asserts that string starts with item.

Member Function Documentation

are_equal_ignoring_case() [1/2]

auto xtd::tunit::string_assert::are_equal_ignoring_case ( const xtd::string & expected, const xtd::string & actual, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::are_equal_ignoring_case("value", xtd::string("VALUE")); // test ok.
xtd::tunit::string_assert::are_equal_ignoring_case("key", xtd::string("VALUE")); // test throws an assert_error exception.

Examples

string_assert.cpp, and string_assert_are_equal_ignoring_case.cpp.

are_equal_ignoring_case() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::are_equal_ignoring_case("value", xtd::string("VALUE"), "User message..."); // test ok.
xtd::tunit::string_assert::are_equal_ignoring_case("key", xtd::string("VALUE"), "User message..."); // test throws an assert_error exception.

are_not_equal_ignoring_case() [1/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::are_not_equal_ignoring_case("key", xtd::string("VALUE")); // test ok.
xtd::tunit::string_assert::are_not_equal_ignoring_case("value", xtd::string("VALUE")); // test throws an assert_error exception.

Examples

string_assert_are_not_equal_ignoring_case.cpp.

are_not_equal_ignoring_case() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::are_not_equal_ignoring_case("key", xtd::string("VALUE"), "User message..."); // test ok.
xtd::tunit::string_assert::are_not_equal_ignoring_case("value", xtd::string("VALUE"), "User message..."); // test throws an assert_error exception.

contains() [1/2]

auto xtd::tunit::string_assert::contains ( const xtd::string & item, const xtd::string & string, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that string contains an item.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::contains("a", s); // test ok.
xtd::tunit::string_assert::contains("z", s); // test throws an assert_error exception.

Examples

string_assert.cpp, and string_assert_contains.cpp.

contains() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::contains("a", s, "User message..."); // test ok.
xtd::tunit::string_assert::contains("z", s, "User message..."); // test throws an assert_error exception.

does_not_contain() [1/2]

auto xtd::tunit::string_assert::does_not_contain ( const xtd::string & item, const xtd::string & string, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that string contains an item.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::contains("a", s); // test ok.
xtd::tunit::string_assert::contains("z", s); // test throws an assert_error exception.

Examples

string_assert_does_not_contain.cpp.

does_not_contain() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::contains("a", s, "User message..."); // test ok.
xtd::tunit::string_assert::contains("z", s, "User message..."); // test throws an assert_error exception.

does_not_end_with() [1/2]

auto xtd::tunit::string_assert::does_not_end_with ( const xtd::string & item, const xtd::string & string, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that string ends with item.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::does_not_end_with("law", s); // test ok.
xtd::tunit::string_assert::does_not_end_with("lue", s); // test throws an assert_error exception.

Examples

string_assert_does_not_end_with.cpp.

does_not_end_with() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

Asserts that string ends 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.

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::does_not_end_with("law", s, "User message..."); // test ok.
xtd::tunit::string_assert::does_not_end_with("lue", s, "User message..."); // test throws an assert_error exception.

does_not_match() [1/2]

auto xtd::tunit::string_assert::does_not_match ( const xtd::string & regex_pattern, const xtd::string & actual, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::does_not_match("^Salut", xtd::string("Hello, World!")); // test ok.
xtd::tunit::string_assert::does_not_match("^Hello", xtd::string("Hello, World!")); // test throws an assert_error exception.

Examples

string_assert_does_not_match.cpp.

does_not_match() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::does_not_match("^Salut", "Hello, World!", xtd::string("User message...")); // test ok.
xtd::tunit::string_assert::does_not_match("^Hello", "Hello, World!", xtd::string("User message...")); // test throws an assert_error exception.

does_not_start_with() [1/2]

auto xtd::tunit::string_assert::does_not_start_with ( const xtd::string & item, const xtd::string & string, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that string starts with item.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::does_not_start_with("zoe", s); // test ok.
xtd::tunit::string_assert::does_not_start_with("val", s); // test throws an assert_error exception.

Examples

string_assert_does_not_start_with.cpp.

does_not_start_with() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::does_not_start_with("zoe", s, "User message..."); // test ok.
xtd::tunit::string_assert::does_not_start_with("val", s, "User message..."); // test throws an assert_error exception.

ends_with() [1/2]

auto xtd::tunit::string_assert::ends_with ( const xtd::string & item, const xtd::string & string, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that string ends with item.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::ends_with("val", s); // test ok.
xtd::tunit::string_assert::ends_with("law", s); // test throws an assert_error exception.

Examples

string_assert_ends_with.cpp.

ends_with() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

Asserts that string ends 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.

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::ends_with("lue", s, "User message..."); // test ok.
xtd::tunit::string_assert::ends_with("law", s, "User message..."); // test throws an assert_error exception.

matches() [1/2]

auto xtd::tunit::string_assert::matches ( const xtd::string & regex_pattern, const xtd::string & actual, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that matches regex pattern.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::matches("^Hello", xtd::string("Hello, World!")); // test ok.
xtd::tunit::string_assert::matches("^Salut", xtd::string("Hello, World!")); // test throws an assert_error exception.

Examples

string_assert.cpp, and string_assert_matches.cpp.

matches() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::tunit::string_assert::matches("^Hello", "Hello, World!", xtd::string("User message...")); // test ok.
xtd::tunit::string_assert::matches("^Salut", "Hello, World!", xtd::string("User message...")); // test throws an assert_error exception.

starts_with() [1/2]

auto xtd::tunit::string_assert::starts_with ( const xtd::string & item, const xtd::string & string, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() ) -> void

static

Asserts that string starts with item.

Parameters

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::starts_with("val", s); // test ok.
xtd::tunit::string_assert::starts_with("zoe", s); // test throws an assert_error exception.

Examples

string_assert_starts_with.cpp.

starts_with() [2/2]

auto xtd::tunit::string_assert::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() ) -> void

static

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

Exceptions

xtd::tunit::assert_error

If bad assertion.

Examples

xtd::string s = "value";
xtd::tunit::string_assert::starts_with("val", s, "User message..."); // test ok.
xtd::tunit::string_assert::starts_with("zoe", s, "User message..."); // test throws an assert_error exception.

---

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

• xtd.tunit/include/xtd/tunit/string_assert.hpp