This AI is still in early stages of development.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Signals are used to prematurely terminate Unit Tests...

 

Overview

There are 4 types of signal that will cause a unit test to immediately terminate. Each adds a comment to the test results for tracking purposes (comments do not count towards result totals).

SignalTypeNotesAPI Version
<error>Error or derivative

Any uncaught exception.

The error message will be logged as a comment in the test results.

The affected test will be marked as failed.

1.0
ABORT()AbortSignal

The signal is sent immediately and will terminate the test, logging the specified message as a comment in the test results.

The affected test will be marked as failed.

1.0
REQUIRE()RequireSignal

If the referenced unit test is not marked as passed, or is not yet defined, the signal will be sent.

When sent, the signal will terminate the test, logging the referenced unit test as a comment in the test results.

The affected test will be marked as failed.

1.0
FINISH()FinishSignal

The signal is sent immediately and will terminate the test.

The affected test will be processed as if it had ended normally, so it's state may be passed, failed or in-progress depending on results logged prior to the signal being sent and the Test Mode associate with the test.

1.0
Availability STABLE

Requires:

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

 

  • No labels