auto updated documentation

DavertMik · DavertMik · commit 93a6b9e4a90d · 2018-05-27T01:20:43.000+03:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,35 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.4.2
+
+* Added support for `extends` in the `codeception.yml` and `*.suite.yml` files; by **[johannesschobel](https://github.com/johannesschobel)**.
+ Allows to inherit current config from a provided file. See example for `functional.suite.yml`:
+
+
+```yml
+actor: FunctionalTester
+extends: shared.functional.suite.yml
+modules:
+    enabled:
+        - \App\Modules\X\Tests\Helper\Functional
+```
+
+* **[Yii2]** Restore null check for client in Yii2 by **[wkritzinger](https://github.com/wkritzinger)**. See [#4940](https://github.com/Codeception/Codeception/issues/4940)
+* **[Yii2]** Resetting Yii application in `_after`. By **[SamMousa](https://github.com/SamMousa)**. See [#4928](https://github.com/Codeception/Codeception/issues/4928)
+* **[Yii2]** **Breaking** `$settings['configFile']` now supports absolute paths. In you have defined relative path to config in absolute manner
+* **[WebDriverIO]** Added `deleteSessionSnapshot` by **[vi4o](https://github.com/vi4o)**
+* **[Symfony]** Added support for custom kernel names with `kernel_class` config option. By **[omnilight](https://github.com/omnilight)**.
+* **[Asserts]** Better exception message for `expectException` by **[Slamdunk](https://github.com/Slamdunk)**
+* **[REST]** Decode all non-arrays to array. See [#4946](https://github.com/Codeception/Codeception/issues/4946) by **[Amunak](https://github.com/Amunak)**, fixes [#4944](https://github.com/Codeception/Codeception/issues/4944). 
+* **[ZF2]** Fixed compatibility with ZF2 ServiceManager by **[omnilight](https://github.com/omnilight)**.
+* **[Laravel5]** Fixed memory leak when using Laravel factories inside Codeception. See [#4971](https://github.com/Codeception/Codeception/issues/4971) by **[AdrianSkierniewski](https://github.com/AdrianSkierniewski)**
+* **[Db]** Added support for `null` values in MSSQL driver by **[philek](https://github.com/philek)**
+* Handle absolute paths in ParamsLoader by **[SilverFire](https://github.com/SilverFire)**
+* Fix error on single file test. See [#4986](https://github.com/Codeception/Codeception/issues/4986) by **[mikbox74](https://github.com/mikbox74)** 
+* Upgraded to Codeception/Stub 2.0 by **[Naktibalda](https://github.com/Naktibalda)**, fixed compatibility.
+ 
+
 #### 2.4.1
 
 * Fixed "Uncaught Error: Call to undefined method Codeception\Test\Descriptor::getTestDataSetIndex()" error when filtering tests.
@@ -20,7 +49,8 @@ title: Codeception Changelog
   * More reliable application state before and during test execution
   * Fixtures method is now configurable
   * Subset of misconfigurations are now detected and informative messages created
-* Fixed using `$settings['path']` in `Codeception\Configuration::suiteSettings()` on Windows by **[olegpro](https://github.com/olegpro)** 
+* Fixed using `$settings['path']` in `Codeception\Configuration::suiteSettings()` on Windows by **[olegpro](https://github.com/olegpro)**  
+(starting with `/`), you must change it. **[silverfire](https://github.com/silverfire)**
 * **[Laravel5]** Added Laravel 5.4+ (5.1+ backward compatible) support for `callArtisan` method in Laravel5 module. See [#4860](https://github.com/Codeception/Codeception/issues/4860) by **[mohamed-aiman](https://github.com/mohamed-aiman)** 
 * Fixed [#4854](https://github.com/Codeception/Codeception/issues/4854): unnecessary escaping in operation arguments logging by **[nicholascus](https://github.com/nicholascus)**
 * Fixed humanizing steps for utf8 strings by **[nicholascus](https://github.com/nicholascus)**. See [#4850](https://github.com/Codeception/Codeception/issues/4850)
diff --git a/docs/08-Customization.md b/docs/08-Customization.md
@@ -110,29 +110,29 @@ All listed events are available as constants in `Codeception\Events` class.
 
 |    Event             |    When?                                |    Triggered by
 |:--------------------:| --------------------------------------- | --------------------------:
-| `suite.before`       | Before suite is executed                | [Suite, Settings](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/SuiteEvent.php)
-| `test.start`         | Before test is executed                 | [Test](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/TestEvent.php)
-| `test.before`        | At the very beginning of test execution | [Codeception Test](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/TestEvent.php)
-| `step.before`        | Before step                             | [Step](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/StepEvent.php)
-| `step.after`         | After step                              | [Step](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/StepEvent.php)
-| `step.fail`          | After failed step                       | [Step](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/StepEvent.php)
-| `test.fail`          | After failed test                       | [Test, Fail](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/FailEvent.php)
-| `test.error`         | After test ended with error             | [Test, Fail](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/FailEvent.php)
-| `test.incomplete`    | After executing incomplete test         | [Test, Fail](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/FailEvent.php)
-| `test.skipped`       | After executing skipped test            | [Test, Fail](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/FailEvent.php)
-| `test.success`       | After executing successful test         | [Test](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/TestEvent.php)
-| `test.after`         | At the end of test execution            | [Codeception Test](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/TestEvent.php)
-| `test.end`           | After test execution                    | [Test](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/TestEvent.php)
-| `suite.after`        | After suite was executed                | [Suite, Result, Settings](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/SuiteEvent.php)
-| `test.fail.print`    | When test fails are printed             | [Test, Fail](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/FailEvent.php)
-| `result.print.after` | After result was printed                | [Result, Printer](https://github.com/Codeception/Codeception/blob/master/src/Codeception/Event/PrintResultEvent.php)
+| `suite.before`       | Before suite is executed                | [Suite, Settings](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/SuiteEvent.php)
+| `test.start`         | Before test is executed                 | [Test](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/TestEvent.php)
+| `test.before`        | At the very beginning of test execution | [Codeception Test](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/TestEvent.php)
+| `step.before`        | Before step                             | [Step](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/StepEvent.php)
+| `step.after`         | After step                              | [Step](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/StepEvent.php)
+| `step.fail`          | After failed step                       | [Step](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/StepEvent.php)
+| `test.fail`          | After failed test                       | [Test, Fail](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/FailEvent.php)
+| `test.error`         | After test ended with error             | [Test, Fail](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/FailEvent.php)
+| `test.incomplete`    | After executing incomplete test         | [Test, Fail](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/FailEvent.php)
+| `test.skipped`       | After executing skipped test            | [Test, Fail](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/FailEvent.php)
+| `test.success`       | After executing successful test         | [Test](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/TestEvent.php)
+| `test.after`         | At the end of test execution            | [Codeception Test](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/TestEvent.php)
+| `test.end`           | After test execution                    | [Test](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/TestEvent.php)
+| `suite.after`        | After suite was executed                | [Suite, Result, Settings](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/SuiteEvent.php)
+| `test.fail.print`    | When test fails are printed             | [Test, Fail](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/FailEvent.php)
+| `result.print.after` | After result was printed                | [Result, Printer](https://github.com/Codeception/Codeception/blob/2.4/src/Codeception/Event/PrintResultEvent.php)
 
 There may be some confusion between `test.start`/`test.before` and `test.after`/`test.end`.
 The start and end events are triggered by PHPUnit, but the before and after events are triggered by Codeception.
 Thus, when you are using classical PHPUnit tests (extended from `PHPUnit\Framework\TestCase`),
 the before/after events won't be triggered for them. During the `test.before` event you can mark a test
 as skipped or incomplete, which is not possible in `test.start`. You can learn more from
-[Codeception internal event listeners](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Subscriber).
+[Codeception internal event listeners](https://github.com/Codeception/Codeception/tree/2.4/src/Codeception/Subscriber).
 
 The extension class itself is inherited from `Codeception\Extension`:
 
diff --git a/docs/12-ParallelExecution.md b/docs/12-ParallelExecution.md
@@ -33,7 +33,7 @@ Run official Codeception image from DockerHub:
     docker run codeception/codeception
 
 Running tests from a project, by mounting the current path as a host-volume into the container.
-The default working directory in the container is `/project`.
+The **default working directory in the container is `/project`**.
 
     docker run -v ${PWD}:/project codeception/codeception run
 
@@ -45,17 +45,15 @@ We prepared a sample config with codeception, web server, database, and selenium
 
 {% highlight yaml %}
 
-version: '2'
+version: '3'
 services:
   codecept:
     image: codeception/codeception
     depends_on:
-      - firefox
+      - chrome
       - web
     volumes:
-      - ./src:/src
-      - ./tests:/tests
-      - ./codeception.yml:/codeception.yml
+      - .:/project
   web:
     image: php:7-apache
     depends_on:
@@ -64,13 +62,8 @@ services:
       - .:/var/www/html
   db:
     image: percona:5.6
-    ports:
-      - '3306'
-  firefox:
-    image: selenium/standalone-firefox-debug:2.53.0
-    ports:
-      - '4444'
-      - '5900'
+  chrome:
+    image: selenium/standalone-chrome
 
 {% endhighlight %}
 
diff --git a/docs/modules/AngularJS.md b/docs/modules/AngularJS.md
@@ -519,6 +519,15 @@ Print out latest Selenium Logs in debug mode
  * `param TestInterface` $test
 
 
+#### deleteSessionSnapshot
+ 
+Deletes session snapshot.
+
+See [saveSessionSnapshot](#saveSessionSnapshot)
+
+ * `param` $name
+
+
 #### dontSee
  
 Checks that the current page doesn't contain the text specified (case insensitive).
@@ -1031,8 +1040,12 @@ $name = $I->grabValueFrom(['name' => 'username']);
 
 #### loadSessionSnapshot
  
- * `param string` $name
- * `return` bool
+Loads cookies from a saved snapshot.
+Allows to reuse same session across tests without additional login.
+
+See [saveSessionSnapshot](#saveSessionSnapshot)
+
+ * `param` $name
 
 
 #### makeScreenshot
@@ -1228,7 +1241,35 @@ $I->resizeWindow(800, 600);
 
 #### saveSessionSnapshot
  
- * `param string` $name
+Saves current cookies into named snapshot in order to restore them in other tests
+This is useful to save session state between tests.
+For example, if user needs log in to site for each test this scenario can be executed once
+while other tests can just restore saved cookies.
+
+{% highlight php %}
+
+<?php
+// inside AcceptanceTester class:
+
+public function login()
+{
+     // if snapshot exists - skipping login
+     if ($I->loadSessionSnapshot('login')) return;
+
+     // logging in
+     $I->amOnPage('/login');
+     $I->fillField('name', 'jon');
+     $I->fillField('password', '123345');
+     $I->click('Login');
+
+     // saving snapshot
+     $I->saveSessionSnapshot('login');
+}
+?>
+
+{% endhighlight %}
+
+ * `param` $name
 
 
 #### scrollTo
diff --git a/docs/modules/Db.md b/docs/modules/Db.md
@@ -249,31 +249,21 @@ $mails = $I->grabColumnFromDatabase('users', 'email', array('name' => 'RebOOter'
 
 #### grabFromDatabase
  
-Fetches a single column value from a database.
+Fetches all values from the column in database.
 Provide table name, desired column and criteria.
 
 {% highlight php %}
 
 <?php
-$mail = $I->grabFromDatabase('users', 'email', array('name' => 'Davert'));
-
-{% endhighlight %}
-Comparison expressions can be used as well:
-
-{% highlight php %}
-
-<?php
-$post = $I->grabFromDatabase('posts', ['num_comments >=' => 100]);
-$user = $I->grabFromDatabase('users', ['email like' => 'miles%']);
+$mails = $I->grabFromDatabase('users', 'email', array('name' => 'RebOOter'));
 
 {% endhighlight %}
 
-Supported operators: `<`, `>`, `>=`, `<=`, `!=`, `like`.
-
  * `param string` $table
  * `param string` $column
- * `param array` $criteria
+ * `param array`  $criteria
 
+ * `return` array
 
 
 #### grabNumRecords
diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md
@@ -22,6 +22,7 @@ This module uses Symfony Crawler and HttpKernel to emulate requests and test res
 
 * app_path: 'src' - in Symfony 4 Kernel is located inside `src`
 * environment: 'local' - environment used for load kernel
+* kernel_class: 'App\Kernel' - kernel class name
 * em_service: 'doctrine.orm.entity_manager' - use the stated EntityManager to pair with Doctrine Module.
 * debug: true - turn on/off debug mode
 * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
@@ -41,6 +42,7 @@ This module uses Symfony Crawler and HttpKernel to emulate requests and test res
 * app_path: 'app' - specify custom path to your app dir, where the kernel interface is located.
 * var_path: 'var' - specify custom path to your var dir, where bootstrap cache is located.
 * environment: 'local' - environment used for load kernel
+* kernel_class: 'AppKernel' - kernel class name
 * em_service: 'doctrine.orm.entity_manager' - use the stated EntityManager to pair with Doctrine Module.
 * debug: true - turn on/off debug mode
 * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
@@ -60,6 +62,7 @@ This module uses Symfony Crawler and HttpKernel to emulate requests and test res
 
 * app_path: 'app' - specify custom path to your app dir, where bootstrap cache and kernel interface is located.
 * environment: 'local' - environment used for load kernel
+* kernel_class: 'AppKernel' - kernel class name
 * debug: true - turn on/off debug mode
 * em_service: 'doctrine.orm.entity_manager' - use the stated EntityManager to pair with Doctrine Module.
 * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -719,6 +719,15 @@ Print out latest Selenium Logs in debug mode
  * `param TestInterface` $test
 
 
+#### deleteSessionSnapshot
+ 
+Deletes session snapshot.
+
+See [saveSessionSnapshot](#saveSessionSnapshot)
+
+ * `param` $name
+
+
 #### dontSee
  
 Checks that the current page doesn't contain the text specified (case insensitive).
@@ -1231,8 +1240,12 @@ $name = $I->grabValueFrom(['name' => 'username']);
 
 #### loadSessionSnapshot
  
- * `param string` $name
- * `return` bool
+Loads cookies from a saved snapshot.
+Allows to reuse same session across tests without additional login.
+
+See [saveSessionSnapshot](#saveSessionSnapshot)
+
+ * `param` $name
 
 
 #### makeScreenshot
@@ -1428,7 +1441,35 @@ $I->resizeWindow(800, 600);
 
 #### saveSessionSnapshot
  
- * `param string` $name
+Saves current cookies into named snapshot in order to restore them in other tests
+This is useful to save session state between tests.
+For example, if user needs log in to site for each test this scenario can be executed once
+while other tests can just restore saved cookies.
+
+{% highlight php %}
+
+<?php
+// inside AcceptanceTester class:
+
+public function login()
+{
+     // if snapshot exists - skipping login
+     if ($I->loadSessionSnapshot('login')) return;
+
+     // logging in
+     $I->amOnPage('/login');
+     $I->fillField('name', 'jon');
+     $I->fillField('password', '123345');
+     $I->click('Login');
+
+     // saving snapshot
+     $I->saveSessionSnapshot('login');
+}
+?>
+
+{% endhighlight %}
+
+ * `param` $name
 
 
 #### scrollTo
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
@@ -15,6 +15,7 @@ It initializes Yii framework in test environment and provides actions for functi
 ### Application state during testing
 This section details what you can expect when using this module.
 * You will get a fresh application in `\Yii::$app` at the start of each test (available in the test and in `_before()`).
+* Inside your test you may change application state; however these changes will be lost when doing a request if you have enabled `recreateApplication`.
 * When executing a request via one of the request functions the `request` and `response` component are both recreated.
 * After a request the whole application is available for inspection / interaction.
 * You may use multiple database connections, each will use a separate transaction; to prevent accidental mistakes we
@@ -29,16 +30,23 @@ will warn you if you try to connect to the same database twice but we cannot reu
 * `cleanup` - (default: true) cleanup fixtures after the test
 * `ignoreCollidingDSN` - (default: false) When 2 database connections use the same DSN but different settings an exception will be thrown, set this to true to disable this behavior.
 * `fixturesMethod` - (default: _fixtures) Name of the method used for creating fixtures.
-
+* `responseCleanMethod` - (default: clear) Method for cleaning the response object. Note that this is only for multiple requests inside a single test case.
+Between test casesthe whole application is always recreated
+* `requestCleanMethod` - (default: recreate) Method for cleaning the request object. Note that this is only for multiple requests inside a single test case.
+Between test cases the whole application is always recreated
+* `recreateComponents` - (default: []) Some components change their state making them unsuitable for processing multiple requests. In production this is usually
+not a problem since web apps tend to die and start over after each request. This allows you to list application components that need to be recreated before each request.
+As a consequence, any components specified here should not be changed inside a test since those changes will get regarded.
+You can use this module by setting params in your functional.suite.yml:
+* `recreateApplication` - (default: false) whether to recreate the whole application before each request
 You can use this module by setting params in your functional.suite.yml:
-
 {% highlight yaml %}
 
 actor: FunctionalTester
 modules:
     enabled:
         - Yii2:
-            configFile: '/path/to/config.php'
+            configFile: 'path/to/config.php'
 
 {% endhighlight %}
 
@@ -397,6 +405,10 @@ $I->click(['link' => 'Login']);
  * `param` $context
 
 
+#### connectionOpenHandler
+__not documented__
+
+
 #### createAndSetCsrfCookie
  
 This function creates the CSRF Cookie.
diff --git a/docs/reference/Configuration.md b/docs/reference/Configuration.md
