@Failure
- Michael Bruton (Deactivated)
Description
- Annotation on a test method.
- Causes an 'error' type of exception to be thrown from the test method.
- Will appear in the CLI as an a
FAIL_UNSPECIFIEDerror, unless the@Testannotation on the same test method has an attributeexpected-error-id, with 'FAIL_UNSPECIFIED' as its value. - Practically indistinguishable from
@Error.
Attributes
Attribute Name | Required? | Possible Values | Info |
|---|---|---|---|
| description | No |
|
|
Location in the test class file
Before a test method.
Examples
The @Failure annotation does not generate a failure ID.
To fail gracefully using the @Failure annotation, the @Test annotation should use expected-error-id, not expected-failure-id as it would for natural failures or failures induced by the fail() operation.
This test will pass.
@Test(expected-error-id: 'FAIL_UNSPECIFIED')
@Failure(description: 'How did this FAILURE happen?')
executeFailure()
{
log(
message: 'Annotated with failure',
log-file-name: 'test_me.log',
log-classifier: 'anyClassifier'
);
}
The result when you run this test:
userme > te #executeFailure Processing [1] tests class experiment.test_me ------------------------------------------------------- 1/1 .executeFailure Passed P[1] Tests run: 1, Successes: 1, Time elapsed: 0.178 sec
Here is the @Failure annotation again, without a description. It is functionally the same as the above example.
This test will pass.
@Test(expected-error-id: 'FAIL_UNSPECIFIED')
@Failure
executeFailure()
{
log(
message: 'Annotated with failure',
log-file-name: 'test_me.log',
log-classifier: 'anyClassifier'
);
}
The following test will not pass. It will end with an error.
@Test
@Failure
executeFailure()
{
log(
message: 'Annotated with failure',
log-file-name: 'test_me.log',
log-classifier: 'anyClassifier'
);
}
userme > te #executeFailure
Processing [1] tests
class experiment.test_me -------------------------------------------------------
1/1 .executeFailure
FAIL_UNSPECIFIED
Caused an error E[1]
Tests run: 1, Errors: 1, Time elapsed: 0.16 sec