codeceptjs 2.6.7 → 2.6.11

package/docs/build/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,
@@ -1428,6 +1428,38 @@ class Protractor extends Helper {
     return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).negate(url, currentUrl));
   }
 
+  /**
+   * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   * 
+   * ```js
+   * I.saveElementScreenshot(`#submit`,'debug.png');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.  
+   * @param {string} fileName file name to save.
+   *
+   */
+  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);
+  }
+
   /**
    * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
    * Filename is relative to output folder.

package/docs/build/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;
@@ -1519,6 +1522,37 @@ class Puppeteer extends Helper {
     return this._waitForAction();
   }
 
+  /**
+   * Types out the given text into an active field.
+   * To slow down typing use a second parameter, to set interval between key presses.
+   * _Note:_ Should be used when [`fillField`](#fillfield) is not an option.
+   * 
+   * ```js
+   * // passing in a string
+   * I.type('Type this out.');
+   * 
+   * // typing values with a 100ms interval
+   * I.type('4141555311111111', 100);
+   * 
+   * // passing in an array
+   * I.type(['T', 'E', 'X', 'T']);
+   * ```
+   * 
+   * @param {string|string[]} key or array of keys to type.
+   * @param {?number} [delay=null] (optional) delay in ms between key presses
+   * 
+   */
+  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);
+    }
+  }
+
   /**
    * Fills a text field or textarea, after clearing its value, with the given string.
    * Field is located by name, label, CSS, or XPath.
@@ -2339,6 +2373,29 @@ class Puppeteer extends Helper {
     return array.length === 1 ? array[0] : array;
   }
 
+  /**
+   * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   * 
+   * ```js
+   * I.saveElementScreenshot(`#submit`,'debug.png');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.  
+   * @param {string} fileName file name to save.
+   *
+   */
+  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' });
+  }
+
   /**
    * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
    * Filename is relative to output folder.

package/docs/build/TestCafe.js

@@ -1043,6 +1043,29 @@ class TestCafe extends Helper {
     stringIncludes('HTML source of a page').negate(text, source);
   }
 
+  /**
+   * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   * 
+   * ```js
+   * I.saveElementScreenshot(`#submit`,'debug.png');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.  
+   * @param {string} fileName file name to save.
+   *
+   */
+  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);
+  }
+
   /**
    * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
    * Filename is relative to output folder.

package/docs/build/WebDriver.js

@@ -2037,6 +2037,29 @@ class WebDriver extends Helper {
     return elem.moveTo({ xOffset, yOffset });
   }
 
+  /**
+   * Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
+   * Filename is relative to output folder.
+   * 
+   * ```js
+   * I.saveElementScreenshot(`#submit`,'debug.png');
+   * ```
+   * 
+   * @param {string|object} locator element located by CSS|XPath|strict locator.  
+   * @param {string} fileName file name to save.
+   *
+   */
+  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);
+  }
+
   /**
    * Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
    * Filename is relative to output folder.
@@ -2397,26 +2420,37 @@ class WebDriver extends Helper {
   }
 
   /**
-   * 
-   * Types out the given string or the array of keys provided.
-   * _Note:_ Should only be used when using [`fillField`](#fillfield) is not an option.
+   * Types out the given text into an active field.
+   * To slow down typing use a second parameter, to set interval between key presses.
+   * _Note:_ Should be used when [`fillField`](#fillfield) is not an option.
    * 
    * ```js
-   * // When passing in a string
+   * // passing in a string
    * I.type('Type this out.');
-   * // When passing in an array
+   * 
+   * // typing values with a 100ms interval
+   * I.type('4141555311111111', 100);
+   * 
+   * // passing in an array
    * I.type(['T', 'E', 'X', 'T']);
    * ```
    * 
    * @param {string|string[]} key or array of keys to type.
-   * Type out given array of keys or a string of text
+   * @param {?number} [delay=null] (optional) delay in ms between key presses
+   * 
    */
-  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);
   }
 
   /**
@@ -2493,12 +2527,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 },
+        ],
+      },
       ]);
     }