test.compare

Boolean test.compare(value1, value2)

Boolean test.compare(value1, value2, message)

This function compares value1 and value2, and if they are equal, a test result of type PASS is added to the test log and this function returns a true value. Otherwise a test result of type FAIL is added to the test log and a false value is returned.

If the optional message parameter (of type string—e.g., a comment, bug number, or test plan reference) is present, it will be added to the test result no matter whether the test passed or failed.

The testSettings.breakOnFailure property can be used to make the debugger stop in case the verification fails.

The testSettings.throwOnFailure property can be used to make this function raise a script exception in case the verification fails.