codeceptjs 2.2.0 → 2.2.1

package/docs/build/Puppeteer.js

@@ -57,12 +57,13 @@ const consoleLogStore = new Console();
  * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
  * * `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.
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
  * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
  * * `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["Puppeteer"]._startBrowser()`.
- * * `browser`: (optional, default: chrome) - can be changed to `firefox` when using [puppeteer-firefox]((https://codecept.io/helpers/Puppeteer-firefox)).
+ * * `browser`: (optional, default: chrome) - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
  * * `chrome`: (optional) pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
  *
  *
@@ -159,6 +160,7 @@ class Puppeteer extends Helper {
       browser: 'chrome',
       waitForAction: 100,
       waitForTimeout: 1000,
+      pressKeyDelay: 10,
       fullPageScreenshots: false,
       disableScreenshots: false,
       uniqueScreenshotNames: false,
@@ -189,6 +191,9 @@ class Puppeteer extends Helper {
   static _config() {
     return [
       { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
+      {
+        name: 'show', message: 'Show browser window', default: true, type: 'confirm',
+      },
     ];
   }
 
@@ -643,7 +648,7 @@ class Puppeteer extends Helper {
    * {--end--}
    */
   scrollPageToTop() {
-    return this.page.evaluate(() => {
+    return this.executeScript(() => {
       window.scrollTo(0, 0);
     });
   }
@@ -657,7 +662,7 @@ class Puppeteer extends Helper {
    * {--end--}
    */
   scrollPageToBottom() {
-    return this.page.evaluate(() => {
+    return this.executeScript(() => {
       const body = document.body;
       const html = document.documentElement;
       window.scrollTo(0, Math.max(
@@ -687,20 +692,16 @@ class Puppeteer extends Helper {
       offsetX = locator;
       locator = null;
     }
-    let x = 0;
-    let y = 0;
+
     if (locator) {
       const els = await this._locate(locator);
       assertElementExists(els, locator, 'Element');
       await els[0]._scrollIntoViewIfNeeded();
       const elementCoordinates = await els[0]._clickablePoint();
-      x = elementCoordinates.x;
-      y = elementCoordinates.y;
+      await this.executeScript((x, y) => window.scrollBy(x, y), elementCoordinates.x + offsetX, elementCoordinates.y + offsetY);
+    } else {
+      await this.executeScript((x, y) => window.scrollTo(x, y), offsetX, offsetY);
     }
-
-    await this.page.evaluate((x, y) => {
-      window.scrollTo(x, y);
-    }, x + offsetX, y + offsetY);
     return this._waitForAction();
   }
 
@@ -1335,7 +1336,7 @@ class Puppeteer extends Helper {
     } else if (editable) {
       await this._evaluateHandeInContext(el => el.innerHTML = '', el);
     }
-    await el.type(value.toString(), { delay: 10 });
+    await el.type(value.toString(), { delay: this.options.pressKeyDelay });
     return this._waitForAction();
   }
 
@@ -1372,7 +1373,7 @@ class Puppeteer extends Helper {
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
     await els[0].press('End');
-    await els[0].type(value, { delay: 10 });
+    await els[0].type(value, { delay: this.options.pressKeyDelay });
     return this._waitForAction();
   }
 

package/docs/build/TestCafe.js

@@ -124,6 +124,10 @@ class TestCafe extends Helper {
   static _config() {
     return [
       { name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
+      { name: 'browser', message: 'Browser to be used', default: 'chrome' },
+      {
+        name: 'show', message: 'Show browser window', default: true, type: 'confirm',
+      },
     ];
   }
 
@@ -248,7 +252,7 @@ class TestCafe extends Helper {
   async _withinBegin(locator) {
     const els = await this._locate(locator);
     assertElementExists(els, locator);
-    this.context = els.nth(0);
+    this.context = await els.nth(0);
   }
 
   async _withinEnd() {
@@ -943,7 +947,7 @@ class TestCafe extends Helper {
     const el = await els.nth(0);
 
     return this.t
-      .expect(el.value).eql(value)
+      .expect(await el.value).eql(value)
       .catch(mapError);
   }
 
@@ -1198,6 +1202,94 @@ class TestCafe extends Helper {
     return ClientFunction(() => document.location.href).with({ boundTestRun: this.t })();
   }
 
+  /**
+   * Retrieves a page scroll position and returns it to test.
+   * Resumes test execution, so **should be used inside an async function with `await`** operator.
+   * 
+   * ```js
+   * let { x, y } = await I.grabPageScrollPosition();
+   * ```
+   * 
+   * @returns {Promise<object>} scroll position
+   * {--end--}
+   */
+  async grabPageScrollPosition() {
+    return ClientFunction(() => ({ x: window.pageXOffset, y: window.pageYOffset })).with({ boundTestRun: this.t })();
+  }
+
+  /**
+   * Scroll page to the top.
+   * 
+   * ```js
+   * I.scrollPageToTop();
+   * ```
+   * {--end--}
+   */
+  scrollPageToTop() {
+    return ClientFunction(() => window.scrollTo(0, 0)).with({ boundTestRun: this.t })().catch(mapError);
+  }
+
+  /**
+   * Scroll page to the bottom.
+   * 
+   * ```js
+   * I.scrollPageToBottom();
+   * ```
+   * {--end--}
+   */
+  scrollPageToBottom() {
+    return ClientFunction(() => {
+      const body = document.body;
+      const html = document.documentElement;
+      window.scrollTo(0, Math.max(
+        body.scrollHeight, body.offsetHeight,
+        html.clientHeight, html.scrollHeight, html.offsetHeight,
+      ));
+    }).with({ boundTestRun: this.t })().catch(mapError);
+  }
+
+  /**
+   * Scrolls to element matched by locator.
+   * Extra shift can be set with offsetX and offsetY options.
+   * 
+   * ```js
+   * I.scrollTo('footer');
+   * I.scrollTo('#submit', 5, 5);
+   * ```
+   * 
+   * @param {string|object} locator located by CSS|XPath|strict locator.
+   * @param {number} offsetX (optional, `0` by default) X-axis offset.
+   * @param {number} offsetY (optional, `0` by default) Y-axis offset.
+   * {--end--}
+   */
+  async scrollTo(locator, offsetX = 0, offsetY = 0) {
+    if (typeof locator === 'number' && typeof offsetX === 'number') {
+      offsetY = offsetX;
+      offsetX = locator;
+      locator = null;
+    }
+
+    const scrollBy = ClientFunction((offset) => {
+      if (window && window.scrollBy && offset) {
+        window.scrollBy(offset.x, offset.y);
+      }
+    }).with({ boundTestRun: this.t });
+
+    if (locator) {
+      const els = await this._locate(locator);
+      assertElementExists(els, locator, 'Element');
+      const el = await els.nth(0);
+      const x = (await el.offsetLeft) + offsetX;
+      const y = (await el.offsetTop) + offsetY;
+
+      return scrollBy({ x, y }).catch(mapError);
+    }
+
+    const x = offsetX;
+    const y = offsetY;
+    return scrollBy({ x, y }).catch(mapError);
+  }
+
   /**
    * Switches frame or in case of null locator reverts to parent.
    * 
@@ -1210,6 +1302,13 @@ class TestCafe extends Helper {
    * {--end--}
    */
   async switchTo(locator) {
+    if (Number.isInteger(locator)) {
+      throw new Error('Not supported switching to iframe by number');
+    }
+
+    if (!locator) {
+      return this.t.switchToMainWindow();
+    }
     return this.t.switchToIframe(findElements.call(this, this.context, locator));
   }
 

package/docs/build/WebDriver.js

@@ -15,7 +15,6 @@ const {
   chunkArray,
   convertCssPropertiesToCamelCase,
   screenshotOutputFolder,
-  fileToBase64Zip,
 } = require('../utils');
 const {
   isColorProperty,
@@ -61,15 +60,15 @@ const webRoot = 'body';
  *
  * Example:
  *
- * ```json
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "smartWait": 5000,
- *        "browser": "chrome",
- *        "restart": false,
- *        "windowSize": "maximize",
- *        "timeouts": {
+ *    helpers: {
+ *      WebDriver : {
+ *        smartWait: 5000,
+ *        browser: "chrome",
+ *        restart: false,
+ *        windowSize: "maximize",
+ *        timeouts: {
  *          "script": 60000,
  *          "page load": 10000
  *        }
@@ -83,15 +82,15 @@ const webRoot = 'body';
  *
  * ### Headless Chrome
  *
- * ```json
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "url": "http://localhost",
- *        "browser": "chrome",
- *        "desiredCapabilities": {
- *          "chromeOptions": {
- *            "args": [ "--headless", "--disable-gpu", "--window-size=800,600" ]
+ *    helpers: {
+ *      WebDriver : {
+ *        url: "http://localhost",
+ *        browser: "chrome",
+ *        desiredCapabilities: {
+ *          chromeOptions: {
+ *            args: [ "--headless", "--disable-gpu", "--window-size=800,600" ]
  *          }
  *        }
  *      }
@@ -103,14 +102,14 @@ const webRoot = 'body';
  *
  * Additional configuration params can be used from [IE options](https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/IE/Options.html)
  *
- * ```json
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "url": "http://localhost",
- *        "browser": "internet explorer",
- *        "desiredCapabilities": {
- *          "ieOptions": {
+ *    helpers: {
+ *      WebDriver : {
+ *        url: "http://localhost",
+ *        browser: "internet explorer",
+ *        desiredCapabilities: {
+ *          ieOptions: {
  *            "ie.browserCommandLineSwitches": "-private",
  *            "ie.usePerProcessProxy": true,
  *            "ie.ensureCleanSession": true,
@@ -123,15 +122,18 @@ const webRoot = 'body';
  *
  * ### Selenoid Options
  *
- * ```json
+ * [Selenoid](https://aerokube.com/selenoid/latest/) is a modern way to run Selenium inside Docker containers.
+ * Selenoid is easy to set up and provides more features than original Selenium Server. Use `selenoidOptions` to set Selenoid capabilities
+ *
+ * ```js
  * {
- *    "helpers": {
- *      "WebDriver" : {
- *        "url": "http://localhost",
- *        "browser": "chrome",
- *        "desiredCapabilities": {
- *          "selenoidOptions": {
- *            "enableVNC": true,
+ *    helpers: {
+ *      WebDriver : {
+ *        url: "http://localhost",
+ *        browser: "chrome",
+ *        desiredCapabilities: {
+ *          selenoidOptions: {
+ *            enableVNC: true,
  *          }
  *        }
  *      }
@@ -139,17 +141,17 @@ const webRoot = 'body';
  * }
  * ```
  *
- * ### Connect through proxy
+ * ### Connect Through proxy
  *
  * CodeceptJS also provides flexible options when you want to execute tests to Selenium servers through proxy. You will
  * need to update the `helpers.WebDriver.capabilities.proxy` key.
  *
  * ```js
  * {
- *     "helpers": {
- *         "WebDriver": {
- *             "capabilities": {
- *                 "proxy": {
+ *     helpers: {
+ *         WebDriver: {
+ *             capabilities: {
+ *                 proxy: {
  *                     "proxyType": "manual|pac",
  *                     "proxyAutoconfigUrl": "URL TO PAC FILE",
  *                     "httpProxy": "PROXY SERVER",
@@ -169,10 +171,10 @@ const webRoot = 'body';
  *
  * ```js
  * {
- *     "helpers": {
- *         "WebDriver": {
- *             "capabilities": {
- *                 "proxy": {
+ *     helpers: {
+ *         WebDriver: {
+ *             capabilities: {
+ *                 proxy: {
  *                     "proxyType": "manual",
  *                     "httpProxy": "http://corporate.proxy:8080",
  *                     "socksUsername": "codeceptjs",
@@ -199,12 +201,12 @@ const webRoot = 'body';
  *
  * ```js
  * {
- *     "helpers":{
- *         "WebDriver": {
- *             "url": "YOUR_DESIRED_HOST",
- *             "user": "YOUR_BROWSERSTACK_USER",
- *             "key": "YOUR_BROWSERSTACK_KEY",
- *             "capabilities": {
+ *     helpers:{
+ *         WebDriver: {
+ *             url: "YOUR_DESIRED_HOST",
+ *             user: "YOUR_BROWSERSTACK_USER",
+ *             key: "YOUR_BROWSERSTACK_KEY",
+ *             capabilities: {
  *                 "browserName": "chrome",
  *
  *                 // only set this if you're using BrowserStackLocal to test a local domain
@@ -318,8 +320,8 @@ const webRoot = 'body';
  *
  * ```js
  * {
- *     "helpers": {
- *         "WebDriver": {
+ *     helpers: {
+ *         WebDriver: {
  *             "multiremote": {
  *                 "MyChrome": {
  *                     "desiredCapabilities": {
@@ -973,12 +975,11 @@ class WebDriver extends Helper {
     assertElementExists(res, locator, 'File field');
     const el = usingFirstElement(res);
 
-    // Remote Uplaod (when running Selenium Server)
+    // Remote Upload (when running Selenium Server)
     if (this.options.remoteFileUpload) {
-      const fileCompressed = await fileToBase64Zip(file);
       try {
         this.debugSection('File', 'Uploading file to remote server');
-        file = await this.browser.uploadFile(fileCompressed);
+        file = await this.browser.uploadFile(file);
       } catch (err) {
         throw new Error(`File can't be transferred to remote server. Set \`remoteFileUpload: false\` in config to upload file locally.\n${err.message}`);
       }