Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

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 The signal is only sent if the specified requirement was not met, causing the test to be terminated and logging the requirement failure 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
Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox

Test API

Topics:

Child pages (Children Display)
alltrue
depthall
pageTest API
excerpttrue