Versions Compared

Key

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

The most basic unit test mode...

 

Syntax

Code Block
themeRDark
languagejavascript
titleBasic syntax
linenumberstrue
Test("Basic syntax", Test.ANY( ), function() {
  // assertions, if any, go here
});

Parameters

No parameters.

Return values

ValueTypeNotesAPI Version
<mode>ObjectThe mode object is associated with the unit test defined in the same Test() invocation.1.0

Effect on test

The test is treated as synchronous and its pass/fail state will be determined as soon as the unit test function has the Unit Tests has been processed...

Fail conditions

The unit test will fail if any of the following occur:

Pass conditions

If the test has not failed, it will be deemed to have passed – even if it did not generate any results (eg. no assertions or signals in the test).

Examples

Test.ANY( ) mode is useful when the number of results could vary based on some external factor...

Code Block
themeRDark
languagejavascript
titleUseful when number of results can be affected by external code...
linenumberstrue
var thingsToCheck = ["chat", "include", "playerData"];
 
Test("Check things", Test.ANY( ), function(settings) {
	if (settings && settings.length) {
		settings.forEach(function(thing) {
			hasNative( thing, thing+" is native?" );
		});
	}
}, thingsToCheck);

Test.ANY( ) is also useful if you want to use a test as a flag that determines whether other tests run...

Code Block
themeRDark
languagejavascript
titleA test that enables other tests...
linenumberstrue
Test("Check is defined", Test.ANY( ), function() {
	hasNative( "Check", "Dependency Checker installed?" );
});
 
Test("Test dependency checker", Test.EXPECT( 1 ), function() {
	REQUIRE( "Check is defined" ); // will abort if the test above failed
 
	Check.provide({file: "testing", ver: 1.0});
 
	ok( Check.has("testing", 1.0), "Dependency successfully provided" );
});
Div
classnotice box ping

If you know how many results a test should generate, it's recommended to use Test.EXPECT( ) instead.

Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Test API

Topics:

Child pages (Children Display)
alltrue
depthall
pageTest API
excerpttrue