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

Test.APPEND( )

Appends results to a specific asynchronous test session...

 

Syntax

Basic syntax
Test("Basic syntax", Test.APPEND( testName ), function() {
	// If the test called "testName" is running, any results from this
	// test will be added to "testName"
});

Parameters

ParameterTypeMandatoryNotesAPI Version
testNameString(tick)

The name of the test to append results to.

If that test is not currently active, invocations of the Test.APPEND( ) will be ignored.

1.0

Return values

ValueTypeNotesAPI Version
<mode>ObjectThe mode object is associated with the unit test defined in the same Test() invocation.1.0
<error>ErrorIf a testName is not specified, or a test with that name is not currently queued or running, an error will be thrown.1.0

Effect on test

A Test.APPEND( ) Unit Tests redirects its results to the initiating test in an asynchronous session if that session is currently active.

The Test.APPEND( ) test is effectively treated as if it were part of the initiating Test.ASYNCH( ) test:

  • Only the initiating Test.ASYNCH( ) unit test will have a pass/fail state
  • Test.APPEND( ) unit tests merely contribute towards the Test.ASYNCH( ) unit test's pass/fail state

For more information and examples, see Test.ASYNCH( ).

Availability STABLE

Requires:

Contents

Jump to:

Test API

Topics:

  • Test()Define a unit test and it's configuration...
  • Test ModulesA test module groups one or more unit tests and provides additional lifecycle settings for those tests...
  • Test ModesDefines 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 TestsThe unit test function, responsible for performing one or more Test Assertions...
  • Test AssertionsAssertions 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 SignalsSignals 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 EventsEvents defined by Test API...
  • Test ResultsAfter testing is finished, output results...
  • Test API - Dev NotesDeveloper notes for this API...