xtd::tunit::string_assume Class Reference

Inheritance diagram for xtd::tunit::string_assume:

Definition

The string_assume class contains a collection of static methods that implement the most string 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>
 
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_assume::are_equal_ignoring_case("A STRING VALUE", s);
    }
    
    void test_method_(test_case2) {
      auto s = "A string value";
      string_assume::contains("item", s);
    }
    
    void test_method_(test_case3) {
      auto s = "A string value";
      string_assume::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)
//   ABORTED test.test_case2 (0 ms total)
//     Test aborted
//     Expected: string containing "item"
//     But was:  "A string value"
//     Stack Trace: in |---OMITTED---|/string_assume.cpp:17
//   ABORTED test.test_case3 (0 ms total)
//     Test aborted
//     Expected: string matching "item$"
//     But was:  "A string value"
//     Stack Trace: in |---OMITTED---|/string_assume.cpp:22
//
// Test results:
//   SUCCEED 1 test.
//   ABORTED 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
	Validates 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
	Validates 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
	Validates 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
	Validates 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
	Validates 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
	Validates 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
	Validates 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
	Validates 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
	Validates that string starts 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
	Validates that string starts 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
	Validates 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
	Validates 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
	Validates 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
	Validates 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
	Validates that string starts 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
	Validates that string starts 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
	Validates 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
	Validates 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
	Validates 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
	Validates that string starts with item.

Member Function Documentation

are_equal_ignoring_case() [1/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume.cpp, and string_assume_are_equal_ignoring_case.cpp.

are_equal_ignoring_case() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

are_not_equal_ignoring_case() [1/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_are_not_equal_ignoring_case.cpp.

are_not_equal_ignoring_case() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

contains() [1/2]

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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume.cpp, and string_assume_contains.cpp.

contains() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

does_not_contain() [1/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_does_not_contain.cpp.

does_not_contain() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

does_not_end_with() [1/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_does_not_end_with.cpp.

does_not_end_with() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

does_not_match() [1/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_does_not_match.cpp.

does_not_match() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

does_not_start_with() [1/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_does_not_start_with.cpp.

does_not_start_with() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

ends_with() [1/2]

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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_ends_with.cpp.

ends_with() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

matches() [1/2]

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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume.cpp, and string_assume_matches.cpp.

matches() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

starts_with() [1/2]

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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

Examples

string_assume_starts_with.cpp.

starts_with() [2/2]

auto xtd::tunit::string_assume::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

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.

Exceptions

xtd::tunit::abort_error

If bad assertion.

Examples

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

---

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

• xtd.tunit/include/xtd/tunit/string_assume.hpp