MUnit Matchers - MUnit Tools - v2.1

MUnit Matchers

MUnit matchers are a set of DataWeave functions to define assertion conditions in terms of general values instead of specific hardcoded values.

When defining matchers you need to add the MunitTools:: prefix to the expression.

Matchers are grouped according to the type of conditions you want to validate.
You can find:

Core Matchers

These matchers evaluate core values in the expression.
You can use these matchers to evaluate:

• o   Whether the expression is null or not.
• o   Media Type or Encoding of the expression.
• o   Whether the returns false.
• o   Whether two evaluations were successful.

These matchers are:

Matcher	Description	Example
nullValue()	Checks that the expression is null.	o   #[MunitTools::nullValue()]
notNullValue()	Checks that the expression is not null.	o   #[MunitTools::notNullValue()]
withMediaType(String)	Checks that the expression’s media type is the one specified.	o   #[MunitTools::withMediaType('text/xml')]
withEncoding(String)	Checks that the expression’s encoding is the one specified.	o   #[MunitTools::withEncoding('UTF-8')]
both(Matcher, Matcher)	Checks that both provided matchers are successful.	o   #[MunitTools::both(MunitTools::notNullValue(),MunitTools::equalTo('example'))]
either(Matcher,Matcher)	Checks that at least one of the matchers is successful.	o   #[MunitTools::either(MunitTools::nullValue(),MunitTools::equalTo(0))]
not(Matcher)	Checks if the provided matcher is not successful.	o   #[MunitTools::not(MunitTools::equalTo(0))]
anyOf(Matchers[)]	Checks if any of the matchers are successful.	o   #[MunitTools::anyOf(MunitTools::notNullValue(),MunitTools::withMediaType('text/xml'),MunitTools::isEmptyString())]
allOf(Matchers[)]	Checks if all of the matchers are successful.	o   #[MunitTools::allOf(MunitTools::notNullValue(),MunitTo

String Matchers

These Matchers are meant to perform assertions over String expressions.
You can use these matchers to evaluate:

• o   Whether the expression contains a specific String.
• o   Whether the expression starts or ends with a specific String.
• o   Whether the String in the expression has zero length.
• o   Compare the String in the expression against a String determined by you.

These matchers are:

Matcher	Description	Example
containsString(String)	Checks that the expression contains the specified String.	o   #[MunitTools::containsString('example')]
startsWith(String)	Checks that the expression starts with the specified String.	o   #[MunitTools::startsWith('exam')]
endsWith(String)	Checks that the expression ends with the specified String.	o   #[MunitTools::endsWith('ple')]
isEmptyString()	Checks that the expression has zero length.	o   #[MunitTools::isEmptyString()]
isEmptyOrNullString()	Checks that the expression is null, or has zero length.	o   #[MunitTools::isEmptyOrNullString()]
equalToIgnoringCase(String)	Checks that the expression is equal to the specified String, ignoring case.	o   #[MunitTools::equalToIgnoringCase('Example')]
equalToIgnoringWhiteSpace(String)	Checks that the expression is equal to the string disregarding leading and trailing white spaces, and compression all inner white spaces to a single space.	o   #[MunitTools::equalToIgnoringWhiteSpace('An Example')]
stringContainsInOrder(>)	Checks that the expression contains all of the specified substrings, regardless of the order of their appearance.	o   #[MunitTools::stringContainsInOrder('an', 'example')]

Reference: https://docs.mulesoft.com/munit/2.1/munit-matchers

Jayaraman Pancharathinam
21 Nov 2018