codeceptjs 3.0.3 → 3.0.7

package/CHANGELOG.md

@@ -1,26 +1,122 @@
+## 3.0.7
+
+Documentation fixes:
+* Remove broken link from `Nightmare helper`. See #2860 by @Arhell
+* Fixed broken links in `playwright.md`. See #2848 by @johnhoodjr
+* Fix mocha-multi config example. See #2881 by @rimesc
+* Fix small errors in email documentation file. See #2884 by @mkrtchian
+* Improve documentation for `Sharing Data Between Workers` section. See #2891 by @ngraf
+
+Features:
+* [WebDriver] Shadow DOM Support for `Webdriver`. See #2741 by @gkushang
+* [Release management] Introduce the versioning automatically, it follows the semantics versioning. See #2883 by @PeterNgTr
+* Adding opts into `Scenario.skip` that it would be useful for building reports. See #2867 by @AlexKo4
+* Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See #2888 by @fijijavis
+* Supported config file for `codeceptjs shell` command. See #2895 by @PeterNgTr:
+
+```
+npx codeceptjs shell -c foo.conf.js
+```
+
+Bug fixes:
+* [GraphQL] Use a helper-specific instance of Axios to avoid contaminating global defaults. See #2868 by @vanvoljg
+* A default system color is used when passing non supported system color when using I.say(). See #2874 by @PeterNgTr
+* [Playwright] Avoid the timout due to calling the click on invisible elements. See #2875 by cbayer97
+
+
+## 3.0.6
+
+* [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97
+* [Playwright] Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See #2817 by @brunoqueiros. Fixes #2376.
+* Fixed printing logs and stack traces for `run-workers`. See #2857 by @haveac1gar. Fixes #2621, #2852
+* Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes
+* Improved workers processes output. See #2804 by @drfiresign
+* BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See #2814 by @jbergeronjr
+
+```js
+"features": [
+  "./features/*.feature",
+  "./features/api_features/*.feature"
+],
+```
+* Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask
+* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco
+
+```feature
+Scenario Outline: ...
+  Given ...
+  When ...
+  Then ...
+
+  Examples:
+  | productName          | customer              | email              | anythingMore |
+  | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |
+```
+* [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg
+* [Appium] Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See #2832 by @gurjeetbains
+
+## 3.0.5
+
+
+Features:
+
+* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin
+* Better support for Typescript `codecept.conf.ts` configuration files. See #2750 by @elaichenkov
+* Propagate more events for custom parallel script. See #2796 by @jccguimaraes
+* [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard
+* CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz
+* [REST] Mask sensitive data from log messages.
+```js
+I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
+```
+See #2786 by @PeterNgTr
+
+Bug fixes:
+* Fixed reporting of nested steps with PageObjects and BDD scenarios. See #2800 by @davertmik. Fixes #2720 #2682
+* Fixed issue with `codeceptjs shell` which was broken since 3.0.0. See #2743 by @stedman
+* [Gherkin] Fixed issue suppressed or hidden errors in tests. See #2745 by @ktryniszewski-mdsol
+* [Playwright] fix grabCssPropertyFromAll serialization by using property names. See #2757 by @elaichenkov
+* [Allure] fix report for multi sessions. See #2771 by @cbayer97
+* [WebDriver] Fix locator object debug log messages in smart wait. See 2748 by @elaichenkov
+
+Documentation fixes:
+* Fixed some broken examples. See #2756 by @danielrentz
+* Fixed Typescript typings. See #2747, #2758 and #2769 by @elaichenkov
+* Added missing type for xFeature. See #2754 by @PeterNgTr
+* Fixed code example in Page Object documentation. See #2793 by @mkrtchian
+
+Library updates:
+* Updated Axios to 0.21.1. See by @sseide
+* Updated @pollyjs/core @pollyjs/adapter-puppeteer. See #2760 by @Anikethana
+
+## 3.0.4
+
+* **Hotfix** Fixed `init` script by adding `cross-spawn` package. By @vipulgupta2048
+* Fixed handling error during initialization of `run-multiple`. See #2730 by @wagoid
+
 ## 3.0.3
 
 * **Playwright 1.7 support**
-* [Playwright] Fixed handling null context in click. See #2667 by @matthewjf  
-* [Playwright] Fixed `Cannot read property '$$' of null` when locating elements. See #2713 by @matthewjf 
+* [Playwright] Fixed handling null context in click. See #2667 by @matthewjf
+* [Playwright] Fixed `Cannot read property '$$' of null` when locating elements. See #2713 by @matthewjf
 * Command `npx codeceptjs init` improved
   * auto-installing required packages
   * better error messages
   * fixed generating type definitions
-* Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See #2698 by @Georgegriff 
-* [Puppeteer] Fixed that `waitForFunction` was not working with number values. See #2703 by @MumblesNZ 
+* Data Driven Tests improvements: instead of having one skipped test for data driven scenarios when using xData you get a skipped test for each entry in the data table. See #2698 by @Georgegriff
+* [Puppeteer] Fixed that `waitForFunction` was not working with number values. See #2703 by @MumblesNZ
 * Enabled autocompletion for custom helpers. #2695 by @PeterNgTr
 * Emit test.after on workers. Fix #2693 by @jccguimaraes
-* TypeScript: Allow .ts config files. See #2708 by @elukoyanov 
+* TypeScript: Allow .ts config files. See #2708 by @elukoyanov
 * Fixed definitions generation errors by @elukoyanov. See #2707 and #2718
 * Fixed handing error in _after function; for example, browser is closed during test and tests executions is stopped, but error was not logged. See #2715 by @elukoyanov
 * Emit hook.failed in workers. Fix #2723 by @jccguimaraes
-* [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See #2687 by @andrerleao 
+* [wdio plugin] Added `seleniumArgs` and `seleniumInstallArgs` config options for plugin. See #2687 by @andrerleao
 * [allure plugin] Added `addParameter` method in #2717 by @jancorvus. Fixes #2716
-* Added mocha-based `--reporter-options` and `--reporter <name>` commands to `run-workers` command by in #2691 @Ameterezu 
-* Fixed infinite loop for junit reports. See #2691 @Ameterezu 
-* Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol 
-* [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao 
+* Added mocha-based `--reporter-options` and `--reporter <name>` commands to `run-workers` command by in #2691 @Ameterezu
+* Fixed infinite loop for junit reports. See #2691 @Ameterezu
+* Added status, start/end time, and match line for BDD steps. See #2678 by @ktryniszewski-mdsol
+* [stepByStepReport plugin] Fixed "helper.saveScreenshot is not a function". Fix #2688 by @andrerleao
 
 
 
@@ -28,21 +124,21 @@
 
 * [Playwright] Fix connection close with remote browser. See #2629 by @dipiash
 * [REST] set maxUploadFileSize when performing api calls. See #2611 by @PeterNgTr
-* Duplicate Scenario names (combined with Feature name) are now detected via a warning message. 
+* Duplicate Scenario names (combined with Feature name) are now detected via a warning message.
 Duplicate test names can cause `codeceptjs run-workers` to not function. See #2656 by @Georgegriff
 * Documentation fixes
 
 Bug Fixes:
   *  --suites flag now should function correctly for `codeceptjs run-workers`. See #2655 by @Georgegriff
   * [autoLogin plugin] Login methods should now function as expected with `codeceptjs run-workers`. See #2658 by @Georgegriff, resolves #2620
-  
+
 
 
 ## 3.0.1
 
 ♨️ Hot fix:
   * Lock the mocha version to avoid the errors. See #2624 by PeterNgTr
- 
+
 🐛 Bug Fix:
   * Fixed error handling in Scenario.js. See #2607 by haveac1gar
   * Changing type definition in order to allow the use of functions with any number of any arguments. See #2616 by akoltun
@@ -65,9 +161,9 @@ Scenario('title', (I, loginPage) => {});
 Scenario('title', ({ I, loginPage }) => {});
 ```
 
-* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up).
+* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up).
 * **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate)
-* [tryTo](/plugins/#tryTo) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default
+* [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default
 * Introduced one-line installer:
 
 ```
@@ -193,9 +289,9 @@ tryTo(() => I.click('Accept', '.cookies'));
 ## 2.6.11
 
 * [Playwright] Playwright 1.4 compatibility
-* [Playwright] Added `ignoreHTTPSErrors` config option (default: false). See #2566 by gurjeetbains 
-* Added French translation by @vimar 
-* [WebDriver] Updated `dragSlider` to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01  
+* [Playwright] Added `ignoreHTTPSErrors` config option (default: false). See #2566 by gurjeetbains
+* Added French translation by @vimar
+* [WebDriver] Updated `dragSlider` to work in WebDriver W3C protocol. Fixes #2557 by suniljaiswal01
 
 ## 2.6.10
 

package/bin/codecept.js

@@ -27,6 +27,7 @@ program.command('shell [path]')
   .description('Interactive shell')
   .option('--verbose', 'output internal logging information')
   .option('--profile [value]', 'configuration profile to be used')
+  .option('-c, --config [file]', 'configuration file to be used')
   .action(require('../lib/command/interactive'));
 
 program.command('list [path]')

package/docs/basics.md

@@ -30,7 +30,7 @@ The following is a diagram of the CodeceptJS architecture:
 ![architecture](/img/architecture.svg)
 
 All helpers share the same API, so it's easy to migrate tests from one backend to another.
-However, because of the difference in backends and their limitations, they are not guaranteed to be compatible with each other. For instance, you can't set request headers in WebDriver or Protractor, but you can do so in Puppteer or Nightmare.
+However, because of the difference in backends and their limitations, they are not guaranteed to be compatible with each other. For instance, you can't set request headers in WebDriver or Protractor, but you can do so in Puppeteer or Nightmare.
 
 **Pick one helper, as it defines how tests are executed.** If requirements change it's easy to migrate to another.
 
@@ -697,7 +697,7 @@ You may also use `tryTo` for cases when you deal with uncertainty on page:
 * soft assertions
 * cookies & gdpr
 
-`tryTo` function is enabled by default via [tryTo plugin](/plugins#tryTo)
+`tryTo` function is enabled by default via [tryTo plugin](/plugins/#tryto)
 
 ## Comments
 

package/docs/bdd.md

@@ -343,7 +343,7 @@ Tag should be placed before *Scenario:* or before *Feature:* keyword. In the las
 ## Configuration
 
 * `gherkin`
-  * `features` - path to feature files
+  * `features` - path to feature files, or an array of feature file paths
   * `steps` - array of files with step definitions
 
 ```js
@@ -354,6 +354,17 @@ Tag should be placed before *Scenario:* or before *Feature:* keyword. In the las
   ]
 }
 ```
+```js
+"gherkin": {
+  "features": [
+      "./features/*.feature",
+      "./features/api_features/*.feature"
+    ],
+  "steps": [
+    "./step_definitions/steps.js"
+  ]
+}
+```
 
 ## Before
 

package/docs/build/Appium.js

@@ -183,6 +183,7 @@ class Appium extends Webdriver {
     config.capabilities.browserName = config.browser || config.capabilities.browserName;
     config.capabilities.app = config.app || config.capabilities.app;
     config.capabilities.platformName = config.platform || config.capabilities.platformName;
+    config.capabilities.tunnelIdentifier = config.tunnelIdentifier || config.capabilities.tunnelIdentifier; // Adding the code to connect to sauce labs via sauce tunnel
     config.waitForTimeout /= 1000; // convert to seconds
 
     // [CodeceptJS compatible] transform host to hostname
@@ -1414,7 +1415,7 @@ class Appium extends Webdriver {
    * I.fillField({css: 'form#login input[name=username]'}, 'John');
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {string} value text value to fill.
+   * @param {CodeceptJS.StringOrSecret} value text value to fill.
    * 
    *
    */

package/docs/build/GraphQL.js

@@ -1,8 +1,6 @@
-let axios = require('axios');
+const axios = require('axios').default;
 const Helper = require('../helper');
 
-let headers = {};
-
 /**
  * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
  * [Axios](https://github.com/axios/axios) library is used to perform requests.
@@ -41,15 +39,16 @@ let headers = {};
 class GraphQL extends Helper {
   constructor(config) {
     super(config);
-    axios = require('axios');
+    this.axios = axios.create();
+    this.headers = {};
     this.options = {
       timeout: 10000,
       defaultHeaders: {},
       endpoint: '',
     };
     this.options = Object.assign(this.options, config);
-    headers = { ...this.options.defaultHeaders };
-    axios.defaults.headers = this.options.defaultHeaders;
+    this.headers = { ...this.options.defaultHeaders };
+    this.axios.defaults.headers = this.options.defaultHeaders;
   }
 
   static _checkRequirements() {
@@ -66,10 +65,10 @@ class GraphQL extends Helper {
    * @param {object} request
    */
   async _executeQuery(request) {
-    axios.defaults.timeout = request.timeout || this.options.timeout;
+    this.axios.defaults.timeout = request.timeout || this.options.timeout;
 
-    if (headers && headers.auth) {
-      request.auth = headers.auth;
+    if (this.headers && this.headers.auth) {
+      request.auth = this.headers.auth;
     }
 
     request.headers = Object.assign(request.headers, {
@@ -84,7 +83,7 @@ class GraphQL extends Helper {
 
     let response;
     try {
-      response = await axios(request);
+      response = await this.axios(request);
     } catch (err) {
       if (!err.response) throw err;
       this.debugSection(

package/docs/build/Nightmare.js

@@ -966,7 +966,7 @@ class Nightmare extends Helper {
    * I.fillField({css: 'form#login input[name=username]'}, 'John');
    * ```
    * @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-   * @param {string} value text value to fill.
+   * @param {CodeceptJS.StringOrSecret} value text value to fill.
    * 
    */
   async fillField(field, value) {
@@ -1180,15 +1180,14 @@ class Nightmare extends Helper {
   }
 
   /**
-   * Retrieves a value from a form element located by CSS or XPath and returns it to test.
+   * Retrieves an array of value from a form located by CSS or XPath and returns it to test.
    * Resumes test execution, so **should be used inside async function with `await`** operator.
-   * If more than one element is found - value of first element is returned.
    * 
    * ```js
-   * let email = await I.grabValueFrom('input[name=email]');
+   * let inputs = await I.grabValueFromAll('//form/input');
    * ```
    * @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
-   * @returns {Promise<string>} attribute value
+   * @returns {Promise<string[]>} attribute value
    * 
    */
   async grabValueFromAll(locator) {