codeceptjs 3.1.1 → 3.1.2

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 3.1.2
+
+🛩️ Features:
+
+* Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By @anirudh-modi
+* Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By @anirudh-modi
+* Configuration: `config.tests` to accept array of file patterns. See #2994 by @monsteramba
+
+```js
+exports.config = {
+  tests: ['./*_test.js','./sampleTest.js'],
+  // ... 
+}
+```
+* Notification is shown for test files without `Feature()`. See #3011 by @PeterNgTr
+
+🐛 Bugfixes:
+
+* [Playwright] Fixed #2986 error is thrown when deleting a missing video. Fix by @hatufacci 
+* Fixed false positive result when invalid function is called in a helper. See #2997 by @abhimanyupandian
+* [Appium] Removed full page mode for `saveScreenshot`. See #3002 by @nlespiaucq
+* [Playwright] Fixed #3003 saving trace for a test with a long name. Fix by @hatufacci 
+
+🎱 Other:
+
+* Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin.
+
 ## 3.1.1
 
 * [Appium] Fixed #2759

package/docs/build/Appium.js

@@ -1551,6 +1551,20 @@ class Appium extends Webdriver {
     return super.grabValueFrom(parseLocator.call(this, locator));
   }
 
+  /**
+   * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   *
+   * ```js
+   * I.saveScreenshot('debug.png');
+   * ```
+   *
+   * @param {string} fileName file name to save.
+   */
+  async saveScreenshot(fileName) {
+    return super.saveScreenshot(fileName, false);
+  }
+
   /**
    * Scroll element into viewport.
    * 

package/docs/build/Playwright.js

@@ -2570,7 +2570,7 @@ class Playwright extends Helper {
     }
 
     if (this.options.trace) {
-      const path = `${global.output_dir}/trace/${clearString(test.title)}.zip`;
+      const path = `${global.output_dir}/trace/${clearString(test.title).slice(0, 255)}.zip`;
       await this.browserContext.tracing.stop({ path });
       test.artifacts.trace = path;
     }
@@ -2581,7 +2581,7 @@ class Playwright extends Helper {
       if (this.options.keepVideoForPassedTests) {
         test.artifacts.video = await this.page.video().path();
       } else {
-        this.page.video().delete();
+        this.page.video().delete().catch(e => {});
       }
     }
 

package/docs/build/Puppeteer.js

@@ -129,8 +129,9 @@ const consoleLogStore = new Console();
  *    }
  * }
  * ```
+ * > Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
-* #### Example #5: Target URL with provided basic authentication
+ * #### Example #5: Target URL with provided basic authentication
  *
  * ```js
  * {
@@ -143,10 +144,25 @@ const consoleLogStore = new Console();
  *    }
  * }
  * ```
+ * #### Troubleshooting
  *
+ * Error Message:  `No usable sandbox!`
+ *
+ * When running Puppeteer on CI try to disable sandbox if you see that message
+ *
+ * ```
+ * helpers: {
+ *  Puppeteer: {
+ *     url: 'http://localhost',
+ *     show: false,
+ *     chrome: {
+ *       args: ['--no-sandbox', '--disable-setuid-sandbox']
+ *     }
+ *   },
+ * }
+ * ```
  *
  *
- * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
  * ## Access From Helpers
  *

package/docs/changelog.md

@@ -7,6 +7,33 @@ layout: Section
 
 # Releases
 
+## 3.1.2
+
+🛩️ Features:
+
+* Added `coverage` plugin to generate code coverage for Playwright & Puppeteer. By **[anirudh-modi](https://github.com/anirudh-modi)**
+* Added `subtitle` plugin to generate subtitles for videos recorded with Playwright. By **[anirudh-modi](https://github.com/anirudh-modi)**
+* Configuration: `config.tests` to accept array of file patterns. See [#2994](https://github.com/codeceptjs/CodeceptJS/issues/2994) by **[monsteramba](https://github.com/monsteramba)**
+
+```js
+exports.config = {
+  tests: ['./*_test.js','./sampleTest.js'],
+  // ... 
+}
+```
+* Notification is shown for test files without `Feature()`. See [#3011](https://github.com/codeceptjs/CodeceptJS/issues/3011) by **[PeterNgTr](https://github.com/PeterNgTr)**
+
+🐛 Bugfixes:
+
+* **[Playwright]** Fixed [#2986](https://github.com/codeceptjs/CodeceptJS/issues/2986) error is thrown when deleting a missing video. Fix by **[hatufacci](https://github.com/hatufacci)** 
+* Fixed false positive result when invalid function is called in a helper. See [#2997](https://github.com/codeceptjs/CodeceptJS/issues/2997) by **[abhimanyupandian](https://github.com/abhimanyupandian)**
+* **[Appium]** Removed full page mode for `saveScreenshot`. See [#3002](https://github.com/codeceptjs/CodeceptJS/issues/3002) by **[nlespiaucq](https://github.com/nlespiaucq)**
+* **[Playwright]** Fixed [#3003](https://github.com/codeceptjs/CodeceptJS/issues/3003) saving trace for a test with a long name. Fix by **[hatufacci](https://github.com/hatufacci)** 
+
+🎱 Other:
+
+* Deprecated `puppeteerCoverage` plugin in favor of `coverage` plugin.
+
 ## 3.1.1
 
 * **[Appium]** Fixed [#2759](https://github.com/codeceptjs/CodeceptJS/issues/2759)

package/docs/configuration.md

@@ -11,7 +11,7 @@ After running `codeceptjs init` it should be saved in test root.
 
 Here is an overview of available options with their defaults:
 
-* **tests**: `"./*_test.js"` - pattern to locate tests. Allows to enter [glob pattern](https://github.com/isaacs/node-glob).
+* **tests**: `"./*_test.js"` - pattern to locate tests. Allows to enter [glob pattern](https://github.com/isaacs/node-glob), Can either be a pattern to locate tests or an array of patterns to locate tests / test file names.
 * **grep**: - pattern to filter tests by name
 * **include**: `{}` - actors and page objects to be registered in DI container and included in tests. Accepts objects and module `require` paths
 * **timeout**: `10000` - default tests timeout
@@ -47,7 +47,20 @@ exports.config = {
   require: ["ts-node/register", "should"]
 }
 ```
-
+For array of test pattern
+```js
+exports.config = {
+  tests: ['./*_test.js','./sampleTest.js'],
+  timeout: 10000,
+  output: '',
+  helpers: {},
+  include: {},
+  bootstrap: false,
+  mocha: {},
+  // require modules
+  require: ["ts-node/register", "should"]
+}
+```
 ## Dynamic Configuration
 
  By default `codecept.json` is used for configuration. You can override its values in runtime by using `--override` or `-o` option in command line, passing valid JSON as a value:

package/docs/helpers/Appium.md

@@ -1027,6 +1027,19 @@ let email = await I.grabValueFrom('input[name=email]');
 
 Returns **[Promise][13]<[string][4]>** attribute value
 
+### saveScreenshot
+
+Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+Filename is relative to output folder.
+
+```js
+I.saveScreenshot('debug.png');
+```
+
+#### Parameters
+
+-   `fileName` **[string][4]** file name to save.
+
 ### scrollIntoView
 
 Scroll element into viewport.
@@ -1663,27 +1676,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][4]** file name to save.
 
-### saveScreenshot
-
-Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder.
-Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
-
-```js
-I.saveScreenshot('debug.png');
-I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
-```
-
-#### Parameters
-
--   `fileName` **[string][4]** file name to save.
--   `fullPage` **[boolean][20]** (optional, `false` by default) flag to enable fullscreen screenshot mode. (optional, default `false`)
-
 ### type
 
 Types out the given text into an active field.
 To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`][21] is not an option.
+_Note:_ Should be used when [`fillField`][20] is not an option.
 
 ```js
 // passing in a string
@@ -1921,6 +1918,4 @@ Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element
 
 [19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[21]: #fillfield
+[20]: #fillfield

package/docs/helpers/Puppeteer.md

@@ -101,6 +101,8 @@ This helper should be configured in codecept.json or codecept.conf.js
 }
 ```
 
+> Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
+
 #### Example #5: Target URL with provided basic authentication
 
 ```js
@@ -115,7 +117,21 @@ This helper should be configured in codecept.json or codecept.conf.js
 }
 ```
 
-Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
+#### Troubleshooting
+
+Error Message:  `No usable sandbox!`
+
+When running Puppeteer on CI try to disable sandbox if you see that message
+
+    helpers: {
+     Puppeteer: {
+        url: 'http://localhost',
+        show: false,
+        chrome: {
+          args: ['--no-sandbox', '--disable-setuid-sandbox']
+        }
+      },
+    }
 
 ## Access From Helpers
 

package/docs/playwright.md

@@ -456,6 +456,63 @@ 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
+
+Code coverage can be captured, by enabling the `coverage` plugin in `codecept.config.js`.
+
+```js
+{
+  plugins: {
+    coverage: {
+      enabled: true
+    }
+  }
+}
+```
+
+Once all the tests are completed, `codecept` will create and store coverage in `output/coverage` folder, as shown below.
+
+![](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));
+    }
+})();
+```
+
+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
+```
+
+The above command will generate a text report like shown below.
+
+![](https://user-images.githubusercontent.com/16587779/131363170-b03b4398-5e9a-4142-bc32-764a5f4a5e11.png)
 ## Extending Helper
 
 To create custom `I.*` commands using Playwright API you need to create a custom helper.

package/docs/plugins.md

@@ -409,6 +409,29 @@ Scenario('project update test', async (I) => {
 
 -   `config`  
 
+## coverage
+
+Dumps code coverage from Playwright/Puppeteer after every test.
+
+#### Configuration
+
+```js
+plugins: {
+   playwrightCoverage: {
+     enabled: true
+   }
+}
+```
+
+Possible config options:
+
+-   `coverageDir`: directory to dump coverage files
+-   `uniqueFileName`: generate a unique filename by adding uuid
+
+### Parameters
+
+-   `config`  
+
 ## customLocator
 
 Creates a [custom locator][3] by using special attributes in HTML.
@@ -441,7 +464,7 @@ Using `data-test` attribute with `$` prefix:
 // in codecept.conf.js
 plugins: {
  customLocator: {
-   enabled: true
+   enabled: true,
    attribute: 'data-test'
  }
 }
@@ -460,7 +483,7 @@ Using `data-qa` attribute with `=` prefix:
 // in codecept.conf.js
 plugins: {
  customLocator: {
-   enabled: true
+   enabled: true,
    prefix: '=',
    attribute: 'data-qa'
  }
@@ -536,45 +559,6 @@ Enable it manually on each run via `-p` option:
 
     npx codeceptjs run -p pauseOnFail
 
-## puppeteerCoverage
-
-Dumps puppeteers code coverage after every test.
-
-#### Configuration
-
-Configuration can either be taken from a corresponding helper (deprecated) or a from plugin config (recommended).
-
-```js
-plugins: {
-   puppeteerCoverage: {
-     enabled: true
-   }
-}
-```
-
-Possible config options:
-
--   `coverageDir`: directory to dump coverage files
--   `uniqueFileName`: generate a unique filename by adding uuid
-
-    First of all, your mileage may vary!
-
-    To work, you need the client javascript code to be NOT uglified. They need to be built in "development" mode.
-    And the end of your tests, you'll get a directory full of coverage per test run.  Now what?
-    You'll need to convert the coverage code to something istanbul can read.  Good news is someone wrote the code
-    for you (see puppeteer-to-istanbul link below).  Then using istanbul you need to combine the converted
-    coverage and create a report.  Good luck!
-
-    Links:
-
--   [https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage][7]
--   [https://github.com/istanbuljs/puppeteer-to-istanbul][8]
--   [https://github.com/gotwarlost/istanbul][9]
-
-### Parameters
-
--   `config`  
-
 ## retryFailedStep
 
 Retries each failed step in a test.
@@ -673,14 +657,14 @@ Possible config options:
 
 ## selenoid
 
-[Selenoid][10] plugin automatically starts browsers and video recording.
+[Selenoid][7] 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 the official [Configuration Manager][11] tool from Selenoid
+> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][8] tool from Selenoid
 
 ### Usage
 
@@ -709,7 +693,7 @@ plugins: {
   }
 ```
 
-When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][12] and start Selenoid automatically.
+When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][9] 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.
@@ -721,10 +705,10 @@ In automatic mode the latest version of browser will be used for tests. It is re
 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][11] to create and start containers semi-automatically.
+> Use [Selenoid Configuration Manager][8] 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][13] to know more about browsers.json.
+    [Refer to Selenoid documentation][10] to know more about browsers.json.
 
 _Sample browsers.json_
 
@@ -749,7 +733,7 @@ _Sample browsers.json_
 
 2.  Create Selenoid container
 
-Run the following command to create a container. To know more [refer here][14]
+Run the following command to create a container. To know more [refer here][11]
 
 ```bash
 docker create                                    \
@@ -782,7 +766,7 @@ When `allure` plugin is enabled a video is attached to report automatically.
 | 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][15] to know more   |
+| additionalParams | example: `additionalParams: '--env TEST=test'` [Refer here][12] to know more   |
 
 ### Parameters
 
@@ -790,7 +774,7 @@ When `allure` plugin is enabled a video is attached to report automatically.
 
 ## stepByStepReport
 
-![step-by-step-report][16]
+![step-by-step-report][13]
 
 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.
@@ -823,6 +807,20 @@ Possible config options:
 
 -   `config` **any** 
 
+## subtitles
+
+Automatically captures steps as subtitle, and saves it as an artifact when a video is found for a failed test
+
+#### Configuration
+
+```js
+plugins: {
+ subtitles: {
+   enabled: true
+ }
+}
+```
+
 ## tryTo
 
 Adds global `tryTo` function inside of which all failed steps won't fail a test but will return true/false.
@@ -897,7 +895,7 @@ This plugin allows to run webdriverio services like:
 -   browserstack
 -   appium
 
-A complete list of all available services can be found on [webdriverio website][17].
+A complete list of all available services can be found on [webdriverio website][14].
 
 #### Setup
 
@@ -909,7 +907,7 @@ See examples below:
 
 #### Selenium Standalone Service
 
-Install `@wdio/selenium-standalone-service` package, as [described here][18].
+Install `@wdio/selenium-standalone-service` package, as [described here][15].
 It is important to make sure it is compatible with current webdriverio version.
 
 Enable `wdio` plugin in plugins list and add `selenium-standalone` service:
@@ -928,7 +926,7 @@ Please note, this service can be used with Protractor helper as well!
 
 #### Sauce Service
 
-Install `@wdio/sauce-service` package, as [described here][19].
+Install `@wdio/sauce-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 `sauce` service:
@@ -970,28 +968,22 @@ In the same manner additional services from webdriverio can be installed, enable
 
 [6]: /basics/#pause
 
-[7]: https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage
-
-[8]: https://github.com/istanbuljs/puppeteer-to-istanbul
-
-[9]: https://github.com/gotwarlost/istanbul
-
-[10]: https://aerokube.com/selenoid/
+[7]: https://aerokube.com/selenoid/
 
-[11]: https://aerokube.com/cm/latest/
+[8]: https://aerokube.com/cm/latest/
 
-[12]: https://hub.docker.com/u/selenoid
+[9]: https://hub.docker.com/u/selenoid
 
-[13]: https://aerokube.com/selenoid/latest/#_prepare_configuration
+[10]: https://aerokube.com/selenoid/latest/#_prepare_configuration
 
-[14]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container
+[11]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container
 
-[15]: https://docs.docker.com/engine/reference/commandline/create/
+[12]: https://docs.docker.com/engine/reference/commandline/create/
 
-[16]: https://codecept.io/img/codeceptjs-slideshow.gif
+[13]: https://codecept.io/img/codeceptjs-slideshow.gif
 
-[17]: https://webdriver.io
+[14]: https://webdriver.io
 
-[18]: https://webdriver.io/docs/selenium-standalone-service.html
+[15]: https://webdriver.io/docs/selenium-standalone-service.html
 
-[19]: https://webdriver.io/docs/sauce-service.html
+[16]: https://webdriver.io/docs/sauce-service.html

package/lib/codecept.js

@@ -130,7 +130,16 @@ class Codecept {
     let patterns = [pattern];
     if (!pattern) {
       patterns = [];
-      if (this.config.tests && !this.opts.features) patterns.push(this.config.tests);
+
+      // If the user wants to test a specific set of test files as an array or string.
+      if (this.config.tests && !this.opts.features) {
+        if (Array.isArray(this.config.tests)) {
+          patterns.push(...this.config.tests);
+        } else {
+          patterns.push(this.config.tests);
+        }
+      }
+
       if (this.config.gherkin.features && !this.opts.tests) {
         if (Array.isArray(this.config.gherkin.features)) {
           this.config.gherkin.features.forEach(feature => {
@@ -147,7 +156,9 @@ class Codecept {
         if (!fsPath.isAbsolute(file)) {
           file = fsPath.join(global.codecept_dir, file);
         }
-        this.testFiles.push(fsPath.resolve(file));
+        if (!this.testFiles.includes(fsPath.resolve(file))) {
+          this.testFiles.push(fsPath.resolve(file));
+        }
       });
     }
   }

package/lib/helper/Appium.js

@@ -1397,6 +1397,20 @@ class Appium extends Webdriver {
     return super.grabValueFrom(parseLocator.call(this, locator));
   }
 
+  /**
+   * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   *
+   * ```js
+   * I.saveScreenshot('debug.png');
+   * ```
+   *
+   * @param {string} fileName file name to save.
+   */
+  async saveScreenshot(fileName) {
+    return super.saveScreenshot(fileName, false);
+  }
+
   /**
    * {{> scrollIntoView }}
    *

package/lib/helper/Playwright.js

@@ -1856,7 +1856,7 @@ class Playwright extends Helper {
     }
 
     if (this.options.trace) {
-      const path = `${global.output_dir}/trace/${clearString(test.title)}.zip`;
+      const path = `${global.output_dir}/trace/${clearString(test.title).slice(0, 255)}.zip`;
       await this.browserContext.tracing.stop({ path });
       test.artifacts.trace = path;
     }
@@ -1867,7 +1867,7 @@ class Playwright extends Helper {
       if (this.options.keepVideoForPassedTests) {
         test.artifacts.video = await this.page.video().path();
       } else {
-        this.page.video().delete();
+        this.page.video().delete().catch(e => {});
       }
     }
 

package/lib/helper/Puppeteer.js

@@ -129,8 +129,9 @@ const consoleLogStore = new Console();
  *    }
  * }
  * ```
+ * > Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
-* #### Example #5: Target URL with provided basic authentication
+ * #### Example #5: Target URL with provided basic authentication
  *
  * ```js
  * {
@@ -143,10 +144,25 @@ const consoleLogStore = new Console();
  *    }
  * }
  * ```
+ * #### Troubleshooting
  *
+ * Error Message:  `No usable sandbox!`
+ *
+ * When running Puppeteer on CI try to disable sandbox if you see that message
+ *
+ * ```
+ * helpers: {
+ *  Puppeteer: {
+ *     url: 'http://localhost',
+ *     show: false,
+ *     chrome: {
+ *       args: ['--no-sandbox', '--disable-setuid-sandbox']
+ *     }
+ *   },
+ * }
+ * ```
  *
  *
- * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
  * ## Access From Helpers
  *

package/lib/mochaFactory.js

@@ -17,12 +17,6 @@ class MochaFactory {
     output.process(opts.child);
     mocha.ui(scenarioUi);
 
-    // process.on('unhandledRejection', (reason) => {
-    //   output.error('Unhandled rejection');
-    //   console.log(Error.captureStackTrace(reason));
-    //   output.error(reason);
-    // });
-
     Mocha.Runner.prototype.uncaught = function (err) {
       if (err) {
         if (err.toString().indexOf('ECONNREFUSED') >= 0) {
@@ -51,19 +45,30 @@ class MochaFactory {
 
         // add ids for each test and check uniqueness
         const dupes = [];
+        let missingFeatureInFile = [];
         const seenTests = [];
         mocha.suite.eachTest(test => {
           test.id = genTestId(test);
+
           const name = test.fullTitle();
           if (seenTests.includes(test.id)) {
             dupes.push(name);
           }
           seenTests.push(test.id);
+
+          if (name.slice(0, name.indexOf(':')) === '') {
+            missingFeatureInFile.push(test.file);
+          }
         });
         if (dupes.length) {
           // ideally this should be no-op and throw (breaking change)...
           output.error(`Duplicate test names detected - Feature + Scenario name should be unique:\n${dupes.join('\n')}`);
         }
+
+        if (missingFeatureInFile.length) {
+          missingFeatureInFile = [...new Set(missingFeatureInFile)];
+          output.error(`Missing Feature section in:\n${missingFeatureInFile.join('\n')}`);
+        }
       }
     };
 

package/lib/plugin/{puppeteerCoverage.js → coverage.js}

@@ -1,4 +1,4 @@
-const debug = require('debug')('codeceptjs:plugin:puppeteerCoverage');
+const debugModule = require('debug');
 const fs = require('fs');
 const path = require('path');
 
@@ -13,7 +13,7 @@ const defaultConfig = {
   uniqueFileName: true,
 };
 
-const supportedHelpers = ['Puppeteer'];
+const supportedHelpers = ['Puppeteer', 'Playwright'];
 
 function buildFileName(test, uniqueFileName) {
   let fileName = clearString(test.title);
@@ -41,15 +41,14 @@ function buildFileName(test, uniqueFileName) {
 }
 
 /**
- * Dumps puppeteers code coverage after every test.
+ * Dumps code coverage from Playwright/Puppeteer after every test.
  *
  * #### Configuration
  *
- * Configuration can either be taken from a corresponding helper (deprecated) or a from plugin config (recommended).
  *
  * ```js
  * plugins: {
- *    puppeteerCoverage: {
+ *    playwrightCoverage: {
  *      enabled: true
  *    }
  * }
@@ -59,33 +58,22 @@ function buildFileName(test, uniqueFileName) {
  *
  * * `coverageDir`: directory to dump coverage files
  * * `uniqueFileName`: generate a unique filename by adding uuid
- *
- *  First of all, your mileage may vary!
- *
- *  To work, you need the client javascript code to be NOT uglified. They need to be built in "development" mode.
- *  And the end of your tests, you'll get a directory full of coverage per test run.  Now what?
- *  You'll need to convert the coverage code to something istanbul can read.  Good news is someone wrote the code
- *  for you (see puppeteer-to-istanbul link below).  Then using istanbul you need to combine the converted
- *  coverage and create a report.  Good luck!
- *
- *  Links:
- *  * https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage
- *  * https://github.com/istanbuljs/puppeteer-to-istanbul
- *  * https://github.com/gotwarlost/istanbul
  */
 module.exports = function (config) {
   const helpers = Container.helpers();
   let coverageRunning = false;
   let helper;
 
+  let debug;
   for (const helperName of supportedHelpers) {
     if (Object.keys(helpers).indexOf(helperName) > -1) {
       helper = helpers[helperName];
+      debug = debugModule(`codeceptjs:plugin:${helperName.toLowerCase()}Coverage`);
     }
   }
 
   if (!helper) {
-    console.error('Coverage is only supported in Puppeteer');
+    console.error('Coverage is only supported in Puppeteer, Playwright');
     return; // no helpers for screenshot
   }
 
@@ -102,7 +90,7 @@ module.exports = function (config) {
       'starting coverage',
       async () => {
         try {
-          if (!coverageRunning) {
+          if (!coverageRunning && helper.page && helper.page.coverage) {
             debug('--> starting coverage <--');
             coverageRunning = true;
             await helper.page.coverage.startJSCoverage();
@@ -115,13 +103,13 @@ module.exports = function (config) {
     );
   });
 
-  // Save puppeteer coverage data after every test run
+  // Save coverage data after every test run
   event.dispatcher.on(event.test.after, async (test) => {
     recorder.add(
       'saving coverage',
       async () => {
         try {
-          if (coverageRunning) {
+          if (coverageRunning && helper.page && helper.page.coverage) {
             debug('--> stopping coverage <--');
             coverageRunning = false;
             const coverage = await helper.page.coverage.stopJSCoverage();

package/lib/plugin/customLocator.js

@@ -38,7 +38,7 @@ const defaultConfig = {
  * // in codecept.conf.js
  * plugins: {
  *  customLocator: {
- *    enabled: true
+ *    enabled: true,
  *    attribute: 'data-test'
  *  }
  * }
@@ -57,7 +57,7 @@ const defaultConfig = {
  * // in codecept.conf.js
  * plugins: {
  *  customLocator: {
- *    enabled: true
+ *    enabled: true,
  *    prefix: '=',
  *    attribute: 'data-qa'
  *  }

package/lib/plugin/subtitles.js

@@ -0,0 +1,88 @@
+const { v4: uuidv4 } = require('uuid');
+const fsPromise = require('fs').promises;
+const path = require('path');
+const event = require('../event');
+
+// This will convert a given timestamp in milliseconds to
+// an SRT recognized timestamp, ie HH:mm:ss,SSS
+function formatTimestamp(timestampInMs) {
+  const date = new Date(0, 0, 0, 0, 0, 0, timestampInMs);
+  const hours = date.getHours();
+  const minutes = date.getMinutes();
+  const seconds = date.getSeconds();
+  const ms = timestampInMs - (hours * 3600000 + minutes * 60000 + seconds * 1000);
+  return `${hours.toString().padStart(2, '0')}:${minutes.toString().padStart(2, '0')}:${seconds.toString().padStart(2, '0')},${ms.toString().padStart(3, '0')}`;
+}
+
+let steps = {};
+let testStartedAt;
+/**
+ * Automatically captures steps as subtitle, and saves it as an artifact when a video is found for a failed test
+ *
+ * #### Configuration
+ * ```js
+ * plugins: {
+ *  subtitles: {
+ *    enabled: true
+ *  }
+ * }
+ * ```
+ */
+module.exports = function () {
+  event.dispatcher.on(event.test.before, (_) => {
+    testStartedAt = Date.now();
+    steps = {};
+  });
+
+  event.dispatcher.on(event.step.started, (step) => {
+    const stepStartedAt = Date.now();
+    step.id = uuidv4();
+
+    let title = `${step.actor}.${step.name}(${step.args ? step.args.join(',') : ''})`;
+    if (title.length > 100) {
+      title = `${title.substring(0, 100)}...`;
+    }
+
+    steps[step.id] = {
+      start: formatTimestamp(stepStartedAt - testStartedAt),
+      startedAt: stepStartedAt,
+      title,
+    };
+  });
+
+  event.dispatcher.on(event.step.finished, (step) => {
+    if (step && step.id && steps[step.id]) {
+      steps[step.id].end = formatTimestamp(Date.now() - testStartedAt);
+    }
+  });
+
+  event.dispatcher.on(event.test.after, async (test) => {
+    if (test && test.artifacts && test.artifacts.video) {
+      const stepsSortedByStartTime = Object.values(steps);
+      stepsSortedByStartTime.sort((stepA, stepB) => {
+        return stepA.startedAt - stepB.startedAt;
+      });
+
+      let subtitle = '';
+
+      // For an SRT file, every subtitle has to be in the format as mentioned below:
+      //
+      // 1
+      // HH:mm:ss,SSS --> HH:mm:ss,SSS
+      // [title]
+      stepsSortedByStartTime.forEach((step, index) => {
+        if (step.end) {
+          subtitle = `${subtitle}${index + 1}
+${step.start} --> ${step.end}
+${step.title}
+
+`;
+        }
+      });
+
+      const { dir: artifactsDirectory, name: fileName } = path.parse(test.artifacts.video);
+      await fsPromise.writeFile(`${artifactsDirectory}/${fileName}.srt`, subtitle);
+      test.artifacts.subtitle = `${artifactsDirectory}/${fileName}.srt`;
+    }
+  });
+};

package/lib/plugin/tryTo.js

@@ -89,7 +89,7 @@ function tryTo(callback) {
     recorder.session.catch((err) => {
       result = false;
       const msg = err.inspect ? err.inspect() : err.toString();
-      debug(`Unsuccesful try > ${msg}`);
+      debug(`Unsuccessful try > ${msg}`);
       recorder.session.restore('tryTo');
       return result;
     });

package/lib/step.js

@@ -212,16 +212,18 @@ class MetaStep extends Step {
       step.metaStep = this;
     };
     event.dispatcher.prependListener(event.step.before, registerStep);
+    let rethrownError = null;
     try {
       this.startTime = Date.now();
       result = fn.apply(this.context, this.args);
     } catch (error) {
-      this.status = 'failed';
+      this.setStatus('failed');
+      rethrownError = error;
     } finally {
       this.endTime = Date.now();
-
       event.dispatcher.removeListener(event.step.before, registerStep);
     }
+    if (rethrownError) { throw rethrownError; }
     return result;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -84,7 +84,8 @@
     "promise-retry": "^1.1.1",
     "requireg": "^0.2.2",
     "resq": "^1.10.0",
-    "sprintf-js": "^1.1.1"
+    "sprintf-js": "^1.1.1",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",

package/typings/types.d.ts

@@ -948,6 +948,16 @@ declare namespace CodeceptJS {
          * @returns attribute value
          */
         grabValueFrom(locator: CodeceptJS.LocatorOrString): Promise<string>;
+        /**
+         * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+         * Filename is relative to output folder.
+         *
+         * ```js
+         * I.saveScreenshot('debug.png');
+         * ```
+         * @param fileName - file name to save.
+         */
+        saveScreenshot(fileName: string): void;
         /**
          * Scroll element into viewport.
          *
@@ -5374,6 +5384,7 @@ declare namespace CodeceptJS {
      *    }
      * }
      * ```
+     * > Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
      *
      * #### Example #5: Target URL with provided basic authentication
      *
@@ -5388,10 +5399,25 @@ declare namespace CodeceptJS {
      *    }
      * }
      * ```
+     * #### Troubleshooting
      *
+     * Error Message:  `No usable sandbox!`
+     *
+     * When running Puppeteer on CI try to disable sandbox if you see that message
+     *
+     * ```
+     * helpers: {
+     *  Puppeteer: {
+     *     url: 'http://localhost',
+     *     show: false,
+     *     chrome: {
+     *       args: ['--no-sandbox', '--disable-setuid-sandbox']
+     *     }
+     *   },
+     * }
+     * ```
      *
      *
-     * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
      *
      * ## Access From Helpers
      *