| Excerpt |
|---|
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. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
REQUIRE( requirement ); |
Parameters
| Parameter | Type | Mandatory | Notes | API Version |
|---|---|---|---|---|
| requirement | String |  | The requirement to check – see requirement types below for more details. If the requirement is not met, a signal will be sent to abort the current test. | 1.0 |
Requirement types
| requirement | Notes | API Version |
|---|---|---|
| "testName" | Checks a specific test, specified by it's name, to see if it passed. Example: If the test is not yet defined, not started, still in progress or failed, the requirement will fail. | 1.0 |
| "^" | Checks the previous test in the queue to see if it passed. Example: Note: Test.APPEND( ) tests don't get queued. If the test is still in progress or failed, the requirement will fail. | 1.1 |
| "@" | Checks to see if all tests (that have been performed) in the current module have passed so far. Example: If any of the tests in the module have failed, the requirement will fail. | 1.1 |
| "@^" | Checks to see if all tests in the previous module have passed. Example: Note: The previous module is the last module to be defined before the current module was defined. If any of the tests in the module failed, the requirement will fail. | 1.1 |
| "@module/path/" | Specify a module path, prefixed by "@", to check if all tests (if any) in modules starting with that path have passed. Example: If the path does not exist or contains at least one failed testany test in the matching modules failed, the requirement will fail. | 1.1 |
| "*" | Check if all invoked tests in all modules have passed so far. Example: Note: Unless you know exactly which test scripts have run prior to the script containing your tests, using this could give unexpected results. For example, the script that tests the Test API generates some failures by design (to check that tests fail where expected). If one or more tests have failed, the requirement will fail. | 1.1 |
Return values
| Value | Type | Notes | API Version |
|---|---|---|---|
| <error> | Error | Most likely the parameters are wrong. | 1.0 |
<signal> | RequireSignal | Forces the current unit test to abort, marking it as failed in the process.
| 1.0 |
true | Boolean | The specified requirement was met. | 1.0 |
Do not catch the Example
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Test("Chat() defined", Test.EXPECT( 1 ), function() {
if (!hasNative( "chat", "chat() defined" )) {
ABORT( "Unable to test chat system" );
}
})
Test("Send a chat message", Test.ANY( ), function() {
REQUIRE( "Chat() defined" ); // will abort if that test failed
// do further testing of chat() here
}); |
| Div | ||
|---|---|---|
| ||
REQUIRE( ) is not related to Dependency Checking. |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Test APITopics:
|