codeceptjs 2.1.3 → 2.2.1

package/lib/helper/Protractor.js

@@ -13,7 +13,6 @@ const truth = require('../assert/truth').truth;
 const {
   xpathLocator,
   fileExists,
-  clearString,
   convertCssPropertiesToCamelCase,
   screenshotOutputFolder,
 } = require('../utils');
@@ -25,7 +24,6 @@ const ElementNotFound = require('./errors/ElementNotFound');
 const ConnectionRefused = require('./errors/ConnectionRefused');
 const Locator = require('../locator');
 const path = require('path');
-const recorder = require('../recorder');
 
 let withinStore = {};
 let Runner;
@@ -424,7 +422,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/amOnPage }}
+   * {{> amOnPage }}
    */
   async amOnPage(url) {
     if (!(/^\w+\:\/\//.test(url))) {
@@ -436,7 +434,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/click }}
+   * {{> click }}
    */
   async click(locator, context = null) {
     let matcher = this.browser;
@@ -450,7 +448,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/doubleClick }}
+   * {{> doubleClick }}
    */
   async doubleClick(locator, context = null) {
     let matcher = this.browser;
@@ -464,7 +462,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/rightClick }}
+   * {{> rightClick }}
    */
   async rightClick(locator, context = null) {
     /**
@@ -486,7 +484,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/moveCursorTo}}
+   * {{> moveCursorTo }}
    */
   async moveCursorTo(locator, offsetX = null, offsetY = null) {
     let offset = null;
@@ -499,7 +497,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/see }}
+   * {{> see }}
    */
   async see(text, context = null) {
     return proceedSee.call(this, 'assert', text, context);
@@ -517,28 +515,28 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSee }}
+   * {{> dontSee }}
    */
   dontSee(text, context = null) {
     return proceedSee.call(this, 'negate', text, context);
   }
 
   /**
-   * {{> ../webapi/grabBrowserLogs }}
+   * {{> grabBrowserLogs }}
    */
   async grabBrowserLogs() {
     return this.browser.manage().logs().get('browser');
   }
 
   /**
-   * {{> ../webapi/grabCurrentUrl }}
+   * {{> grabCurrentUrl }}
    */
   async grabCurrentUrl() {
     return this.browser.getCurrentUrl();
   }
 
   /**
-   * {{> ../webapi/selectOption }}
+   * {{> selectOption }}
    */
   async selectOption(select, option) {
     const fields = await findFields(this.browser, select);
@@ -561,7 +559,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/fillField }}
+   * {{> fillField }}
    */
   async fillField(field, value) {
     const els = await findFields(this.browser, field);
@@ -570,8 +568,8 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/pressKey }}
-   * {{> ../webapi/_keys }}
+   * {{> pressKey }}
+   * {{ keys }}
    */
   async pressKey(key) {
     let modifier;
@@ -593,7 +591,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/attachFile }}
+   * {{> attachFile }}
    */
   async attachFile(locator, pathToFile) {
     const file = path.join(global.codecept_dir, pathToFile);
@@ -610,21 +608,21 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeInField }}
+   * {{> seeInField }}
    */
   async seeInField(field, value) {
     return proceedSeeInField.call(this, 'assert', field, value);
   }
 
   /**
-   * {{> ../webapi/dontSeeInField }}
+   * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
     return proceedSeeInField.call(this, 'negate', field, value);
   }
 
   /**
-   * {{> ../webapi/appendField }}
+   * {{> appendField }}
    */
   async appendField(field, value) {
     const els = await findFields(this.browser, field);
@@ -633,7 +631,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/clearField }}
+   * {{> clearField }}
    */
   async clearField(field) {
     const els = await findFields(this.browser, field);
@@ -642,7 +640,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/checkOption }}
+   * {{> checkOption }}
    */
   async checkOption(field, context = null) {
     let matcher = this.browser;
@@ -658,21 +656,37 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeCheckboxIsChecked }}
+   * {{> uncheckOption }}
+   */
+  async uncheckOption(field, context = null) {
+    let matcher = this.browser;
+    if (context) {
+      const els = await this._locate(context, true);
+      assertElementExists(els, context);
+      matcher = els[0];
+    }
+    const els = await findCheckable(matcher, field);
+    assertElementExists(els, field, 'Checkbox or radio');
+    const isSelected = await els[0].isSelected();
+    if (isSelected) return els[0].click();
+  }
+
+  /**
+   * {{> seeCheckboxIsChecked }}
    */
   async seeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'assert', field);
   }
 
   /**
-   * {{> ../webapi/dontSeeCheckboxIsChecked }}
+   * {{> dontSeeCheckboxIsChecked }}
    */
   async dontSeeCheckboxIsChecked(field) {
     return proceedIsChecked.call(this, 'negate', field);
   }
 
   /**
-   * {{> ../webapi/grabTextFrom }}
+   * {{> grabTextFrom }}
    */
   async grabTextFrom(locator) {
     const els = await this._locate(locator);
@@ -686,7 +700,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabHTMLFrom }}
+   * {{> grabHTMLFrom }}
    */
   async grabHTMLFrom(locator) {
     const els = await this._locate(locator);
@@ -703,7 +717,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabValueFrom }}
+   * {{> grabValueFrom }}
    */
   async grabValueFrom(locator) {
     const els = await findFields(this.browser, locator);
@@ -712,7 +726,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabCssPropertyFrom }}
+   * {{> grabCssPropertyFrom }}
    */
   async grabCssPropertyFrom(locator, cssProperty) {
     const els = await this._locate(locator, true);
@@ -726,7 +740,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabAttributeFrom }}
+   * {{> grabAttributeFrom }}
    */
   async grabAttributeFrom(locator, attr) {
     const els = await this._locate(locator);
@@ -740,7 +754,7 @@ class Protractor extends Helper {
     return array.length === 1 ? array[0] : array;
   }
   /**
-   * {{> ../webapi/seeInTitle }}
+   * {{> seeInTitle }}
    */
   async seeInTitle(text) {
     return this.browser.getTitle().then(title => stringIncludes('web page title').assert(text, title));
@@ -759,14 +773,14 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeInTitle }}
+   * {{> dontSeeInTitle }}
    */
   async dontSeeInTitle(text) {
     return this.browser.getTitle().then(title => stringIncludes('web page title').negate(text, title));
   }
 
   /**
-   * {{> ../webapi/grabTitle }}
+   * {{> grabTitle }}
    */
   async grabTitle() {
     return this.browser.getTitle().then((title) => {
@@ -776,7 +790,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeElement }}
+   * {{> seeElement }}
    */
   async seeElement(locator) {
     let els = await this._locate(locator, true);
@@ -785,7 +799,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/dontSeeElement }}
+   * {{> dontSeeElement }}
    */
   async dontSeeElement(locator) {
     let els = await this._locate(locator, false);
@@ -794,55 +808,50 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeElementInDOM }}
+   * {{> seeElementInDOM }}
    */
   async seeElementInDOM(locator) {
     return this.browser.findElements(guessLocator(locator) || global.by.css(locator)).then(els => empty('elements').negate(els.fill('ELEMENT')));
   }
 
   /**
-   * {{> ../webapi/dontSeeElementInDOM }}
+   * {{> dontSeeElementInDOM }}
    */
   async dontSeeElementInDOM(locator) {
     return this.browser.findElements(guessLocator(locator) || global.by.css(locator)).then(els => empty('elements').assert(els.fill('ELEMENT')));
   }
 
   /**
-   * {{> ../webapi/seeInSource }}
+   * {{> seeInSource }}
    */
   async seeInSource(text) {
     return this.browser.getPageSource().then(source => stringIncludes('HTML source of a page').assert(text, source));
   }
 
   /**
-   * {{> ../webapi/grabSource }}
+   * {{> grabSource }}
    */
   async grabSource() {
     return this.browser.getPageSource();
   }
 
   /**
-   * {{> ../webapi/dontSeeInSource }}
+   * {{> dontSeeInSource }}
    */
   async dontSeeInSource(text) {
     return this.browser.getPageSource().then(source => stringIncludes('HTML source of a page').negate(text, source));
   }
 
   /**
-   * asserts that an element appears a given number of times in the DOM
-   * Element is located by label or name or CSS or XPath.
-   *
-   * ```js
-   * I.seeNumberOfElements('#submitBtn', 1);
-   * ```
+   * {{> seeNumberOfElements }}
    */
-  async seeNumberOfElements(selector, num) {
-    const elements = await this._locate(selector);
-    return equals(`expected number of elements (${selector}) is ${num}, but found ${elements.length}`).assert(elements.length, num);
+  async seeNumberOfElements(locator, num) {
+    const elements = await this._locate(locator);
+    return equals(`expected number of elements (${locator}) is ${num}, but found ${elements.length}`).assert(elements.length, num);
   }
 
   /**
-   * {{> ../webapi/seeNumberOfVisibleElements }}
+   * {{> seeNumberOfVisibleElements }}
    */
   async seeNumberOfVisibleElements(locator, num) {
     const res = await this.grabNumberOfVisibleElements(locator);
@@ -850,7 +859,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabNumberOfVisibleElements }}
+   * {{> grabNumberOfVisibleElements }}
    */
   async grabNumberOfVisibleElements(locator) {
     let els = await this._locate(locator);
@@ -859,7 +868,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeCssPropertiesOnElements }}
+   * {{> seeCssPropertiesOnElements }}
    */
   async seeCssPropertiesOnElements(locator, cssProperties) {
     const els = await this._locate(locator);
@@ -890,7 +899,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeAttributesOnElements }}
+   * {{> seeAttributesOnElements }}
    */
   async seeAttributesOnElements(locator, attributes) {
     const els = await this._locate(locator);
@@ -917,14 +926,14 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/executeScript }}
+   * {{> executeScript }}
    */
   async executeScript(fn) {
     return this.browser.executeScript.apply(this.browser, arguments);
   }
 
   /**
-   * {{> ../webapi/executeAsyncScript }}
+   * {{> executeAsyncScript }}
    */
   async executeAsyncScript(fn) {
     this.browser.manage().timeouts().setScriptTimeout(this.options.scriptTimeout);
@@ -932,35 +941,35 @@ class Protractor extends Helper {
   }
 
   /**
-     * {{> ../webapi/seeInCurrentUrl }}
+     * {{> seeInCurrentUrl }}
    */
   async seeInCurrentUrl(url) {
     return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').assert(url, currentUrl));
   }
 
   /**
-   * {{> ../webapi/dontSeeInCurrentUrl }}
+   * {{> dontSeeInCurrentUrl }}
    */
   async dontSeeInCurrentUrl(url) {
     return this.browser.getCurrentUrl().then(currentUrl => stringIncludes('url').negate(url, currentUrl));
   }
 
   /**
-   * {{> ../webapi/seeCurrentUrlEquals }}
+   * {{> seeCurrentUrlEquals }}
    */
   async seeCurrentUrlEquals(url) {
     return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).assert(url, currentUrl));
   }
 
   /**
-   * {{> ../webapi/dontSeeCurrentUrlEquals }}
+   * {{> dontSeeCurrentUrlEquals }}
    */
   async dontSeeCurrentUrlEquals(url) {
     return this.browser.getCurrentUrl().then(currentUrl => urlEquals(this.options.url).negate(url, currentUrl));
   }
 
   /**
-   * {{> ../webapi/saveScreenshot }}
+   * {{> saveScreenshot }}
    */
   async saveScreenshot(fileName, fullPage = false) {
     const outputFile = screenshotOutputFolder(fileName);
@@ -993,7 +1002,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/clearCookie}}
+   * {{> clearCookie }}
    */
   async clearCookie(cookie = null) {
     if (!cookie) {
@@ -1003,25 +1012,26 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/seeCookie}}
+   * {{> seeCookie }}
    */
   async seeCookie(name) {
     return this.browser.manage().getCookie(name).then(res => truth(`cookie ${name}`, 'to be set').assert(res));
   }
 
   /**
-   * {{> ../webapi/dontSeeCookie}}
+   * {{> dontSeeCookie }}
    */
   async dontSeeCookie(name) {
     return this.browser.manage().getCookie(name).then(res => truth(`cookie ${name}`, 'to be set').negate(res));
   }
 
   /**
-   * {{> ../webapi/grabCookie}}
+   * {{> grabCookie }}
    *
    * Returns cookie in JSON [format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
    */
   async grabCookie(name) {
+    if (!name) return this.browser.manage().getCookies();
     return this.browser.manage().getCookie(name);
   }
 
@@ -1078,7 +1088,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/resizeWindow }}
+   * {{> resizeWindow }}
    */
   async resizeWindow(width, height) {
     if (width === 'maximize') {
@@ -1089,7 +1099,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/dragAndDrop }}
+   * {{> dragAndDrop }}
    */
   async dragAndDrop(srcElement, destElement) {
     const srcEl = await this._locate(srcElement, true);
@@ -1208,7 +1218,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabNumberOfOpenTabs }}
+   * {{> grabNumberOfOpenTabs }}
    */
   async grabNumberOfOpenTabs() {
     const pages = await this.browser.getAllWindowHandles();
@@ -1216,7 +1226,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/switchTo }}
+   * {{> switchTo }}
    */
   async switchTo(locator) {
     if (Number.isInteger(locator)) {
@@ -1231,7 +1241,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/wait }}
+   * {{> wait }}
    */
   wait(sec) {
     return this.browser.sleep(sec * 1000);
@@ -1239,7 +1249,7 @@ class Protractor extends Helper {
 
 
   /**
-   * {{> ../webapi/waitForElement }}
+   * {{> waitForElement }}
    */
   async waitForElement(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1255,7 +1265,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForDetached }}
+   * {{> waitForDetached }}
    */
   async waitForDetached(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1281,7 +1291,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForVisible }}
+   * {{> waitForVisible }}
    */
   async waitForVisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1290,14 +1300,14 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitToHide }}
+   * {{> waitToHide }}
    */
   async waitToHide(locator, sec = null) {
     return this.waitForInvisible(locator, sec);
   }
 
   /**
-   * {{> ../webapi/waitForInvisible }}
+   * {{> waitForInvisible }}
    */
   async waitForInvisible(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1313,7 +1323,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitNumberOfVisibleElements }}
+   * {{> waitNumberOfVisibleElements }}
    */
   async waitNumberOfVisibleElements(locator, num, sec = null) {
     function visibilityCountOf(loc, expectedCount) {
@@ -1335,7 +1345,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForEnabled }}
+   * {{> waitForEnabled }}
    */
   async waitForEnabled(locator, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1348,7 +1358,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForValue }}
+   * {{> waitForValue }}
    */
   async waitForValue(field, value, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1372,7 +1382,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForFunction }}
+   * {{> waitForFunction }}
    */
   async waitForFunction(fn, argsOrSec = null, sec = null) {
     let args = [];
@@ -1389,7 +1399,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitUntil }}
+   * {{> waitUntil }}
    */
   async waitUntil(fn, sec = null, timeoutMsg = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1397,7 +1407,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitInUrl }}
+   * {{> waitInUrl }}
    */
   async waitInUrl(urlPart, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1415,7 +1425,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitUrlEquals }}
+   * {{> waitUrlEquals }}
    */
   async waitUrlEquals(urlPart, sec = null) {
     const aSec = sec || this.options.waitForTimeout;
@@ -1437,7 +1447,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/waitForText }}
+   * {{> waitForText }}
    */
   async waitForText(text, sec = null, context = null) {
     if (!context) {
@@ -1459,7 +1469,7 @@ class Protractor extends Helper {
 
 
   /**
-   * {{> ../webapi/refreshPage }}
+   * {{> refreshPage }}
    */
   refreshPage() {
     return this.browser.refresh();
@@ -1474,7 +1484,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/scrollTo }}
+   * {{> scrollTo }}
    */
   async scrollTo(locator, offsetX = 0, offsetY = 0) {
     if (typeof locator === 'number' && typeof offsetX === 'number') {
@@ -1501,14 +1511,14 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/scrollPageToTop }}
+   * {{> scrollPageToTop }}
    */
   async scrollPageToTop() {
     return this.executeScript('window.scrollTo(0, 0);');
   }
 
   /**
-   * {{> ../webapi/scrollPageToBottom }}
+   * {{> scrollPageToBottom }}
    */
   async scrollPageToBottom() {
     /* eslint-disable prefer-arrow-callback, comma-dangle */
@@ -1524,7 +1534,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/grabPageScrollPosition}}
+   * {{> grabPageScrollPosition }}
    */
   async grabPageScrollPosition() {
     /* eslint-disable comma-dangle */
@@ -1567,7 +1577,7 @@ class Protractor extends Helper {
   }
 
   /**
-   * {{> ../webapi/setCookie}}
+   * {{> setCookie }}
    */
   setCookie(cookie) {
     return this.browser.manage().addCookie(cookie);