codeceptjs 3.0.6 → 3.1.2

package/CHANGELOG.md

@@ -1,10 +1,94 @@
+## 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
+ `grabNumberOfVisibleElements`, `grabAttributeFrom`, `grabAttributeFromAll` to allow id locators.
+
+## 3.1.0
+
+* [Plawyright] Updated to Playwright 1.13
+* [Playwright] **Possible breaking change**: `BrowserContext` is initialized before each test and closed after. This behavior matches recommendation from Playwright team to use different contexts for tests.
+* [Puppeteer] Updated to Puppeteer 10.2.
+* [Protractor] Helper deprecated
+
+🛩️ Features:
+
+* [Playwright] Added recording of [video](https://codecept.io/playwright/#video) and [traces](https://codecept.io/playwright/#trace) by @davertmik
+* [Playwritght] [Mocking requests](https://codecept.io/playwright/#mocking-network-requests) implemented via `route` API of Playwright by @davertmik
+* [Playwright] Added **support for [React locators](https://codecept.io/react/#locators)** in #2912 by @AAAstorga
+
+🐛 Bugfixes:
+
+* [Puppeteer] Fixed #2244 `els[0]._clickablePoint is not a function` by @karunandrii.
+* [Puppeteer] Fixed `fillField` to check for invisible elements. See #2916 by @anne-open-xchange 
+* [Playwright] Reset of dialog event listener before registration of new one. #2946 by @nikocanvacom 
+* Fixed running Gherkin features with `run-multiple` using chunks. See #2900 by @andrenoberto
+* Fixed #2937 broken typings for subfolders on Windows by @jancorvus
+* Fixed issue where cucumberJsonReporter not working with fakerTransform plugin. See #2942 by @ilangv 
+* Fixed #2952 finished job with status code 0 when playwright cannot connect to remote wss url. By @davertmik
+
+
+## 3.0.7
+
+📖 Documentation fixes:
+
+* Remove broken link from `Nightmare helper`. See #2860 by @Arhell
+* Fixed broken links in `playwright.md`. See #2848 by @johnhoodjr
+* Fix mocha-multi config example. See #2881 by @rimesc
+* Fix small errors in email documentation file. See #2884 by @mkrtchian
+* Improve documentation for `Sharing Data Between Workers` section. See #2891 by @ngraf
+
+🛩️ Features:
+
+* [WebDriver] Shadow DOM Support for `Webdriver`. See #2741 by @gkushang
+* [Release management] Introduce the versioning automatically, it follows the semantics versioning. See #2883 by @PeterNgTr
+* Adding opts into `Scenario.skip` that it would be useful for building reports. See #2867 by @AlexKo4
+* Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See #2888 by @fijijavis
+* Supported config file for `codeceptjs shell` command. See #2895 by @PeterNgTr:
+
+```
+npx codeceptjs shell -c foo.conf.js
+```
+
+Bug fixes:
+* [GraphQL] Use a helper-specific instance of Axios to avoid contaminating global defaults. See #2868 by @vanvoljg
+* A default system color is used when passing non supported system color when using I.say(). See #2874 by @PeterNgTr
+* [Playwright] Avoid the timout due to calling the click on invisible elements. See #2875 by cbayer97
+
+
 ## 3.0.6
 
-* [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97  
+* [Playwright] Added `electron` as a browser to config. See #2834 by @cbayer97
 * [Playwright] Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See #2817 by @brunoqueiros. Fixes #2376.
 * Fixed printing logs and stack traces for `run-workers`. See #2857 by @haveac1gar. Fixes #2621, #2852
-* Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes 
-* Improved workers processes output. See #2804 by @drfiresign 
+* Emit custom messages from worker to the main thread. See #2824 by @jccguimaraes
+* Improved workers processes output. See #2804 by @drfiresign
 * BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See #2814 by @jbergeronjr
 
 ```js
@@ -13,8 +97,8 @@
   "./features/api_features/*.feature"
 ],
 ```
-* Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask 
-* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco 
+* Added `getQueueId` to reporter to rerun a specific promise. See #2837 by @jonatask
+* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See #2854 by @adrielcodeco
 
 ```feature
 Scenario Outline: ...
@@ -26,7 +110,7 @@ Scenario Outline: ...
   | productName          | customer              | email              | anythingMore |
   | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |
 ```
-* [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg 
+* [REST] Use class instance of axios, not the global instance, to avoid contaminating global configuration. #2846 by @vanvoljg
 * [Appium] Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See #2832 by @gurjeetbains
 
 ## 3.0.5
@@ -34,9 +118,9 @@ Scenario Outline: ...
 
 Features:
 
-* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin  
+* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks @VikentyShevyrin
 * Better support for Typescript `codecept.conf.ts` configuration files. See #2750 by @elaichenkov
-* Propagate more events for custom parallel script. See #2796 by @jccguimaraes 
+* Propagate more events for custom parallel script. See #2796 by @jccguimaraes
 * [mocha-junit-reporter] Now supports attachments, see documentation for details. See #2675 by @Shard
 * CustomLocators interface for TypeScript to extend from LocatorOrString. See #2798 by @danielrentz
 * [REST] Mask sensitive data from log messages.

package/README.md

@@ -1,4 +1,12 @@
-[<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url] [![Build Status](https://travis-ci.org/Codeception/CodeceptJS.svg?branch=master)](https://travis-ci.org/Codeception/CodeceptJS) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/1823c38c74e44724b5555e3641f72621)](https://www.codacy.com/app/DavertMik/CodeceptJS?utm_source=github.com&utm_medium=referral&utm_content=Codeception/CodeceptJS&utm_campaign=badger) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+[<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url]
+
+Build Status:
+
+[![Playwright Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml)
+[![Puppeteer Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml)
+[![WebDriver Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml)
+[![Appium Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium.yml)
+[![TestCafe Tests](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml/badge.svg)](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml)
 
 # CodeceptJS
 

package/bin/codecept.js

@@ -2,6 +2,16 @@
 const program = require('commander');
 const Codecept = require('../lib/codecept');
 const { print, error } = require('../lib/output');
+const { printError } = require('../lib/command/utils');
+
+const errorHandler = (fn) => async (...args) => {
+  try {
+    await fn(...args);
+  } catch (e) {
+    printError(e);
+    process.exitCode = 1;
+  }
+};
 
 if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 8) {
   error('NodeJS >= 8 is required to run.');
@@ -16,41 +26,42 @@ program.version(Codecept.version());
 
 program.command('init [path]')
   .description('Creates dummy config in current dir or [path]')
-  .action(require('../lib/command/init'));
+  .action(errorHandler(require('../lib/command/init')));
 
 program.command('migrate [path]')
   .description('Migrate json config to js config in current dir or [path]')
-  .action(require('../lib/command/configMigrate'));
+  .action(errorHandler(require('../lib/command/configMigrate')));
 
 program.command('shell [path]')
   .alias('sh')
   .description('Interactive shell')
   .option('--verbose', 'output internal logging information')
   .option('--profile [value]', 'configuration profile to be used')
-  .action(require('../lib/command/interactive'));
+  .option('-c, --config [file]', 'configuration file to be used')
+  .action(errorHandler(require('../lib/command/interactive')));
 
 program.command('list [path]')
   .alias('l')
   .description('List all actions for I.')
-  .action(require('../lib/command/list'));
+  .action(errorHandler(require('../lib/command/list')));
 
 program.command('def [path]')
   .description('Generates TypeScript definitions for all I actions.')
   .option('-c, --config [file]', 'configuration file to be used')
   .option('-o, --output [folder]', 'target folder to paste definitions')
-  .action(require('../lib/command/definitions'));
+  .action(errorHandler(require('../lib/command/definitions')));
 
 program.command('gherkin:init [path]')
   .alias('bdd:init')
   .description('Prepare CodeceptJS to run feature files.')
   .option('-c, --config [file]', 'configuration file to be used')
-  .action(require('../lib/command/gherkin/init'));
+  .action(errorHandler(require('../lib/command/gherkin/init')));
 
 program.command('gherkin:steps [path]')
   .alias('bdd:steps')
   .description('Prints all defined gherkin steps.')
   .option('-c, --config [file]', 'configuration file to be used')
-  .action(require('../lib/command/gherkin/steps'));
+  .action(errorHandler(require('../lib/command/gherkin/steps')));
 
 program.command('gherkin:snippets [path]')
   .alias('bdd:snippets')
@@ -59,28 +70,28 @@ program.command('gherkin:snippets [path]')
   .option('-c, --config [file]', 'configuration file to be used')
   .option('--feature [file]', 'feature files(s) to scan')
   .option('--path [file]', 'file in which to place the new snippets')
-  .action(require('../lib/command/gherkin/snippets'));
+  .action(errorHandler(require('../lib/command/gherkin/snippets')));
 
 program.command('generate:test [path]')
   .alias('gt')
   .description('Generates an empty test')
-  .action(require('../lib/command/generate').test);
+  .action(errorHandler(require('../lib/command/generate').test));
 
 program.command('generate:pageobject [path]')
   .alias('gpo')
   .description('Generates an empty page object')
-  .action(require('../lib/command/generate').pageObject);
+  .action(errorHandler(require('../lib/command/generate').pageObject));
 
 program.command('generate:object [path]')
   .alias('go')
   .option('--type, -t [kind]', 'type of object to be created')
   .description('Generates an empty support object (page/step/fragment)')
-  .action(require('../lib/command/generate').pageObject);
+  .action(errorHandler(require('../lib/command/generate').pageObject));
 
 program.command('generate:helper [path]')
   .alias('gh')
   .description('Generates a new helper')
-  .action(require('../lib/command/generate').helper);
+  .action(errorHandler(require('../lib/command/generate').helper));
 
 program.command('run [test]')
   .description('Executes tests')
@@ -116,8 +127,8 @@ program.command('run [test]')
   .option('--recursive', 'include sub directories')
   .option('--trace', 'trace function calls')
   .option('--child <string>', 'option for child processes')
+  .action(errorHandler(require('../lib/command/run')));
 
-  .action(require('../lib/command/run'));
 program.command('run-workers <workers>')
   .description('Executes tests in workers')
   .option('-c, --config [file]', 'configuration file to be used')
@@ -133,7 +144,7 @@ program.command('run-workers <workers>')
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
   .option('-O, --reporter-options <k=v,k2=v2,...>', 'reporter-specific options')
   .option('-R, --reporter <name>', 'specify the reporter to use')
-  .action(require('../lib/command/run-workers'));
+  .action(errorHandler(require('../lib/command/run-workers')));
 
 program.command('run-multiple [suites...]')
   .description('Executes tests multiple')
@@ -157,12 +168,12 @@ program.command('run-multiple [suites...]')
   // mocha options
   .option('--colors', 'force enabling of colors')
 
-  .action(require('../lib/command/run-multiple'));
+  .action(errorHandler(require('../lib/command/run-multiple')));
 
 program.command('info [path]')
   .description('Print debugging information concerning the local environment')
   .option('-c, --config', 'your config file path')
-  .action(require('../lib/command/info'));
+  .action(errorHandler(require('../lib/command/info')));
 
 program.command('dry-run [test]')
   .description('Prints step-by-step scenario for a test without actually running it')
@@ -178,7 +189,7 @@ program.command('dry-run [test]')
   .option('--steps', 'show step-by-step execution')
   .option('--verbose', 'output internal logging information')
   .option('--debug', 'output additional information')
-  .action(require('../lib/command/dryRun'));
+  .action(errorHandler(require('../lib/command/dryRun')));
 
 program.on('command:*', (cmd) => {
   console.log(`\nUnknown command ${cmd}\n`);

package/docs/build/Appium.js

@@ -183,6 +183,7 @@ class Appium extends Webdriver {
     config.capabilities.browserName = config.browser || config.capabilities.browserName;
     config.capabilities.app = config.app || config.capabilities.app;
     config.capabilities.platformName = config.platform || config.capabilities.platformName;
+    config.capabilities.tunnelIdentifier = config.tunnelIdentifier || config.capabilities.tunnelIdentifier; // Adding the code to connect to sauce labs via sauce tunnel
     config.waitForTimeout /= 1000; // convert to seconds
 
     // [CodeceptJS compatible] transform host to hostname
@@ -1461,6 +1462,60 @@ class Appium extends Webdriver {
     return super.grabTextFrom(parseLocator.call(this, locator));
   }
 
+  /**
+   * Grab number of visible elements by locator.
+   * Resumes test execution, so **should be used inside async function with `await`** operator.
+   * 
+   * ```js
+   * let numOfElements = await I.grabNumberOfVisibleElements('p');
+   * ```
+   * 
+   * @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
+   * @returns {Promise<number>} number of visible elements
+   */
+  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")
+   *
+   * Retrieves an attribute from an element located by CSS or XPath and returns it to test.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * If more than one element is found - attribute of first element is returned.
+   * 
+   * ```js
+   * let hint = await I.grabAttributeFrom('#tooltip', 'title');
+   * ```
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string} attr attribute name.
+   * @returns {Promise<string>} attribute value
+   * 
+   */
+  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")
+   * Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
+   * Resumes test execution, so **should be used inside async with `await`** operator.
+   * 
+   * ```js
+   * let hints = await I.grabAttributeFromAll('.tooltip', 'title');
+   * ```
+   * @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+   * @param {string} attr attribute name.
+   * @returns {Promise<string[]>} attribute value
+   * 
+   */
+  async grabAttributeFromAll(locator, attr) {
+    if (this.isWeb) return super.grabAttributeFromAll(locator, attr);
+    return super.grabAttributeFromAll(parseLocator.call(this, locator), attr);
+  }
+
   /**
    * Retrieves an array of value from a form located by CSS or XPath and returns it to test.
    * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -1496,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/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(