This AI is still in early stages of development.
Test.module()
- Aubergine
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 } });
Contents
Jump to:
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...