/
ABORT( )

(info) This AI is still in early stages of development.

ABORT( )

Owned by Aubergine
Last updated: Nov 22, 2012Version comment
Aborts the current test, marking it as failed in the process...

 

Syntax

ABORT( message );

Parameters

ParameterTypeMandatoryNotesAPI Version
messageString(error)

A message stating why the test was aborted.

Default: "ABORT signal received"

1.0

Return Values

ValueTypeNotesAPI Version
<signal>AbortSignal

An AbortSignal will be generated immediately in order to forcibly prevent further test execution, causing the test to fail in the process.

(warning) Do not catch the AbortSignal, 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) {
	// this test will be skipped if "Test chat system" test failed
	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

As you can see in the example above, the ABORT( ) assertion is particularly useful in asynchronous tests as it not only terminates the Test.ASYNCH( ) unit test but also causes any subsequent Test.APPEND( ) tests associated with it to be skipped.

Availability STABLE

Requires:

Contents

Jump to:

Test API

Topics:

  • Test() — Define a unit test and it's configuration...
  • Test Modules — A test module groups one or more unit tests and provides additional lifecycle settings for those tests...
  • Test Modes — Defines the mode in which a unit test is run...
    • Test.ANY( ) — The most basic unit test mode...
    • Test.EXPECT( ) — Causes the test to fail if it does not generate the specified number of results...
    • Test.ASYNCH( ) — Causes a test to keep running until it either passes, fails or times-out...
    • Test.APPEND( ) — Appends results to a specific asynchronous test session...
  • Unit Tests — The unit test function, responsible for performing one or more Test Assertions...
  • Test Assertions — Assertions are used to perform various tests and annotations within a unit test...
    • comment( ) — Adds a comment to the test results...
    • ok( ) — A simple state checking assertion...
    • hasNative( ) — Assert presence of a native property on the global object...
    • hasFunction( ) — Check if a context has a function property, optionally with specified number of formal parameters...
    • equal( ) — A basic equality checking assertion...
    • notEqual( ) — A basic inequality checking assertion...
    • strictEqual( ) — A strict equality checking assertion...
    • notStrictEqual( ) — A strict inequality checking assertion...
    • deepEqual( ) — A deep equality checking assertion...
    • notDeepEqual( ) — A deep inequality checking assertion...
    • 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...
  • Test Events — Events defined by Test API...
  • Test Results — After testing is finished, output results...
  • Test API - Dev Notes — Developer notes for this API...