codeceptjs 3.1.2 → 3.1.3

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 3.1.3
+
+🛩️ Features:
+
+* BDD Improvement. Added `DataTableArgument` class to work with table data structures. 
+
+```js
+const { DataTableArgument } = require('codeceptjs');
+//...
+Given('I have an employee card', (table) => {
+  const dataTableArgument = new DataTableArgument(table);
+  const hashes = dataTableArgument.hashes(); 
+  // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }];
+  const rows = dataTableArgument.rows();
+  // rows = [['Harry', 'Potter', Seeker]];
+  }
+```
+See updated [BDD section](https://codecept.io/bdd/) for more API options.
+
+* Support `cjs` file extensions for config file: `codecept.conf.cjs`. See #3052 by @kalvenschraut
+* API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. 
+
+🐛 Bugfixes:
+
+* [Playwright] Fixed resetting `test.artifacts` for failing tests. See #3033 by @jancorvus. Fixes #3032
+* [Playwright] Apply `basicAuth` credentials to all opened browser contexts. See #3036 by @nikocanvacom. Fixes #3035
+* [WebDriver] Updated `webdriverio` default version to `^6.12.1`. See #3043 by @sridhareaswaran
+* [Playwright] `I.haveRequestHeaders` affects all tabs. See #3049 by @jancorvus
+* BDD: Fixed unhandled empty feature files. Fix #3046 by @abhimanyupandian 
+* Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests.  
+
+📖 Documentation:
+
+* Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail)
+
+
 ## 3.1.2
 
 🛩️ Features:

package/docs/bdd.md

@@ -264,8 +264,10 @@ You can also use the `parse()` method to obtain an object that allow you to get
 - `raw()` - returns the table as a 2-D array
 - `rows()` - returns the table as a 2-D array, without the first row
 - `hashes()` - returns an array of objects where each row is converted to an object (column header is the key)
+- `rowsHash()` - returns an object where each row corresponds to an entry(first column is the key, second column is the value)
+- `transpose()` - transpose the data, returns nothing. To work with the transposed table use the methods above.
 
-If we use hashes() with the previous exemple :
+If we use hashes() with the previous example :
 
 ```js
 Given('I have products in my cart', (table) => { // eslint-disable-line
@@ -281,7 +283,59 @@ Given('I have products in my cart', (table) => { // eslint-disable-line
   }
 });
 ```
+Examples of tables using: 
 
+```gherkin
+  Given I have a short employees card
+    | Harry | Potter  |
+    | Chuck | Norris  |
+```
+```js
+const { DataTableArgument } = require('codeceptjs');
+//...
+Given('I have a short employees card', (table) => {
+  const dataTableArgument = new DataTableArgument(table);
+  const raw = dataTableArgument.raw(); 
+  // row = [['Harry', 'Potter'], ['Chuck', 'Norris']]
+  dataTableArgument.transpose();
+  const transposedRaw = dataTableArgument.raw();
+  // transposedRaw = [['Harry', 'Chuck'], ['Potter', 'Norris']];
+  }
+);
+```
+```gherkin
+  Given I have an employee card
+    | name  | surname | position |
+    | Harry | Potter  | Seeker   |
+```
+```js
+const { DataTableArgument } = require('codeceptjs');
+//...
+Given('I have an employee card', (table) => {
+  const dataTableArgument = new DataTableArgument(table);
+  const hashes = dataTableArgument.hashes(); 
+  // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }];
+  const rows = dataTableArgument.rows();
+  // rows = [['Harry', 'Potter', Seeker]];
+  }
+);
+```
+```gherkin
+  Given I have a formatted employee card
+    | name     | Harry  |
+    | surname  | Potter |
+    | position | Seeker |
+```
+```js
+const { DataTableArgument } = require('codeceptjs');
+//...
+Given('I have a formatted employee card', (table) => {
+  const dataTableArgument = new DataTableArgument(table);
+  const rawHash = dataTableArgument.rowsHash();
+  // rawHash = { name: 'Harry', surname: 'Potter', position: 'Seeker' };
+  }
+);
+```
 ### Examples
 
 In case scenarios represent the same logic but differ on data, we can use *Scenario Outline* to provide different examples for the same behavior. Scenario outline is just like a basic scenario with some values replaced with placeholders, which are filled from a table. Each set of values is executed as a different test.

package/docs/build/Appium.js

@@ -481,10 +481,11 @@ class Appium extends Webdriver {
    * ```js
    * I.removeApp('appName', 'com.example.android.apis');
    * ```
-   * @param {string} appId
-   * @param {string}  bundleId String  ID of bundle
    *
    * Appium: support only Android
+   *
+   * @param {string} appId
+   * @param {string} [bundleId] ID of bundle
    */
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, 'Android');
@@ -820,9 +821,10 @@ class Appium extends Webdriver {
    * I.hideDeviceKeyboard('pressKey', 'Done');
    * ```
    *
-   * @param {'tapOutside' | 'pressKey'} strategy  desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-   *
    * Appium: support Android and iOS
+   *
+   * @param {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+   * @param {string} [key] Optional key
    */
   async hideDeviceKeyboard(strategy, key) {
     onlyForApps.call(this);
@@ -1162,6 +1164,8 @@ class Appium extends Webdriver {
    * ```
    *
    * Appium: support Android and iOS
+   *
+   * @param {Array} actions Array of touch actions
    */
   async touchPerform(actions) {
     onlyForApps.call(this);

package/docs/build/Playwright.js

@@ -354,6 +354,7 @@ class Playwright extends Helper {
     if (this.options.restart && !this.options.manualStart) await this._startBrowser();
     if (!this.isRunning && !this.options.manualStart) await this._startBrowser();
 
+    this.isAuthenticated = false;
     if (this.isElectron) {
       this.browserContext = this.browser.context();
     } else if (this.userDataDir) {
@@ -364,6 +365,10 @@ class Playwright extends Helper {
         acceptDownloads: true,
         ...this.options.emulate,
       };
+      if (this.options.basicAuth) {
+        contextOptions.httpCredentials = this.options.basicAuth;
+        this.isAuthenticated = true;
+      }
       if (this.options.recordVideo) contextOptions.recordVideo = this.options.recordVideo;
       if (this.storageState) contextOptions.storageState = this.storageState;
       this.browserContext = await this.browser.newContext(contextOptions); // Adding the HTTPSError ignore in the context so that we can ignore those errors
@@ -566,7 +571,7 @@ class Playwright extends Helper {
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await this.page;
     this.contextLocator = null;
-    if (this.config.browser === 'chrome') {
+    if (this.options.browser === 'chrome') {
       await page.bringToFront();
     }
   }
@@ -730,9 +735,9 @@ class Playwright extends Helper {
       url = this.options.url + url;
     }
 
-    if (this.config.basicAuth && (this.isAuthenticated !== true)) {
+    if (this.options.basicAuth && (this.isAuthenticated !== true)) {
       if (url.includes(this.options.url)) {
-        await this.browserContext.setHTTPCredentials(this.config.basicAuth);
+        await this.browserContext.setHTTPCredentials(this.options.basicAuth);
         this.isAuthenticated = true;
       }
     }
@@ -795,7 +800,7 @@ class Playwright extends Helper {
     if (!customHeaders) {
       throw new Error('Cannot send empty headers.');
     }
-    return this.page.setExtraHTTPHeaders(customHeaders);
+    return this.browserContext.setExtraHTTPHeaders(customHeaders);
   }
 
   /**
@@ -2565,6 +2570,11 @@ class Playwright extends Helper {
 
   async _failed(test) {
     await this._withinEnd();
+
+    if (!test.artifacts) {
+      test.artifacts = {};
+    }
+
     if (this.options.recordVideo && this.page.video()) {
       test.artifacts.video = await this.page.video().path();
     }

package/docs/build/WebDriver.js

@@ -481,7 +481,7 @@ class WebDriver extends Helper {
     try {
       require('webdriverio');
     } catch (e) {
-      return ['webdriverio@^5.2.2'];
+      return ['webdriverio@^6.12.1'];
     }
   }
 

package/docs/changelog.md

@@ -7,6 +7,42 @@ layout: Section
 
 # Releases
 
+## 3.1.3
+
+🛩️ Features:
+
+* BDD Improvement. Added `DataTableArgument` class to work with table data structures. 
+
+```js
+const { DataTableArgument } = require('codeceptjs');
+//...
+Given('I have an employee card', (table) => {
+  const dataTableArgument = new DataTableArgument(table);
+  const hashes = dataTableArgument.hashes(); 
+  // hashes = [{ name: 'Harry', surname: 'Potter', position: 'Seeker' }];
+  const rows = dataTableArgument.rows();
+  // rows = [['Harry', 'Potter', Seeker]];
+  }
+```
+See updated [BDD section](https://codecept.io/bdd/) for more API options.
+
+* Support `cjs` file extensions for config file: `codecept.conf.cjs`. See [#3052](https://github.com/codeceptjs/CodeceptJS/issues/3052) by **[kalvenschraut](https://github.com/kalvenschraut)**
+* API updates: Added `test.file` and `suite.file` properties to `test` and `suite` objects to use in helpers and plugins. 
+
+🐛 Bugfixes:
+
+* **[Playwright]** Fixed resetting `test.artifacts` for failing tests. See [#3033](https://github.com/codeceptjs/CodeceptJS/issues/3033) by **[jancorvus](https://github.com/jancorvus)**. Fixes [#3032](https://github.com/codeceptjs/CodeceptJS/issues/3032)
+* **[Playwright]** Apply `basicAuth` credentials to all opened browser contexts. See [#3036](https://github.com/codeceptjs/CodeceptJS/issues/3036) by **[nikocanvacom](https://github.com/nikocanvacom)**. Fixes [#3035](https://github.com/codeceptjs/CodeceptJS/issues/3035)
+* **[WebDriver]** Updated `webdriverio` default version to `^6.12.1`. See [#3043](https://github.com/codeceptjs/CodeceptJS/issues/3043) by **[sridhareaswaran](https://github.com/sridhareaswaran)**
+* **[Playwright]** `I.haveRequestHeaders` affects all tabs. See [#3049](https://github.com/codeceptjs/CodeceptJS/issues/3049) by **[jancorvus](https://github.com/jancorvus)**
+* BDD: Fixed unhandled empty feature files. Fix [#3046](https://github.com/codeceptjs/CodeceptJS/issues/3046) by **[abhimanyupandian](https://github.com/abhimanyupandian)** 
+* Fixed `RangeError: Invalid string length` in `recorder.js` when running huge amount of tests.  
+
+📖 Documentation:
+
+* Added Testrail reporter [Reports Docs](https://codecept.io/reports/#testrail)
+
+
 ## 3.1.2
 
 🛩️ Features:

package/docs/commands.md

@@ -47,18 +47,12 @@ Run single test with steps printed
 npx codeceptjs run github_test.js --steps
 ```
 
-Run single test in debug mode
+Run single test in debug mode (see more in [debugging](#Debugging) section)
 
 ```sh
 npx codeceptjs run github_test.js --debug
 ```
 
-Run test with internal logs printed (global promises, and events).
-
-```sh
-npx codeceptjs run github_test.js --verbose
-```
-
 Select config file manually (`-c` or `--config` option)
 
 ```sh
@@ -80,6 +74,26 @@ npx codeceptjs run --reporter xunit
 
 Use any of [Mocha reporters](https://github.com/mochajs/mocha/tree/master/lib/reporters) used.
 
+#### Debugging 
+
+Run single test in debug mode
+
+```sh
+npx codeceptjs run --debug
+```
+
+Run test with internal logs printed.
+
+```sh
+npx codeceptjs run --verbose
+```
+
+Display complete debug output including scheduled promises
+
+```
+DEBUG=codeceptjs:* npx codeceptjs run
+```
+
 ## Run Workers
 
 Run tests in parallel threads.

package/docs/helpers/Appium.md

@@ -245,10 +245,12 @@ Remove an app from the device.
 I.removeApp('appName', 'com.example.android.apis');
 ```
 
+Appium: support only Android
+
 #### Parameters
 
 -   `appId` **[string][4]** 
--   `bundleId` **[string][4]** String  ID of bundleAppium: support only Android
+-   `bundleId` **[string][4]?** ID of bundle
 
 ### seeCurrentActivityIs
 
@@ -473,10 +475,12 @@ I.hideDeviceKeyboard('tapOutside');
 I.hideDeviceKeyboard('pressKey', 'Done');
 ```
 
+Appium: support Android and iOS
+
 #### Parameters
 
--   `strategy` **(`"tapOutside"` \| `"pressKey"`)** desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)Appium: support Android and iOS
--   `key`  
+-   `strategy` **(`"tapOutside"` \| `"pressKey"`)?** Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+-   `key` **[string][4]?** Optional key
 
 ### sendDeviceKeyEvent
 
@@ -685,7 +689,7 @@ Appium: support Android and iOS
 
 #### Parameters
 
--   `actions`  
+-   `actions` **[Array][11]** Array of touch actions
 
 ### pullFile
 
@@ -722,7 +726,7 @@ Perform a rotation gesture centered on the specified element.
 I.rotate(120, 120)
 ```
 
-See corresponding [webdriverio reference][11].
+See corresponding [webdriverio reference][12].
 
 Appium: support only iOS
 
@@ -739,7 +743,7 @@ Appium: support only iOS
 
 Set immediate value in app.
 
-See corresponding [webdriverio reference][12].
+See corresponding [webdriverio reference][13].
 
 Appium: support only iOS
 
@@ -926,7 +930,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+Returns **[Promise][14]<[Array][11]<[string][4]>>** attribute value
 
 ### grabTextFrom
 
@@ -943,7 +947,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[string][4]>** attribute value
+Returns **[Promise][14]<[string][4]>** attribute value
 
 ### grabNumberOfVisibleElements
 
@@ -958,7 +962,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[number][8]>** number of visible elements
+Returns **[Promise][14]<[number][8]>** number of visible elements
 
 ### grabAttributeFrom
 
@@ -977,7 +981,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][13]<[string][4]>** attribute value
+Returns **[Promise][14]<[string][4]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -994,7 +998,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][4]** attribute name.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+Returns **[Promise][14]<[Array][11]<[string][4]>>** attribute value
 
 ### grabValueFromAll
 
@@ -1009,7 +1013,7 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][4] \| [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+Returns **[Promise][14]<[Array][11]<[string][4]>>** attribute value
 
 ### grabValueFrom
 
@@ -1025,7 +1029,7 @@ let email = await I.grabValueFrom('input[name=email]');
 
 -   `locator` **([string][4] \| [object][6])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[string][4]>** attribute value
+Returns **[Promise][14]<[string][4]>** attribute value
 
 ### saveScreenshot
 
@@ -1139,7 +1143,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 #### Parameters
 
 -   `select` **([string][4] \| [object][6])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][4] \| [Array][14]<any>)** visible text or value of option.Supported only for web testing
+-   `option` **([string][4] \| [Array][11]<any>)** visible text or value of option.Supported only for web testing
 
 ### waitForElement
 
@@ -1482,7 +1486,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** HTML code for an element
+Returns **[Promise][14]<[Array][11]<[string][4]>>** HTML code for an element
 
 ### grabHTMLFrom
 
@@ -1499,7 +1503,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][13]<[string][4]>** HTML code for an element
+Returns **[Promise][14]<[string][4]>** HTML code for an element
 
 ### seeTextEquals
 
@@ -1560,7 +1564,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let pageSource = await I.grabSource();
 ```
 
-Returns **[Promise][13]<[string][4]>** source code
+Returns **[Promise][14]<[string][4]>** source code
 
 ### grabBrowserLogs
 
@@ -1572,7 +1576,7 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
-Returns **([Promise][13]<[Array][14]<[object][6]>> | [undefined][19])** all browser logs
+Returns **([Promise][14]<[Array][11]<[object][6]>> | [undefined][19])** all browser logs
 
 ### dontSeeInSource
 
@@ -1697,7 +1701,7 @@ I.type(['T', 'E', 'X', 'T']);
 
 -   `keys`  
 -   `delay` **[number][8]?** (optional) delay in ms between key presses (optional, default `null`)
--   `key` **([string][4] \| [Array][14]<[string][4]>)** or array of keys to type.
+-   `key` **([string][4] \| [Array][11]<[string][4]>)** or array of keys to type.
 
 ### dragAndDrop
 
@@ -1736,7 +1740,7 @@ Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
 const windows = await I.grabAllWindowHandles();
 ```
 
-Returns **[Promise][13]<[Array][14]<[string][4]>>** 
+Returns **[Promise][14]<[Array][11]<[string][4]>>** 
 
 ### grabCurrentWindowHandle
 
@@ -1747,7 +1751,7 @@ Useful for referencing it when calling `I.switchToWindow(handle)`
 const window = await I.grabCurrentWindowHandle();
 ```
 
-Returns **[Promise][13]<[string][4]>** 
+Returns **[Promise][14]<[string][4]>** 
 
 ### switchToWindow
 
@@ -1797,7 +1801,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns **[Promise][13]<[number][8]>** number of open tabs
+Returns **[Promise][14]<[number][8]>** number of open tabs
 
 ### scrollPageToTop
 
@@ -1824,7 +1828,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][13]<PageScrollPosition>** scroll position
+Returns **[Promise][14]<PageScrollPosition>** scroll position
 
 ### setGeoLocation
 
@@ -1850,7 +1854,7 @@ Resumes test execution, so **should be used inside async function with `await`**
 let geoLocation = await I.grabGeoLocation();
 ```
 
-Returns **[Promise][13]<{latitude: [number][8], longitude: [number][8], altitude: [number][8]}>** 
+Returns **[Promise][14]<{latitude: [number][8], longitude: [number][8], altitude: [number][8]}>** 
 
 ### grabElementBoundingRect
 
@@ -1878,7 +1882,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][4]?** x, y, width or height of the given element.
 
-Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element bounding rectangle
+Returns **([Promise][14]<DOMRect> | [Promise][14]<[number][8]>)** Element bounding rectangle
 
 [1]: http://codecept.io/helpers/WebDriver/
 
@@ -1900,13 +1904,13 @@ Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element
 
 [10]: http://webdriver.io/api/mobile/swipe.html
 
-[11]: http://webdriver.io/api/mobile/rotate.html
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[12]: http://webdriver.io/api/mobile/setImmediateValue.html
+[12]: http://webdriver.io/api/mobile/rotate.html
 
-[13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[13]: http://webdriver.io/api/mobile/setImmediateValue.html
 
-[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
 [15]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
 

package/docs/playwright.md

@@ -406,6 +406,11 @@ When a test fails and video was enabled a video file is shown under the `artifac
 
 Open video and use it to debug a failed test case. Video helps when running tests on CI. Configure your CI system to enable artifacts storage for `output/video` and review videos of failed test case to understand failures. 
 
+It is recommended to enable [subtitles](https://codecept.io/plugins/#subtitles) plugin which will generate subtitles from steps in `.srt` format. Subtitles file will be saved into after a video file so video player (like VLC) would load them automatically:
+
+![](https://user-images.githubusercontent.com/220264/131644090-38d1ca55-1ba1-41fa-8fd1-7dea2b7ae995.png)
+
+
 ## Trace <Badge text="Since 3.1" type="warning"/>
 
 If video is not enough to descover why a test failed a [trace](https://playwright.dev/docs/trace-viewer/) can be recorded.
@@ -456,7 +461,7 @@ For instance, this is how you can read a trace for a failed test from an example
 npx playwright show-trace /home/davert/projects/codeceptjs/examples/output/trace/open.zip
 ```
 
-## Capturing code coverage
+## Capturing Code Coverage
 
 Code coverage can be captured, by enabling the `coverage` plugin in `codecept.config.js`.
 
@@ -474,45 +479,23 @@ Once all the tests are completed, `codecept` will create and store coverage in `
 
 ![](https://user-images.githubusercontent.com/16587779/131362352-30ee9c51-705f-4098-b665-53035ea9275f.png)
 
-### Converting `playwright` coverage to `istanbul` coverage
-
-To convert coverage generated from `playwright` to `istanbul` coverage, you first need to install
-- [`v8-to-istanbul`](https://www.npmjs.com/package/v8-to-istanbul)
-
-Once installed, convert the coverage to a format which `istanbul` can recognize, by writing a script as shown below.
-
-```js
-const v8toIstanbul = require('v8-to-istanbul');
-// read all the coverage file from output/coverage folder
-const coverage = require('./output/coverage/Visit_Home_1630335005.coverage.json');
-const fs = require('fs/promises');
-
-(async () => {
-    for (const entry of coverage) {
-        // Used to get file name
-        const file = entry.url.match(/(?:http(s)*:\/\/.*\/)(?<file>.*)/);
-        const converter = new v8toIstanbul(file.groups.file, 0, {
-            source: entry.source
-        });
-
-        await converter.load();
-        converter.applyCoverage(entry.functions);
-
-        // Store converted coverage file which can later be used to generate report
-        await fs.writeFile('./coverage/final.json', JSON.stringify(converter.toIstanbul(), null, 2));
-    }
-})();
-```
+Then you need to [convert code coverage from Playwright's format into Istanbul format](https://github.com/codeceptjs/CodeceptJS/wiki/Converting-Playwright-to-Istanbul-Coverage).
 
 Once the istanbul compatible coverage is generated, use [`nyc`](https://www.npmjs.com/package/nyc) to generate your coverage report in your desired format.
 
 ```
-npx nyc report --reporter text -t coverage
+npx nyc report --reporter html -t coverage
 ```
 
-The above command will generate a text report like shown below.
+The above command will generate will generate coverage in an interactive html format. It should generate `html` files in the directory where your code coverage is present, something like shown below.
+
+![](https://user-images.githubusercontent.com/16587779/131858419-cbc7df7d-0851-47b9-b086-b5e3b9165674.png)
+
+Open `index.html` in your browser to view the full interactive coverage report.
+
+![](https://user-images.githubusercontent.com/16587779/131858993-87d1aafc-8ef1-4a82-867d-e64a13e36106.png)
 
-![](https://user-images.githubusercontent.com/16587779/131363170-b03b4398-5e9a-4142-bc32-764a5f4a5e11.png)
+![](https://user-images.githubusercontent.com/16587779/131859006-c6f17d18-c603-44a5-9d59-0670177276cf.png)
 ## Extending Helper
 
 To create custom `I.*` commands using Playwright API you need to create a custom helper.

package/docs/plugins.md

@@ -417,7 +417,7 @@ Dumps code coverage from Playwright/Puppeteer after every test.
 
 ```js
 plugins: {
-   playwrightCoverage: {
+   coverage: {
      enabled: true
    }
 }

package/docs/reports.md

@@ -7,8 +7,8 @@ title: Reporters
 
 ## Cli
 
-By default CodeceptJS provides cli reporter with console output.
-Test names and failures will be printed to screen.
+By default, CodeceptJS provides cli reporter with console output.
+Test names and failures will be printed out on screen.
 
 ```sh
 GitHub --
@@ -201,7 +201,7 @@ npx codeceptjs dry-run --debug -p allure
 
 ## ReportPortal
 
-Allure is a great reportin tool, however, if you are running tests on different machines it is hard to merge its XML result files to build a proper report. So, for enterprise grade reporting we recommend using [ReportPortal](https://reportportal.io).
+Allure is a great reporting tool, however, if you are running tests on different machines it is hard to merge its XML result files to build a proper report. So, for enterprise grade reporting we recommend using [ReportPortal](https://reportportal.io).
 
 ![](https://camo.githubusercontent.com/6550c0365f1d0ce1e29c53f1860b12957d1fc529/68747470733a2f2f692e6962622e636f2f516d353247306e2f53637265656e73686f742d323031392d30342d31312d61742d31352d35372d34302e706e67)
 
@@ -376,3 +376,21 @@ npx codeceptjs run --reporter mocha-multi
 ```
 
 This will give you cli with steps in console and HTML report in `output` directory.
+
+
+## Testrail
+
+Testrail integration with CodeceptJS is now so seamless. The test run is created automatically afterwards. The screenshots of failed tests are also attached to test results.
+
+Try to use [codeceptjs-testrail](https://www.npmjs.com/package/codeceptjs-testrail) plugin
+
+Install it via NPM:
+
+```sh
+npm i codeceptjs-testrail --save
+```
+
+![Attachemnt for failed case](http://g.recordit.co/ajaa2QRlnW.gif)
+
+Now there is new feature, add the configuration to test run of test plan
+![Attachemnt for failed case](http://g.recordit.co/uQLvQUq7cT.gif)

package/lib/actor.js

@@ -28,7 +28,7 @@ class Actor {
 
   /**
    * @function
-   * @param {*} opts
+   * @param {*} [opts]
    * @return {this}
    * @inner
    */

package/lib/config.js

@@ -128,7 +128,7 @@ function loadConfigFile(configFile) {
   const extensionName = path.extname(configFile);
 
   // .conf.js config file
-  if (extensionName === '.js' || extensionName === '.ts') {
+  if (extensionName === '.js' || extensionName === '.ts' || extensionName === '.cjs') {
     return Config.create(require(configFile).config);
   }
 

package/lib/data/dataTableArgument.js

@@ -1,4 +1,9 @@
+/**
+ * DataTableArgument class to store the Cucumber data table from
+ * a step as an object with methods that can be used to access the data.
+ */
 class DataTableArgument {
+  /** @param {*} gherkinDataTable */
   constructor(gherkinDataTable) {
     this.rawData = gherkinDataTable.rows.map((row) => {
       return row.cells.map((cell) => {
@@ -7,16 +12,25 @@ class DataTableArgument {
     });
   }
 
+  /** Returns the table as a 2-D array
+  * @returns {string[][]}
+  */
   raw() {
     return this.rawData.slice(0);
   }
 
+  /** Returns the table as a 2-D array, without the first row
+  * @returns {string[][]}
+  */
   rows() {
     const copy = this.raw();
     copy.shift();
     return copy;
   }
 
+  /** Returns an array of objects where each row is converted to an object (column header is the key)
+  * @returns {any[]}
+  */
   hashes() {
     const copy = this.raw();
     const header = copy.shift();
@@ -26,6 +40,27 @@ class DataTableArgument {
       return r;
     });
   }
+
+  /** Returns an object where each row corresponds to an entry
+   * (first column is the key, second column is the value)
+  * @returns {Record<string, string>}
+  */
+  rowsHash() {
+    const rows = this.raw();
+    const everyRowHasTwoColumns = rows.every((row) => row.length === 2);
+    if (!everyRowHasTwoColumns) {
+      throw new Error('rowsHash can only be called on a data table where all rows have exactly two columns');
+    }
+    /** @type {Record<string, string>} */
+    const result = {};
+    rows.forEach((x) => (result[x[0]] = x[1]));
+    return result;
+  }
+
+  /** Transposed the data */
+  transpose() {
+    this.rawData = this.rawData[0].map((x, i) => this.rawData.map((y) => y[i]));
+  }
 }
 
 module.exports = DataTableArgument;

package/lib/helper/Appium.js

@@ -481,10 +481,11 @@ class Appium extends Webdriver {
    * ```js
    * I.removeApp('appName', 'com.example.android.apis');
    * ```
-   * @param {string} appId
-   * @param {string}  bundleId String  ID of bundle
    *
    * Appium: support only Android
+   *
+   * @param {string} appId
+   * @param {string} [bundleId] ID of bundle
    */
   async removeApp(appId, bundleId) {
     onlyForApps.call(this, 'Android');
@@ -820,9 +821,10 @@ class Appium extends Webdriver {
    * I.hideDeviceKeyboard('pressKey', 'Done');
    * ```
    *
-   * @param {'tapOutside' | 'pressKey'} strategy  desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-   *
    * Appium: support Android and iOS
+   *
+   * @param {'tapOutside' | 'pressKey'} [strategy] Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+   * @param {string} [key] Optional key
    */
   async hideDeviceKeyboard(strategy, key) {
     onlyForApps.call(this);
@@ -1162,6 +1164,8 @@ class Appium extends Webdriver {
    * ```
    *
    * Appium: support Android and iOS
+   *
+   * @param {Array} actions Array of touch actions
    */
   async touchPerform(actions) {
     onlyForApps.call(this);

package/lib/helper/Playwright.js

@@ -354,6 +354,7 @@ class Playwright extends Helper {
     if (this.options.restart && !this.options.manualStart) await this._startBrowser();
     if (!this.isRunning && !this.options.manualStart) await this._startBrowser();
 
+    this.isAuthenticated = false;
     if (this.isElectron) {
       this.browserContext = this.browser.context();
     } else if (this.userDataDir) {
@@ -364,6 +365,10 @@ class Playwright extends Helper {
         acceptDownloads: true,
         ...this.options.emulate,
       };
+      if (this.options.basicAuth) {
+        contextOptions.httpCredentials = this.options.basicAuth;
+        this.isAuthenticated = true;
+      }
       if (this.options.recordVideo) contextOptions.recordVideo = this.options.recordVideo;
       if (this.storageState) contextOptions.storageState = this.storageState;
       this.browserContext = await this.browser.newContext(contextOptions); // Adding the HTTPSError ignore in the context so that we can ignore those errors
@@ -559,7 +564,7 @@ class Playwright extends Helper {
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await this.page;
     this.contextLocator = null;
-    if (this.config.browser === 'chrome') {
+    if (this.options.browser === 'chrome') {
       await page.bringToFront();
     }
   }
@@ -714,9 +719,9 @@ class Playwright extends Helper {
       url = this.options.url + url;
     }
 
-    if (this.config.basicAuth && (this.isAuthenticated !== true)) {
+    if (this.options.basicAuth && (this.isAuthenticated !== true)) {
       if (url.includes(this.options.url)) {
-        await this.browserContext.setHTTPCredentials(this.config.basicAuth);
+        await this.browserContext.setHTTPCredentials(this.options.basicAuth);
         this.isAuthenticated = true;
       }
     }
@@ -775,7 +780,7 @@ class Playwright extends Helper {
     if (!customHeaders) {
       throw new Error('Cannot send empty headers.');
     }
-    return this.page.setExtraHTTPHeaders(customHeaders);
+    return this.browserContext.setExtraHTTPHeaders(customHeaders);
   }
 
   /**
@@ -1851,6 +1856,11 @@ class Playwright extends Helper {
 
   async _failed(test) {
     await this._withinEnd();
+
+    if (!test.artifacts) {
+      test.artifacts = {};
+    }
+
     if (this.options.recordVideo && this.page.video()) {
       test.artifacts.video = await this.page.video().path();
     }

package/lib/helper/WebDriver.js

@@ -481,7 +481,7 @@ class WebDriver extends Helper {
     try {
       require('webdriverio');
     } catch (e) {
-      return ['webdriverio@^5.2.2'];
+      return ['webdriverio@^6.12.1'];
     }
   }
 

package/lib/index.js

@@ -32,6 +32,8 @@ module.exports = {
   within: require('./within'),
   /**  @type {typeof CodeceptJS.DataTable} */
   dataTable: require('./data/table'),
+  /**  @type {typeof CodeceptJS.DataTableArgument} */
+  dataTableArgument: require('./data/dataTableArgument'),
   /** @type {typeof CodeceptJS.store} */
   store: require('./store'),
   /** @type {typeof CodeceptJS.Locator} */

package/lib/interfaces/gherkin.js

@@ -11,15 +11,19 @@ const transform = require('../transform');
 const parser = new Parser();
 parser.stopAtFirstError = false;
 
-module.exports = (text) => {
+module.exports = (text, file) => {
   const ast = parser.parse(text);
 
+  if (!ast.feature) {
+    throw new Error(`No 'Features' available in Gherkin '${file}' provided!`);
+  }
   const suite = new Suite(ast.feature.name, new Context());
   const tags = ast.feature.tags.map(t => t.name);
   suite.title = `${suite.title} ${tags.join(' ')}`.trim();
   suite.tags = tags || [];
   suite.comment = ast.feature.description;
   suite.feature = ast.feature;
+  suite.file = file;
   suite.timeout(0);
 
   suite.beforeEach('codeceptjs.before', () => scenario.setup(suite));
@@ -95,6 +99,7 @@ module.exports = (text) => {
           const title = `${child.name} ${JSON.stringify(current)} ${tags.join(' ')}`.trim();
           const test = new Test(title, async () => runSteps(addExampleInTable(exampleSteps, current)));
           test.tags = suite.tags.concat(tags);
+          test.file = file;
           suite.addTest(scenario.test(test));
         }
       }
@@ -104,6 +109,7 @@ module.exports = (text) => {
     const title = `${child.name} ${tags.join(' ')}`.trim();
     const test = new Test(title, async () => runSteps(child.steps));
     test.tags = suite.tags.concat(tags);
+    test.file = file;
     suite.addTest(scenario.test(test));
   }
 

package/lib/listener/helpers.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const event = require('../event');
 const container = require('../container');
 const recorder = require('../recorder');

package/lib/mochaFactory.js

@@ -2,7 +2,7 @@ const Mocha = require('mocha');
 const fsPath = require('path');
 const fs = require('fs');
 const reporter = require('./cli');
-const gherkinParser = require('./interfaces/gherkin.js');
+const gherkinParser = require('./interfaces/gherkin');
 const output = require('./output');
 const { genTestId } = require('./utils');
 const ConnectionRefused = require('./helper/errors/ConnectionRefused');
@@ -35,8 +35,7 @@ class MochaFactory {
       if (mocha.suite.suites.length === 0) {
         mocha.files
           .filter(file => file.match(/\.feature$/))
-          .map(file => fs.readFileSync(file, 'utf8'))
-          .forEach(content => mocha.suite.addSuite(gherkinParser(content)));
+          .forEach(file => mocha.suite.addSuite(gherkinParser(fs.readFileSync(file, 'utf8'), file)));
 
         // remove feature files
         mocha.files = mocha.files.filter(file => !file.match(/\.feature$/));

package/lib/plugin/coverage.js

@@ -48,7 +48,7 @@ function buildFileName(test, uniqueFileName) {
  *
  * ```js
  * plugins: {
- *    playwrightCoverage: {
+ *    coverage: {
  *      enabled: true
  *    }
  * }

package/lib/recorder.js

@@ -3,6 +3,8 @@ const promiseRetry = require('promise-retry');
 
 const { log } = require('./output');
 
+const MAX_TASKS = 100;
+
 let promise;
 let running = false;
 let errFn;
@@ -172,7 +174,7 @@ module.exports = {
       return;
     }
     tasks.push(taskName);
-    debug(`${currentQueue()}Queued | ${taskName}`);
+    if (process.env.DEBUG) debug(`${currentQueue()}Queued | ${taskName}`);
 
     return promise = Promise.resolve(promise).then((res) => {
       const retryOpts = this.retries.slice(-1).pop();
@@ -296,7 +298,7 @@ module.exports = {
    * @inner
    */
   stop() {
-    debug(this.toString());
+    if (process.env.DEBUG) debug(this.toString());
     log(`${currentQueue()}Stopping recording promises`);
     running = false;
   },
@@ -318,7 +320,7 @@ module.exports = {
    * @inner
    */
   scheduled() {
-    return tasks.join('\n');
+    return tasks.slice(-MAX_TASKS).join('\n');
   },
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",

package/typings/index.d.ts

@@ -111,6 +111,7 @@ declare const pause: typeof CodeceptJS.pause;
 declare const within: typeof CodeceptJS.within;
 declare const session: typeof CodeceptJS.session;
 declare const DataTable: typeof CodeceptJS.DataTable;
+declare const DataTableArgument: typeof CodeceptJS.DataTableArgument;
 declare const codeceptjs: typeof CodeceptJS.index;
 declare const locate: typeof CodeceptJS.Locator.build;
 declare function inject(): CodeceptJS.SupportObject;
@@ -160,6 +161,7 @@ declare namespace NodeJS {
     within: typeof within;
     session: typeof session;
     DataTable: typeof DataTable;
+    DataTableArgument: typeof DataTableArgument;
     locate: typeof locate;
     inject: typeof inject;
     secret: typeof secret;

package/typings/types.d.ts

@@ -321,11 +321,11 @@ declare namespace CodeceptJS {
          * ```js
          * I.removeApp('appName', 'com.example.android.apis');
          * ```
-         * @param bundleId - String  ID of bundle
          *
          * Appium: support only Android
+         * @param [bundleId] - ID of bundle
          */
-        removeApp(appId: string, bundleId: string): void;
+        removeApp(appId: string, bundleId?: string): void;
         /**
          * Check current activity on an Android device.
          *
@@ -522,11 +522,12 @@ declare namespace CodeceptJS {
          * // or by pressing key
          * I.hideDeviceKeyboard('pressKey', 'Done');
          * ```
-         * @param strategy - desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
          *
          * Appium: support Android and iOS
+         * @param [strategy] - Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
+         * @param [key] - Optional key
          */
-        hideDeviceKeyboard(strategy: 'tapOutside' | 'pressKey'): void;
+        hideDeviceKeyboard(strategy?: 'tapOutside' | 'pressKey', key?: string): void;
         /**
          * Send a key event to the device.
          * List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
@@ -682,8 +683,9 @@ declare namespace CodeceptJS {
          * ```
          *
          * Appium: support Android and iOS
+         * @param actions - Array of touch actions
          */
-        touchPerform(): void;
+        touchPerform(actions: any[]): void;
         /**
          * Pulls a file from the device.
          *
@@ -9803,7 +9805,7 @@ declare namespace CodeceptJS {
          * add print comment method`
          */
         say(msg: string, color?: string): Promise<any> | undefined;
-        retry(opts: any): this;
+        retry(opts?: any): this;
     }
     /**
      * Create CodeceptJS runner.
@@ -9947,6 +9949,34 @@ declare namespace CodeceptJS {
         xadd(array: any[]): void;
         filter(func: (...params: any[]) => any): void;
     }
+    /**
+     * DataTableArgument class to store the Cucumber data table from
+     * a step as an object with methods that can be used to access the data.
+     */
+    class DataTableArgument {
+        constructor(gherkinDataTable: any);
+        /**
+         * Returns the table as a 2-D array
+         */
+        raw(): string[][];
+        /**
+         * Returns the table as a 2-D array, without the first row
+         */
+        rows(): string[][];
+        /**
+         * Returns an array of objects where each row is converted to an object (column header is the key)
+         */
+        hashes(): any[];
+        /**
+         * Returns an object where each row corresponds to an entry
+         * (first column is the key, second column is the value)
+         */
+        rowsHash(): Record<string, string>;
+        /**
+         * Transposed the data
+         */
+        transpose(): void;
+    }
     namespace event {
         const dispatcher: NodeJS.EventEmitter;
         const test: {
@@ -10043,6 +10073,7 @@ declare namespace CodeceptJS {
         var pause: typeof CodeceptJS.pause;
         var within: typeof CodeceptJS.within;
         var dataTable: typeof CodeceptJS.DataTable;
+        var dataTableArgument: typeof CodeceptJS.DataTableArgument;
         var store: typeof CodeceptJS.store;
         var locator: typeof CodeceptJS.Locator;
     }