Terminates the test as if it had finished normally... |
Syntax
FINISH( message ); |
Parameters
| Parameter | Type | Mandatory | Notes | API Version |
|---|---|---|---|---|
| message | String |  | A message stating why the test was finshed. Default: "FINISH signal received" | 1.0 |
Return Values
| Value | Type | Notes | API Version |
|---|---|---|---|
| <signal> | FinishSignal | The FinishSignal is generated immediately in order to forcibly prevent further test execution. The test success will be determined normally (eg. based on expected results, etc).
| 1.0 |
Do not catch the Example
Test("Test chat system", Test.ASYNCH( ), function() {
// will fail on WZ 3.1, pass on WZ 3.2+
if (!hasNative( "chat", "chat() natively defined?" )) {
// abort the test if failed
ABORT( "Unable to test chat()" );
} else {
comment( "Sending chat() message..." );
chat(me, "test");
}
});
function eventChat(sender, to, message) {
Test("eventChat() triggered", Test.APPEND("Test chat system"), function() {
equal( message, "test", "message == 'test'" );
equal( sender, me, "sender == me" );
equal( to, me, "to == me" );
FINISH( "End of chat system test" );
});
} |
Notes
The FINISH( ) assertion is useful in asynchronous tests as it allows the test to end as soon as the desired results have been gathered rather than waiting for the test to timeout.