Ballerina API Documentation

Functions of ballerina.test package

function assertBooleanEquals(boolean actual, boolean expected, string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
actualbooleanActual boolean value
expectedbooleanExpected boolean value
errorMessagestringAssertion error message

function assertFail(string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
errorMessagestringAssertion error message

function assertFalse(boolean condition, string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
conditionbooleanBoolean condition to evaluate
errorMessagestringAssertion error message

function assertFloatArrayEquals(float[] actual, float[] expected, string errorMessage)

Asserts whether the given float arrays are equal. If it is not, a AssertError is thrown with the given errorMessage including differed float values and array index.

Parameters:

Parameter NameData TypeDescription
actualfloat[]Actual float array
expectedfloat[]Expected float array
errorMessagestringAssertion error message

function assertFloatEquals(float actual, float expected, string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
actualfloatActual float value
expectedfloatExpected float value
errorMessagestringAssertion error message

function assertIntArrayEquals(int[] actual, int[] expected, string errorMessage)

Asserts whether the given integer arrays are equal. If it is not, a AssertError is thrown with the given errorMessage including differed integer values and array index.

Parameters:

Parameter NameData TypeDescription
actualint[]Actual integer array
expectedint[]Expected integer array
errorMessagestringAssertion error message

function assertIntEquals(int actual, int expected, string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
actualintActual integer value
expectedintExpected integer value
errorMessagestringAssertion error message

function assertStringArrayEquals(string[] actual, string[] expected, string errorMessage)

Asserts whether the given string arrays are equal. If it is not, a AssertError is thrown with the given errorMessage including differed string values and array index.

Parameters:

Parameter NameData TypeDescription
actualstring[]Actual string array
expectedstring[]Expected string array
errorMessagestringAssertion error message

function assertStringEquals(string actual, string expected, string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
actualstringActual string value
expectedstringExpected string value
errorMessagestringAssertion error message

function assertTrue(boolean condition, string errorMessage)

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

Parameters:

Parameter NameData TypeDescription
conditionbooleanBoolean condition to evaluate
errorMessagestringAssertion error message

function createBallerinaError(string errorMessage, string category) (AssertError )

Creates a AssertError with custom message and category

Parameters:

Parameter NameData TypeDescription
errorMessagestringCustom message for the ballerina error
categorystringerror category

Return Parameters:

Return VariableData TypeDescription
AssertError

function startService(string serviceName) (string )

Starts the service specified in the 'serviceName' argument

Parameters:

Parameter NameData TypeDescription
serviceNamestringName of the service to start

Return Parameters:

Return VariableData TypeDescription
string


Structs of ballerina.test package

struct AssertError

Fields:

Field NameData TypeDescription
msgstring
causeerror
stackTracestackFrame[]
categorystring


Menu

  • Functions
    • assertBooleanEquals(boolean actual, boolean expected, string errorMessage)
    • assertFail(string errorMessage)
    • assertFalse(boolean condition, string errorMessage)
    • assertFloatArrayEquals(float[] actual, float[] expected, string errorMessage)
    • assertFloatEquals(float actual, float expected, string errorMessage)
    • assertIntArrayEquals(int[] actual, int[] expected, string errorMessage)
    • assertIntEquals(int actual, int expected, string errorMessage)
    • assertStringArrayEquals(string[] actual, string[] expected, string errorMessage)
    • assertStringEquals(string actual, string expected, string errorMessage)
    • assertTrue(boolean condition, string errorMessage)
    • createBallerinaError(string errorMessage, string category) (AssertError )
    • startService(string serviceName) (string )
  • Structs
    • AssertError

Copyright 2017 Ballerina API Documentation