codeceptjs 3.5.4-beta.1 → 3.5.4

package/lib/helper/Puppeteer.js

@@ -23,7 +23,7 @@ const {
   screenshotOutputFolder,
   getNormalizedKeyAttributeValue,
   isModifierKey,
-  requireWithFallback,
+  requireWithFallback, normalizeSpacesInString,
 } = require('../utils');
 const {
   isColorProperty,
@@ -69,7 +69,7 @@ const consoleLogStore = new Console();
  * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
  * @prop {string} [browser=chrome] - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
  * @prop {object} [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
- * @prop {boolean} [highlightElement] - highlight the interacting elements
+ * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false
 */
 const config = {};
 
@@ -231,6 +231,7 @@ class Puppeteer extends Helper {
       keepBrowserState: false,
       show: false,
       defaultPopupAction: 'accept',
+      highlightElement: false,
     };
 
     return Object.assign(defaults, config);
@@ -765,8 +766,11 @@ class Puppeteer extends Helper {
       const body = document.body;
       const html = document.documentElement;
       window.scrollTo(0, Math.max(
-        body.scrollHeight, body.offsetHeight,
-        html.clientHeight, html.scrollHeight, html.offsetHeight,
+        body.scrollHeight,
+        body.offsetHeight,
+        html.clientHeight,
+        html.scrollHeight,
+        html.offsetHeight,
       ));
     });
   }
@@ -1318,7 +1322,7 @@ class Puppeteer extends Helper {
       await this._evaluateHandeInContext(el => el.innerHTML = '', el);
     }
 
-    highlightActiveElement.call(this, el, this.page);
+    highlightActiveElement.call(this, el, await this._getContext());
     await el.type(value.toString(), { delay: this.options.pressKeyDelay });
 
     return this._waitForAction();
@@ -1339,7 +1343,7 @@ class Puppeteer extends Helper {
   async appendField(field, value) {
     const els = await findVisibleFields.call(this, field);
     assertElementExists(els, field, 'Field');
-    highlightActiveElement.call(this, els[0], this.page);
+    highlightActiveElement.call(this, els[0], await this._getContext());
     await els[0].press('End');
     await els[0].type(value.toString(), { delay: this.options.pressKeyDelay });
     return this._waitForAction();
@@ -1349,14 +1353,16 @@ class Puppeteer extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
-    return proceedSeeInField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'assert', field, _value);
   }
 
   /**
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
-    return proceedSeeInField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeInField.call(this, 'negate', field, _value);
   }
 
   /**
@@ -1386,7 +1392,7 @@ class Puppeteer extends Helper {
     if (await el.getProperty('tagName').then(t => t.jsonValue()) !== 'SELECT') {
       throw new Error('Element is not <select>');
     }
-    highlightActiveElement.call(this, els[0], this.page);
+    highlightActiveElement.call(this, els[0], await this._getContext());
     if (!Array.isArray(option)) option = [option];
 
     for (const key in option) {
@@ -2359,7 +2365,7 @@ async function proceedClick(locator, context = null, options = {}) {
     assertElementExists(els, locator, 'Clickable element');
   }
 
-  highlightActiveElement.call(this, els[0], this.page);
+  highlightActiveElement.call(this, els[0], await this._getContext());
 
   await els[0].click(options);
   const promises = [];
@@ -2419,7 +2425,7 @@ async function proceedSee(assertType, text, context, strict = false) {
   if (strict) {
     return allText.map(elText => equals(description)[assertType](text, elText));
   }
-  return stringIncludes(description)[assertType](text, allText.join(' | '));
+  return stringIncludes(description)[assertType](normalizeSpacesInString(text), normalizeSpacesInString(allText.join(' | ')));
 }
 
 async function findCheckable(locator, context) {
@@ -2714,7 +2720,7 @@ function getNormalizedKey(key) {
 }
 
 function highlightActiveElement(element, context) {
-  if (!this.options.enableHighlight && !store.debugMode) return;
+  if (!this.options.highlightElement && !store.debugMode) return;
 
   highlightElement(element, context);
 }

package/lib/helper/TestCafe.js

@@ -20,7 +20,7 @@ const { urlEquals } = require('../assert/equal');
 const { empty } = require('../assert/empty');
 const { truth } = require('../assert/truth');
 const {
-  xpathLocator,
+  xpathLocator, normalizeSpacesInString,
 } = require('../utils');
 const Locator = require('../locator');
 
@@ -637,9 +637,9 @@ class TestCafe extends Helper {
   async see(text, context = null) {
     let els;
     if (context) {
-      els = (await findElements.call(this, this.context, context)).withText(text);
+      els = (await findElements.call(this, this.context, context)).withText(normalizeSpacesInString(text));
     } else {
-      els = (await findElements.call(this, this.context, '*')).withText(text);
+      els = (await findElements.call(this, this.context, '*')).withText(normalizeSpacesInString(text));
     }
 
     return this.t
@@ -727,13 +727,14 @@ class TestCafe extends Helper {
    * {{> seeInField }}
    */
   async seeInField(field, value) {
+    const _value = (typeof value === 'boolean') ? value : value.toString();
     // const expectedValue = findElements.call(this, this.context, field).value;
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
     const el = await els.nth(0);
 
     return this.t
-      .expect(await el.value).eql(value)
+      .expect(await el.value).eql(_value)
       .catch(mapError);
   }
 
@@ -741,13 +742,14 @@ class TestCafe extends Helper {
    * {{> dontSeeInField }}
    */
   async dontSeeInField(field, value) {
+    const _value = (typeof value === 'boolean') ? value : value.toString();
     // const expectedValue = findElements.call(this, this.context, field).value;
     const els = await findFields.call(this, field);
     assertElementExists(els, field, 'Field');
     const el = await els.nth(0);
 
     return this.t
-      .expect(el.value).notEql(value)
+      .expect(el.value).notEql(_value)
       .catch(mapError);
   }
 
@@ -960,8 +962,11 @@ class TestCafe extends Helper {
       const body = document.body;
       const html = document.documentElement;
       window.scrollTo(0, Math.max(
-        body.scrollHeight, body.offsetHeight,
-        html.clientHeight, html.scrollHeight, html.offsetHeight,
+        body.scrollHeight,
+        body.offsetHeight,
+        html.clientHeight,
+        html.scrollHeight,
+        html.offsetHeight,
       ));
     }).with({ boundTestRun: this.t })().catch(mapError);
   }
@@ -1220,7 +1225,9 @@ class TestCafe extends Helper {
 }
 
 async function waitForFunction(browserFn, waitTimeout) {
-  const pause = () => new Promise((done => setTimeout(done, 50)));
+  const pause = () => new Promise((done => {
+    setTimeout(done, 50);
+  }));
 
   const start = Date.now();
   // eslint-disable-next-line no-constant-condition

package/lib/helper/WebDriver.js

@@ -62,7 +62,7 @@ const webRoot = 'body';
  * @prop {object} [desiredCapabilities] Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
  * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
  * @prop {object} [timeouts] [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
- * @prop {boolean} [highlightElement] - highlight the interacting elements
+ * @prop {boolean} [highlightElement] - highlight the interacting elements. Default: false
  */
 const config = {};
 
@@ -429,6 +429,7 @@ class WebDriver extends Helper {
       keepCookies: false,
       keepBrowserState: false,
       deprecationWarnings: false,
+      highlightElement: false,
     };
 
     // override defaults with config
@@ -1347,7 +1348,8 @@ class WebDriver extends Helper {
    *
    */
   async seeInField(field, value) {
-    return proceedSeeField.call(this, 'assert', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeField.call(this, 'assert', field, _value);
   }
 
   /**
@@ -1355,7 +1357,8 @@ class WebDriver extends Helper {
    *
    */
   async dontSeeInField(field, value) {
-    return proceedSeeField.call(this, 'negate', field, value);
+    const _value = (typeof value === 'boolean') ? value : value.toString();
+    return proceedSeeField.call(this, 'negate', field, _value);
   }
 
   /**
@@ -2062,7 +2065,9 @@ class WebDriver extends Helper {
    * {{> wait }}
    */
   async wait(sec) {
-    return new Promise(resolve => setTimeout(resolve, sec * 1000));
+    return new Promise(resolve => {
+      setTimeout(resolve, sec * 1000);
+    });
   }
 
   /**
@@ -2167,20 +2172,18 @@ class WebDriver extends Helper {
     const aSec = sec || this.options.waitForTimeoutInSeconds;
     const _context = context || this.root;
 
-    return this.browser.waitUntil(
-      async () => {
-        const res = await this.$$(withStrictLocator.call(this, _context));
-        if (!res || res.length === 0) return false;
-        const selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)));
-        if (Array.isArray(selected)) {
-          return selected.filter(part => part.indexOf(text) >= 0).length > 0;
-        }
-        return selected.indexOf(text) >= 0;
-      }, {
-        timeout: aSec * 1000,
-        timeoutMsg: `element (${_context}) is not in DOM or there is no element(${_context}) with text "${text}" after ${aSec} sec`,
-      },
-    );
+    return this.browser.waitUntil(async () => {
+      const res = await this.$$(withStrictLocator.call(this, _context));
+      if (!res || res.length === 0) return false;
+      const selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)));
+      if (Array.isArray(selected)) {
+        return selected.filter(part => part.indexOf(text) >= 0).length > 0;
+      }
+      return selected.indexOf(text) >= 0;
+    }, {
+      timeout: aSec * 1000,
+      timeoutMsg: `element (${_context}) is not in DOM or there is no element(${_context}) with text "${text}" after ${aSec} sec`,
+    });
   }
 
   /**
@@ -2190,20 +2193,18 @@ class WebDriver extends Helper {
     const client = this.browser;
     const aSec = sec || this.options.waitForTimeoutInSeconds;
 
-    return client.waitUntil(
-      async () => {
-        const res = await findFields.call(this, field);
-        if (!res || res.length === 0) return false;
-        const selected = await forEachAsync(res, async el => el.getValue());
-        if (Array.isArray(selected)) {
-          return selected.filter(part => part.indexOf(value) >= 0).length > 0;
-        }
-        return selected.indexOf(value) >= 0;
-      }, {
-        timeout: aSec * 1000,
-        timeoutMsg: `element (${field}) is not in DOM or there is no element(${field}) with value "${value}" after ${aSec} sec`,
-      },
-    );
+    return client.waitUntil(async () => {
+      const res = await findFields.call(this, field);
+      if (!res || res.length === 0) return false;
+      const selected = await forEachAsync(res, async el => el.getValue());
+      if (Array.isArray(selected)) {
+        return selected.filter(part => part.indexOf(value) >= 0).length > 0;
+      }
+      return selected.indexOf(value) >= 0;
+    }, {
+      timeout: aSec * 1000,
+      timeoutMsg: `element (${field}) is not in DOM or there is no element(${field}) with value "${value}" after ${aSec} sec`,
+    });
   }
 
   /**
@@ -2411,8 +2412,11 @@ class WebDriver extends Helper {
       const body = document.body;
       const html = document.documentElement;
       window.scrollTo(0, Math.max(
-        body.scrollHeight, body.offsetHeight,
-        html.clientHeight, html.scrollHeight, html.offsetHeight
+        body.scrollHeight,
+        body.offsetHeight,
+        html.clientHeight,
+        html.scrollHeight,
+        html.offsetHeight
       ));
     });
     /* eslint-enable */
@@ -2914,7 +2918,7 @@ function isModifierKey(key) {
 }
 
 function highlightActiveElement(element) {
-  if (!this.options.enableHighlight && !store.debugMode) return;
+  if (!this.options.highlightElement && !store.debugMode) return;
 
   highlightElement(element, this.browser);
 }

package/lib/helper/clientscripts/nightmare.js

@@ -0,0 +1,213 @@
+if (!window.codeceptjs) {
+  /**
+   * @alias CodeceptJS.browserCodecept
+   * @namespace
+   */
+  const codeceptjs = {};
+
+  /**
+   * all found elements are stored here for reuse
+   * @inner
+   * @type {Node[]}
+   */
+  codeceptjs.elements = [];
+
+  /**
+   * global context changer
+   * @inner
+   * @type {?Node}
+   */
+  codeceptjs.within = null;
+
+  // save
+  const storeElement = function (el) {
+    if (!el) return;
+    return codeceptjs.elements.push(el) - 1; // return index
+  };
+
+  const storeElements = function (els) {
+    return els.map(el => storeElement(el));
+  };
+
+  /**
+   * finders
+   * @param {number} id
+   * @return {Node}
+   */
+  codeceptjs.fetchElement = function (id) {
+    if (!this.elements[id]) throw new Error(`Element (${id}) is not accessible`);
+    return this.elements[id];
+  };
+
+  /**
+   * @param   {string}  by
+   * @param   {CodeceptJS.ILocator}  locator
+   * @param   {*}  [contextEl]
+   * @return  {number[]}
+   */
+  codeceptjs.findAndStoreElements = function (by, locator, contextEl) {
+    return storeElements(this.findElements(by, locator, contextEl));
+  };
+
+  /**
+   * @param   {string}  by
+   * @param   {CodeceptJS.ILocator}  locator
+   * @param   {*}  [contextEl]
+   * @return  {number | undefined}
+   */
+  codeceptjs.findAndStoreElement = function (by, locator, contextEl) {
+    return storeElement(this.findElement(by, locator, contextEl));
+  };
+
+  /**
+   * @param {string} by
+   * @param {CodeceptJS.ILocator} locator
+   */
+  codeceptjs.setWithin = function (by, locator) {
+    this.within = this.findElement(by, locator);
+  };
+
+  /**
+   * @param   {string}  by
+   * @param   {CodeceptJS.ILocator}  locator
+   * @param   {*}  [contextEl]
+   * @return  {Node[]}
+   */
+  codeceptjs.findElements = function (by, locator, contextEl) {
+    let context;
+    if (typeof contextEl !== 'number') {
+      context = this.within || document;
+    } else {
+      context = this.fetchElement(contextEl);
+    }
+
+    if (by === 'name') {
+      by = 'css';
+      locator = `*[name="${locator}"]`;
+    }
+    if (by === 'id') {
+      by = 'css';
+      locator = `#${locator}`;
+    }
+
+    if (by === 'css') {
+      const found = context.querySelectorAll(locator);
+      const res = [];
+      for (let i = 0; i < found.length; i++) {
+        res.push(found[i]);
+      }
+      return res;
+    }
+
+    if (by === 'xpath') {
+      const found = document.evaluate(locator, context, null, 5, null);
+      const res = [];
+      let current = null;
+      while (current = found.iterateNext()) {
+        res.push(current);
+      }
+      return res;
+    }
+
+    if (by === 'frame') {
+      if (!Array.isArray(locator)) locator = [locator];
+      return [locator.reduce((parent, child) => parent.querySelector(child).contentDocument, window.document).querySelector('body')];
+    }
+    return [];
+  };
+
+  /**
+   * @param   {string}  by
+   * @param   {CodeceptJS.ILocator}  locator
+   * @param   {*}  [context]
+   * @return  {?Node}
+   */
+  codeceptjs.findElement = function (by, locator, context) {
+    return this.findElements(by, locator, context)[0] || null;
+  };
+
+  // actions
+  /**
+   * @param {number} el
+   * @return {boolean}
+   */
+  codeceptjs.clickEl = function (el) {
+    if (document.activeElement instanceof HTMLElement) {
+      document.activeElement.blur();
+    }
+    const event = document.createEvent('MouseEvent');
+    event.initEvent('click', true, true);
+    return this.fetchElement(el).dispatchEvent(event);
+  };
+
+  /** @param {number} el */
+  codeceptjs.doubleClickEl = function (el) {
+    if (document.activeElement instanceof HTMLElement) {
+      document.activeElement.blur();
+    }
+    const event = document.createEvent('MouseEvent');
+    event.initEvent('dblclick', true, true);
+    this.fetchElement(el).dispatchEvent(event);
+  };
+
+  /**
+   * @param {number} el
+   * @param {number | undefined} x
+   * @param {number | undefined} y
+   */
+  codeceptjs.hoverEl = function (el, x, y) {
+    if (document.activeElement instanceof HTMLElement) {
+      document.activeElement.blur();
+    }
+
+    const event = new MouseEvent('mouseover', {
+      bubbles: true,
+      cancelable: true,
+      screenX: x,
+      screenY: y,
+      clientX: x,
+      clientY: y,
+    });
+
+    this.fetchElement(el).dispatchEvent(event);
+  };
+
+  /** @param {number} el */
+  codeceptjs.rightClickEl = function (el) {
+    const event = new MouseEvent('contextmenu', {
+      bubbles: true,
+      cancelable: true,
+      view: window,
+      buttons: 2,
+    });
+
+    this.fetchElement(el).dispatchEvent(event);
+  };
+
+  /**
+   * @param {number} el
+   * @return {boolean  |  undefined}
+   */
+  codeceptjs.checkEl = function (el) {
+    const element = this.fetchElement(el);
+    const event = document.createEvent('HTMLEvents');
+    if (element.checked) return;
+    element.checked = true;
+    event.initEvent('change', true, true);
+    return element.dispatchEvent(event);
+  };
+
+  /**
+   * @param {number} el
+   * @return {boolean}
+   */
+  codeceptjs.unCheckEl = function (el) {
+    const element = this.fetchElement(el);
+    const event = document.createEvent('HTMLEvents');
+    element.checked = false;
+    event.initEvent('change', true, true);
+    return element.dispatchEvent(event);
+  };
+
+  window.codeceptjs = codeceptjs;
+}

package/lib/helper/errors/ElementNotFound.js

@@ -5,7 +5,8 @@ const Locator = require('../../locator');
  */
 class ElementNotFound {
   constructor(
-    locator, prefixMessage = 'Element',
+    locator,
+    prefixMessage = 'Element',
     postfixMessage = 'was not found by text|CSS|XPath',
   ) {
     if (typeof locator === 'object') {

package/lib/helper/scripts/highlightElement.js

@@ -8,7 +8,7 @@ module.exports.highlightElement = (element, context) => {
 
   try {
     // Playwright, Puppeteer
-    context.evaluate(clientSideHighlightFn, element);
+    context.evaluate(clientSideHighlightFn, element).catch(err => console.error(err));
   } catch (e) {
     // WebDriver
     try {

package/lib/interfaces/bdd.js

@@ -30,7 +30,7 @@ const parameterTypeRegistry = new ParameterTypeRegistry();
 const matchStep = (step) => {
   for (const stepName in steps) {
     if (stepName.indexOf('/') === 0) {
-      const regExpArr = stepName.match(new RegExp('^/(.*?)/([gimy]*)$')) || [];
+      const regExpArr = stepName.match(/^\/(.*?)\/([gimy]*)$/) || [];
       const res = step.match(new RegExp(regExpArr[1], regExpArr[2]));
       if (res) {
         const fn = steps[stepName];

package/lib/mochaFactory.js

@@ -97,7 +97,8 @@ class MochaFactory {
     const attributes = Object.getOwnPropertyDescriptor(reporterOptions, 'codeceptjs-cli-reporter');
     if (reporterOptions['codeceptjs-cli-reporter'] && attributes) {
       Object.defineProperty(
-        reporterOptions, 'codeceptjs/lib/cli',
+        reporterOptions,
+        'codeceptjs/lib/cli',
         attributes,
       );
       delete reporterOptions['codeceptjs-cli-reporter'];

package/lib/pause.js

@@ -67,6 +67,7 @@ function pauseSession(passedObject = {}) {
   });
   return new Promise(((resolve) => {
     finish = resolve;
+    // eslint-disable-next-line
     return askForStep();
   }));
 }
@@ -114,13 +115,13 @@ async function parseInput(cmd) {
       isAiCommand = true;
       executeCommand = executeCommand.then(async () => {
         try {
-          const html = await res; 
+          const html = await res;
           aiAssistant.setHtmlContext(html);
         } catch (err) {
           output.print(output.styles.error(' ERROR '), 'Can\'t get HTML context', err.stack);
           return;
         } finally {
-          output.level(currentOutputLevel);          
+          output.level(currentOutputLevel);
         }
         // aiAssistant.mockResponse("```js\nI.click('Sign in');\n```");
         const spinner = ora("Processing OpenAI request...").start();
@@ -148,12 +149,12 @@ async function parseInput(cmd) {
     })
 
     const val = await executeCommand;
-    
+
     if (isCustomCommand) {
       if (val !== undefined) console.log('Result', '$res=', val); // eslint-disable-line
       $res = val;
     }
-    
+
     if (cmd?.startsWith('I.see') || cmd?.startsWith('I.dontSee')) {
       output.print(output.styles.success('  OK  '), cmd);
     }

package/lib/plugin/heal.js

@@ -147,11 +147,10 @@ module.exports = function (config = {}) {
   async function tryToHeal(failedStep, err) {
     output.debug(`Running OpenAI to heal ${failedStep.toCode()} step`);
 
-    const codeSnippets = await aiAssistant.healFailedStep(
-      failedStep, err, currentTest,
-    );
+    const codeSnippets = await aiAssistant.healFailedStep(failedStep, err, currentTest);
 
     output.debug(`Received ${codeSnippets.length} suggestions from OpenAI`);
+    const I = Container.support('I'); // eslint-disable-line
 
     for (const codeSnippet of codeSnippets) {
       try {

package/lib/plugin/selenoid.js

@@ -58,7 +58,12 @@ let seleniumUrl = 'http://localhost:$port$';
 const supportedHelpers = ['WebDriver'];
 const SELENOID_START_TIMEOUT = 2000;
 const SELENOID_STOP_TIMEOUT = 10000;
-const wait = time => new Promise((res) => setTimeout(() => res(), time));
+const wait = time => new Promise((res) => {
+  setTimeout(() => {
+    // @ts-ignore
+    res();
+  }, time);
+});
 
 /**
  * [Selenoid](https://aerokube.com/selenoid/) plugin automatically starts browsers and video recording.