codeceptjs 2.6.7 → 2.6.11

package/lib/helper/Playwright.js

@@ -1,7 +1,6 @@
 const requireg = require('requireg');
 const path = require('path');
 const fs = require('fs');
-const fsExtra = require('fs-extra');
 
 const Helper = require('../helper');
 const Locator = require('../locator');
@@ -11,7 +10,7 @@ const { urlEquals } = require('../assert/equal');
 const { equals } = require('../assert/equal');
 const { empty } = require('../assert/empty');
 const { truth } = require('../assert/truth');
-const isElementClickable = require('./scripts/isElementClickable');
+
 const {
   xpathLocator,
   ucfirst,
@@ -160,7 +159,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * }
  * ```
  *
- * #### Example #6: Lunach tests emulating iPhone 6
+ * #### Example #6: Launch tests emulating iPhone 6
  *
  *
  *
@@ -234,6 +233,7 @@ class Playwright extends Helper {
       keepBrowserState: false,
       show: false,
       defaultPopupAction: 'accept',
+      ignoreHTTPSErrors: false, // Adding it here o that context can be set up to ignore the SSL errors
     };
 
     config = Object.assign(defaults, config);
@@ -348,6 +348,9 @@ class Playwright extends Helper {
       await this.executeScript('localStorage.clear();').catch((err) => {
         if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
       });
+      await this.executeScript('sessionStorage.clear();').catch((err) => {
+        if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
+      });
     }
     // await this.closeOtherTabs();
     return this.browser;
@@ -539,7 +542,7 @@ class Playwright extends Helper {
     this.browser.on('targetchanged', (target) => {
       this.debugSection('Url', target.url());
     });
-    this.browserContext = await this.browser.newContext({ acceptDownloads: true, ...this.options.emulate });
+    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();
 
@@ -691,7 +694,7 @@ class Playwright extends Helper {
     assertElementExists(els);
 
     // Use manual mouse.move instead of .hover() so the offset can be added to the coordinates
-    const { x, y } = await els[0]._clickablePoint();
+    const { x, y } = await clickablePoint(els[0]);
     await this.page.mouse.move(x + offsetX, y + offsetY);
     return this._waitForAction();
   }
@@ -747,7 +750,7 @@ class Playwright extends Helper {
       const els = await this._locate(locator);
       assertElementExists(els, locator, 'Element');
       await els[0].scrollIntoViewIfNeeded();
-      const elementCoordinates = await els[0]._clickablePoint();
+      const elementCoordinates = await clickablePoint(els[0]);
       await this.executeScript((offsetX, offsetY) => window.scrollBy(offsetX, offsetY), { offsetX: elementCoordinates.x + offsetX, offsetY: elementCoordinates.y + offsetY });
     } else {
       await this.executeScript(({ offsetX, offsetY }) => window.scrollTo(offsetX, offsetY), { offsetX, offsetY });
@@ -1141,7 +1144,7 @@ class Playwright extends Helper {
   /**
    * {{> pressKeyWithKeyNormalization }}
    *
-   * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Playwright#1313](https://github.com/GoogleChrome/Playwright/issues/1313)).
+   * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
    */
   async pressKey(key) {
     const modifiers = [];
@@ -1168,6 +1171,20 @@ class Playwright extends Helper {
     return this._waitForAction();
   }
 
+  /**
+   * {{> type }}
+   */
+  async type(keys, delay = null) {
+    if (!Array.isArray(keys)) {
+      keys = keys.split('');
+    }
+
+    for (const key of keys) {
+      await this.page.keyboard.press(key);
+      if (delay) await this.wait(delay / 1000);
+    }
+  }
+
   /**
    * {{> fillField }}
    *
@@ -1600,8 +1617,8 @@ class Playwright extends Helper {
     const src = await this._locate(locator);
     assertElementExists(src, locator, 'Slider Element');
 
-    // Note: Using private api ._clickablePoint because the .BoundingBox does not take into account iframe offsets!
-    const sliderSource = await src[0]._clickablePoint();
+    // Note: Using clickablePoint private api because the .BoundingBox does not take into account iframe offsets!
+    const sliderSource = await clickablePoint(src[0]);
 
     // Drag start point
     await this.page.mouse.move(sliderSource.x, sliderSource.y, { steps: 5 });
@@ -1631,6 +1648,21 @@ class Playwright extends Helper {
     return array.length === 1 ? array[0] : array;
   }
 
+  /**
+   * {{> saveElementScreenshot }}
+   *
+   */
+  async saveElementScreenshot(locator, fileName) {
+    const outputFile = screenshotOutputFolder(fileName);
+
+    const res = await this._locate(locator);
+    assertElementExists(res, locator);
+    if (res.length > 1) this.debug(`[Elements] Using first element out of ${res.length}`);
+    const elem = res[0];
+    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    return elem.screenshot({ path: outputFile, type: 'png' });
+  }
+
   /**
    * {{> saveScreenshot }}
    */
@@ -1962,7 +1994,7 @@ class Playwright extends Helper {
   /**
    * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
    *
-   * See [Pupeteer's reference](https://github.com/GoogleChrome/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
+   * See [Pupeteer's reference](https://github.com/microsoft/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions)
    *
    * @param {*} opts
    */
@@ -2068,7 +2100,14 @@ async function proceedClick(locator, context = null, options = {}) {
   } else {
     assertElementExists(els, locator, 'Clickable element');
   }
-  await els[0].click(options);
+  /*
+    using the force true options itself but instead dispatching a click
+  */
+  if (options.force) {
+    await els[0].dispatchEvent('click');
+  } else {
+    await els[0].click(options);
+  }
   const promises = [];
   if (options.waitForNavigation) {
     promises.push(this.waitForNavigation());
@@ -2190,9 +2229,9 @@ async function proceedDragAndDrop(sourceLocator, destinationLocator, options = {
   const dst = await this._locate(destinationLocator);
   assertElementExists(dst, destinationLocator, 'Destination Element');
 
-  // Note: Using private api ._clickablePoint becaues the .BoundingBox does not take into account iframe offsets!
-  const dragSource = await src[0]._clickablePoint();
-  const dragDestination = await dst[0]._clickablePoint();
+  // Note: Using clickablePoint private api becaues the .BoundingBox does not take into account iframe offsets!
+  const dragSource = await clickablePoint(src[0]);
+  const dragDestination = await clickablePoint(dst[0]);
 
   // Drag start point
   await this.page.mouse.move(dragSource.x, dragSource.y, { steps: 5 });
@@ -2317,10 +2356,20 @@ function $XPath(element, selector) {
 async function targetCreatedHandler(page) {
   if (!page) return;
   this.withinLocator = null;
-  page.on('load', (frame) => {
+  page.on('load', () => {
     page.$('body')
       .catch(() => null)
-      .then(context => this.context = context);
+      .then(async context => {
+        if (this.context._type === 'Frame') {
+          // we are inside iframe?
+          const frameEl = await this.context.frameElement();
+          this.context = await frameEl.contentFrame();
+          return;
+        }
+        // if context element was in iframe - keep it
+        // if (await this.context.ownerFrame()) return;
+        this.context = context;
+      });
   });
   page.on('console', (msg) => {
     this.debugSection(`Browser:${ucfirst(msg.type())}`, (msg._text || '') + msg.args().join(' '));
@@ -2339,7 +2388,7 @@ async function targetCreatedHandler(page) {
 }
 
 // List of key values to key definitions
-// https://github.com/GoogleChrome/Playwright/blob/v1.20.0/lib/USKeyboardLayout.js
+// https://github.com/puppeteer/puppeteer/blob/v1.20.0/lib/USKeyboardLayout.js
 const keyDefinitionMap = {
   /* eslint-disable quote-props */
   '0': 'Digit0',
@@ -2403,3 +2452,12 @@ function getNormalizedKey(key) {
   }
   return normalizedKey;
 }
+
+async function clickablePoint(el) {
+  const rect = await el.boundingBox();
+  if (!rect) throw new ElementNotFound(el);
+  const {
+    x, y, width, height,
+  } = rect;
+  return { x: x + width / 2, y: y + height / 2 };
+}

package/lib/helper/Protractor.js

@@ -10,8 +10,8 @@ const requireg = require('requireg');
 const Helper = require('../helper');
 const stringIncludes = require('../assert/include').includes;
 const { urlEquals, equals } = require('../assert/equal');
-const empty = require('../assert/empty').empty;
-const truth = require('../assert/truth').truth;
+const { empty } = require('../assert/empty');
+const { truth } = require('../assert/truth');
 const {
   xpathLocator,
   fileExists,
@@ -967,6 +967,30 @@ class Protractor extends Helper {
     return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).negate(url, currentUrl));
   }
 
+  /**
+   * {{> saveElementScreenshot }}
+   *
+   */
+  async saveElementScreenshot(locator, fileName) {
+    const outputFile = screenshotOutputFolder(fileName);
+
+    const writeFile = (png, outputFile) => {
+      const fs = require('fs');
+      const stream = fs.createWriteStream(outputFile);
+      stream.write(Buffer.from(png, 'base64'));
+      stream.end();
+      return new Promise(resolve => stream.on('finish', resolve));
+    };
+
+    const res = await this._locate(locator);
+    assertElementExists(res, locator);
+    if (res.length > 1) this.debug(`[Elements] Using first element out of ${res.length}`);
+    const elem = res[0];
+    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    const png = await elem.takeScreenshot();
+    return writeFile(png, outputFile);
+  }
+
   /**
    * {{> saveScreenshot }}
    */

package/lib/helper/Puppeteer.js

@@ -64,7 +64,7 @@ const consoleLogStore = new Console();
  * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
  * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
  * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
- * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
+ * * `getPageTimeout` (optional, default: '30000') config option to set maximum navigation time in milliseconds. If the timeout is set to 0, then timeout will be disabled.
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
  * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
  * * `userAgent`: (optional) user-agent string.
@@ -190,7 +190,7 @@ class Puppeteer extends Helper {
       disableScreenshots: false,
       uniqueScreenshotNames: false,
       manualStart: false,
-      getPageTimeout: 0,
+      getPageTimeout: 30000,
       waitForNavigation: 'load',
       restart: true,
       keepCookies: false,
@@ -295,6 +295,9 @@ class Puppeteer extends Helper {
       await this.executeScript('localStorage.clear();').catch((err) => {
         if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
       });
+      await this.executeScript('sessionStorage.clear();').catch((err) => {
+        if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
+      });
     }
     await this.closeOtherTabs();
     return this.browser;
@@ -1195,6 +1198,20 @@ class Puppeteer extends Helper {
     return this._waitForAction();
   }
 
+  /**
+   * {{> type }}
+   */
+  async type(keys, delay = null) {
+    if (!Array.isArray(keys)) {
+      keys = keys.split('');
+    }
+
+    for (const key of keys) {
+      await this.page.keyboard.press(key);
+      if (delay) await this.wait(delay / 1000);
+    }
+  }
+
   /**
    * {{> fillField }}
    * {{ react }}
@@ -1671,6 +1688,21 @@ class Puppeteer extends Helper {
     return array.length === 1 ? array[0] : array;
   }
 
+  /**
+   * {{> saveElementScreenshot }}
+   *
+   */
+  async saveElementScreenshot(locator, fileName) {
+    const outputFile = screenshotOutputFolder(fileName);
+
+    const res = await this._locate(locator);
+    assertElementExists(res, locator);
+    if (res.length > 1) this.debug(`[Elements] Using first element out of ${res.length}`);
+    const elem = res[0];
+    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    return elem.screenshot({ path: outputFile, type: 'png' });
+  }
+
   /**
    * {{> saveScreenshot }}
    */

package/lib/helper/TestCafe.js

@@ -731,6 +731,21 @@ class TestCafe extends Helper {
     stringIncludes('HTML source of a page').negate(text, source);
   }
 
+  /**
+   * {{> saveElementScreenshot }}
+   *
+   */
+  async saveElementScreenshot(locator, fileName) {
+    const outputFile = path.join(global.output_dir, fileName);
+
+    const sel = await findElements.call(this, this.context, locator);
+    assertElementExists(sel);
+    const firstElement = await sel.filterVisible().nth(0);
+
+    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    return this.t.takeElementScreenshot(firstElement, fileName);
+  }
+
   /**
    * {{> saveScreenshot }}
    */

package/lib/helper/WebDriver.js

@@ -1530,6 +1530,21 @@ class WebDriver extends Helper {
     return elem.moveTo({ xOffset, yOffset });
   }
 
+  /**
+   * {{> saveElementScreenshot }}
+   *
+   */
+  async saveElementScreenshot(locator, fileName) {
+    const outputFile = screenshotOutputFolder(fileName);
+
+    const res = await this._locate(withStrictLocator(locator), true);
+    assertElementExists(res, locator);
+    const elem = usingFirstElement(res);
+
+    this.debug(`Screenshot of ${locator} element has been saved to ${outputFile}`);
+    return elem.saveScreenshot(outputFile);
+  }
+
   /**
    * {{> saveScreenshot }}
    *
@@ -1755,14 +1770,19 @@ class WebDriver extends Helper {
 
   /**
    * {{> type }}
-   * Type out given array of keys or a string of text
    */
-  async type(keys) {
-    if (Array.isArray(keys)) {
-      await this.browser.keys(keys);
+  async type(keys, delay = null) {
+    if (!Array.isArray(keys)) {
+      keys = keys.split('');
+    }
+    if (delay) {
+      for (const key of keys) {
+        await this.browser.keys(key);
+        await this.wait(delay / 1000);
+      }
       return;
     }
-    await this.browser.keys(keys.split(''));
+    await this.browser.keys(keys);
   }
 
   /**
@@ -1819,12 +1839,24 @@ class WebDriver extends Helper {
 
     // for chrome
     if (browser.isW3C) {
-      return browser.performActions([
-        { type: 'pointerDown', button: 0 },
-        {
-          type: 'pointerMove', origin: 'pointer', duration: 1000, x: offsetX, y: 0,
-        },
-        { type: 'pointerUp', button: 0 },
+      const xOffset = await this.grabElementBoundingRect(locator, 'x');
+      const yOffset = await this.grabElementBoundingRect(locator, 'y');
+
+      return browser.performActions([{
+        type: 'pointer',
+        id: 'pointer1',
+        parameters: { pointerType: 'mouse' },
+        actions: [
+          {
+            type: 'pointerMove', origin: 'pointer', duration: 1000, x: xOffset, y: yOffset,
+          },
+          { type: 'pointerDown', button: 0 },
+          {
+            type: 'pointerMove', origin: 'pointer', duration: 1000, x: offsetX, y: 0,
+          },
+          { type: 'pointerUp', button: 0 },
+        ],
+      },
       ]);
     }
 

package/lib/helper/clientscripts/PollyWebDriverExt.js

@@ -55,7 +55,7 @@ const pollyWebDriver = {
         throw new Error(`Invalid value for baseUrl: ${baseUrl}`);
       }
       if (!(typeof oneOrMoreUrls === 'string' || Array.isArray(oneOrMoreUrls))) {
-        throw new Error(`Expected type of Urls is 'string' or 'array', Found '${typeof oneOrMoreUrls}'.`);
+        throw new Error(`Expected type of URLs is 'string' or 'array', found '${typeof oneOrMoreUrls}'.`);
       }
       // Remove '/' if it's at the end of baseUrl
       const lastChar = baseUrl.substr(-1);

package/lib/hooks.js

@@ -1,7 +1,6 @@
 const fsPath = require('path');
 
-const getParamNames = require('./utils').getParamNames;
-const fileExists = require('./utils').fileExists;
+const { getParamNames, fileExists } = require('./utils');
 const output = require('./output');
 
 module.exports = function (hook, done, stage) {

package/lib/interfaces/gherkin.js

@@ -2,7 +2,6 @@ const { Parser } = require('gherkin');
 const { Context, Suite, Test } = require('mocha');
 
 const { matchStep } = require('./bdd');
-const { isAsyncFunction } = require('../utils');
 const event = require('../event');
 const scenario = require('../scenario');
 const Step = require('../step');

package/lib/listener/helpers.js

@@ -2,8 +2,7 @@ const event = require('../event');
 const container = require('../container');
 const recorder = require('../recorder');
 const store = require('../store');
-const error = require('../output').error;
-const { deepMerge } = require('../utils');
+const { error } = require('../output');
 /**
  * Enable Helpers to listen to test events
  */

package/lib/listener/mocha.js

@@ -1,7 +1,6 @@
 const event = require('../event');
 const container = require('../container');
 const recorder = require('../recorder');
-const error = require('../output').error;
 
 module.exports = function () {
   let mocha;

package/lib/locator.js

@@ -1,7 +1,7 @@
 const cssToXPath = require('css-to-xpath');
-const sprintf = require('sprintf-js').sprintf;
+const { sprintf } = require('sprintf-js');
 
-const xpathLocator = require('./utils').xpathLocator;
+const { xpathLocator } = require('./utils');
 
 const locatorTypes = ['css', 'by', 'xpath', 'id', 'name', 'fuzzy', 'frame'];
 /** @class */

package/lib/pause.js

@@ -7,7 +7,7 @@ const store = require('./store');
 const recorder = require('./recorder');
 const event = require('./event');
 const output = require('./output');
-const methodsOfObject = require('./utils').methodsOfObject;
+const { methodsOfObject } = require('./utils');
 
 // npm install colors
 let rl;

package/lib/plugin/allure.js

@@ -2,7 +2,7 @@ const Allure = require('allure-js-commons');
 
 const event = require('../event');
 const logger = require('../output');
-const ansiRegExp = require('../utils').ansiRegExp;
+const { ansiRegExp } = require('../utils');
 
 const defaultConfig = {
   outputDir: global.output_dir,

package/lib/plugin/autoDelay.js

@@ -2,9 +2,8 @@ const Container = require('../container');
 const store = require('../store');
 const recorder = require('../recorder');
 const event = require('../event');
-const log = require('../output').log;
-
-const supportedHelpers = require('./standardActingHelpers');
+const { log } = require('../output');
+const supportedHelpers = require('./standardActingHelpers').slice();
 
 const methodsToDelay = [
   'click',
@@ -60,6 +59,7 @@ const defaultConfig = {
  *
  */
 module.exports = function (config) {
+  supportedHelpers.push('REST');
   const helpers = Container.helpers();
   let helper;
 

package/lib/plugin/autoLogin.js

@@ -4,7 +4,7 @@ const { fileExists } = require('../utils');
 const container = require('../container');
 const store = require('../store');
 const recorder = require('../recorder');
-const debug = require('../output').debug;
+const { debug } = require('../output');
 const isAsyncFunction = require('../utils').isAsyncFunction;
 
 const defaultUser = {

package/lib/plugin/screenshotOnFail.js

@@ -86,7 +86,7 @@ module.exports = function (config) {
       } else {
         fileName += '.failed.png';
       }
-      output.plugin('screenshotOnFail', 'Test failed, saving screenshot');
+      output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot');
 
       try {
         if (options.reportDir) {
@@ -107,6 +107,7 @@ module.exports = function (config) {
           allureReporter.addAttachment('Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), 'image/png');
         }
       } catch (err) {
+        output.plugin(err);
         if (
           err
           && err.type

package/lib/plugin/standardActingHelpers.js

@@ -1,14 +1,11 @@
 const standardActingHelpers = [
-  'Mochawesome',
   'WebDriver',
-  'WebDriverIO',
   'Protractor',
   'Appium',
   'Nightmare',
   'Puppeteer',
   'Playwright',
   'TestCafe',
-  'REST',
 ];
 
 module.exports = standardActingHelpers;

package/lib/recorder.js

@@ -1,7 +1,7 @@
 const debug = require('debug')('codeceptjs');
 const promiseRetry = require('promise-retry');
 
-const log = require('./output').log;
+const { log } = require('./output');
 
 let promise;
 let running = false;

package/lib/step.js

@@ -96,6 +96,9 @@ class Step {
   /** @return {string} */
   humanizeArgs() {
     return this.args.map((arg) => {
+      if (!arg) {
+        return '';
+      }
       if (typeof arg === 'string') {
         return `"${arg}"`;
       }

package/lib/ui.js

@@ -99,6 +99,7 @@ module.exports = function (suite) {
 
       const suite = Suite.create(suites[0], title);
       if (!opts) opts = {};
+      suite.opts = opts;
       suite.timeout(0);
 
       if (opts.retries) suite.retries(opts.retries);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "2.6.7",
+  "version": "2.6.11",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -9,6 +9,7 @@
     "puppeteer",
     "webdriver",
     "testcafe",
+    "playwright",
     "protractor",
     "bdd",
     "tdd",
@@ -110,7 +111,7 @@
     "mocha-parallel-tests": "^2.3.0",
     "nightmare": "^3.0.2",
     "nodemon": "^1.19.4",
-    "playwright": "^1.1.1",
+    "playwright": "^1.4.0",
     "protractor": "^5.4.4",
     "puppeteer": "^4.0.0",
     "qrcode-terminal": "^0.12.0",