Preparing 2.4.2 release; Updated changelog (#4990)

CHANGELOG-2.4.md

@@ -1,5 +1,31 @@
 #### 2.4.2
-* Added support for `extends` in the `codeception.yml` and `*.suite.yml` files; by @johannesschobel
+
+* Added support for `extends` in the `codeception.yml` and `*.suite.yml` files; by @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. See #4940
+* [Yii2] Resetting Yii application in `_after`. By @SamMousa. See #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
+* [Symfony] Added support for custom kernel names with `kernel_class` config option. By @omnilight.
+* [Asserts] Better exception message for `expectException` by @Slamdunk
+* [REST] Decode all non-arrays to array. See #4946 by @Amunak, fixes #4944. 
+* [ZF2] Fixed compatibility with ZF2 ServiceManager by @omnilight.
+* [Laravel5] Fixed memory leak when using Laravel factories inside Codeception. See #4971 by @AdrianSkierniewski
+* [Db] Added support for `null` values in MSSQL driver by @philek
+* Handle absolute paths in ParamsLoader by @SilverFire
+* Fix error on single file test. See #4986 by @mikbox74 
+* Upgraded to Codeception/Stub 2.0 by @Naktibalda, fixed compatibility.
+
 
 #### 2.4.1
 
@@ -14,8 +40,7 @@
   * 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 
-* **Breaking** `$settings['configFile']` now supports absolute paths. In you have defined relative path to config in absolute manner 
+* Fixed using `$settings['path']` in `Codeception\Configuration::suiteSettings()` on Windows by @olegpro  
 (starting with `/`), you must change it. @silverfire
 * [Laravel5] Added Laravel 5.4+ (5.1+ backward compatible) support for `callArtisan` method in Laravel5 module. See #4860 by @mohamed-aiman 
 * Fixed #4854: unnecessary escaping in operation arguments logging by @nicholascus

docs/12-ParallelExecution.md

@@ -28,7 +28,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
 
@@ -39,17 +39,15 @@ Define all required services in `docker-compose.yml` file. Make sure to follow D
 We prepared a sample config with codeception, web server, database, and selenium with firefox to be executed together.
 
 ```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:
@@ -58,13 +56,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
 ```
 
 Codeception service will execute command `codecept run` but only after all services are started. This is defined using `depends_on` parameter.

src/Codeception/Lib/Interfaces/SessionSnapshot.php

@@ -36,11 +36,23 @@ interface SessionSnapshot
     public function saveSessionSnapshot($name);
 
     /**
-     * Loads cookies from saved snapshot.
+     * Loads cookies from a saved snapshot.
+     * Allows to reuse same session across tests without additional login.
+     *
+     * See [saveSessionSnapshot](#saveSessionSnapshot)
      *
      * @param $name
-     * @see saveSessionSnapshot
      * @return mixed
      */
     public function loadSessionSnapshot($name);
+
+    /**
+     * Deletes session snapshot.
+     *
+     * See [saveSessionSnapshot](#saveSessionSnapshot)
+     *
+     * @param $name
+     * @return mixed
+     */
+    public function deleteSessionSnapshot($name);
 }

src/Codeception/Module/WebDriver.php

@@ -3028,9 +3028,6 @@ protected function getLocator($selector)
         throw new \InvalidArgumentException("Only CSS or XPath allowed");
     }
 
-    /**
-     * @param string $name
-     */
     public function saveSessionSnapshot($name)
     {
         $this->sessionSnapshots[$name] = [];
@@ -3048,10 +3045,6 @@ public function saveSessionSnapshot($name)
         $this->debugSection('Snapshot', "Saved \"$name\" session snapshot");
     }
 
-    /**
-     * @param string $name
-     * @return bool
-     */
     public function loadSessionSnapshot($name)
     {
         if (!isset($this->sessionSnapshots[$name])) {
@@ -3065,9 +3058,6 @@ public function loadSessionSnapshot($name)
         return true;
     }
 
-    /**
-     * @param string $name
-     */
     public function deleteSessionSnapshot($name)
     {
         if (isset($this->sessionSnapshots[$name])) {