Skip to content

Commit 5c2dd47

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent 993d451 commit 5c2dd47

36 files changed

+424
-371
lines changed

‎_includes/extensions.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## DotReporter
44

5-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/DotReporter.php)
5+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/DotReporter.php)
66

77
DotReporter provides less verbose output for test execution.
88
Like PHPUnit printer it prints dots "." for successful testes and "F" for failures.
@@ -38,7 +38,7 @@ Use this extension as an example for building custom reporters.
3838

3939
## Logger
4040

41-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/Logger.php)
41+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/Logger.php)
4242

4343
Log suites/tests/steps using Monolog library.
4444
Monolog should be installed additionally by Composer.
@@ -65,7 +65,7 @@ extensions:
6565

6666
## Recorder
6767

68-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/Recorder.php)
68+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/Recorder.php)
6969

7070
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](http://codeception.com/images/recorder.gif))
7171
Activated only for suites with WebDriver module enabled.
@@ -124,7 +124,7 @@ public function testLogin(AcceptanceTester $I)
124124

125125
## RunBefore
126126

127-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/RunBefore.php)
127+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/RunBefore.php)
128128

129129
Extension for execution of some processes before running tests.
130130

@@ -155,7 +155,7 @@ HINT: you can use different configurations per environment.
155155

156156
## RunFailed
157157

158-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/RunFailed.php)
158+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/RunFailed.php)
159159

160160
Saves failed tests into tests/log/failed in order to rerun failed tests.
161161

@@ -184,7 +184,7 @@ On each execution failed tests are logged and saved into `tests/_output/failed`
184184

185185
## RunProcess
186186

187-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/RunProcess.php)
187+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/RunProcess.php)
188188

189189
Extension to start and stop processes per suite.
190190
Can be used to start/stop selenium server, chromedriver, phantomjs, mailcatcher, etc.
@@ -231,7 +231,7 @@ HINT: you can use different configurations per environment.
231231

232232
## SimpleReporter
233233

234-
[See Source](https://github.com/Codeception/Codeception/blob/3.0/ext/SimpleReporter.php)
234+
[See Source](https://github.com/Codeception/Codeception/blob/3.1/ext/SimpleReporter.php)
235235

236236
This extension demonstrates how you can implement console output of your own.
237237
Recommended to be used for development purposes only.

‎changelog.markdown

+26
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,32 @@ title: Codeception Changelog
77

88
# Changelog
99

10+
#### 3.1.1
11+
12+
* Preparation for Symfony 5, removes deprecation message when Symfony 4.3 components are used. See [#5670](https://github.com/Codeception/Codeception/issues/5670) by **[Naktibalda](https://github.com/Naktibalda)**
13+
* **[Db]** Support initial queries execution after creating connection. See [#5660](https://github.com/Codeception/Codeception/issues/5660) by **[tadasauciunas](https://github.com/tadasauciunas)**
14+
15+
```yml
16+
Db:
17+
dsn: # dsn goes hre
18+
initial_queries:
19+
- 'CREATE DATABASE IF NOT EXISTS temp_db;'
20+
- 'USE temp_db;'
21+
- 'SET NAMES utf8;'
22+
```
23+
24+
* Do not fail steps for `retry` and `tryTo` step decorators. Fixes [#5666](https://github.com/Codeception/Codeception/issues/5666) by **[Mitrichius](https://github.com/Mitrichius)**
25+
* **[Symfony]** Added `runSymfonyConsoleCommand` by **[wirwolf](https://github.com/wirwolf)**
26+
27+
```php
28+
$result = $I->runSymfonyConsoleCommand('hello:world', '--verbose' => 3]);
29+
```
30+
* **[Doctrine2]** Bugfix: calling `haveInRepository` with preconstructed entity requires providing constructor parameters. See [#5680](https://github.com/Codeception/Codeception/issues/5680) by **[burned42](https://github.com/burned42)**
31+
* **[Doctrine2]** Make debug message in `haveInRepository` to support entities with composite keys of entities in bidirectional relations. See [#5685](https://github.com/Codeception/Codeception/issues/5685) by Basster. Fixes [#5663](https://github.com/Codeception/Codeception/issues/5663).
32+
* Adds possibility to use absolute path for `groups` files in `codeception.yml`. [#5674](https://github.com/Codeception/Codeception/issues/5674) by **[maks-rafalko](https://github.com/maks-rafalko)**
33+
* Fixes the issue with paths in `groups` section when `codeception.yml` is not in the root of the project. [#5674](https://github.com/Codeception/Codeception/issues/5674)) by maks-rafalko.
34+
* **[Asserts]** `expectException` deprecated in favor of `expectThrowable`.
35+
1036
#### 3.1.0
1137

1238
* Unified bootstrap file loading

‎docs/modules/AMQP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -284,4 +284,4 @@ $I->seeQueueIsEmpty('queue.emails');
284284
* `param string` $queue
285285
* `param int` $expected
286286

287-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/AMQP.php">Help us to improve documentation. Edit module reference</a></div>
287+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/AMQP.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Apc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,4 +131,4 @@ $I->seeInApc('users_count', 200);
131131
* `param string|string[]` $key
132132
* `param mixed` $value
133133

134-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Apc.php">Help us to improve documentation. Edit module reference</a></div>
134+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Apc.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Asserts.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -432,6 +432,7 @@ $I->expectException(new MyException("Don't do bad things"), function() {
432432

433433
{% endhighlight %}
434434

435+
@deprecated Use expectThrowable() instead
435436
* `param` $exception string or \Exception
436437
* `param` $callback
437438

@@ -474,4 +475,4 @@ Fails the test with message.
474475

475476
* `param` $message
476477

477-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Asserts.php">Help us to improve documentation. Edit module reference</a></div>
478+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Asserts.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ $I->seeResultCodeIsNot(0);
8787

8888
* `param` $regex
8989

90-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Cli.php">Help us to improve documentation. Edit module reference</a></div>
90+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Cli.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/DataFactory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,4 +196,4 @@ Returns an instance of created user without creating a record in database.
196196

197197
@throws ModuleException
198198

199-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/DataFactory.php">Help us to improve documentation. Edit module reference</a></div>
199+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/DataFactory.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Db.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ if you run into problems loading dumps and cleaning databases.
5151
* ssl_verify_server_cert - disables certificate CN verification (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php)
5252
* ssl_cipher - list of one or more permissible ciphers to use for SSL encryption (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher)
5353
* databases - include more database configs and switch between them in tests.
54+
* initial_queries - list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation
5455

5556
### Example
5657

@@ -70,6 +71,10 @@ if you run into problems loading dumps and cleaning databases.
7071
ssl_ca: '/path/to/ca-cert.pem'
7172
ssl_verify_server_cert: false
7273
ssl_cipher: 'AES256-SHA'
74+
initial_queries:
75+
- 'CREATE DATABASE IF NOT EXISTS temp_db;'
76+
- 'USE temp_db;'
77+
- 'SET NAMES utf8;'
7378

7479
### Example with multi-dumps
7580
modules:
@@ -446,4 +451,4 @@ $I->updateInDatabase('users', array('isAdmin' => true), array('email' => 'miles@
446451
* `param array` $data
447452
* `param array` $criteria
448453

449-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Db.php">Help us to improve documentation. Edit module reference</a></div>
454+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Db.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Doctrine2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -367,4 +367,4 @@ Fails if record for given criteria can\'t be found,
367367
* `param` $entity
368368
* `param array` $params
369369

370-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Doctrine2.php">Help us to improve documentation. Edit module reference</a></div>
370+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Doctrine2.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/FTP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -476,4 +476,4 @@ $I->writeToFile('composer.json', 'some data here');
476476
* `param` $filename
477477
* `param` $contents
478478

479-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/FTP.php">Help us to improve documentation. Edit module reference</a></div>
479+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/FTP.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Filesystem.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -225,4 +225,4 @@ Saves contents to file
225225
* `param string` $filename
226226
* `param string` $contents
227227

228-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Filesystem.php">Help us to improve documentation. Edit module reference</a></div>
228+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Filesystem.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Laravel5.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2202,4 +2202,4 @@ $I->uncheckOption('#notify');
22022202
22032203
* `param` $option
22042204
2205-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Laravel5.php">Help us to improve documentation. Edit module reference</a></div>
2205+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Laravel5.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Lumen.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1816,4 +1816,4 @@ $I->uncheckOption('#notify');
18161816
18171817
* `param` $option
18181818
1819-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Lumen.php">Help us to improve documentation. Edit module reference</a></div>
1819+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Lumen.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Memcache.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,4 @@ $I->seeInMemcached('users_count', 200);
120120
* `param` $key
121121
* `param` $value
122122

123-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Memcache.php">Help us to improve documentation. Edit module reference</a></div>
123+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Memcache.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/MongoDb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,4 +202,4 @@ $I->useDatabase('db_1');
202202

203203
* `param` $dbName
204204

205-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/MongoDb.php">Help us to improve documentation. Edit module reference</a></div>
205+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/MongoDb.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Phalcon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1700,4 +1700,4 @@ $I->uncheckOption('#notify');
17001700
17011701
* `param` $option
17021702
1703-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Phalcon.php">Help us to improve documentation. Edit module reference</a></div>
1703+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Phalcon.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/PhpBrowser.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1561,4 +1561,4 @@ $I->uncheckOption('#notify');
15611561
15621562
* `param` $option
15631563
1564-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/PhpBrowser.php">Help us to improve documentation. Edit module reference</a></div>
1564+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/PhpBrowser.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Queue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -327,4 +327,4 @@ $I->seeQueueHasTotalCount('default', 10);
327327
* `param string` $queue Queue Name
328328
* `param int` $expected Number of messages expected
329329

330-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Queue.php">Help us to improve documentation. Edit module reference</a></div>
330+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Queue.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/REST.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -955,4 +955,4 @@ $I->stopFollowingRedirects();
955955
* `[Part]` xml
956956
* `[Part]` json
957957

958-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/REST.php">Help us to improve documentation. Edit module reference</a></div>
958+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/REST.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Redis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -307,4 +307,4 @@ $I->sendCommandToRedis('flushdb');
307307
* `param string` $command The command name
308308

309309

310-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Redis.php">Help us to improve documentation. Edit module reference</a></div>
310+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Redis.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/SOAP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,4 +251,4 @@ $I->sendSoapRequest('UpdateUser', \Codeception\Utils\Soap::request()->user
251251
* `param` $request
252252
* `param` $body
253253

254-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/SOAP.php">Help us to improve documentation. Edit module reference</a></div>
254+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/SOAP.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Sequence.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ Sequence:
116116

117117
### Actions
118118

119-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Sequence.php">Help us to improve documentation. Edit module reference</a></div>
119+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Sequence.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Symfony.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -898,6 +898,27 @@ You can set additional cookie params like `domain`, `path` in array passed as la
898898
* `param array` $params
899899

900900

901+
#### runSymfonyConsoleCommand
902+
903+
Run Symfony console command, grab response and return as string.
904+
Recommended to use for integration or functional testing.
905+
906+
{% highlight php %}
907+
908+
<?php
909+
$result = $I->runSymfonyConsoleCommand('hello:world', '--verbose' => 3]);
910+
?>
911+
912+
{% endhighlight %}
913+
914+
* `param string` $command
915+
* `param mixed[]` $params
916+
917+
* `return` string
918+
919+
@throws \Exception
920+
921+
901922
#### see
902923

903924
Checks that the current page contains the given string (case insensitive).
@@ -1666,4 +1687,4 @@ Remove service $serviceName from the lists of persistent services.
16661687
16671688
* `param string` $serviceName
16681689
1669-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/Symfony.php">Help us to improve documentation. Edit module reference</a></div>
1690+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/Symfony.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/WebDriver.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2388,4 +2388,4 @@ $I->waitForText('foo', 30, '.title'); // secs
23882388
* `param string` $selector optional
23892389
@throws \Exception
23902390
2391-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.0/src/Codeception/Module/WebDriver.php">Help us to improve documentation. Edit module reference</a></div>
2391+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/3.1/src/Codeception/Module/WebDriver.php">Help us to improve documentation. Edit module reference</a></div>

0 commit comments

Comments
 (0)