Skip to content

Commit 155036d

Browse files
committed
Update README.md
1 parent 06cb824 commit 155036d

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,15 @@ You can customize the default settings by specifying either a [DSN string](https
7474
as extension configuration values:
7575

7676
```xml
77-
<extension class="Tarantool\PhpUnit\Annotation">
77+
<extension class="Tarantool\PhpUnit\Annotation\AnnotationExtension">
7878
<arguments>
7979
<string>tcp://127.0.0.1:3301/?socket_timeout=10</string>
8080
</arguments>
8181
</extension>
8282
```
8383
or
8484
```xml
85-
<extension class="Tarantool\PhpUnit\Annotation">
85+
<extension class="Tarantool\PhpUnit\Annotation\AnnotationExtension">
8686
<arguments>
8787
<array>
8888
<element key="uri">
@@ -101,7 +101,7 @@ which might be useful if you need to share the same settings with a Tarantool
101101
instance file or any other script:
102102

103103
```xml
104-
<extension class="Tarantool\PhpUnit\Annotation">
104+
<extension class="Tarantool\PhpUnit\Annotation\AnnotationExtension">
105105
<arguments>
106106
<string>tcp://%env(TARANTOOL_HOST)%:%env(TARANTOOL_PORT)%</string>
107107
</arguments>
@@ -114,6 +114,10 @@ Once the annotations are configured, you can start using them:
114114

115115
#### Lua
116116

117+
Allows executing Lua code before running a test.
118+
119+
*Example:*
120+
117121
```php
118122
/**
119123
* @lua tube:put('kick_me')
@@ -127,6 +131,10 @@ public function testKickReleasesBuriedTask() : void
127131

128132
#### Sql
129133

134+
Allows executing SQL statements before running a test (requires Tarantool 2.0+).
135+
136+
*Example:*
137+
130138
```php
131139
/**
132140
* @sql DROP TABLE IF EXISTS foobar
@@ -142,6 +150,8 @@ public function testExecuteQueryFetchesAllRows() : void
142150

143151
### Requirements
144152

153+
Requirements allow skipping tests based on preconditions.
154+
145155
#### ClientPacker
146156

147157
*Format:*
@@ -208,7 +218,7 @@ public function testPrepareCreatesPreparedStatement() : void
208218

209219
> *Note*
210220
>
211-
> If you're interested in how to create and register your own annotations,
221+
> If you're interested in how to create and register your own annotations and requirements,
212222
> please refer to the `rybakit/phpunit-extras` [README](https://github.com/rybakit/phpunit-extras).
213223
214224

0 commit comments

Comments
 (0)