|
3 | 3 | # Annotations |
4 | 4 |
|
5 | 5 | Annotations are used to configure tests and suites in a declarative way similar to modern OOP languages. This way, test configuration is stored along with the test logic inside the test package. |
6 | | -No configuration files or tables are needed. The annotation names are based on popular testing frameworks such as JUnit. |
| 6 | +No additional configuration files or tables are needed for test cases. The annotation names are based on popular testing frameworks such as JUnit. |
7 | 7 | The framework runner searches for all the suitable annotated packages, automatically configures suites, forms the suite hierarchy, executes it and reports results in specified formats. |
8 | 8 |
|
9 | | -Annotations are interpreted only in the package specification and are case-insensitive. We strongly recommend using lower-case annotations as described in this documentation. |
| 9 | +Annotation is defined by: |
| 10 | +- single line comment `--` (double dash) |
| 11 | +- followed directly by a `%` (percent) |
| 12 | +- followed by annotation name |
| 13 | +- followed by optional annotation text placed in single brackets. |
10 | 14 |
|
11 | | -There are two distinct types of annotations, identified by their location in package: |
| 15 | +All of text between first opening bracket and last closing bracket in annotation line is considered to be annotation text |
| 16 | + |
| 17 | +Examples: |
| 18 | +`--%suite(The name of my test suite)` - represents `suite` annotation with text `The name of my test suite` |
| 19 | + |
| 20 | +utPLSQL interprets the whole line of annotation and will treat all the text from the first opening bracket in the line to the last closing bracket |
| 21 | + |
| 22 | +Example: |
| 23 | + `--%suite(Stuff) -- we should name this ( correctly )` - represents `suite` annotation with text `Stuff) -- we should name this ( correctly ` |
| 24 | + |
| 25 | +Do not place comments within annotation line to avoid unexpected behaviors. |
| 26 | + |
| 27 | +**Note:** |
| 28 | +>Annotations are interpreted only in the package specification and are case-insensitive. We strongly recommend using lower-case annotations as described in this documentation. |
| 29 | +
|
| 30 | +There are two distinct types of annotations, identified by their location in package. |
| 31 | +- package annotations |
| 32 | +- procedure annotations |
12 | 33 |
|
13 | 34 | ### Procedure level annotations |
14 | 35 |
|
|
0 commit comments