Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Excerpt |
---|
The unit test function, responsible for performing one or more Test Assertions... |
Syntax
Warning | ||
---|---|---|
| ||
The scope of unit test functions is manipulated before a test runs, so you cannot reference variables defined in the function's scope chain (closures will not work either). If you want to reference variables external to the Unit Test function, pass them in via a settings object defined in the associated Test() invocation (see Example section below). |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
function(settings[dataRef]) { // code and assertions } |
Parameters
Parameter | Type | Mandatory | Notes | API Version | |
---|---|---|---|---|---|
dataRef | Variant | You can use the first formal parameter of the function to get a custom-named reference to the testData associated with the unit test. Note: The | settings data passed in to Test(), if applicabletest settings will always be available via the testData variable (see Notes section below for details). | 1.0 |
Return value
The return value is not processed.
Notes
Within the unit test, the following additional variables and properties are also available:
Property / Variable | Type | Test.APPEND( ) mode | Any other mode | Notes | API Version | |
---|---|---|---|---|---|---|
_global | Object | A reference to the global object (not scope). | This variable is defined by Test API and is thus safer to use within tests than the equivalent global defined by Util APIThe _global var was added to allow Test API to run independently of Util API. If you don't have Util API installed, you can use _global to get the same effect as global. | 1.0 | ||
modulePath | String | The modulePath that the test is running in – see Test.module() for more information. | 1.1 | |||
moduleSettingsmoduleData | Object Undefined | The | moduleSettings for data associated with the modulePath, if specified in the Module Lifecycle Object. If the module doesn't have | settingsany data, | the variable moduleData will have a value of | 1.1 |
this.settingsdata | Variant | The settings associated with For tests of mode Test.APPEND( ) this will be the testData for the Test.ASYNCH( ) that initiated the current asynchronous test session. | The settings associated with your unit test (also available via the settings parameter on the unit test function)For all other test modes, it will be the testData for the current test – same value as testData variable below... | 1.0 | ||
testSettingstestData | Variant | The | settings data associated with | your the current unit test, if applicable. Will have a value of | 1.0 | |
testName | String | The name of | yourthe current unit test. | 1.0 | ||
testMode | Object | An object describing the | test mode | , with the following properties:An object describing the test mode, with the following mandatory properties:
There may be several other properties depending on the test mode – For more information see Test API - Dev Notes. | in which the test is being run – for more information see Test API - Dev Notes. | 1.0 |
currentTest | Object | A reference to the context of the current test, useful for .call and .apply, etc. | 1.0 |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Define some test data for our unit test var mySettingsdata = {bar: "fish"}; // The test data is passed in as 3rd parameter of the Test() function // and is accessible via the testData variable Test("Foo", Test.ANY( ), function(settings) { comment( "My first unit test!" ); // In here, 'data' is undefined as the function is re-scoped // to the unit test instance it's running within equal( "fish", data.bar, settings "data.bar == 'fish'?" ); // error: data not defined equal( "fish", testData.bar, "settingstestData.bar == 'fish'?" ); // pass }, mySettings data); // <-- test data passed in here // If you wanted to access the testData via a custom named variable, // specify it's name as the first parameter to the unit test function... Test("Foo2", Test.ANY( ), function(data) { // <-- custom reference to testData comment( "My second unit test!" ); // Now you can access testData via 'data' parameter equal( "fish", data.bar, "data.bar == 'fish'" ); // pass // Note that testData variable will still be defined... equal( "fish", testData.bar, "testData.bar == 'fish'" ); // pass }, data); |
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Test APITopics:
|