1. dw::test::Asserts

This module contains the set of core Matchers to use in your tests

1.1. Example

Source

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()

Validates if a payload is of type Object

1.2. Functions

1.2.1. anyOf

anyOf(matchers: Array<Matcher<Any>>): Matcher<Any>

Validates that the value satisfies at least one of the given matchers

Parameters
Name Description

matchers

The list of matchers to be tested.
Example

This example shows how to assert that a value must be either an Object or a String.

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"A Text" must anyOf(beObject(), beString())

1.2.2. beArray

beArray(): Matcher

Validates that a given value is of type Array

Example

This example shows how to validate that a value is of type 'Array'

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must beArray()

1.2.3. beBlank

beBlank(): Matcher<String | Null>

Validates that the String value is blank

Example

Validates that the String is empty or has whitespaces

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"  " must beBlank()

1.2.4. beBoolean

beBoolean(): Matcher

Validates that a given value is of type Boolean

Example

This example shows how to validate that a value is of type Boolean

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
true must beBoolean()

1.2.5. beEmpty

beEmpty(): Matcher<String | Object | Array | Null>

Validates that the value (String, Object or Array) is empty

Example

Validates that the Array is of size 0

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
[] must beEmpty()

1.2.6. beGreaterThan

beGreaterThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted Comparable value is greater than the given one

Can be equal to when using the _inclusive_ argument
Parameters
Name Description

expected

The number to compare to

inclusive

If it is inclusive or not (Optional) false by default
Example

Expects a Number to be bigger than 2

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2)
Example

Expects a Number to be bigger or equal than 2

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
3 must beGreaterThan(2, true)

1.2.7. beLowerThan

beLowerThan(expected: Comparable, inclusive: Boolean = false): Matcher<Comparable>

Validates that the asserted Comparable value is lower than the given one

Can be equal to when using the inclusive argument

Parameters
Name Description

expected

The number to compare to

inclusive

If it is inclusive or not (Optional) false by default
Example

Expects a Number to be less than 2

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2)
Example

Expects a Number to be less or equal than 2

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
1 must beLowerThan(2, true)

1.2.8. beNull

beNull(): Matcher

Validates that a given value is of type Null ===== Example

This example shows how to validate that a value is of type Null

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
null must beNull()

1.2.9. beNumber

beNumber(): Matcher

Validates that a given value is of type Number

Example

This example shows how to validate that a value is of type Number

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
123 must beNumber()

1.2.10. beObject

beObject(): Matcher

Validates that a given value is of type Object

Example

This example shows how to validate that a value is of type Object

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
{ name : "Lionel", lastName: "Messi"} must beObject()

1.2.11. beOneOf

beOneOf(expected: Array<Any>): Matcher

Validates that the value is contained in the given Array

Parameters
Name Description

expected

The array of possible elements
Example

Asserts that the value is either 1 or "A Text" or true

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
1 must beOneOf([1, "A Text", true])

1.2.12. beString

beString(): Matcher

Validates that a given value is of type String

Example

This example shows how to validate that a value is of type String

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"A Text" must beString()

1.2.13. contain

contain(expected: String): Matcher<String>

Validates that the asserted String contains the given String

Parameters
Name Description

expected

The expected text to be contained
Example

Expects the value to contain the String "ex"

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"A Text" must contain("ex")
contain(expected: Any): Matcher<Array<Any>>

Validates that the asserted Array contains the given value

Parameters
Name Description

expected

The expected value to be contained
Example

Expects the Array value to contain the Number 1

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
[1, "A Text", true] must contain(1)

1.2.14. eachItem

eachItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that each item of the array satisfies the given matcher

Parameters
Name Description

matcher

The matcher to apply to all the elements
Example

Expects all the elements in the Array to be a Number

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
[1,2,3] must eachItem(beNumber())

1.2.15. endWith

endWith(expected: String): Matcher<String>

Validates that the asserted String ends with the given String

Parameters
Name Description

expected

Suffix of the 'String'
Example

Expects the String to end with "xt"

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"A Text" must endWith("xt")

1.2.16. equalTo

equalTo(expected: Any, equalToConfig: { unordered?: Boolean } = {}): Matcher<Any>

Validates that a value is equal to another one

Parameters
Name Description

expected

The expected value

equalToConfig

Configuration of how to compare them.
Example

This example shows how to assert that a value must be equal to 3.

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
(1 + 2) must equalTo(3)

1.2.17. equalToResource

equalToResource(resourceName: String, contentType: String = "application/dw", readerProperties: Object = {}): Matcher<Any>

Validates that the given value is equal to the content of a resource file

The resource file must belong to the classpath

Parameters
Name Description

resourceName

The resource name

contentType

The content type of the resource (Optional)

readerProperties

An object with the config properties (Optional)
Example

Expects a value to be equal to the content of the resource "user.json"

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must equalToResource("user.json", "application/json")

1.2.18. haveItem

haveItem(matcher: Matcher<Any>): Matcher<Array<Any>>

Validates that at least one item of the array satisfies the given matcher

Parameters
Name Description

matcher

The matcher to apply to at least one of the elements
Example

Expects that one element of the Array is a Number

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
[1, true, "a text"] must haveItem(beNumber())

1.2.19. haveKey

haveKey(keyName: String): Matcher<Object>

Validates that the Object has the given key

Parameters
Name Description

keyName

The name of the key to expect to be present.
Example

Validates that the Object contains a key called "name"

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveKey("name")

1.2.20. haveSize

haveSize(expectedSize: Number): Matcher<Array | String | Object | Null>

Validates that the array has the given size

Parameters
Name Description

expectedSize

The expected array size
Example

Expects that the array must be of size 3

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
[1, 4, 7] must haveSize(3)

1.2.21. haveValue

haveValue(value: Any): Matcher<Object>

Validates that the Object has the given value

Parameters
Name Description

value

The value that is expected to be present
Example

Expected that the Object contains the value "Messi"

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
{ name: "Lionel", lastName: "Messi" } must haveValue("Messi")

1.2.22. must

must<T>(value: T, matchExpressions: Array<(value: T) -> Matcher<T> | MatcherResult | Boolean>): MatcherResult

This function allows to assert a value with with a list of Matcher or Expressions

Parameters
Name Description

value

matchExpressions
Example

This example shows how to assert that a payload is of type Object and has a property foo that is null

Source 

  
1
2
3
4
5
6
7


  
%dw 2.0
import dw::tests::Asserts
---
payload must [
    beObject(),
    $.foo is Null
]
must<T>(value: T, matcher: (value: T) -> Matcher<T> | Boolean): MatcherResult

This function allows to assert a value with a Matcher of Expressions

Parameters
Name Description

value

The value to be assert

matcher

The matcher to be used
Example

This example shows how to assert that a payload is of type Object.

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
payload must beObject()

1.2.23. notBe

notBe<T>(matcher: Matcher<T>): Matcher<T>

Validates that the value doesn’t satisfy the given matcher

Parameters
Name Description

matcher

The matcher that is going to be negated
Example

This example shows how to assert that a value must not be 2.

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
1 must notBe(equalTo(2))

1.2.24. notBeNull

notBeNull(): Matcher

Validates that a given value isn’t of type Null

Example

This example shows how to validate that a value is not of type Null

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"A Text" must notBeNull()

1.2.25. startWith

startWith(expected: String): Matcher<String>

Validates that the asserted String starts with the given String

Parameters
Name Description

expected

Prefix of the 'String'
Example

Validates that the String starts with "A"

Source 

  
1
2
3
4


  
%dw 2.0
import dw::tests::Asserts
---
"A Text" must startWith("A")

1.3. Variables

1.3.1. MATCHED

Constant that represents a successful match

1.4. Types

1.4.1. Matcher

Data Type that represents a Matcher to perform assertions

Example
Source 

  
1
2
3
4
5
6
7
8
9
10


  
%dw 2.0
import dw::tests::Asserts

fun beEqualToOne(): Matcher<Any> =
    (actual) -> do {
        {
            matches: actual == 1,
            description: "Expected value to be one but was $(write(actual)) as String"
        }
    }
Definition

  
1


  
(value: T) -> MatcherResult

1.4.2. MatcherResult

Data Type that represents the result of an Assertion

Example
Source 

  
1
2
3
4


  
{
    "matches": false,
    description : 'Expected value to be of type Number but was "A Text"'
}
Definition

  
1


  
{ matches: Boolean, description: String, reasons?: Array<String> }