Release 2.4.2 (#2162)

* prepared 2.4.2 release

* fixed test

* updates to docs

Author: DavertMik

CHANGELOG.md

@@ -1,3 +1,22 @@
+## 2.4.2
+
+* **Interactive pause improvements** by @koushikmohan1996
+  * allows using in page objects and variables: `pause({ loginPage, a })`
+  * enables custom commands inside pause with `=>` prefix: `=> loginPage.open()`
+* [Selenoid plugin](/plugins#selenoid) added by by @koushikmohan1996
+  * uses Selenoid to launch browsers inside Docker containers
+  * automatically **records videos** and attaches them to allure reports
+  * can delete videos for successful tests
+  * can automatically pull in and start Selenoid containers
+  * works with WebDriver helper
+* Avoid failiure report on successful retry in worker by @koushikmohan1996
+* Added translation ability to Scenario, Feature and other context methods by @koushikmohan1996
+  * 📢 Please help us translate context methods to your language! See [italian translation](https://github.com/Codeception/CodeceptJS/blob/master/translations/it-IT.js#L3) as an example and send [patches to vocabularies](https://github.com/Codeception/CodeceptJS/tree/master/translations).
+* allurePlugin: Added `say` comments to allure reports by @PeterNgTr.
+* Fixed no custom output folder created when executed with run-worker. Fix by @PeterNgTr
+* [Puppeteer] Fixed error description for context element not found. See #2065. Fix by @PeterNgTr
+
+
 ## 2.4.1
 
 * [Hotfix] - Add missing lib that prevents codeceptjs from initializing.

docs/plugins.md

@@ -531,9 +531,124 @@ Possible config options:
 
 -   `config`  
 
+## selenoid
+
+[Selenoid][8] plugin automatically starts browsers and video recording.
+Works with WebDriver helper.
+
+### Prerequisite
+
+This plugin **requires Docker** to be installed.
+
+> If you have issues starting Selenoid with this plugin consider using official [Configuration Manager][9] tool from Selenoid
+
+### Usage
+
+Selenoid plugin can be started in two ways:
+
+1.  **Automatic** - this plugin will create and manage selenoid container for you.
+2.  **Manual** - you create the conatainer and configure it with a plugin (recommended).
+
+#### Automatic
+
+If you are new to Selenoid and you want plug and play setup use automatic mode.
+
+Add plugin configuration in `codecept.conf.js`:
+
+```js
+plugins: {
+    selenoid: {
+      enabled: true,
+      deletePassed: true,
+      autoCreate: true,
+      autoStart: true,
+      sessionTimeout: '30m',
+      enableVideo: true,
+      enableLog: true,
+    },
+  }
+```
+
+When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][10] and start Selenoid automatically.
+It will also create `browsers.json` file required by Selenoid.
+
+In automatic mode the latest version of browser will be used for tests. It is recommended to specify exact version of each browser inside `browsers.json` file.
+
+> **If you are using Windows machine or if `autoCreate` does not work properly, create container manually**
+
+#### Manual
+
+While this plugin can create containers for you for better control it is recommended to create and launch containers manually.
+This is especially useful for Continous Integration server as you can configure scaling for Selenoid containers.
+
+> Use [Selenoid Configuration Manager][9] to create and start containers semi-automatically.
+
+1.  Create `browsers.json` file in the same directory `codecept.conf.js` is located
+    [Refer to Selenoid documentation][11] to know more about browsers.json.
+
+_Sample browsers.json_
+
+```js
+{
+ "chrome": {
+   "default": "latest",
+   "versions": {
+     "latest": {
+       "image": "selenoid/chrome:latest",
+       "port": "4444",
+       "path": "/"
+     }
+   }
+ }
+}
+```
+
+> It is recommended to use specific versions of browsers in `browsers.json` instead of latest. This will prevent tests fail when browsers will be updated.
+
+2.  Create Selenoid container
+
+Run the following command to create a container. To know more [refer here][12]
+
+```bash
+docker create                                    \
+--name selenoid                                  \
+-p 4444:4444                                     \
+-v /var/run/docker.sock:/var/run/docker.sock     \
+-v `pwd`/:/etc/selenoid/:ro                      \
+-v `pwd`/output/video/:/opt/selenoid/video/      \
+-e OVERRIDE_VIDEO_OUTPUT_DIR=`pwd`/output/video/ \
+aerokube/selenoid:latest-release
+```
+
+### Video Recording
+
+This plugin allows to record and save video per each executed tests.
+
+When `enableVideo` is `true` this plugin saves video in `output/videos` directory with each test by name
+To save space videos for all succesful tests are deleted. This can be changed by `deletePassed` option.
+
+When `allure` plugin is enabled a video is attached to report automatically.
+
+### Options:
+
+| Param            | Description                                                                    |
+| ---------------- | ------------------------------------------------------------------------------ |
+| name             | Name of the container (default : selenoid)                                     |
+| port             | Port of selenium server (default : 4444)                                       |
+| autoCreate       | Will automatically create container (Linux only) (default : true)              |
+| autoStart        | If disabled start the container manually before running tests (default : true) |
+| enableVideo      | Enable video recording and use `video` folder of output (default: false)       |
+| enableLog        | Enable log recording and use `logs` folder of output (default: false)          |
+| deletePassed     | Delete video and logs of passed tests (default : true)                         |
+| additionalParams | example: `additionalParams: '--env TEST=test'` [Refer here][13] to know more   |
+
+### Parameters
+
+-   `config`  
+
 ## stepByStepReport
 
-![step-by-step-report][8]
+![step-by-step-report][14]
 
 Generates step by step report for a test.
 After each step in a test a screenshot is created. After test executed screenshots are combined into slideshow.
@@ -578,7 +693,7 @@ This plugin allows to run webdriverio services like:
 -   browserstack
 -   appium
 
-A complete list of all available services can be found on [webdriverio website][9].
+A complete list of all available services can be found on [webdriverio website][15].
 
 ###### Setup
 
@@ -590,7 +705,7 @@ See examples below:
 
 ###### Selenium Standalone Service
 
-Install `@wdio/selenium-standalone-service` package, as [described here][10].
+Install `@wdio/selenium-standalone-service` package, as [described here][16].
 It is important to make sure it is compatible with current webdriverio version.
 
 Enable `wdio` plugin in plugins list and add `selenium-standalone` service:
@@ -609,7 +724,7 @@ Please note, this service can be used with Protractor helper as well!
 
 ##### Sauce Service
 
-Install `@wdio/sauce-service` package, as [described here][11].
+Install `@wdio/sauce-service` package, as [described here][17].
 It is important to make sure it is compatible with current webdriverio version.
 
 Enable `wdio` plugin in plugins list and add `sauce` service:
@@ -653,10 +768,22 @@ In the same manner additional services from webdriverio can be installed, enable
 
 [7]: https://github.com/gotwarlost/istanbul
 
-[8]: https://codecept.io/img/codeceptjs-slideshow.gif
+[8]: https://aerokube.com/selenoid/
+
+[9]: https://aerokube.com/cm/latest/
+
+[10]: https://hub.docker.com/u/selenoid
+
+[11]: https://aerokube.com/selenoid/latest/#_prepare_configuration
+
+[12]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container
+
+[13]: https://docs.docker.com/engine/reference/commandline/create/
+
+[14]: https://codecept.io/img/codeceptjs-slideshow.gif
 
-[9]: https://webdriver.io
+[15]: https://webdriver.io
 
-[10]: https://webdriver.io/docs/selenium-standalone-service.html
+[16]: https://webdriver.io/docs/selenium-standalone-service.html
 
-[11]: https://webdriver.io/docs/sauce-service.html
+[17]: https://webdriver.io/docs/sauce-service.html

docs/puppeteer.md

@@ -247,51 +247,6 @@ npx codeceptjs def
 Mocking rules will be kept while a test is running. To stop mocking use `I.stopMocking()` command
 
 
-## Cloud Browsers
-
-Puppeteer browser can be executed locally or remotely.
-If you want to run your tests in parallel you may face problem of maintaining infrastructure for Puppeteer tests.
-
-That's why we recommend using [Aerokube Browsers](https://browsers.aerokube.com) as a fast cloud provider for browsers. At this moment, this is the only cloud provider that can launch multiple puppeteer sessions for you.
-
-To start with Aerokube Browsers you need to register at [Aerokube Browsers](https://browsers.aerokube.com) and obtain a private key. Then install `aerokube-plugin`:
-
-```
-npm i @codeceptjs/aerokube-plugin --save-dev
-```
-
-And add this plugin to a config. Please provide Aerokube credentials in configuration:
-
-```js
-// codecept.conf.js config
-exports.config = {
-  helpers: {
-    Puppeteer: {
-     // regular Puppeteer config goes here
-     // no need to change anything here
-    }
-  },
-  // ....
-  plugins: {
-    aerokube: {
-      // uncomment next line to permanently enable this plugin
-      // enabled: true,
-       require: '@codeceptjs/aerokube-plugin',
-       user: '<username from aerokube>',
-       password: '<password from aerokube>',
-     }
-  }
-}
-```
-
-To launch tests and use Aerokube Browsers enable `aerokube` plugin from a command line:
-
-```
-npx codeceptjs run --plugins aerokube
-```
-
-> ℹ When running a browser from Aerokube it can't access your local environment or private networks. Consider using [Selenoid or Moon](https://aerokube.com) to set up a private browsers cloud.
-
 ## Extending
 
 Puppeteer has a very [rich and flexible API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md). Sure, you can extend your test suites to use the methods listed there. CodeceptJS already prepares some objects for you and you can use them from your you helpers.