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).
Do not catch the FinishSignal, otherwise it will have no effect.
1.0
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.
similarTo( ) — A deep similarity checking assertion...
notSimilarTo( ) — A deep dissimilarity spotting assertion...
Test Signals — Signals are used to prematurely terminate Unit Tests...
REQUIRE( ) — Check whether a test or group of tests have passed. If the requirement fails, a RequireSignal will be sent which terminates the current test and marks it as failed.
ABORT( ) — Aborts the current test, marking it as failed in the process...
FINISH( ) — Terminates the test as if it had finished normally...