STRING ¶ Assert_String_Contains (Function) Assert_String_ContainsNot (Function) Assert_String_EndsWith (Function) Assert_String_Equal (Function) Assert_String_NotEqual (Function) Assert_String_StartsWith (Function) Assert_String_StrCmpEndA (Function) Assert_String_StrCmpStartA (Function)
Assert_LInt_GreaterEqual (FUN) ¶ FUNCTION Assert_LInt_GreaterEqual : BOOL Assertion function to check that a value of LINT is greater or equal the given threshold InOut: Scope Name Type Initial Comment Return Assert_LInt_GreaterEqual BOOL TRUE if the assertion passes succesfully, FALSE otherwise Input context IBaseIecUnitTest The instance of the test function block calling this function. This instance can be provided by using THIS^ . referenceValue LINT The value indicating the threshold actualValue LINT The value to check wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) “” A custom error message, that is added to the error message of the assertion itself. If this parameter is used, it is recommended to adapt the value of the library parameter Constants.WSTRING_LENGTH .
Assert_LInt_Less (FUN) ¶ FUNCTION Assert_LInt_Less : BOOL Assertion function to check that a value of LINT is less then the given threshold InOut: Scope Name Type Initial Comment Return Assert_LInt_Less BOOL TRUE if the assertion passes succesfully, FALSE otherwise Input context IBaseIecUnitTest The instance of the test function block calling this function. This instance can be provided by using THIS^ . referenceValue LINT The value indicating the threshold actualValue LINT The value to check wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) “” A custom error message, that is added to the error message of the assertion itself. If this parameter is used, it is recommended to adapt the value of the library parameter Constants.WSTRING_LENGTH .
Assert_LInt_LessEqual (FUN) ¶ FUNCTION Assert_LInt_LessEqual : BOOL Assertion function to check that a value of LINT is less or equal the given threshold InOut: Scope Name Type Initial Comment Return Assert_LInt_LessEqual BOOL TRUE if the assertion passes succesfully, FALSE otherwise Input context IBaseIecUnitTest The instance of the test function block calling this function. This instance can be provided by using THIS^ . referenceValue LINT The value indicating the threshold actualValue LINT The value to check wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) “” A custom error message, that is added to the error message of the assertion itself. If this parameter is used, it is recommended to adapt the value of the library parameter Constants.WSTRING_LENGTH .
CreateAssertionErrorMessageForStandardDatatype (FUN) ¶ FUNCTION CreateAssertionErrorMessageForStandardDatatype Helper function to create an error message for failed assertions of standard datatypes. Hint: if wsErrorMsg is used, it is recommended to change the value of the library parameter Constants.WSTRING_LENGTH . InOut: Scope Name Type Comment Inout wsAssertError WSTRING(Constants.WSTRING_LENGTH) Inout Const wsActualValue WSTRING(Constants.WSTRING_LENGTH) The actual value as WSTRING wsReferenceValue WSTRING(Constants.WSTRING_LENGTH) The reference value as WSTRING wsAssertOperator WSTRING(Constants.WSTRING_LENGTH) The assert operator e.g. Strings.EQUAL or Strings.CONTAINS wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) A custom error message that should be appended. If no message is provided the “Additional information” part will not be added to the returned error.
CreateAssertionErrorMessageForStandardDatatypeSingleValue (FUN) ¶ FUNCTION CreateAssertionErrorMessageForStandardDatatypeSingleValue Helper function to create an error message for failed assertions of standard datatypes that only expect an actual value. Hint: if wsErrorMsg is used, it is recommended to change the value of the library parameter Constants.WSTRING_LENGTH . InOut: Scope Name Type Comment Inout wsAssertError WSTRING(Constants.WSTRING_LENGTH) Inout Const wsActualValue WSTRING(Constants.WSTRING_LENGTH) The actual value as WSTRING wsAssertOperator WSTRING(Constants.WSTRING_LENGTH) The assert operator e.g. Strings.IS_TRUE wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) A custom error message that should be appended. If no message is provided the “Additional information” part will not be added to the returned error.
CreateAssertionErrorMessageNonEqualArrayBounds (FUN) ¶ FUNCTION CreateAssertionErrorMessageNonEqualArrayBounds Helper function to create an error message for non-equal bounds of an array. InOut: Scope Name Type Comment Inout wsAssertError WSTRING(Constants.WSTRING_LENGTH) Input diExpectedBound DINT the upper or lower bound of the reference array diActualBound DINT the upper or lower bound of the actual array xIsLowerBound BOOL if set to TRUE the error message contains Lower bounds otherwise Upper bounds diDimension DINT the dimension in which the bounds differ
Interfaces ¶ IBaseIecUnitTest (Interface) HandleAssertResult (Method) HasError (Method)
IBaseIecUnitTest (ITF) ¶ INTERFACE IBaseIecUnitTest This interface is required to use the assertion functionality for IecUnitTests Methods: HandleAssertResult HasError Structure: HandleAssertResult (Method) HasError (Method)
IBaseIecUnitTest.HandleAssertResult (METH) ¶ METHOD HandleAssertResult : BOOL This method should handle the error outputs used to evalutate the success of the unittest The default implementation should look like: CASE eAssertion_Result OF ASSERTION_RESULT.ASSERTION_FAILED: xError := TRUE; iError := 1; sInfo := wsErrorMsg; wsInfo := wsErrorMsg; wsError := wsErrorMsg; ELSE RETURN; END_CASE InOut: Scope Name Type Return HandleAssertResult BOOL Input eAssertion_Result ASSERTION_RESULT wsErrorMsg WSTRING(Constants.WSTRING_LENGTH)