Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Terminates the test as if it had finished normally...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
FINISH( message );

Parameters

ParameterTypeMandatoryNotesAPI Version
messageString(error)

A message stating why the test was finshed.

Default: "FINISH signal received"

1.0

Return Values

ValueTypeNotesAPI 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).

(warning) Do not catch the FinishSignal, otherwise it will have no effect.

1.0

Example

Code Block
themeRDark
languagejavascript
linenumberstrue
Test("Test chat system", Test.ASYNCH( ), function(_global, settings) {
	// 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.

Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Test API

Topics:

Child pages (Children Display)
alltrue
depthall
pageTest API
excerpttrue