auto updated documentation

Author: Naktibalda

changelog.markdown

@@ -7,6 +7,19 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 3.0.3
+- **[Laravel5]** Add `make` and `makeMultiple` methods for generating model instance by **[ibpavlov](https://github.com/ibpavlov)**
+- **[Lumen]** Add `make` and `makeMultiple` methods for generating model instance by **[ibpavlov](https://github.com/ibpavlov)**
+- **[Phalcon]** ActiveRecord: escape all column names using [] by **[maxgalbu](https://github.com/maxgalbu)**
+- **[Yii2]** Fixed issue on PHP7.3 because `preg_quote` now also quotes `#` by **[SamMousa](https://github.com/SamMousa)**
+- **[ZF2]** Persistent service functionality for ZF3 by **[svycka](https://github.com/svycka)**
+- **[ZF2]** Doctrine entity manager name is configurable by **[svycka](https://github.com/svycka)**
+- **[Db]** Fix sqlite connection close when holding reference in PHP's GC ([#5557](https://github.com/Codeception/Codeception/issues/5557)) by **[hoogi91](https://github.com/hoogi91)**
+- **[Doctrine2]** Fixed handling of embedables, inherited entities and parameter name clashes by **[alexkunin](https://github.com/alexkunin)**
+- [Frameworks][PhpBrowser] Fixed compatibility with symfony/browserkit 4.3 by **[kapcus](https://github.com/kapcus)**
+- **[Docs]** Small documentation updates by **[Nebulosar](https://github.com/Nebulosar)**, **[reinholdfuereder](https://github.com/reinholdfuereder)** and **[richardbrinkman](https://github.com/richardbrinkman)**
+- **[Docker]** Switched to buster php build by **[OneEyedSpaceFish](https://github.com/OneEyedSpaceFish)**
+
 #### 3.0.2
 * **[weshooper](https://github.com/weshooper)** reduced size of exported package.
 * --no-redirect option disables the redirect to a Composer-installed version, by **[DanielRuf](https://github.com/DanielRuf)**
@@ -43,11 +56,11 @@ title: Codeception Changelog
 > Upgrade Notice: If you face issues with conflicting PHPUnit classes or difference in method signatures, lock version for PHPUnit in composer.json: “phpunit/phpunit”:”^7.0.0”
 * **BREAKING** Multi-session testing disabled by default. Add `use \Codeception\Lib\Actor\Shared\Friend;` to enable `$I->haveFriend`.     
 * **BREAKING** **[WebDriver]** `pauseExecution` removed in favor of `$I->pause()`
-* [Interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) inside tests with `$I->pause();` command in debug mode added. Allows to write and debug test in realtime.
-* Introduced [Step Decorators](https://codeception.com/docs/08-Customization#Step-Decorators) - auto-generated actions around module and helper methods. As part of this feature implemented
+* [Interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) inside tests with `$I->pause()` command in debug mode added. Allows to write and debug test in realtime.
+* Introduced [Step Decorators](https://codeception.com/docs/08-Customization#Step-Decorators) - auto-generated actions around module and helper methods. As part of this feature implemented:
   * [Conditional Assertions](https://codeception.com/docs/03-AcceptanceTests#Conditional-Assertions) (`$I->canSee()`)
-  * [Retries](https://codeception.com/docs/03-AcceptanceTests#Retry) (`$I->retryClick()`); 
-  * [Silent Actions](https://codeception.com/docs/03-AcceptanceTests#A-B-Testing)(`$I->tryToClick`).
+  * [Retries](https://codeception.com/docs/03-AcceptanceTests#Retry) (`$I->retryClick()`)
+  * [Silent Actions](https://codeception.com/docs/03-AcceptanceTests#AB-Testing) (`$I->tryToClick()`)
 * Print artifacts on test failure
 * **[REST]** Short API responses in debug mode with `shortDebugResponse` config option. See [#5455](https://github.com/Codeception/Codeception/issues/5455) by **[sebastianneubert](https://github.com/sebastianneubert)** 
 * **[WebDriver]** `switchToIFrame` allow to locate iframe by CSS/XPath.

docs/03-AcceptanceTests.md

@@ -584,19 +584,20 @@ $I->retrySee('Something changed');
 
 {% endhighlight %}
 
-Retry can be configured via `$I->retry()` command, where you can set number of retries and interval.
+Retry can be configured via `$I->retry()` command, where you can set number of retries and initial interval:
+interval will be doubled on each unsuccessful execution.
 
 {% highlight php %}
 
 <?php
-// Retry up to 4 sec: 10 times, for 400ms interval 
-$I->retry(10, 400);
+// Retry up to 6 sec: 4 times, for 400ms initial interval => 400ms + 800ms + 1600ms + 3200ms = 6000ms
+$I->retry(4, 400);
 
 {% endhighlight %}
 
 `$I->retry` takes 2 parameters:
 * number of retries (1 by default)
-* interval (200ms by default)
+* initial interval (200ms by default)
 
 Retries are disabled by default. To enable them you should add retry step decorators to suite config:
 

docs/04-FunctionalTests.md

@@ -116,27 +116,6 @@ modules:
 Yii2 tests are included in [Basic](https://github.com/yiisoft/yii2-app-basic)
 and [Advanced](https://github.com/yiisoft/yii2-app-advanced) application templates. Follow the Yii2 guides to start.
 
-### Yii
-
-By itself Yii framework does not have an engine for functional testing.
-So Codeception is the first and the only functional testing framework for Yii.
-To use it with Yii include `Yii1` module into config:
-
-{% highlight yaml %}
-
-# functional.suite.yml
-
-actor: FunctionalTester
-modules:
-    enabled:
-        - Yii1
-        - \Helper\Functional
-
-{% endhighlight %}
-
-To avoid the common pitfalls we discussed earlier, Codeception provides basic hooks over the Yii engine.
-Please set them up following [the installation steps in the module reference](http://codeception.com/docs/modules/Yii1).
-
 ### Zend Framework 2
 
 Use [the ZF2 module](http://codeception.com/docs/modules/ZF2) to run functional tests inside Zend Framework 2:
@@ -269,7 +248,7 @@ The error reporting level can be set in the suite configuration file:
 actor: FunctionalTester
 modules:
     enabled:
-        - Yii1
+        - Yii2
         - \Helper\Functional
 error_level: "E_ALL & ~E_STRICT & ~E_DEPRECATED"
 

docs/08-Customization.md

@@ -148,7 +148,7 @@ class MyCustomExtension extends \Codeception\Extension
 
     public static $events = array(
         Events::SUITE_AFTER  => 'afterSuite',
-        Events::SUITE_BEFORE => 'beforeTest',
+        Events::TEST_BEFORE => 'beforeTest',
         Events::STEP_BEFORE => 'beforeStep',
         Events::TEST_FAIL => 'testFailed',
         Events::RESULT_PRINT_AFTER => 'print',

docs/12-ContinuousIntegration.md

@@ -125,7 +125,7 @@ php vendor/bin/codecept run
 
 {% endhighlight %}
 
-More details on configuration can be learned from Codeception's [`.travis.yml`](https://github.com/Codeception/Codeception/blob/master/.travis.yml).
+More details on configuration can be learned from Codeception's [`.travis.yml`](https://github.com/Codeception/Codeception/blob/3.0/.travis.yml).
 
 Travis doesn't provide visualization for XML or HTML reports so you can't view reports in format any different than console output. However, Codeception produces nice console output with detailed error reports.
 

docs/12-ParallelExecution.md

@@ -41,7 +41,7 @@ To prepare application and tests to be executed inside containers you will need
 
 Define all required services in `docker-compose.yml` file. Make sure to follow Docker philisophy: 1 service = 1 container. So each process should be defined as its own service. Those services can use official Docker images pulled from DockerHub. Directories with code and tests should be mounted using `volume` directive. And exposed ports should be explicitly set using `ports` directive.
 
-We prepared a sample config with codeception, web server, database, and selenium with firefox to be executed together.
+We prepared a sample config with codeception, web server, database, and selenium with Chrome to be executed together.
 
 {% highlight yaml %}
 

docs/modules/Laravel5.md

@@ -1225,6 +1225,28 @@ $I->haveSingleton('My\Interface', 'My\Singleton');
 Logout user.
 
 
+#### make
+ 
+Use Laravel's model factory to make a model instance.
+Can only be used with Laravel 5.1 and later.
+
+{% highlight php %}
+
+<?php
+$I->make('App\User');
+$I->make('App\User', ['name' => 'John Doe']);
+$I->make('App\User', [], 'admin');
+?>
+
+{% endhighlight %}
+
+@see http://laravel.com/docs/5.1/testing#model-factories
+ * `param string` $model
+ * `param array` $attributes
+ * `param string` $name
+ * `[Part]` orm
+
+
 #### makeHtmlSnapshot
 
 Saves current page's HTML into a temprary file.
@@ -1233,16 +1255,39 @@ Use this method in debug mode within an interactive pause to get a source code o
 {% highlight php %}
 
 <?php
-$I->makePageSnapshot('edit_page');
+$I->makeHtmlSnapshot('edit_page');
 // saved to: tests/_output/debug/edit_page.html
-$I->makePageSnapshot();
+$I->makeHtmlSnapshot();
 // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
 
 {% endhighlight %}
 
  * `param null` $name
 
 
+#### makeMultiple
+ 
+Use Laravel's model factory to make multiple model instances.
+Can only be used with Laravel 5.1 and later.
+
+{% highlight php %}
+
+<?php
+$I->makeMultiple('App\User', 10);
+$I->makeMultiple('App\User', 10, ['name' => 'John Doe']);
+$I->makeMultiple('App\User', 10, [], 'admin');
+?>
+
+{% endhighlight %}
+
+@see http://laravel.com/docs/5.1/testing#model-factories
+ * `param string` $model
+ * `param int` $times
+ * `param array` $attributes
+ * `param string` $name
+ * `[Part]` orm
+
+
 #### moveBack
 
 Moves back in history.

docs/modules/Lumen.md

@@ -998,6 +998,28 @@ $I->haveSingleton('My\Interface', 'My\Singleton');
  * `param` $concrete
 
 
+#### make
+ 
+Use Lumen's model factory to make a model instance.
+Can only be used with Lumen 5.1 and later.
+
+{% highlight php %}
+
+<?php
+$I->make('App\User');
+$I->make('App\User', ['name' => 'John Doe']);
+$I->make('App\User', [], 'admin');
+?>
+
+{% endhighlight %}
+
+@see https://lumen.laravel.com/docs/master/testing#model-factories
+ * `param string` $model
+ * `param array` $attributes
+ * `param string` $name
+ * `[Part]` orm
+
+
 #### makeHtmlSnapshot
 
 Saves current page's HTML into a temprary file.
@@ -1006,16 +1028,39 @@ Use this method in debug mode within an interactive pause to get a source code o
 {% highlight php %}
 
 <?php
-$I->makePageSnapshot('edit_page');
+$I->makeHtmlSnapshot('edit_page');
 // saved to: tests/_output/debug/edit_page.html
-$I->makePageSnapshot();
+$I->makeHtmlSnapshot();
 // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
 
 {% endhighlight %}
 
  * `param null` $name
 
 
+#### makeMultiple
+ 
+Use Laravel's model factory to make multiple model instances.
+Can only be used with Lumen 5.1 and later.
+
+{% highlight php %}
+
+<?php
+$I->makeMultiple('App\User', 10);
+$I->makeMultiple('App\User', 10, ['name' => 'John Doe']);
+$I->makeMultiple('App\User', 10, [], 'admin');
+?>
+
+{% endhighlight %}
+
+@see https://lumen.laravel.com/docs/master/testing#model-factories
+ * `param string` $model
+ * `param int` $times
+ * `param array` $attributes
+ * `param string` $name
+ * `[Part]` orm
+
+
 #### moveBack
 
 Moves back in history.

docs/modules/Phalcon.md

@@ -880,9 +880,9 @@ Use this method in debug mode within an interactive pause to get a source code o
 {% highlight php %}
 
 <?php
-$I->makePageSnapshot('edit_page');
+$I->makeHtmlSnapshot('edit_page');
 // saved to: tests/_output/debug/edit_page.html
-$I->makePageSnapshot();
+$I->makeHtmlSnapshot();
 // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
 
 {% endhighlight %}

docs/modules/PhpBrowser.md

@@ -817,9 +817,9 @@ Use this method in debug mode within an interactive pause to get a source code o
 {% highlight php %}
 
 <?php
-$I->makePageSnapshot('edit_page');
+$I->makeHtmlSnapshot('edit_page');
 // saved to: tests/_output/debug/edit_page.html
-$I->makePageSnapshot();
+$I->makeHtmlSnapshot();
 // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
 
 {% endhighlight %}