Functions - test

assertEquals

Asserts whether the given values are equal.

assertExactEquals

Asserts whether the given values are exactly equal.

assertFail

Assert failure is triggered based on user discretion.

assertFalse

Asserts whether the given condition is false.

assertNotEquals

Asserts whether the given values are not equal.

assertNotExactEquals

Asserts whether the given values are not exactly equal.

assertTrue

Asserts whether the given condition is true.

createBallerinaError

Creates an AssertError with custom message and category.

mock

Creates and returns a mock object of provided type description.

mockHandler

Inter-op to handle function mocking.

prepare

Prepares a provided default mock object for stubbing.

when

Objects and functions related to function mocking Allows a function to stub.

assertEquals

(anydata | error actual, anydata | error expected, string msg)

Asserts whether the given values are equal. If it is not, an AssertError is thrown with the given errorMessage.

Parameters

  • actual anydata | error
  • Actual value

  • expected anydata | error
  • Expected value

  • msg string (default Assertion Failed!)
  • Assertion error message

assertExactEquals

(any | error actual, any | error expected, string msg)

Asserts whether the given values are exactly equal. If it is not, an AssertError is thrown with the given errorMessage.

Parameters

  • actual any | error
  • Actual value

  • expected any | error
  • Expected value

  • msg string (default Assertion Failed!)
  • Assertion error message

assertFail

(string msg)

Assert failure is triggered based on user discretion. AssertError is thrown with the given errorMessage.

Parameters

  • msg string (default Test Failed!)
  • Assertion error message

assertFalse

(boolean condition, string msg)

Asserts whether the given condition is false. If it is not, a AssertError is thrown with the given errorMessage.

Parameters

  • condition boolean
  • Boolean condition to evaluate

  • msg string (default Assertion Failed!)
  • Assertion error message

assertNotEquals

(anydata | error actual, anydata | error expected, string msg)

Asserts whether the given values are not equal. If it is equal, an AssertError is thrown with the given errorMessage.

Parameters

  • actual anydata | error
  • Actual value

  • expected anydata | error
  • Expected value

  • msg string (default Assertion Failed!)
  • Assertion error message

assertNotExactEquals

(any | error actual, any | error expected, string msg)

Asserts whether the given values are not exactly equal. If it is equal, an AssertError is thrown with the given errorMessage.

Parameters

  • actual any | error
  • Actual value

  • expected any | error
  • Expected value

  • msg string (default Assertion Failed!)
  • Assertion error message

assertTrue

(boolean condition, string msg)

Asserts whether the given condition is true. If it is not, a AssertError is thrown with the given errorMessage.

Parameters

  • condition boolean
  • Boolean condition to evaluate

  • msg string (default Assertion Failed!)
  • Assertion error message

createBallerinaError

(string errorMessage, string category)

returns error

Creates an AssertError with custom message and category.

Parameters

  • errorMessage string
  • Custom message for the ballerina error

  • category string
  • error category

  • Return Type

    (error)
  • an AssertError with custom message and category

mock

(typedesc T, object { } mockObject)

returns T

Creates and returns a mock object of provided type description.

Parameters

  • T typedesc
  • type of object to create the mock

  • mockObject object { } (default <object { }> object { } $obj$ = BLangTypeInit: new $init$ ([]) ; $init$())
  • mock object to replace the original (optional)

  • Return Type

    (T)
  • created mock object or throw an error if validation failed

mockHandler

(MockFunction mockFunction, any | error... args)

returns any | Error

Inter-op to handle function mocking.

Parameters

  • args any | error...
  • function arguments

  • Return Type

    (any | Error)
  • function return value or error if case registration failed

prepare

(object { } mockObject)

returns MockObject

Prepares a provided default mock object for stubbing.

Parameters

  • mockObject object { }
  • created default mock object

  • Return Type

    (MockObject)
  • prepared object that allows a member function/field to register stubs

when

(MockFunction mockFunction)

returns FunctionStub

Objects and functions related to function mocking Allows a function to stub.

Parameters

  • Return Type

    (FunctionStub)
  • object that allows stubbing calls to provided function