Update by master 2 (#2459)

* updated docs

* release 2.6.5

* Fix valid data output (w3) (#2399)

* add alt for image UI page (fix w3 validator) (#2403)

* docs: fix typo in commands.md (#2405)

* remove unnecessary select placeholder from basics.md (#2407)

* fix display combination in changelog (#2409)

* add description to images (#2412)

* Fix android native locator support for appium helper (#2429)

* Update mobile.md

* Fix android native locator support for appium helper

* update the expected result for windows platform especially the absolute path case because in windows, path.resolve returns driver letter

* chore: jsdoc color param optional in `I.say` (#2443)

* update github links after repository migration (#2447)

* Fixed waitNumberOfVisibleElements for Webdriver (#2418)

* fix waitNumberOfVisibleElements

waitNumberOfVisibleElements returns false everytime as it does not filter the visible element count

* fix waitNumberOfVisibleElements

waitNumberOfVisibleElements returns false everytime as it does not filter for visible elements

* Issue 2434 (handle .indexOf error) (#2436)

* Makes suggested changes to have Chromium install

* fixes #2434

* fix playwright too

Co-authored-by: George Griffiths <[email protected]>

* Puppeteer handle page error (#2435)

* Makes suggested changes to have Chromium install

* handle page crash

* handle undefined page

* dont open new tab on crash

* remove old try catch

Co-authored-by: George Griffiths <[email protected]>

* Feat: Skip feature (#2427)

* Makes suggested changes to have Chromium install

* feat: implement skip of features

* Add unit tests, docs and type defs

* Apply suggestions from code review

Co-authored-by: George Griffiths <[email protected]>
Co-authored-by: Michael Bodnarchuk <[email protected]>

* Release 2.6.6 (#2450)

* updated docs

* fixed tests & updated linter

* updated changelog

* fixed mocks

Co-authored-by: Davert <[email protected]>
Co-authored-by: Mykhailo Bodnarchuk <[email protected]>
Co-authored-by: Ihor Sychevskyi <[email protected]>
Co-authored-by: Aleksei Gurianov <[email protected]>
Co-authored-by: Tanakiat Srisaranyakul <[email protected]>
Co-authored-by: Bartosz Wojtkowiak <[email protected]>
Co-authored-by: Vijay Venkatesh <[email protected]>
Co-authored-by: George Griffiths <[email protected]>
Co-authored-by: George Griffiths <[email protected]>
Co-authored-by: Michael Bodnarchuk <[email protected]>

Author: 10 people

CHANGELOG.md

@@ -87,6 +87,20 @@ tryTo(() => I.click('Accept', '.cookies'));
 * Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996
 * [Playwright] Fixed calling `waitFor*` methods with custom locators #2314. Fix #2389 by @Georgegriff
 
+## 2.6.6
+
+* Puppeteer 4.0 support. Important: MockRequest helper won't work with Puppeter > 3.3
+* Added `xFeature` and `Feature.skip` to skip all tests in a suite. By @Georgegriff
+* [Appium] Fixed #2428 Android native locator support by @idxn
+* [WebDriver] Fixed `waitNumberOfVisibleElements` to actually filter visible elements. By @ilangv
+* [Puppeteer] Fixed handling error which is not an Error object. Fixes `cannot read property indexOf of undefined` error. Fix #2436 by @Georgegriff
+* [Puppeteer] Print error on page crash by @Georgegriff
+
+## 2.6.5
+
+* Added `test.skipped` event to run-workers, fixing allure reports with skipped tests in workers #2391. Fix #2387 by @koushikmohan1996
+* [Playwright] Fixed calling `waitFor*` methods with custom locators #2314. Fix #2389 by @Georgegriff
+
 ## 2.6.4
 
 * [Playwright] **Playwright 1.0 support** by @Georgegriff.

docs/basics.md

@@ -297,7 +297,7 @@ Tests are written in a synchronous way. This improves the readability and mainta
 While writing tests you should not think about promises, and instead should focus on the test scenario.
 
 However, behind the scenes **all actions are wrapped in promises**, inside of the `I` object.
-[Global promise](https://github.com/Codeception/CodeceptJS/blob/master/lib/recorder.js) chain is initialized before each test and all `I.*` calls will be appended to it, as well as setup and teardown.
+[Global promise](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js) chain is initialized before each test and all `I.*` calls will be appended to it, as well as setup and teardown.
 
 > 📺 [Learn how CodeceptJS](https://www.youtube.com/watch?v=MDLLpHAwy_s) works with promises by watching video on YouTube
 
@@ -617,7 +617,7 @@ AfterSuite((I) => {
 });
 ```
 
-[Here are some ideas](https://github.com/Codeception/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
+[Here are some ideas](https://github.com/codecept-js/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
 
 ## Within
 
@@ -798,7 +798,11 @@ Also, you can use `within` inside a session, but you can't call session from ins
 Like in Mocha you can use `x` and `only` to skip tests or to run a single test.
 
 * `xScenario` - skips current test
+* `Scenario.skip` - skips current test
 * `Scenario.only` - executes only the current test
+* `xFeature` - skips current suite <Badge text="Since 2.6.6" type="warning"/>
+* `Feature.skip` - skips the current suite <Badge text="Since 2.6.6" type="warning"/>
+
 
 ## Todo Test <Badge text="Since 2.4" type="warning"/>
 

docs/books.md

@@ -7,7 +7,7 @@ editLink: false
 ---
 
 # Books & Posts
-> Add your own books or posts to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Books-&-Posts)
+> Add your own books or posts to our [Wiki Page](https://github.com/codecept-js/CodeceptJS/wiki/Books-&-Posts)
 ### [Practical End 2 End Testing with CodeceptJS](https://leanpub.com/codeceptjs/)
 
 A book by **Paul Vincent Beigang**
@@ -34,4 +34,4 @@ A list of good educational posts about CodeceptJS
 * [Customizing CodeceptJS Skeleton](https://medium.com/@successivetech/codeceptjs-skeleton-9ba86d3b45ec)
 * [Running End to End tests as Google Cloud Functions](https://hackernoon.com/running-end-to-end-tests-as-google-cloud-functions-f5e34ffc3984)
 * [End-To-End Testing With CodeceptJS](https://www.monterail.com/blog/end-to-end-testing-with-codeceptjs) by Piotr Michalski
-* [Getting started with CodeceptJS and Selenium WebDriver](https://medium.com/@garrettvorce/getting-started-with-selenium-and-codeceptjs-c0698e8df677)
+* [Getting started with CodeceptJS and Selenium WebDriver](https://medium.com/@garrettvorce/getting-started-with-selenium-and-codeceptjs-c0698e8df677)

docs/changelog.md

@@ -5,7 +5,7 @@ editLink: false
 ---
 
 # Community Helpers
-> Share your helpers at our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Community-Helpers)
+> Share your helpers at our [Wiki Page](https://github.com/codecept-js/CodeceptJS/wiki/Community-Helpers)
 
 Here is the list of helpers created by our community.
 Please **add your own** by editing this page.
@@ -47,4 +47,4 @@ Please **add your own** by editing this page.
 
 ## Other
 
-* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.
+* [eslint-plugin-codeceptjs](https://www.npmjs.com/package/eslint-plugin-codeceptjs) Eslint rules for CodeceptJS.

docs/community-helpers.md

@@ -36,7 +36,7 @@ helpers: {
 }
 ```
 
-Helpers are ES6 classes inherited from [corresponding abstract class](https://github.com/Codeception/CodeceptJS/blob/master/lib/helper.js).
+Helpers are ES6 classes inherited from [corresponding abstract class](https://github.com/codecept-js/CodeceptJS/blob/master/lib/helper.js).
 Generated Helper will be added to `codecept.conf.js` config file. It should look like this:
 
 ```js

docs/custom-helpers.md

@@ -7,7 +7,7 @@ editLink: false
 ---
 
 # Examples
-> Add your own examples to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Examples)
+> Add your own examples to our [Wiki Page](https://github.com/codecept-js/CodeceptJS/wiki/Examples)
 ## [TodoMVC Examples](https://github.com/codecept-js/examples)
 
 ![](https://github.com/codecept-js/examples/raw/master/todo.png)
@@ -23,7 +23,7 @@ Tests repository demonstrate usage of
 * PageObjects
 * Cucumber syntax
 
-## [Basic Examples](https://github.com/Codeception/CodeceptJS/tree/master/examples)
+## [Basic Examples](https://github.com/codecept-js/CodeceptJS/tree/master/examples)
 
 CodeceptJS repo contains basic tests (both failing and passing) just to show how it works.
 Our team uses it to test new features and run simple scenarios.
@@ -145,4 +145,4 @@ This is a ready to use example that shows how to integrate CodeceptJS with Puppe
 * puppeteer helper example
 * test steps, pages, fragments
 * examples for sequential and parallel execution
-* generation of allure test results  
+* generation of allure test results  

docs/examples.md

@@ -240,7 +240,7 @@ module.exports = {
 
 Plugins allow to use CodeceptJS internal API to extend functionality. Use internal event dispatcher, container, output, promise recorder, to create your own reporters, test listeners, etc.
 
-CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/Codeception/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
+CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/codecept-js/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
 
 A plugin is a basic JS module returning a function. Plugins can have individual configs which are passed into this function:
 
@@ -255,7 +255,7 @@ module.exports = function(config) {
 }
 ```
 
-Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/Codeception/CodeceptJS/tree/master/lib/helper).
+Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/codecept-js/CodeceptJS/tree/master/lib/helper).
 
 To enable your custom plugin in config add it to `plugins` section. Specify path to node module using `require`.
 
@@ -332,21 +332,21 @@ module.exports = function(options) {
 CodeceptJS provides an API which can be loaded via `require('codeceptjs')` when CodeceptJS is installed locally.
 These internal objects are available:
 
-* [`codecept`](https://github.com/Codeception/CodeceptJS/blob/master/lib/codecept.js): test runner class
-* [`config`](https://github.com/Codeception/CodeceptJS/blob/master/lib/config.js): current codecept config
-* [`event`](https://github.com/Codeception/CodeceptJS/blob/master/lib/event.js): event listener
-* [`recorder`](https://github.com/Codeception/CodeceptJS/blob/master/lib/recorder.js): global promise chain
-* [`output`](https://github.com/Codeception/CodeceptJS/blob/master/lib/output.js): internal printer
-* [`container`](https://github.com/Codeception/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
-* [`helper`](https://github.com/Codeception/CodeceptJS/blob/master/lib/helper.js): basic helper class
-* [`actor`](https://github.com/Codeception/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
+* [`codecept`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/codecept.js): test runner class
+* [`config`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/config.js): current codecept config
+* [`event`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/event.js): event listener
+* [`recorder`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js): global promise chain
+* [`output`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/output.js): internal printer
+* [`container`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
+* [`helper`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/helper.js): basic helper class
+* [`actor`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
 
-[API reference](https://github.com/Codeception/CodeceptJS/tree/master/docs/api) is available on GitHub.
+[API reference](https://github.com/codecept-js/CodeceptJS/tree/master/docs/api) is available on GitHub.
 Also please check the source code of corresponding modules.
 
 ### Event Listeners
 
-CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/Codeception/CodeceptJS/blob/master/lib/event.js).
+CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/codecept-js/CodeceptJS/blob/master/lib/event.js).
 
 It can be required from codeceptjs package if it is installed locally.
 
@@ -389,7 +389,7 @@ Available events:
 * *sync* - means that event is fired in the moment of action happens.
 * *async* - means that event is fired when an actions is scheduled. Use `recorder` to schedule your actions.
 
-For further reference look for [currently available listeners](https://github.com/Codeception/CodeceptJS/tree/master/lib/listener) using event system.
+For further reference look for [currently available listeners](https://github.com/codecept-js/CodeceptJS/tree/master/lib/listener) using event system.
 
 #### Test Object
 
@@ -421,7 +421,7 @@ Step events provide step objects with following fields:
 
 ### Recorder
 
-To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/Codeception/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
+To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
 
 Provide a function description as a first parameter, function should return a promise:
 

docs/hooks.md

@@ -301,4 +301,4 @@ New locator strategy is ready to use:
 I.click('=Login');
 ```
 
-> For more details on locator object see [Locator](https://github.com/Codeception/CodeceptJS/blob/master/lib/locator.js) class implementation.
+> For more details on locator object see [Locator](https://github.com/codecept-js/CodeceptJS/blob/master/lib/locator.js) class implementation.

docs/locators.md

@@ -10,7 +10,7 @@ title: Translation
 Test output and the way tests are written can be localized.
 This way scenarios can be written in almost native language using UTF support of JavaScript.
 If you have non-English team and you work on non-English project consider enabling translation
-by setting translation to [one of available languages](https://github.com/Codeception/CodeceptJS/blob/master/translations).
+by setting translation to [one of available languages](https://github.com/codecept-js/CodeceptJS/blob/master/translations).
 
 Please refer to translated steps inside translation files and send Pull Requests to add missing.
 

docs/translation.md

@@ -6,7 +6,7 @@ title: Videos
 editLink: false
 ---
 
-> Add your own videos to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Videos)
+> Add your own videos to our [Wiki Page](https://github.com/codecept-js/CodeceptJS/wiki/Videos)
 [![Maxresdefault](http://i3.ytimg.com/vi/BRMWstiOTks/maxresdefault.jpg)](https://www.youtube.com/watch?v=BRMWstiOTks)
 
 * ## [An Introduction, Getting started and working with CodeceptJS & Puppeteer (EAWeekend)](https://www.youtube.com/watch?v=BRMWstiOTks)

docs/videos.md

@@ -48,6 +48,11 @@ class Cli extends Base {
     });
 
     runner.on('pending', (test) => {
+      if (test.parent && test.parent.pending) {
+        const suite = test.parent;
+        const skipInfo = suite.opts.skipInfo || {};
+        skipTestConfig(test, skipInfo.message);
+      }
       this.loadedTests.push(test.id);
       cursor.CR();
       output.test.skipped(test);
@@ -101,10 +106,7 @@ class Cli extends Base {
             if (!test.opts.skipInfo) {
               test.opts.skipInfo = {};
             }
-            test.opts.skipInfo.message = 'Skipped due to failure in \'before\' hook';
-            test.opts.skipInfo.isFastSkipped = true;
-            event.emit(event.test.skipped, test);
-            test.state = 'skipped';
+            skipTestConfig(test, 'Skipped due to failure in \'before\' hook');
             output.test.skipped(test);
             skippedCount += 1;
           }
@@ -193,6 +195,19 @@ function matchTest(grep, test) {
   return true;
 }
 
+function skipTestConfig(test, message) {
+  if (!test.opts) {
+    test.opts = {};
+  }
+  if (!test.opts.skipInfo) {
+    test.opts.skipInfo = {};
+  }
+  test.opts.skipInfo.message = test.opts.skipInfo.message || message;
+  test.opts.skipInfo.isFastSkipped = true;
+  event.emit(event.test.skipped, test);
+  test.state = 'skipped';
+}
+
 module.exports = function (runner, opts) {
   return new Cli(runner, opts);
 };

lib/cli.js

@@ -16,6 +16,7 @@ const { tryOrDefault } = require('../../utils');
 // eslint-disable-next-line no-unused-vars
 let stdout = '';
 /* eslint-enable no-unused-vars */
+const stderr = '';
 
 // Requiring of Codecept need to be after tty.getWindowSize is available.
 const Codecept = require(process.env.CODECEPT_CLASS_PATH || '../../codecept');

lib/command/workers/runTests.js

@@ -300,7 +300,13 @@ class Playwright extends Helper {
   async _before() {
     recorder.retry({
       retries: 5,
-      when: err => err.message.indexOf('context') > -1, // ignore context errors
+      when: err => {
+        if (!err || typeof (err.message) !== 'string') {
+          return false;
+        }
+        // ignore context errors
+        return err.message.includes('context');
+      },
     });
     if (this.options.restart && !this.options.manualStart) return this._startBrowser();
     if (!this.isRunning && !this.options.manualStart) return this._startBrowser();
@@ -1867,7 +1873,7 @@ class Playwright extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, urlPart, { timeout: waitTimeout }).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Timeout/i.test(e.message)) {
         throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;
@@ -1891,7 +1897,7 @@ class Playwright extends Helper {
       return currUrl.indexOf(urlPart) > -1;
     }, urlPart, { timeout: waitTimeout }).catch(async (e) => {
       const currUrl = await this._getPageUrl(); // Required because the waitForFunction can't return data.
-      if (/failed: timeout/i.test(e.message)) {
+      if (/Timeout/i.test(e.message)) {
         throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`);
       } else {
         throw e;

lib/helper/Playwright.js

@@ -249,7 +249,13 @@ class Puppeteer extends Helper {
     this.sessionPages = {};
     recorder.retry({
       retries: 5,
-      when: err => err.message.indexOf('context') > -1, // ignore context errors
+      when: err => {
+        if (!err || typeof (err.message) !== 'string') {
+          return false;
+        }
+        // ignore context errors
+        return err.message.includes('context');
+      },
     });
     if (this.options.restart && !this.options.manualStart) return this._startBrowser();
     if (!this.isRunning && !this.options.manualStart) return this._startBrowser();
@@ -418,6 +424,7 @@ class Puppeteer extends Helper {
   async _setPage(page) {
     page = await page;
     this._addPopupListener(page);
+    this._addErrorListener(page);
     this.page = page;
     if (!page) return;
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
@@ -427,6 +434,15 @@ class Puppeteer extends Helper {
     }
   }
 
+  async _addErrorListener(page) {
+    if (!page) {
+      return;
+    }
+    page.on('error', async (error) => {
+      console.error('Puppeteer page error', error);
+    });
+  }
+
   /**
    * Add the 'dialog' event listener to a page
    * @page {Puppeteer.Page}

lib/helper/Puppeteer.js

@@ -2203,6 +2203,7 @@ class WebDriver extends Helper {
         let selected = await forEachAsync(res, async el => el.isDisplayed());
 
         if (!Array.isArray(selected)) selected = [selected];
+        selected = selected.filter(val => val === true);
         return selected.length === num;
       }, aSec * 1000, `The number of elements (${new Locator(locator)}) is not ${num} after ${aSec} sec`);
     }
@@ -2212,6 +2213,7 @@ class WebDriver extends Helper {
       let selected = await forEachAsync(res, async el => el.isDisplayed());
 
       if (!Array.isArray(selected)) selected = [selected];
+      selected = selected.filter(val => val === true);
       return selected.length === num;
     }, { timeout: aSec * 1000, timeoutMsg: `The number of elements (${new Locator(locator)}) is not ${num} after ${aSec} sec` });
   }

lib/helper/WebDriver.js

@@ -114,9 +114,28 @@ module.exports = function (suite) {
       suite.beforeAll('codeceptjs.beforeSuite', () => scenario.suiteSetup(suite));
       afterAllHooks.push(['codeceptjs.afterSuite', () => scenario.suiteTeardown(suite)]);
 
+      if (opts.skipInfo && opts.skipInfo.skipped) {
+        suite.pending = true;
+        suite.opts = { ...suite.opts, skipInfo: opts.skipInfo };
+      }
+
       return new FeatureConfig(suite);
     };
 
+    /**
+     * Pending test suite.
+     * @global
+     * @kind constant
+     * @type {CodeceptJS.IFeature}
+     */
+    context.xFeature = context.Feature.skip = function (title, opts) {
+      const skipInfo = {
+        skipped: true,
+        message: 'Skipped due to "skip" on Feature.',
+      };
+      return context.Feature(title, { ...opts, skipInfo });
+    };
+
     context.BeforeSuite = function (fn) {
       suites[0].beforeAll('BeforeSuite', scenario.injected(fn, suites[0], 'beforeSuite'));
     };