Allows multiple tests to be grouped together in to modules... |
Syntax
Test.module(modulePath[, lifecycle]); |
Parameters
| Parameter | Type | Mandatory | Notes | API Version |
|---|---|---|---|---|
| modulePath | String |  | The "name" of the module, in path format – keep it concise but descriptive. Example: The default module name when Test API loads is | 1.1 |
| lifecycle | Module Lifecycle Object |  | Allows you to specify:
For more information, see Module Lifecycle Object. | 1.1 |
Return values
| Value | Type | Notes | API Version |
|---|---|---|---|
| <name> | String | The module name that has been set. | 1.1 |
| <signal> | AbortSignal | Test.module() can't be used from within a unit test – if it is, an ABORT( ) signal will be sent causing the current test to fail. | 1.1 |
| <error> | Error | If invalid parameters are supplied, an error will be thrown. | 1.1 |
Notes
Modules are used to group related Unit Tests together. When a test is defined using Test(), it is put in to an array associated with the currently set module.
Tests using mode Test.APPEND( ) will assume the module of the test they are appending.
The REQUIRE( ) signal can be made to check whether all tests in a specific module have pass by prefixing it's parameter with "@".
Examples
In it's most basic form, the Test.module() function requires just the name of the module.
Test.module("Tests/Util.js/Dependency Checker");
Test("Test DC", Test.ANY( ), function() {
// etc...
}); |
You can optionally provide a Module Lifecycle Object, for example:
Test.module("Tests/Util.js/Dependency Checker", {
url: "https://warzone.atlassian.net/wiki/display/EGG/Dependency+Checking",
setup: function(testState) {
// will be run immediately before each unit test in the module
REQUIRE( "^" ); // make sure the previous test passed
},
teardown: function(testState) {
// will be run immediately after each unit test in the module
delete _global.guff; // eg. use it to clear up after tests
}
}); |