codeceptjs 3.0.6 → 3.0.7

package/CHANGELOG.md

@@ -1,10 +1,36 @@
+## 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 +39,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 +52,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 +60,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/bin/codecept.js

@@ -27,6 +27,7 @@ program.command('shell [path]')
   .description('Interactive shell')
   .option('--verbose', 'output internal logging information')
   .option('--profile [value]', 'configuration profile to be used')
+  .option('-c, --config [file]', 'configuration file to be used')
   .action(require('../lib/command/interactive'));
 
 program.command('list [path]')

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

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(

package/docs/build/Playwright.js

@@ -35,9 +35,10 @@ let defaultSelectorEnginesInitialized = false;
 
 const popupStore = new Popup();
 const consoleLogStore = new Console();
-const availableBrowsers = ['chromium', 'webkit', 'firefox'];
+const availableBrowsers = ['chromium', 'webkit', 'firefox', 'electron'];
 
 const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine');
+
 /**
  * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
  *
@@ -58,7 +59,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * This helper should be configured in codecept.json or codecept.conf.js
  *
  * * `url`: base url of website to be tested
- * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`. Default: chromium.
+ * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
  * * `show`: (optional, default: false) - show browser window.
  * * `restart`: (optional, default: true) - restart browser between tests.
  * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
@@ -77,6 +78,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * * `userAgent`: (optional) user-agent string.
  * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
  * * `chromium`: (optional) pass additional chromium options
+ * * `electron`: (optional) pass additional electron options
  *
  * #### Example #1: Wait for 0 network connections.
  *
@@ -121,7 +123,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * }
  * ```
  *
- * #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target)
+ * #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://playwright.dev/docs/api/class-browsertype#browsertypeconnectparams)
  *
  * ```js
  * {
@@ -129,7 +131,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  *      Playwright: {
  *        url: "http://localhost",
  *        chromium: {
- *          browserWSEndpoint: "ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a"
+ *          browserWSEndpoint: { wsEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a' }
  *        }
  *      }
  *    }
@@ -147,6 +149,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  *      url: "http://localhost",
  *      show: true // headless mode not supported for extensions
  *      chromium: {
+ *        userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
  *        args: [
  *           `--disable-extensions-except=${pathToExtension}`,
  *           `--load-extension=${pathToExtension}`
@@ -206,6 +209,8 @@ class Playwright extends Helper {
     this.isAuthenticated = false;
     this.sessionPages = {};
     this.activeSessionName = '';
+    this.isElectron = false;
+    this.electronSessions = [];
 
     // override defaults with config
     this._setConfig(config);
@@ -257,6 +262,8 @@ class Playwright extends Helper {
       ...this._getOptionsForBrowser(config),
     };
     this.isRemoteBrowser = !!this.playwrightOptions.browserWSEndpoint;
+    this.isElectron = this.options.browser === 'electron';
+    this.userDataDir = this.playwrightOptions.userDataDir;
     popupStore.defaultAction = this.options.defaultPopupAction;
   }
 
@@ -268,7 +275,7 @@ class Playwright extends Helper {
       },
       {
         name: 'browser',
-        message: 'Browser in which testing will be performed. Possible options: chromium, firefox or webkit',
+        message: 'Browser in which testing will be performed. Possible options: chromium, firefox, webkit or electron',
         default: 'chromium',
       },
     ];
@@ -320,11 +327,21 @@ class Playwright extends Helper {
   async _after() {
     if (!this.isRunning) return;
 
+    if (this.isElectron) {
+      this.browser.close();
+      this.electronSessions.forEach(session => session.close());
+      return;
+    }
+
     // close other sessions
-    const contexts = await this.browser.contexts();
-    contexts.shift();
+    try {
+      const contexts = await this.browser.contexts();
+      contexts.shift();
 
-    await Promise.all(contexts.map(c => c.close()));
+      await Promise.all(contexts.map(c => c.close()));
+    } catch (e) {
+      console.log(e);
+    }
 
     if (this.options.restart) {
       this.isRunning = false;
@@ -371,12 +388,22 @@ class Playwright extends Helper {
         this.debugSection('New Context', config ? JSON.stringify(config) : 'opened');
         this.activeSessionName = sessionName;
 
-        const bc = await this.browser.newContext(config);
-        const page = await bc.newPage();
+        let browserContext;
+        let page;
+        if (this.isElectron) {
+          const browser = await playwright._electron.launch(this.playwrightOptions);
+          this.electronSessions.push(browser);
+          browserContext = browser.context();
+          page = await browser.firstWindow();
+        } else {
+          browserContext = await this.browser.newContext(config);
+          page = await browserContext.newPage();
+        }
+
         targetCreatedHandler.call(this, page);
         this._setPage(page);
         // Create a new page inside context.
-        return bc;
+        return browserContext;
       },
       stop: async () => {
         // is closed by _after
@@ -496,6 +523,7 @@ class Playwright extends Helper {
     if (!page) return;
     page.setDefaultNavigationTimeout(this.options.getPageTimeout);
     this.context = await this.page;
+    this.contextLocator = null;
     if (this.config.browser === 'chrome') {
       await page.bringToFront();
     }
@@ -554,15 +582,19 @@ class Playwright extends Helper {
   }
 
   async _startBrowser() {
-    if (this.isRemoteBrowser) {
+    if (this.isElectron) {
+      this.browser = await playwright._electron.launch(this.playwrightOptions);
+    } else if (this.isRemoteBrowser) {
       try {
-        this.browser = await playwright[this.options.browser].connect(this.playwrightOptions);
+        this.browser = await playwright[this.options.browser].connect(this.playwrightOptions.browserWSEndpoint);
       } catch (err) {
         if (err.toString().indexOf('ECONNREFUSED')) {
           throw new RemoteBrowserConnectionRefused(err);
         }
         throw err;
       }
+    } else if (this.userDataDir) {
+      this.browser = await playwright[this.options.browser].launchPersistentContext(this.userDataDir, this.playwrightOptions);
     } else {
       this.browser = await playwright[this.options.browser].launch(this.playwrightOptions);
     }
@@ -571,11 +603,22 @@ class Playwright extends Helper {
     this.browser.on('targetchanged', (target) => {
       this.debugSection('Url', target.url());
     });
-    this.browserContext = await this.browser.newContext({ ignoreHTTPSErrors: this.options.ignoreHTTPSErrors, acceptDownloads: true, ...this.options.emulate });// Adding the HTTPSError ignore in the context so that we can ignore those errors
 
-    const existingPages = await this.browserContext.pages();
+    if (this.isElectron) {
+      this.browserContext = this.browser.context();
+    } else if (this.userDataDir) {
+      this.browserContext = this.browser;
+    } else {
+      this.browserContext = await this.browser.newContext({ ignoreHTTPSErrors: this.options.ignoreHTTPSErrors, acceptDownloads: true, ...this.options.emulate });// Adding the HTTPSError ignore in the context so that we can ignore those errors
+    }
 
-    const mainPage = existingPages[0] || await this.browserContext.newPage();
+    let mainPage;
+    if (this.isElectron) {
+      mainPage = await this.browser.firstWindow();
+    } else {
+      const existingPages = await this.browserContext.pages();
+      mainPage = existingPages[0] || await this.browserContext.newPage();
+    }
     targetCreatedHandler.call(this, mainPage);
 
     await this._setPage(mainPage);
@@ -584,6 +627,10 @@ class Playwright extends Helper {
     this.isRunning = true;
   }
 
+  _getType() {
+    return this.browser._type;
+  }
+
   async _stopBrowser() {
     this.withinLocator = null;
     this._setPage(null);
@@ -618,6 +665,7 @@ class Playwright extends Helper {
     const els = await this._locate(locator);
     assertElementExists(els, locator);
     this.context = els[0];
+    this.contextLocator = locator;
 
     this.withinLocator = new Locator(locator);
   }
@@ -625,6 +673,7 @@ class Playwright extends Helper {
   async _withinEnd() {
     this.withinLocator = null;
     this.context = await this.page;
+    this.contextLocator = null;
   }
 
   _extractDataFromPerformanceTiming(timing, ...dataNames) {
@@ -651,6 +700,9 @@ class Playwright extends Helper {
    * @param {string} url url path or global url.
    */
   async amOnPage(url) {
+    if (this.isElectron) {
+      throw new Error('Cannot open pages inside an Electron container');
+    }
     if (!(/^\w+\:\/\//.test(url))) {
       url = this.options.url + url;
     }
@@ -984,6 +1036,9 @@ class Playwright extends Helper {
    * @param {number} [num=1]
    */
   async switchToNextTab(num = 1) {
+    if (this.isElectron) {
+      throw new Error('Cannot switch tabs inside an Electron container');
+    }
     const pages = await this.browserContext.pages();
 
     const index = pages.indexOf(this.page);
@@ -1007,6 +1062,9 @@ class Playwright extends Helper {
    * @param {number} [num=1]
    */
   async switchToPreviousTab(num = 1) {
+    if (this.isElectron) {
+      throw new Error('Cannot switch tabs inside an Electron container');
+    }
     const pages = await this.browserContext.pages();
     const index = pages.indexOf(this.page);
     this.withinLocator = null;
@@ -1028,6 +1086,9 @@ class Playwright extends Helper {
    * ```
    */
   async closeCurrentTab() {
+    if (this.isElectron) {
+      throw new Error('Cannot close current tab inside an Electron container');
+    }
     const oldPage = this.page;
     await this.switchToPreviousTab();
     await oldPage.close();
@@ -1066,6 +1127,9 @@ class Playwright extends Helper {
    * ```
    */
   async openNewTab(options) {
+    if (this.isElectron) {
+      throw new Error('Cannot open new tabs inside an Electron container');
+    }
     await this._setPage(await this.browserContext.newPage(options));
     return this._waitForAction();
   }
@@ -2079,6 +2143,22 @@ class Playwright extends Helper {
     return context.evaluate.apply(context, [fn, arg]);
   }
 
+  /**
+   * Grab Locator if called within Context
+   *
+   * @param {*} locator
+   */
+  _contextLocator(locator) {
+    locator = buildLocatorString(new Locator(locator, 'css'));
+
+    if (this.contextLocator) {
+      const contextLocator = buildLocatorString(new Locator(this.contextLocator, 'css'));
+      locator = `${contextLocator} >> ${locator}`;
+    }
+
+    return locator;
+  }
+
   /**
    * Retrieves a text 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.
@@ -2094,10 +2174,11 @@ class Playwright extends Helper {
    *
    */
   async grabTextFrom(locator) {
-    const texts = await this.grabTextFromAll(locator);
-    assertElementExists(texts, locator);
-    this.debugSection('Text', texts[0]);
-    return texts[0];
+    locator = this._contextLocator(locator);
+    const text = await this.page.textContent(locator);
+    assertElementExists(text, locator);
+    this.debugSection('Text', text);
+    return text;
   }
 
   /**
@@ -2850,6 +2931,7 @@ class Playwright extends Helper {
 
       if (locator >= 0 && locator < childFrames.length) {
         this.context = childFrames[locator];
+        this.contextLocator = locator;
       } else {
         throw new Error('Element #invalidIframeSelector was not found by text|CSS|XPath');
       }
@@ -2857,6 +2939,7 @@ class Playwright extends Helper {
     }
     if (!locator) {
       this.context = this.page;
+      this.contextLocator = null;
       return;
     }
 
@@ -2867,8 +2950,10 @@ class Playwright extends Helper {
 
     if (contentFrame) {
       this.context = contentFrame;
+      this.contextLocator = null;
     } else {
       this.context = els[0];
+      this.contextLocator = locator;
     }
   }
 
@@ -3057,6 +3142,19 @@ async function findElements(matcher, locator) {
   return matcher.$$(buildLocatorString(locator));
 }
 
+async function getVisibleElements(elements) {
+  const visibleElements = [];
+  for (const element of elements) {
+    if (await element.isVisible()) {
+      visibleElements.push(element);
+    }
+  }
+  if (visibleElements.length === 0) {
+    return elements;
+  }
+  return visibleElements;
+}
+
 async function proceedClick(locator, context = null, options = {}) {
   let matcher = await this._getContext();
   if (context) {
@@ -3076,7 +3174,8 @@ async function proceedClick(locator, context = null, options = {}) {
   if (options.force) {
     await els[0].dispatchEvent('click');
   } else {
-    await els[0].click(options);
+    const element = els.length > 1 ? (await getVisibleElements(els))[0] : els[0];
+    await element.click(options);
   }
   const promises = [];
   if (options.waitForNavigation) {
@@ -3334,11 +3433,13 @@ async function targetCreatedHandler(page) {
           // we are inside iframe?
           const frameEl = await this.context.frameElement();
           this.context = await frameEl.contentFrame();
+          this.contextLocator = null;
           return;
         }
         // if context element was in iframe - keep it
         // if (await this.context.ownerFrame()) return;
         this.context = page;
+        this.contextLocator = null;
       });
   });
   page.on('console', (msg) => {
@@ -3349,7 +3450,7 @@ async function targetCreatedHandler(page) {
   if (this.options.userAgent) {
     await page.setUserAgent(this.options.userAgent);
   }
-  if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
+  if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0 && this._getType() === 'Browser') {
     const dimensions = this.options.windowSize.split('x');
     const width = parseInt(dimensions[0], 10);
     const height = parseInt(dimensions[1], 10);

package/docs/build/REST.js

@@ -59,7 +59,8 @@ class REST extends Helper {
 
     this.options = { ...this.options, ...config };
     this.headers = { ...this.options.defaultHeaders };
-    axios.defaults.headers = this.options.defaultHeaders;
+    this.axios = axios.create();
+    this.axios.defaults.headers = this.options.defaultHeaders;
   }
 
   static _checkRequirements() {
@@ -77,7 +78,7 @@ class REST extends Helper {
    */
   async _executeRequest(request) {
     const _debugRequest = { ...request };
-    axios.defaults.timeout = request.timeout || this.options.timeout;
+    this.axios.defaults.timeout = request.timeout || this.options.timeout;
 
     if (this.headers && this.headers.auth) {
       request.auth = this.headers.auth;
@@ -102,7 +103,7 @@ class REST extends Helper {
 
     let response;
     try {
-      response = await axios(request);
+      response = await this.axios(request);
     } catch (err) {
       if (!err.response) throw err;
       this.debugSection('Response', `Response error. Status code: ${err.response.status}`);