codeceptjs 2.3.4 → 2.4.1

package/lib/helper/Puppeteer.js

@@ -1,4 +1,9 @@
+const axios = require('axios');
+const fs = require('fs');
+const fsExtra = require('fs-extra');
 const requireg = require('requireg');
+const path = require('path');
+
 const Helper = require('../helper');
 const Locator = require('../locator');
 const recorder = require('../recorder');
@@ -7,11 +12,13 @@ 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,
   fileExists,
   chunkArray,
+  toCamelCase,
   convertCssPropertiesToCamelCase,
   screenshotOutputFolder,
   getNormalizedKeyAttributeValue,
@@ -21,18 +28,15 @@ const {
   isColorProperty,
   convertColorToRGBA,
 } = require('../colorUtils');
-const path = require('path');
 const ElementNotFound = require('./errors/ElementNotFound');
 const RemoteBrowserConnectionRefused = require('./errors/RemoteBrowserConnectionRefused');
 const Popup = require('./extras/Popup');
 const Console = require('./extras/Console');
 const findReact = require('./extras/React');
-const axios = require('axios');
-const fs = require('fs');
-const fsExtra = require('fs-extra');
 
 let puppeteer;
 let perfTiming;
+let isAuthenticated = false;
 const popupStore = new Popup();
 const consoleLogStore = new Console();
 
@@ -50,6 +54,7 @@ const consoleLogStore = new Console();
  * This helper should be configured in codecept.json or codecept.conf.js
  *
  * * `url`: base url of website to be tested
+ * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
  * * `show`: (optional, default: false) - show Google Chrome window for debug.
  * * `restart`: (optional, default: true) - restart browser between tests.
  * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
@@ -127,6 +132,22 @@ const consoleLogStore = new Console();
  * }
  * ```
  *
+* #### Example #5: Target URL with provided basic authentication
+ *
+ * ```js
+ * {
+ *    helpers: {
+ *      Puppeteer : {
+ *        url: 'http://localhost',
+ *        basicAuth: {username: 'username', password: 'password'},
+ *        show: true
+ *      }
+ *    }
+ * }
+ * ```
+ *
+ *
+ *
  * Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
  *
  * ## Access From Helpers
@@ -185,7 +206,10 @@ class Puppeteer extends Helper {
 
   _setConfig(config) {
     this.options = this._validateConfig(config);
-    this.puppeteerOptions = Object.assign({ headless: !this.options.show }, this._getOptions(config));
+    this.puppeteerOptions = {
+      headless: !this.options.show,
+      ...this._getOptions(config),
+    };
     this.isRemoteBrowser = !!this.puppeteerOptions.browserWSEndpoint;
     popupStore.defaultAction = this.options.defaultPopupAction;
   }
@@ -247,9 +271,13 @@ class Puppeteer extends Helper {
       this.debugSection('Session', 'cleaning cookies and localStorage');
       await this.clearCookie();
     }
-    await this.executeScript('localStorage.clear();').catch((err) => {
-      if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
-    });
+    const currentUrl = await this.grabCurrentUrl();
+
+    if (currentUrl.startsWith('http')) {
+      await this.executeScript('localStorage.clear();').catch((err) => {
+        if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
+      });
+    }
     await this.closeOtherTabs();
     return this.browser;
   }
@@ -401,6 +429,7 @@ class Puppeteer extends Helper {
    * ```js
    * await I.grabPopupText();
    * ```
+   * @return {Promise<string | null>}
    */
   async grabPopupText() {
     if (popupStore.popup) {
@@ -513,6 +542,14 @@ class Puppeteer extends Helper {
     if (!(/^\w+\:\/\//.test(url))) {
       url = this.options.url + url;
     }
+
+    if (this.config.basicAuth && (isAuthenticated !== true)) {
+      if (url.includes(this.options.url)) {
+        this.page.authenticate(this.config.basicAuth);
+        isAuthenticated = true;
+      }
+    }
+
     await this.page.goto(url, { waitUntil: this.options.waitForNavigation });
 
     const performanceTiming = JSON.parse(await this.page.evaluate(() => JSON.stringify(window.performance.timing)));
@@ -1241,11 +1278,7 @@ class Puppeteer extends Helper {
   }
 
   /**
-   * Checks that text is equal to provided one.
-   *
-   * ```js
-   * I.seeTextEquals('text', 'h1');
-   * ```
+   * {{> seeTextEquals }}
    */
   async seeTextEquals(text, context = null) {
     return proceedSee.call(this, 'assert', text, context, true);
@@ -1274,6 +1307,7 @@ class Puppeteer extends Helper {
    * let logs = await I.grabBrowserLogs();
    * console.log(JSON.stringify(logs))
    * ```
+   * @return {Promise<any[]>}
    */
   async grabBrowserLogs() {
     const logs = consoleLogStore.entries;
@@ -1441,7 +1475,7 @@ class Puppeteer extends Helper {
   async grabHTMLFrom(locator) {
     const els = await this._locate(locator);
     assertElementExists(els, locator);
-    const values = await Promise.all(els.map(el => this.page.evaluate(element => element.innerHTML, el)));
+    const values = await Promise.all(els.map(el => el.executionContext().evaluate(element => element.innerHTML, el)));
     if (Array.isArray(values) && values.length === 1) {
       return values[0];
     }
@@ -1455,7 +1489,7 @@ class Puppeteer extends Helper {
   async grabCssPropertyFrom(locator, cssProperty) {
     const els = await this._locate(locator);
     const res = await Promise.all(els.map(el => el.executionContext().evaluate(el => JSON.parse(JSON.stringify(getComputedStyle(el))), el)));
-    const cssValues = res.map(props => props[cssProperty]);
+    const cssValues = res.map(props => props[toCamelCase(cssProperty)]);
 
     if (res.length > 0) {
       return cssValues;
@@ -1692,6 +1726,22 @@ class Puppeteer extends Helper {
     });
   }
 
+  /**
+   * {{> waitForClickable }}
+   */
+  async waitForClickable(locator, waitTimeout) {
+    const els = await this._locate(locator);
+    assertElementExists(els, locator);
+
+    return this.waitForFunction(isElementClickable, [els[0]], waitTimeout).catch(async (e) => {
+      if (/failed: timeout/i.test(e.message)) {
+        throw new Error(`element ${new Locator(locator).toString()} still not clickable after ${waitTimeout || this.options.waitForTimeout / 1000} sec`);
+      } else {
+        throw e;
+      }
+    });
+  }
+
   /**
    * {{> waitForElement }}
    * {{ react }}
@@ -1841,10 +1891,11 @@ class Puppeteer extends Helper {
 
       if (locator.isXPath()) {
         waiter = contextObject.waitForFunction((locator, text, $XPath) => {
+          eval($XPath); // eslint-disable-line no-eval
           const el = $XPath(null, locator);
           if (!el.length) return false;
           return el[0].innerText.indexOf(text) > -1;
-        }, { timeout: waitTimeout }, locator.value, text, $XPath);
+        }, { timeout: waitTimeout }, locator.value, text, $XPath.toString());
       }
     } else {
       waiter = contextObject.waitForFunction(text => document.body.innerText.indexOf(text) > -1, { timeout: waitTimeout }, text);
@@ -1864,7 +1915,7 @@ class Puppeteer extends Helper {
    * ```
    *
    * @param {string|function} urlOrPredicate
-   * @param {number?} [sec=null] seconds to wait
+   * @param {?number} [sec=null] seconds to wait
    */
   async waitForRequest(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1880,7 +1931,7 @@ class Puppeteer extends Helper {
    * ```
    *
    * @param {string|function} urlOrPredicate
-   * @param {number?} [sec=null] number of seconds to wait
+   * @param {?number} [sec=null] number of seconds to wait
    */
   async waitForResponse(urlOrPredicate, sec = null) {
     const timeout = sec ? sec * 1000 : this.options.waitForTimeout;
@@ -1907,7 +1958,8 @@ class Puppeteer extends Helper {
         throw new Error('Element #invalidIframeSelector was not found by text|CSS|XPath');
       }
       return;
-    } else if (!locator) {
+    }
+    if (!locator) {
       this.context = await this.page.mainFrame().$('body');
       return;
     }
@@ -1949,7 +2001,11 @@ class Puppeteer extends Helper {
    * @param {*} opts
    */
   async waitForNavigation(opts = {}) {
-    opts = Object.assign({ timeout: this.options.getPageTimeout, waitUntil: this.options.waitForNavigation }, opts);
+    opts = {
+      timeout: this.options.getPageTimeout,
+      waitUntil: this.options.waitForNavigation,
+      ...opts,
+    };
     return this.page.waitForNavigation(opts);
   }
 

package/lib/helper/REST.js

@@ -1,6 +1,7 @@
-const Helper = require('../helper');
-const requireg = require('requireg');
 const axios = require('axios').default;
+const requireg = require('requireg');
+
+const Helper = require('../helper');
 
 /**
  * REST helper allows to send additional requests to the REST API during acceptance tests.
@@ -16,12 +17,15 @@ const axios = require('axios').default;
  * ## Example
  *
  * ```js
- * REST: {
- *    endpoint: 'http://site.com/api',
- *    onRequest: (request) => {
- *      request.headers.auth = '123';
- *    }
- * }
+ *{
+ *   helpers: {
+ *     REST: {
+ *       endpoint: 'http://site.com/api',
+ *       onRequest: (request) => {
+ *       request.headers.auth = '123';
+ *     }
+ *   }
+ *}
  * ```
  *
  * ## Access From Helpers
@@ -46,7 +50,7 @@ class REST extends Helper {
       endpoint: '',
     };
     this.options = Object.assign(this.options, config);
-    this.headers = Object.assign({}, this.options.defaultHeaders);
+    this.headers = { ...this.options.defaultHeaders };
     axios.defaults.headers = this.options.defaultHeaders;
   }
 

package/lib/helper/SeleniumWebdriver.js

@@ -1,21 +1,4 @@
-const requireg = require('requireg');
-const Locator = require('../locator');
 const Helper = require('../helper');
-const stringIncludes = require('../assert/include').includes;
-const urlEquals = require('../assert/equal').urlEquals;
-const equals = require('../assert/equal').equals;
-const empty = require('../assert/empty').empty;
-const truth = require('../assert/truth').truth;
-const xpathLocator = require('../utils').xpathLocator;
-const fileExists = require('../utils').fileExists;
-const clearString = require('../utils').clearString;
-const co = require('co');
-const path = require('path');
-const recorder = require('../recorder');
-const ElementNotFound = require('./errors/ElementNotFound');
-const Protractor = require('./Protractor');
-
-const withinStore = {};
 
 /**
  * SeleniumWebdriver helper is based on the official [Selenium Webdriver JS](https://www.npmjs.com/package/selenium-webdriver)

package/lib/helper/TestCafe.js

@@ -2,11 +2,12 @@
 const fs = require('fs');
 const assert = require('assert');
 const path = require('path');
+const qrcode = require('qrcode-terminal');
 const requireg = require('requireg');
 const createTestCafe = require('testcafe');
 const { Selector, ClientFunction } = require('testcafe');
-const ElementNotFound = require('./errors/ElementNotFound');
 
+const ElementNotFound = require('./errors/ElementNotFound');
 const testControllerHolder = require('./testcafe/testControllerHolder');
 const {
   mapError,
@@ -67,6 +68,21 @@ const getHtmlSource = t => ClientFunction(() => document.getElementsByTagName('h
  * }
  * ```
  *
+ *  To use remote device you can provide 'remote' as browser parameter this will display a link with QR Code
+ *  See https://devexpress.github.io/testcafe/documentation/recipes/test-on-remote-computers-and-mobile-devices.html
+ *  #### Example #2: Remote browser connection
+ *
+ * ```js
+ * {
+ *    helpers: {
+ *      TestCafe : {
+ *        url: "http://localhost",
+ *        waitForTimeout: 15000,
+ *        browser: "remote"
+ *      }
+ *    }
+ * }
+ * ```
  *
  * ## Access From Helpers
  *
@@ -96,7 +112,7 @@ class TestCafe extends Helper {
     this.context = undefined; // TODO Not sure if this applies to testcafe
 
 
-    this.options = Object.assign({
+    this.options = {
       url: 'http://localhost',
       show: false,
       browser: 'chrome',
@@ -108,7 +124,8 @@ class TestCafe extends Helper {
       fullPageScreenshots: false,
       disableScreenshots: false,
       windowSize: undefined,
-    }, config);
+      ...config,
+    };
   }
 
   // TOOD Do a requirements check
@@ -130,12 +147,12 @@ class TestCafe extends Helper {
     ];
   }
 
-  async _startBrowser() {
+  async _configureAndStartBrowser() {
     this.dummyTestcafeFile = createTestFile(global.output_dir); // create a dummy test file to get hold of the test controller
 
     this.iteration += 2; // Use different ports for each test run
     // @ts-ignore
-    this.testcafe = await createTestCafe('localhost', null, null);
+    this.testcafe = await createTestCafe('', null, null);
 
     this.debugSection('_before', 'Starting testcafe browser...');
 
@@ -143,6 +160,19 @@ class TestCafe extends Helper {
 
     // TODO Do we have to cleanup the runner?
     const runner = this.testcafe.createRunner();
+
+    this.options.browser !== 'remote' ? this._startBrowser(runner) : this._startRemoteBrowser(runner);
+
+    this.t = await testControllerHolder.get();
+    assert(this.t, 'Expected to have the testcafe test controller');
+
+    if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
+      const dimensions = this.options.windowSize.split('x');
+      await this.t.resizeWindow(parseInt(dimensions[0], 10), parseInt(dimensions[1], 10));
+    }
+  }
+
+  async _startBrowser(runner) {
     runner
       .src(this.dummyTestcafeFile)
       .screenshots(global.output_dir, !this.options.disableScreenshots)
@@ -166,16 +196,31 @@ class TestCafe extends Helper {
         this.isRunning = false;
         this.testcafe.close();
       });
+  }
 
-    this.t = await testControllerHolder.get();
-    assert(this.t, 'Expected to have the testcafe test controller');
-
-    if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
-      const dimensions = this.options.windowSize.split('x');
-      await this.t.resizeWindow(parseInt(dimensions[0], 10), parseInt(dimensions[1], 10));
-    }
+  async _startRemoteBrowser(runner) {
+    const remoteConnection = await this.testcafe.createBrowserConnection();
+    console.log('Connect your device to the following URL or scan QR Code: ', remoteConnection.url);
+    qrcode.generate(remoteConnection.url);
+    remoteConnection.once('ready', () => {
+      runner
+        .src(this.dummyTestcafeFile)
+        .browsers(remoteConnection)
+        .reporter('minimal')
+        .run({
+          selectorTimeout: this.options.waitForTimeout,
+          skipJsErrors: true,
+          skipUncaughtErrors: true,
+        })
+        .catch((err) => {
+          this.debugSection('_before', `Error ${err.toString()}`);
+          this.isRunning = false;
+          this.testcafe.close();
+        });
+    });
   }
 
+
   async _stopBrowser() {
     this.debugSection('_after', 'Stopping testcafe browser...');
 
@@ -190,19 +235,20 @@ class TestCafe extends Helper {
     this.isRunning = false;
   }
 
-  _init() {}
+  _init() {
+  }
 
   async _beforeSuite() {
     if (!this.options.restart && !this.options.manualStart && !this.isRunning) {
       this.debugSection('Session', 'Starting singleton browser session');
-      return this._startBrowser();
+      return this._configureAndStartBrowser();
     }
   }
 
 
   async _before() {
-    if (this.options.restart && !this.options.manualStart) return this._startBrowser();
-    if (!this.isRunning && !this.options.manualStart) return this._startBrowser();
+    if (this.options.restart && !this.options.manualStart) return this._configureAndStartBrowser();
+    if (!this.isRunning && !this.options.manualStart) return this._configureAndStartBrowser();
     this.context = null;
   }
 
@@ -331,9 +377,10 @@ class TestCafe extends Helper {
     assertElementExists(els, field, 'Field');
     const el = await els.nth(0);
 
-    return this.t
-      .click(el)
-      .pressKey('ctrl+a delete');
+    const res = await this.t
+      .selectText(el)
+      .pressKey('delete');
+    return res;
   }
 
   /**
@@ -494,8 +541,9 @@ class TestCafe extends Helper {
           await this.t.click(optEl, clickOpts).catch(mapError);
           continue;
         }
-      // eslint-disable-next-line no-empty
-      } catch (err) {}
+        // eslint-disable-next-line no-empty
+      } catch (err) {
+      }
 
       try {
         const sel = `[value="${opt}"]`;
@@ -503,8 +551,9 @@ class TestCafe extends Helper {
         if (await optEl.count) {
           await this.t.click(optEl, clickOpts).catch(mapError);
         }
-      // eslint-disable-next-line no-empty
-      } catch (err) {}
+        // eslint-disable-next-line no-empty
+      } catch (err) {
+      }
     }
   }
 
@@ -516,22 +565,22 @@ class TestCafe extends Helper {
   }
 
   /**
-    * {{> dontSeeInCurrentUrl }}
-    */
+   * {{> dontSeeInCurrentUrl }}
+   */
   async dontSeeInCurrentUrl(url) {
     stringIncludes('url').negate(url, await getPageUrl(this.t)().catch(mapError));
   }
 
   /**
-    * {{> seeCurrentUrlEquals }}
-    */
+   * {{> seeCurrentUrlEquals }}
+   */
   async seeCurrentUrlEquals(url) {
     urlEquals(this.options.url).assert(url, await getPageUrl(this.t)().catch(mapError));
   }
 
   /**
-    * {{> dontSeeCurrentUrlEquals }}
-    */
+   * {{> dontSeeCurrentUrlEquals }}
+   */
   async dontSeeCurrentUrlEquals(url) {
     urlEquals(this.options.url).negate(url, await getPageUrl(this.t)().catch(mapError));
   }
@@ -746,14 +795,16 @@ class TestCafe extends Helper {
   async grabAttributeFrom(locator, attr) {
     const sel = await findElements.call(this, this.context, locator);
     assertElementExists(sel);
-    return (await sel.nth(0)).value;
+    return (await sel.nth(0)).getAttribute(attr);
   }
 
   /**
    * {{> grabValueFrom }}
    */
   async grabValueFrom(locator) {
-    return this.grabAttributeFrom(locator, 'value');
+    const sel = await findElements.call(this, this.context, locator);
+    assertElementExists(sel);
+    return (await sel.nth(0)).value;
   }
 
   /**
@@ -990,10 +1041,7 @@ class TestCafe extends Helper {
     }
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout;
 
-    const clientFn = createClientFunction((urlPart) => {
-      const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href)));
-      return currUrl.indexOf(urlPart) > -1;
-    }, args);
+    const clientFn = createClientFunction(fn, args).with({ boundTestRun: this.t });
 
     return waitForFunction(clientFn, waitTimeout);
   }
@@ -1076,7 +1124,7 @@ async function waitForFunction(browserFn, waitTimeout) {
     let result;
     try {
       result = await browserFn();
-    // eslint-disable-next-line no-empty
+      // eslint-disable-next-line no-empty
     } catch (err) {
       throw new Error(`Error running function ${err.toString()}`);
     }