Test Assertions

Assertions are used to perform various tests and annotations within a unit test...

Overview

Within a Unit Tests function, assertions are used to:

Test conditions and record the results:
ok( ), equal( ), notEqual( ), strictEqual( ), notStrictEqual( ), deepEqual( ), notDeepEqual( ), REQUIRE( )
Add comments to test results:
comment( )
Prematurely end a test:
ABORT( ) and FINISH( )

Note: You can also reference the variable _global, which is a pointer to the global object, from within a Unit Test function.

Assertions

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

Availability STABLE

Requires:

Warzone 3.1 or above
Test API

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.module() — Allows multiple tests to be grouped together in to modules...
- Module Lifecycle Object — Configure the lifecycle of tests in the module...
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...
- Test API - possible future direction — Rough ideas for future development...