codeceptjs 2.1.3 → 2.2.1

package/lib/helper/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": {
@@ -490,12 +492,8 @@ class WebDriver extends Helper {
       await this.defineTimeout(this.options.timeouts);
     }
 
-    if (this.isWeb && this.options.windowSize === 'maximize') {
-      await this.resizeWindow('maximize');
-    } else if (this.isWeb && this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
-      const dimensions = this.options.windowSize.split('x');
-      await this.resizeWindow(dimensions[0], dimensions[1]);
-    }
+    await this._resizeWindowIfNeeded(this.browser, this.options.windowSize);
+
     this.$$ = this.browser.$$.bind(this.browser);
     return this.browser;
   }
@@ -547,7 +545,15 @@ class WebDriver extends Helper {
         // opts.disableScreenshots = true; // screenshots cant be saved as session will be already closed
         opts = this._validateConfig(Object.assign(this.options, opts));
         this.debugSection('New Browser', JSON.stringify(opts));
-        return webdriverio.remote(opts);
+        const browser = await webdriverio.remote(opts);
+
+        if (opts.timeouts && this.isWeb) {
+          await this._defineBrowserTimeout(browser, opts.timeouts);
+        }
+
+        await this._resizeWindowIfNeeded(browser, opts.windowSize);
+
+        return browser;
       },
       stop: async (browser) => {
         return browser.deleteSession();
@@ -673,8 +679,6 @@ class WebDriver extends Helper {
   /**
    * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
    *
-   *
-   * * *Appium*: supported only for web testing.
    * Timeouts are expected to be passed as object:
    *
    * ```js
@@ -685,24 +689,25 @@ class WebDriver extends Helper {
    * @param timeouts WebDriver timeouts object.
    */
   defineTimeout(timeouts) {
-    return this.browser.setTimeout(timeouts);
+    return this._defineBrowserTimeout(this.browser, timeouts);
+  }
+
+  _defineBrowserTimeout(browser, timeouts) {
+    return browser.setTimeout(timeouts);
   }
 
   /**
-   * {{> ../webapi/amOnPage }}
+   * {{> amOnPage }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   amOnPage(url) {
     return this.browser.url(url);
   }
 
   /**
-   * {{> ../webapi/click }}
-   *
+   * {{> click }}
    *
-   * * *Appium*: supported
+   * {{ react }}
    */
   async click(locator, context = null) {
     const clickMethod = this.browser.isMobile ? 'touchClick' : 'elementClick';
@@ -719,10 +724,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/doubleClick }}
+   * {{> doubleClick }}
    *
-   *
-   * * *Appium*: supported only for web testing
+   * {{ react }}
    */
   async doubleClick(locator, context = null) {
     const locateFn = prepareLocateFn.call(this, context);
@@ -739,10 +743,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/rightClick }}
-   *
+   * {{> rightClick }}
    *
-   * * *Appium*: supported, but in apps works as usual click
+   * {{ react }}
    */
   async rightClick(locator, context) {
     const locateFn = prepareLocateFn.call(this, context);
@@ -769,10 +772,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/fillField }}
+   * {{> fillField }}
+   * {{ react }}
    *
-   *
-   * * *Appium*: supported
    */
   async fillField(field, value) {
     const res = await findFields.call(this, field);
@@ -782,10 +784,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/appendField }}
-   *
-   *
-   * * *Appium*: supported, but it's clear a field before insert in apps
+   * {{> appendField }}
+   * {{ react }}
    */
   async appendField(field, value) {
     const res = await findFields.call(this, field);
@@ -796,10 +796,8 @@ class WebDriver extends Helper {
 
 
   /**
-   * {{> ../webapi/clearField}}
+   * {{> clearField }}
    *
-   *
-   * * *Appium*: supported
    */
   async clearField(field) {
     const res = await findFields.call(this, field);
@@ -810,7 +808,7 @@ class WebDriver extends Helper {
 
 
   /**
-   * {{> ../webapi/selectOption}}
+   * {{> selectOption }}
    */
   async selectOption(select, option) {
     const res = await findFields.call(this, select);
@@ -842,7 +840,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/attachFile }}
+   * {{> attachFile }}
    * Appium: not tested
    */
   async attachFile(locator, pathToFile) {
@@ -856,12 +854,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}`);
       }
@@ -871,7 +868,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/checkOption }}
+   * {{> checkOption }}
    * Appium: not tested
    */
   async checkOption(field, context = null) {
@@ -885,12 +882,12 @@ class WebDriver extends Helper {
     const elementId = getElementId(elem);
 
     const isSelected = await this.browser.isElementSelected(elementId);
-    if (isSelected.value) return Promise.resolve(true);
+    if (isSelected) return Promise.resolve(true);
     return this.browser[clickMethod](elementId);
   }
 
   /**
-   * {{> ../webapi/uncheckOption }}
+   * {{> uncheckOption }}
    * Appium: not tested
    */
   async uncheckOption(field, context = null) {
@@ -904,15 +901,13 @@ class WebDriver extends Helper {
     const elementId = getElementId(elem);
 
     const isSelected = await this.browser.isElementSelected(elementId);
-    if (!isSelected.value) return Promise.resolve(true);
+    if (!isSelected) return Promise.resolve(true);
     return this.browser[clickMethod](elementId);
   }
 
   /**
-   * {{> ../webapi/grabTextFrom }}
-   *
+   * {{> grabTextFrom }}
    *
-   * * *Appium*: supported
    */
   async grabTextFrom(locator) {
     const res = await this._locate(locator, true);
@@ -928,10 +923,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabHTMLFrom }}
+   * {{> grabHTMLFrom }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async grabHTMLFrom(locator) {
     const elems = await this._locate(locator, true);
@@ -945,10 +938,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabValueFrom }}
-   *
+   * {{> grabValueFrom }}
    *
-   * * *Appium*: supported only for web testing
    */
   async grabValueFrom(locator) {
     const res = await this._locate(locator, true);
@@ -958,7 +949,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabCssPropertyFrom }}
+   * {{> grabCssPropertyFrom }}
    */
   async grabCssPropertyFrom(locator, cssProperty) {
     const res = await this._locate(locator, true);
@@ -967,7 +958,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabAttributeFrom }}
+   * {{> grabAttributeFrom }}
    * Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
    */
   async grabAttributeFrom(locator, attr) {
@@ -977,10 +968,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeInTitle }}
+   * {{> seeInTitle }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async seeInTitle(text) {
     const title = await this.browser.getTitle();
@@ -1002,10 +991,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeInTitle }}
-   *
+   * {{> dontSeeInTitle }}
    *
-   * * *Appium*: supported only for web testing
    */
   async dontSeeInTitle(text) {
     const title = await this.browser.getTitle();
@@ -1013,10 +1000,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabTitle }}
-   *
+   * {{> grabTitle }}
    *
-   * * *Appium*: supported only for web testing
    */
   async grabTitle() {
     const title = await this.browser.getTitle();
@@ -1025,10 +1010,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/see }}
+   * {{> see }}
    *
-   *
-   * * *Appium*: supported with context in apps
+   * {{ react }}
    */
   async see(text, context = null) {
     return proceedSee.call(this, 'assert', text, context);
@@ -1049,37 +1033,32 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSee }}
-   *
+   * {{> dontSee }}
    *
-   * * *Appium*: supported with context in apps
+   * {{ react }}
    */
   async dontSee(text, context = null) {
     return proceedSee.call(this, 'negate', text, context);
   }
 
   /**
-   * {{> ../webapi/seeInField }}
+   * {{> seeInField }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async seeInField(field, value) {
     return proceedSeeField.call(this, 'assert', field, value);
   }
 
   /**
-   * {{> ../webapi/dontSeeInField }}
-   *
+   * {{> dontSeeInField }}
    *
-   * * *Appium*: supported only for web testing
    */
   async dontSeeInField(field, value) {
     return proceedSeeField.call(this, 'negate', field, value);
   }
 
   /**
-   * {{> ../webapi/seeCheckboxIsChecked }}
+   * {{> seeCheckboxIsChecked }}
    * Appium: not tested
    */
   async seeCheckboxIsChecked(field) {
@@ -1087,7 +1066,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeCheckboxIsChecked }}
+   * {{> dontSeeCheckboxIsChecked }}
    * Appium: not tested
    */
   async dontSeeCheckboxIsChecked(field) {
@@ -1095,10 +1074,9 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeElement }}
+   * {{> seeElement }}
+   * {{ react }}
    *
-   *
-   * * *Appium*: supported
    */
   async seeElement(locator) {
     const res = await this._locate(locator, true);
@@ -1108,10 +1086,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeElement}}
-   *
-   *
-   * * *Appium*: supported
+   * {{> dontSeeElement }}
+   * {{ react }}
    */
   async dontSeeElement(locator) {
     const res = await this._locate(locator, false);
@@ -1123,10 +1099,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeElementInDOM }}
+   * {{> seeElementInDOM }}
    *
-   *
-   * * *Appium*: supported
    */
   async seeElementInDOM(locator) {
     const res = await this.$$(withStrictLocator(locator));
@@ -1134,10 +1108,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeElementInDOM }}
-   *
+   * {{> dontSeeElementInDOM }}
    *
-   * * *Appium*: supported
    */
   async dontSeeElementInDOM(locator) {
     const res = await this.$$(withStrictLocator(locator));
@@ -1145,10 +1117,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeInSource }}
+   * {{> seeInSource }}
    *
-   *
-   * * *Appium*: supported
    */
   async seeInSource(text) {
     const source = await this.browser.getPageSource();
@@ -1156,10 +1126,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabSource }}
-   *
+   * {{> grabSource }}
    *
-   * * *Appium*: supported
    */
   async grabSource() {
     return this.browser.getPageSource();
@@ -1182,7 +1150,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabCurrentUrl }}
+   * {{> grabCurrentUrl }}
    */
   async grabCurrentUrl() {
     const res = await this.browser.getUrl();
@@ -1191,10 +1159,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeInSource }}
-   *
-   *
-   * * *Appium*: supported
+   * {{> dontSeeInSource }}
    */
   async dontSeeInSource(text) {
     const source = await this.browser.getPageSource();
@@ -1202,18 +1167,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * Asserts that an element appears a given number of times in the DOM.
-   * Element is located by label or name or CSS or XPath.
-   *
-   *
-   * * *Appium*: supported
-   *
-   * ```js
-   * I.seeNumberOfElements('#submitBtn', 1);
-   * ```
-   *
-   * @param locator element located by CSS|XPath|strict locator.
-   * @param num number of elements.
+   * {{> seeNumberOfElements }}
+   * {{ react }}
    */
   async seeNumberOfElements(locator, num) {
     const res = await this._locate(locator);
@@ -1221,7 +1176,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeNumberOfVisibleElements }}
+   * {{> seeNumberOfVisibleElements }}
+   * {{ react }}
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
@@ -1229,7 +1185,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeCssPropertiesOnElements }}
+   * {{> seeCssPropertiesOnElements }}
    */
   async seeCssPropertiesOnElements(locator, cssProperties) {
     const res = await this._locate(locator);
@@ -1264,7 +1220,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeAttributesOnElements }}
+   * {{> seeAttributesOnElements }}
    */
   async seeAttributesOnElements(locator, attributes) {
     const res = await this._locate(locator);
@@ -1291,7 +1247,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabNumberOfVisibleElements }}
+   * {{> grabNumberOfVisibleElements }}
    */
   async grabNumberOfVisibleElements(locator) {
     const res = await this._locate(locator);
@@ -1303,10 +1259,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeInCurrentUrl }}
-   *
+   * {{> seeInCurrentUrl }}
    *
-   * * *Appium*: supported only for web testing
    */
   async seeInCurrentUrl(url) {
     const res = await this.browser.getUrl();
@@ -1314,10 +1268,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeInCurrentUrl }}
+   * {{> dontSeeInCurrentUrl }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async dontSeeInCurrentUrl(url) {
     const res = await this.browser.getUrl();
@@ -1325,10 +1277,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeCurrentUrlEquals }}
-   *
+   * {{> seeCurrentUrlEquals }}
    *
-   * * *Appium*: supported only for web testing
    */
   async seeCurrentUrlEquals(url) {
     const res = await this.browser.getUrl();
@@ -1336,10 +1286,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeCurrentUrlEquals }}
+   * {{> dontSeeCurrentUrlEquals }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async dontSeeCurrentUrlEquals(url) {
     const res = await this.browser.getUrl();
@@ -1347,10 +1295,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/executeScript }}
-   *
+   * {{> executeScript }}
    *
-   * * *Appium*: supported only for web testing
    *
    * Wraps [execute](http://webdriver.io/api/protocol/execute.html) command.
    */
@@ -1359,34 +1305,16 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/executeAsyncScript }}
+   * {{> executeAsyncScript }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   executeAsyncScript(fn) {
     return this.browser.executeAsync.apply(this.browser, arguments);
   }
 
   /**
-   * Scrolls to element matched by locator.
-   * Extra shift can be set with offsetX and offsetY options.
+   * {{> scrollTo }}
    *
-   * ```js
-   * I.scrollTo('footer');
-   * I.scrollTo('#submit', 5, 5);
-   * ```
-   *
-   * @param locator located by CSS|XPath|strict locator.
-   * @param offsetX (optional) X-axis offset.
-   * @param offsetY (optional) Y-axis offset.
-   */
-
-  /**
-   * {{> ../webapi/scrollTo }}
-   *
-   *
-   * * *Appium*: supported only for web testing
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -1416,10 +1344,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/moveCursorTo}}
-   *
+   * {{> moveCursorTo }}
    *
-   * * *Appium*: supported only for web testing
    */
   async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
     const res = await this._locate(withStrictLocator(locator), true);
@@ -1429,10 +1355,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/saveScreenshot}}
+   * {{> saveScreenshot }}
    *
-   *
-   * * *Appium*: supported
    */
   async saveScreenshot(fileName, fullPage = false) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -1464,10 +1388,8 @@ class WebDriver extends Helper {
 
 
   /**
-   * {{> ../webapi/setCookie}}
-   *
+   * {{> setCookie }}
    *
-   * * *Appium*: supported only for web testing
    *
    * Uses Selenium's JSON [cookie
    * format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
@@ -1477,20 +1399,16 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/clearCookie}}
+   * {{> clearCookie }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async clearCookie(cookie) {
     return this.browser.deleteCookies(cookie);
   }
 
   /**
-   * {{> ../webapi/seeCookie}}
-   *
+   * {{> seeCookie }}
    *
-   * * *Appium*: supported only for web testing
    */
   async seeCookie(name) {
     const cookie = await this.browser.getCookies([name]);
@@ -1498,10 +1416,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeCookie}}
+   * {{> dontSeeCookie }}
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async dontSeeCookie(name) {
     const cookie = await this.browser.getCookies([name]);
@@ -1509,10 +1425,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabCookie}}
-   *
+   * {{> grabCookie }}
    *
-   * * *Appium*: supported only for web testing
    */
   async grabCookie(name) {
     if (!name) return this.browser.getCookies();
@@ -1525,8 +1439,6 @@ class WebDriver extends Helper {
    * Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
    * Don't confuse popups with modal windows, as created by [various
    * libraries](http://jster.net/category/windows-modals-popups).
-   *
-   * * *Appium*: supported only for web testing
    */
   async acceptPopup() {
     return this.browser.getAlertText().then((res) => {
@@ -1539,8 +1451,6 @@ class WebDriver extends Helper {
   /**
    * Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
    *
-   *
-   * * *Appium*: supported only for web testing
    */
   async cancelPopup() {
     return this.browser.getAlertText().then((res) => {
@@ -1554,8 +1464,6 @@ class WebDriver extends Helper {
    * Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
    * given string.
    *
-   * * *Appium*: supported only for web testing
-   *
    * @param text value to check.
    */
   async seeInPopup(text) {
@@ -1583,14 +1491,12 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/pressKey }}
-   * {{> ../webapi/_keys }}
+   * {{> pressKey }}
+   * {{ keys }}
    *
    * To make combinations with modifier and mouse clicks (like Ctrl+Click) press a modifier, click, then release it.
    *
    *
-   * * *Appium*: supported, but clear field before pressing in apps:
-   *
    * ```js
    * I.pressKey('Control');
    * I.click('#someelement');
@@ -1609,23 +1515,36 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/resizeWindow }}
+   * {{> resizeWindow }}
    * Appium: not tested in web, in apps doesn't work
    */
   async resizeWindow(width, height) {
+    return this._resizeBrowserWindow(this.browser, width, height);
+  }
+
+  async _resizeBrowserWindow(browser, width, height) {
     if (width === 'maximize') {
-      const size = await this.browser.maximizeWindow();
+      const size = await browser.maximizeWindow();
       this.debugSection('Window Size', size);
       return;
     }
-    if (this.browser.isW3C) {
-      return this.browser.setWindowRect(null, null, parseInt(width, 10), parseInt(height, 10));
+    if (browser.isW3C) {
+      return browser.setWindowRect(null, null, parseInt(width, 10), parseInt(height, 10));
+    }
+    return browser.setWindowSize(parseInt(width, 10), parseInt(height, 10));
+  }
+
+  async _resizeWindowIfNeeded(browser, windowSize) {
+    if (this.isWeb && windowSize === 'maximize') {
+      await this._resizeBrowserWindow(browser, 'maximize');
+    } else if (this.isWeb && windowSize && windowSize.indexOf('x') > 0) {
+      const dimensions = windowSize.split('x');
+      await this._resizeBrowserWindow(browser, dimensions[0], dimensions[1]);
     }
-    return this.browser.setWindowSize(parseInt(width, 10), parseInt(height, 10));
   }
 
   /**
-   * {{> ../webapi/dragAndDrop }}
+   * {{> dragAndDrop }}
    * Appium: not tested
    */
   async dragAndDrop(srcElement, destElement) {
@@ -1641,7 +1560,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/dragSlider }}
+   * {{> dragSlider }}
    */
   async dragSlider(locator, offsetX = 0) {
     const browser = this.browser;
@@ -1663,12 +1582,51 @@ class WebDriver extends Helper {
     await browser.buttonUp(0);
   }
 
+  /**
+   * Get all Window Handles.
+   * Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
+   *
+   * ```js
+   * const windows = await I.grabAllWindowHandles();
+   * ```
+   */
+  async grabAllWindowHandles() {
+    return this.browser.getWindowHandles();
+  }
 
   /**
-   * Close all tabs except for the current one.
+   * Get the current Window Handle.
+   * Useful for referencing it when calling `I.switchToWindow(handle)`
    *
+   * ```js
+   * const window = await I.grabCurrentWindowHandle();
+   * ```
+   */
+  async grabCurrentWindowHandle() {
+    return this.browser.getWindowHandle();
+  }
+
+  /**
+   * Switch to the window with a specified handle.
+   *
+   * ```js
+   * const windows = await I.grabAllWindowHandles();
+   * // ... do something
+   * await I.switchToWindow( windows[0] );
+   *
+   * const window = await.grabCurrentWindowHandle();
+   * // ... do something
+   * await I.switchToWindow( window );
+   * ```
+   */
+  async switchToWindow(window) {
+    await this.browser.switchToWindow(window);
+  }
+
+
+  /**
+   * Close all tabs except for the current one.
    *
-   * * *Appium*: supported web test
    *
    * ```js
    * I.closeOtherTabs();
@@ -1687,20 +1645,16 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/wait }}
-   *
+   * {{> wait }}
    *
-   * * *Appium*: supported
    */
   async wait(sec) {
     return new Promise(resolve => setTimeout(resolve, sec * 1000));
   }
 
   /**
-   * {{> ../webapi/waitForEnabled }}
-   *
+   * {{> waitForEnabled }}
    *
-   * * *Appium*: supported
    */
   async waitForEnabled(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1718,7 +1672,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForElement }}
+   * {{> waitForElement }}
    */
   async waitForElement(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1737,7 +1691,7 @@ class WebDriver extends Helper {
 
 
   /**
-   * {{> ../webapi/waitInUrl }}
+   * {{> waitInUrl }}
    */
   async waitInUrl(urlPart, sec = null) {
     const client = this.browser;
@@ -1758,7 +1712,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitUrlEquals }}
+   * {{> waitUrlEquals }}
    */
   async waitUrlEquals(urlPart, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1781,7 +1735,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForText }}
+   * {{> waitForText }}
    *
    */
   async waitForText(text, sec = null, context = null) {
@@ -1802,7 +1756,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForValue }}
+   * {{> waitForValue }}
    */
   async waitForValue(field, value, sec = null) {
     const client = this.browser;
@@ -1822,10 +1776,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForVisible }}
+   * {{> waitForVisible }}
    *
-   *
-   * * *Appium*: supported
    */
   async waitForVisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1841,7 +1793,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitNumberOfVisibleElements }}
+   * {{> waitNumberOfVisibleElements }}
    */
   async waitNumberOfVisibleElements(locator, num, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1856,10 +1808,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForInvisible }}
-   *
+   * {{> waitForInvisible }}
    *
-   * * *Appium*: supported
    */
   async waitForInvisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1872,10 +1822,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitToHide }}
-   *
+   * {{> waitToHide }}
    *
-   * * *Appium*: supported
    */
   async waitToHide(locator, sec = null) {
     return this.waitForInvisible(locator, sec);
@@ -1887,10 +1835,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForDetached }}
+   * {{> waitForDetached }}
    *
-   *
-   * * *Appium*: supported
    */
   async waitForDetached(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1904,10 +1850,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForFunction }}
-   *
+   * {{> waitForFunction }}
    *
-   * * *Appium*: supported
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -1924,10 +1868,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitUntil }}
+   * {{> waitUntil }}
    *
-   * @param interval (optional) time in seconds between condition checks.
-   * * *Appium*: supported
    */
   async waitUntil(fn, sec = null, timeoutMsg = null, interval = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1936,10 +1878,8 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/switchTo }}
-   *
+   * {{> switchTo }}
    *
-   * * *Appium*: supported only for web testing
    */
   async switchTo(locator) {
     this.browser.isInsideFrame = true;
@@ -2032,7 +1972,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabNumberOfOpenTabs }}
+   * {{> grabNumberOfOpenTabs }}
    */
   async grabNumberOfOpenTabs() {
     const pages = await this.browser.getWindowHandles();
@@ -2041,7 +1981,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/refreshPage }}
+   * {{> refreshPage }}
    */
   async refreshPage() {
     const client = this.browser;
@@ -2049,7 +1989,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/scrollPageToTop }}
+   * {{> scrollPageToTop }}
    */
   scrollPageToTop() {
     const client = this.browser;
@@ -2061,7 +2001,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/scrollPageToBottom }}
+   * {{> scrollPageToBottom }}
    */
   scrollPageToBottom() {
     const client = this.browser;
@@ -2078,7 +2018,7 @@ class WebDriver extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabPageScrollPosition}}
+   * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
     /* eslint-disable comma-dangle */