codeceptjs 3.0.6 → 3.1.2

package/docs/plugins.md

@@ -341,7 +341,7 @@ This plugin can be used
 ### Config
 
 -   `enabled` - (default: false) enable a plugin
--   `regusterGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
+-   `registerGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
 
 ### Examples
 
@@ -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/docs/react.md

@@ -55,7 +55,7 @@ For React apps a special `react` locator is available. It allows to select an el
 { react: 'Input', state: 'valid'}
 ```
 
-In WebDriver and Puppeteer you can use React locators in any method where locator is required:
+In WebDriver, Puppeteer, and Playwright you can use React locators in any method where locator is required:
 
 ```js
 I.click({ react: 'Tab', props: { title: 'Click Me!' }});

package/docs/reports.md

@@ -352,10 +352,11 @@ Configure mocha-multi with reports that you want:
         }
       },
       "mochawesome": {
-       "stdout": "./output/console.log",
-       "options": {
-         "reportDir": "./output",
-         "reportFilename": "report"
+        "stdout": "./output/console.log",
+        "options": {
+          "reportDir": "./output",
+          "reportFilename": "report"
+        }
       },
       "mocha-junit-reporter": {
         "stdout": "./output/console.log",

package/lib/actor.js

@@ -74,8 +74,7 @@ module.exports = function (obj = {}) {
   const helpers = container.helpers();
 
   // add methods from enabled helpers
-  Object.keys(helpers)
-    .map(key => helpers[key])
+  Object.values(helpers)
     .forEach((helper) => {
       methodsOfObject(helper, 'Helper')
         .filter(method => method !== 'constructor' && method[0] !== '_')

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/command/definitions.js

@@ -194,7 +194,14 @@ function getPath(originalPath, targetFolderPath, testsPath) {
   else if (parsedPath.ext === '.ts') parsedPath.base = parsedPath.name;
 
   if (!parsedPath.dir.startsWith('.')) return path.posix.join(parsedPath.dir, parsedPath.base);
-  const relativePath = path.posix.relative(targetFolderPath, path.posix.join(testsPath, parsedPath.dir, parsedPath.base));
+  const relativePath = path.posix.relative(
+    targetFolderPath.split(path.sep).join(path.posix.sep),
+    path.posix.join(
+      testsPath.split(path.sep).join(path.posix.sep),
+      parsedPath.dir.split(path.sep).join(path.posix.sep),
+      parsedPath.base.split(path.sep).join(path.posix.sep),
+    ),
+  );
 
   return relativePath.startsWith('.') ? relativePath : `./${relativePath}`;
 }

package/lib/command/interactive.js

@@ -8,9 +8,11 @@ module.exports = async function (path, options) {
   // Backward compatibility for --profile
   process.profile = options.profile;
   process.env.profile = options.profile;
+  const configFile = options.config;
+
+  const config = getConfig(configFile);
+  const testsPath = getTestRoot(configFile);
 
-  const testsPath = getTestRoot(path);
-  const config = getConfig(testsPath);
   const codecept = new Codecept(config, options);
   codecept.init(testsPath);
 

package/lib/command/run-multiple/collection.js

@@ -80,6 +80,10 @@ class Collection {
         return;
       }
 
+      if (runConfig.gherkin && config.gherkin.features) {
+        patterns.push(runConfig.gherkin.features);
+      }
+
       createChunks(runConfig, patterns).forEach((runChunkConfig, index) => {
         const run = createRun(`${runName}:chunk${index + 1}`, runChunkConfig);
         run.setOriginalName(runName);

package/lib/container.js

@@ -215,7 +215,7 @@ function createSupportObjects(config) {
         newObj._init();
       }
     } catch (err) {
-      throw new Error(`Initialization failed for ${name}: ${newObj}\n${err.message}`);
+      throw new Error(`Initialization failed for ${name}: ${newObj}\n${err.message}\n${err.stack}`);
     }
     return newObj;
   }
@@ -288,7 +288,7 @@ function createPlugins(config, options = {}) {
       }
       plugins[pluginName] = require(module)(config[pluginName]);
     } catch (err) {
-      throw new Error(`Could not load plugin ${pluginName} from module '${module}':\n${err.message}`);
+      throw new Error(`Could not load plugin ${pluginName} from module '${module}':\n${err.message}\n${err.stack}`);
     }
   }
   return plugins;
@@ -380,7 +380,7 @@ function loadSupportObject(modulePath, supportObjectName) {
 
     return obj;
   } catch (err) {
-    throw new Error(`Could not include object ${supportObjectName} from module '${modulePath}'\n${err.message}`);
+    throw new Error(`Could not include object ${supportObjectName} from module '${modulePath}'\n${err.message}\n${err.stack}`);
   }
 }
 

package/lib/helper/Appium.js

@@ -1352,6 +1352,33 @@ class Appium extends Webdriver {
     return super.grabTextFrom(parseLocator.call(this, locator));
   }
 
+  /**
+   * {{> grabNumberOfVisibleElements }}
+   */
+  async grabNumberOfVisibleElements(locator) {
+    if (this.isWeb) return super.grabNumberOfVisibleElements(locator);
+    return super.grabNumberOfVisibleElements(parseLocator.call(this, locator));
+  }
+
+  /**
+   * Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
+   *
+   * {{> grabAttributeFrom }}
+   */
+  async grabAttributeFrom(locator, attr) {
+    if (this.isWeb) return super.grabAttributeFrom(locator, attr);
+    return super.grabAttributeFrom(parseLocator.call(this, locator), attr);
+  }
+
+  /**
+   * Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
+   * {{> grabAttributeFromAll }}
+   */
+  async grabAttributeFromAll(locator, attr) {
+    if (this.isWeb) return super.grabAttributeFromAll(locator, attr);
+    return super.grabAttributeFromAll(parseLocator.call(this, locator), attr);
+  }
+
   /**
    * {{> grabValueFromAll }}
    *
@@ -1370,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/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(