Annotations
JUnit 5 annotations
Shirates uses some JUnit 5 annotations.
| annotation | target | description |
|---|---|---|
| @Test | Function | Annotate test function with this |
| @Order | Function | Execution order in test class |
| @DisplayName | Function | Display name in JUnit runner |
See JUnit 5 User Guide / Annotations
Shirates annotations
Shirates has these custom annotations.
| annotation | target | description |
|---|---|---|
| @Testrun | Class | Testrun file to initialize test session (see) |
| @MacroObject | Class | Declares it to be a MacroObject (see) |
| @Macro | Function | Declares it to be a Macro function (see) |
| @CustomObject | Class | Declares it to be a CustomObject (see) |
| @CustomFunction | Function | Declares it to be a Custom function (see) |
| @DisableCache | Class, Function | Disable cache |
| @NoLoadRun | Class, Function | (Deprecated. Use @Manual instead.) |
| @Manual | Class, Function | Run the test as No-Load-Run(NLR) mode (see) |
| @Environment | Class, Function | Describes the test environment |
| @Unstable | Class, Function | Describes the test is unstable |
| @Deleted | Class, Function | Describes the test is deleted |
| @Fail | Function | Describes that the test fails |
| @Must | Class, Function | Priority annotation (see) |
| @Should | Class, Function | Priority annotation (see) |
| @Want | Class, Function | Priority annotation (see) |