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

Test()

Owned by Aubergine
Last updated: Nov 26, 2012Version comment
1 min read
Define a unit test and it's configuration...

 

Syntax

Test(testName, testMode, unitTest[, testData]);

Parameters

ParameterTypeMandatoryNotesAPI Version
testNameString(tick)The name of the test – keep it concise but descriptive.1.0
testModeTest Mode(tick)The mode in which the test is run – see Test Modes for more details.1.0
unitTestUnit Tests(tick)

A function that performs one or more Test Assertions and optionally Test Signals.

1.0
testDataVariant(error)Optionally pass in any data that will be exposed as the testData parameter in the unitTest function when it runs.1.0

Return values

Don't read too much in to these. Most test modes result in the test being queued in which case you'll almost always get a return value of Test.PENDING.

ConstantValueTypeNotesAPI Version
Test.SUCCESStrueBooleanIndicates the test was completed and passed.1.0
Test.FAILEDfalseBooleanIndicates the test was completed but failed.1.0
Test.RUNNINGnullNullIndicates a Test.ASYNCH( ) test is waiting for additional results from subsequent Test.APPEND( ) tests.1.0
Test.PENDINGundefinedUndefinedIndicates the test has not yet started.1.0
 <error>ErrorIndicates that during a routine systems check, the NASDA system that was designed to protect us turned out to be our ultimate executioner.1.0
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...