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

Test Events

Owned by Aubergine
Last updated: Nov 27, 2012Version comment
1 min read
Events defined by Test API...

 

Overview

The Test API provides the following events:

EventNotesAPI Version
Test.onStart()Triggered before the first test starts.1.2
Test.onFinish(...)

Triggered after all tests have finished, useful for triggering output of Test Results.

The event has the following parameters:

  • numModules – the total number of Test Modules processed
  • numTests – the total number of Unit Tests processed
  • numPassed – the total number of unit tests that successfully passed
  • numFailed – the total number of unit tests that successfully failed

Note: Tests of mode Test.APPEND( ) are not counted.

1.2

Note: You can use Module Lifecycle Objects if you want to be notified before and after individual tests run.

Examples

Brief summary via console
Test.onFinish(numModules, numTests, numPassed, numFailed) {
	var msg = "In "+numModules+" modules "
              + "there were "+numTests+" "
              + "of which "+numPassed+" passed "
              + "and "+numFailed+" failed."
	console(msg);
}
Detailed results via console
Test.onFinish() {
	Test.outputTo("console");
}
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...