codeceptjs 3.5.9-beta.2 → 3.5.10

package/docs/parallel.md

@@ -26,12 +26,124 @@ This command is similar to `run`, however, steps output can't be shown in worker
 
 Each worker spins an instance of CodeceptJS, executes a group of tests, and sends back report to the main process.
 
-By default the tests are assigned one by one to the available workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assigne the suites one by one to the workers.
+By default, the tests are assigned one by one to the available workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assign the suites one by one to the workers.
 
 ```sh
 npx codeceptjs run-workers --suites 2
 ```
 
+## Test stats with Parallel Execution by Workers
+
+```js
+const { event } = require('codeceptjs');
+
+module.exports = function() {
+
+  event.dispatcher.on(event.workers.result, function (result) {
+
+    console.log(result);
+
+  });
+}
+
+// in console log
+FAIL  | 7 passed, 1 failed, 1 skipped   // 2s
+{
+  "tests": {
+  "passed": [
+    {
+      "type": "test",
+      "title": "Assert @C3",
+      "body": "() => { }",
+      "async": 0,
+      "sync": true,
+      "_timeout": 2000,
+      "_slow": 75,
+      "_retries": -1,
+      "timedOut": false,
+      "_currentRetry": 0,
+      "pending": false,
+      "opts": {},
+      "tags": [
+        "@C3"
+      ],
+      "uid": "xe4q1HdqpRrZG5dPe0JG+A",
+      "workerIndex": 3,
+      "retries": -1,
+      "duration": 493,
+      "err": null,
+      "parent": {
+        "title": "My",
+        "ctx": {},
+        "suites": [],
+        "tests": [],
+        "root": false,
+        "pending": false,
+        "_retries": -1,
+        "_beforeEach": [],
+        "_beforeAll": [],
+        "_afterEach": [],
+        "_afterAll": [],
+        "_timeout": 2000,
+        "_slow": 75,
+        "_bail": false,
+        "_onlyTests": [],
+        "_onlySuites": [],
+        "delayed": false
+      },
+      "steps": [
+        {
+          "actor": "I",
+          "name": "amOnPage",
+          "status": "success",
+          "agrs": [
+            "https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST"
+          ],
+          "startedAt": 1698760652610,
+          "startTime": 1698760652611,
+          "endTime": 1698760653098,
+          "finishedAt": 1698760653098,
+          "duration": 488
+        },
+        {
+          "actor": "I",
+          "name": "grabCurrentUrl",
+          "status": "success",
+          "agrs": [],
+          "startedAt": 1698760653098,
+          "startTime": 1698760653098,
+          "endTime": 1698760653099,
+          "finishedAt": 1698760653099,
+          "duration": 1
+        }
+      ]
+    }
+  ],
+    "failed": [],
+    "skipped": []
+}
+}
+```
+
+CodeceptJS also exposes the env var `process.env.RUNS_WITH_WORKERS` when running tests with `run-workers` command so that you could handle the events better in your plugins/helpers
+
+```js
+const { event } = require('codeceptjs');
+
+module.exports = function() {
+    // this event would trigger the  `_publishResultsToTestrail` when running `run-workers` command
+  event.dispatcher.on(event.workers.result, async () => {
+    await _publishResultsToTestrail();
+  });
+  
+  // this event would not trigger the  `_publishResultsToTestrail` multiple times when running `run-workers` command
+  event.dispatcher.on(event.all.result, async () => {
+      // when running `run` command, this env var is undefined
+    if (!process.env.RUNS_WITH_WORKERS) await _publishResultsToTestrail();
+  });
+}
+```
+
 ## Parallel Execution by Workers on Multiple Browsers
 
 To run tests in parallel across multiple browsers, modify your `codecept.conf.js` file to configure multiple browsers on which you want to run your tests and your tests will run across multiple browsers. 
@@ -236,7 +348,7 @@ customWorkers.on(event.all.result, () => {
 
 ### Emitting messages to the parent worker
 
-Child workers can send non test events to the main process. This is useful if you want to pass along information not related to the tests event cycles itself such as `event.test.success`.
+Child workers can send non-test events to the main process. This is useful if you want to pass along information not related to the tests event cycles itself such as `event.test.success`.
 
 ```js
 // inside main process

package/docs/webapi/grabWebElement.mustache

@@ -0,0 +1,9 @@
+Grab WebElement for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const webElement = await I.grabWebElement('#button');
+```
+
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@returns {Promise<*>} WebElement of being used Web helper

package/docs/webapi/grabWebElements.mustache

@@ -0,0 +1,9 @@
+Grab WebElements for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const webElements = await I.grabWebElements('#button');
+```
+
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@returns {Promise<*>} WebElement of being used Web helper

package/lib/ai.js

@@ -16,6 +16,8 @@ const htmlConfig = {
   html: {},
 };
 
+const aiInstance = null;
+
 class AiAssistant {
   constructor() {
     this.config = config.get('ai', defaultConfig);
@@ -26,7 +28,10 @@ class AiAssistant {
 
     this.isEnabled = !!process.env.OPENAI_API_KEY;
 
-    if (!this.isEnabled) return;
+    if (!this.isEnabled) {
+      debug('No OpenAI API key provided. AI assistant is disabled.');
+      return;
+    }
 
     const configuration = new Configuration({
       apiKey: process.env.OPENAI_API_KEY,
@@ -35,13 +40,17 @@ class AiAssistant {
     this.openai = new OpenAIApi(configuration);
   }
 
-  setHtmlContext(html) {
+  static getInstance() {
+    return aiInstance || new AiAssistant();
+  }
+
+  async setHtmlContext(html) {
     let processedHTML = html;
 
     if (this.htmlConfig.simplify) {
       processedHTML = removeNonInteractiveElements(processedHTML, this.htmlConfig);
     }
-    if (this.htmlConfig.minify) processedHTML = minifyHtml(processedHTML);
+    if (this.htmlConfig.minify) processedHTML = await minifyHtml(processedHTML);
     if (this.htmlConfig.maxLength) processedHTML = splitByChunks(processedHTML, this.htmlConfig.maxLength)[0];
 
     debug(processedHTML);

package/lib/colorUtils.js

@@ -226,15 +226,25 @@ function isColorProperty(prop) {
     'color',
     'background',
     'backgroundColor',
+    'background-color',
     'borderColor',
+    'border-color',
     'borderBottomColor',
+    'border-bottom-color',
     'borderLeftColor',
+    'border-left-color',
     'borderRightColor',
     'borderTopColor',
     'caretColor',
     'columnRuleColor',
     'outlineColor',
     'textDecorationColor',
+    'border-right-color',
+    'border-top-color',
+    'caret-color',
+    'column-rule-color',
+    'outline-color',
+    'text-decoration-color',
   ].indexOf(prop) > -1;
 }
 

package/lib/helper/Appium.js

@@ -276,7 +276,7 @@ class Appium extends Webdriver {
     const _convertedCaps = {};
     for (const [key, value] of Object.entries(capabilities)) {
       if (!key.startsWith(vendorPrefix.appium)) {
-        if (key !== 'platformName') {
+        if (key !== 'platformName' && key !== 'bstack:options') {
           _convertedCaps[`${vendorPrefix.appium}:${key}`] = value;
         } else {
           _convertedCaps[`${key}`] = value;
@@ -1424,10 +1424,10 @@ class Appium extends Webdriver {
    *
    * @return {Promise<void>}
    *
-   * Appium: support only iOS
+   * Appium: support both Android and iOS
    */
   async closeApp() {
-    onlyForApps.call(this, 'iOS');
+    onlyForApps.call(this);
     return this.browser.closeApp();
   }
 

package/lib/helper/Playwright.js

@@ -1304,6 +1304,22 @@ class Playwright extends Helper {
     return findFields.call(this, locator);
   }
 
+  /**
+   * {{> grabWebElements }}
+   *
+   */
+  async grabWebElements(locator) {
+    return this._locate(locator);
+  }
+
+  /**
+   * {{> grabWebElement }}
+   *
+   */
+  async grabWebElement(locator) {
+    return this._locateElement(locator);
+  }
+
   /**
    * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
    *
@@ -2103,19 +2119,17 @@ class Playwright extends Helper {
 
     const cssPropertiesCamelCase = convertCssPropertiesToCamelCase(cssProperties);
     const elemAmount = res.length;
-    const commands = [];
     let props = [];
 
     for (const element of res) {
-      const cssProperties = await element.evaluate((el) => getComputedStyle(el));
-
-      Object.keys(cssPropertiesCamelCase).forEach(prop => {
+      for (const prop of Object.keys(cssProperties)) {
+        const cssProp = await this.grabCssPropertyFrom(locator, prop);
         if (isColorProperty(prop)) {
-          props.push(convertColorToRGBA(cssProperties[prop]));
+          props.push(convertColorToRGBA(cssProp));
         } else {
-          props.push(cssProperties[prop]);
+          props.push(cssProp);
         }
-      });
+      }
     }
 
     const values = Object.keys(cssPropertiesCamelCase).map(key => cssPropertiesCamelCase[key]);
@@ -2123,9 +2137,8 @@ class Playwright extends Helper {
     let chunked = chunkArray(props, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
-        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
-        if (_acutal !== _expected) return false;
+        // eslint-disable-next-line eqeqeq
+        if (val[i] != values[i]) return false;
       }
       return true;
     });
@@ -2154,7 +2167,7 @@ class Playwright extends Helper {
     let chunked = chunkArray(attrs, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        if (val[i] !== values[i]) return false;
+        if (!val[i].includes(values[i])) return false;
       }
       return true;
     });
@@ -2652,7 +2665,7 @@ class Playwright extends Helper {
       const _contextObject = this.frame ? this.frame : contextObject;
       let count = 0;
       do {
-        waiter = await _contextObject.locator(`:has-text('${text}')`).first().isVisible();
+        waiter = await _contextObject.locator(`:has-text("${text}")`).first().isVisible();
         if (waiter) break;
         await this.wait(1);
         count += 1000;

package/lib/helper/Puppeteer.js

@@ -917,6 +917,14 @@ class Puppeteer extends Helper {
     return findFields.call(this, locator);
   }
 
+  /**
+   * {{> grabWebElements }}
+   *
+   */
+  async grabWebElements(locator) {
+    return this._locate(locator);
+  }
+
   /**
    * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
    *
@@ -1762,31 +1770,26 @@ class Puppeteer extends Helper {
 
     const cssPropertiesCamelCase = convertCssPropertiesToCamelCase(cssProperties);
     const elemAmount = res.length;
-    const commands = [];
-    res.forEach((el) => {
-      Object.keys(cssPropertiesCamelCase).forEach((prop) => {
-        commands.push(el.executionContext()
-          .evaluate((el) => {
-            const style = window.getComputedStyle ? getComputedStyle(el) : el.currentStyle;
-            return JSON.parse(JSON.stringify(style));
-          }, el)
-          .then((props) => {
-            if (isColorProperty(prop)) {
-              return convertColorToRGBA(props[prop]);
-            }
-            return props[prop];
-          }));
-      });
-    });
-    let props = await Promise.all(commands);
+    let props = [];
+
+    for (const element of res) {
+      for (const prop of Object.keys(cssProperties)) {
+        const cssProp = await this.grabCssPropertyFrom(locator, prop);
+        if (isColorProperty(prop)) {
+          props.push(convertColorToRGBA(cssProp));
+        } else {
+          props.push(cssProp);
+        }
+      }
+    }
+
     const values = Object.keys(cssPropertiesCamelCase).map(key => cssPropertiesCamelCase[key]);
     if (!Array.isArray(props)) props = [props];
     let chunked = chunkArray(props, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
-        const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
-        if (_acutal !== _expected) return false;
+        // eslint-disable-next-line eqeqeq
+        if (val[i] != values[i]) return false;
       }
       return true;
     });
@@ -1817,9 +1820,9 @@ class Puppeteer extends Helper {
     let chunked = chunkArray(attrs, values.length);
     chunked = chunked.filter((val) => {
       for (let i = 0; i < val.length; ++i) {
-        const _acutal = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(val[i], 10);
+        const _actual = Number.isNaN(val[i]) || (typeof values[i]) === 'string' ? val[i] : Number.parseInt(values[i], 10);
         const _expected = Number.isNaN(values[i]) || (typeof values[i]) === 'string' ? values[i] : Number.parseInt(values[i], 10);
-        if (_acutal !== _expected) return false;
+        if (!_actual.includes(_expected)) return false;
       }
       return true;
     });

package/lib/helper/WebDriver.js

@@ -869,6 +869,14 @@ class WebDriver extends Helper {
     return findFields.call(this, locator).then(res => res);
   }
 
+  /**
+   * {{> grabWebElements }}
+   *
+   */
+  async grabWebElements(locator) {
+    return this._locate(locator);
+  }
+
   /**
    * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
    *

package/lib/html.js

@@ -1,7 +1,7 @@
 const { parse, serialize } = require('parse5');
-const { minify } = require('html-minifier');
+const { minify } = require('html-minifier-terser');
 
-function minifyHtml(html) {
+async function minifyHtml(html) {
   return minify(html, {
     collapseWhitespace: true,
     removeComments: true,
@@ -11,7 +11,7 @@ function minifyHtml(html) {
     removeStyleLinkTypeAttributes: true,
     collapseBooleanAttributes: true,
     useShortDoctype: true,
-  }).toString();
+  });
 }
 
 const defaultHtmlOpts = {

package/lib/pause.js

@@ -18,8 +18,7 @@ let nextStep;
 let finish;
 let next;
 let registeredVariables = {};
-const aiAssistant = new AiAssistant();
-
+let aiAssistant;
 /**
  * Pauses test execution and starts interactive shell
  * @param {Object<string, *>} [passedObject]
@@ -45,6 +44,8 @@ function pauseSession(passedObject = {}) {
     let vars = Object.keys(registeredVariables).join(', ');
     if (vars) vars = `(vars: ${vars})`;
 
+    aiAssistant = AiAssistant.getInstance();
+
     output.print(colors.yellow(' Interactive shell started'));
     output.print(colors.yellow(' Use JavaScript syntax to try steps in action'));
     output.print(colors.yellow(` - Press ${colors.bold('ENTER')} to run the next step`));
@@ -102,7 +103,9 @@ async function parseInput(cmd) {
   let isAiCommand = false;
   let $res;
   try {
+    // eslint-disable-next-line
     const locate = global.locate; // enable locate in this context
+    // eslint-disable-next-line
     const I = container.support('I');
     if (cmd.trim().startsWith('=>')) {
       isCustomCommand = true;
@@ -115,7 +118,7 @@ async function parseInput(cmd) {
       executeCommand = executeCommand.then(async () => {
         try {
           const html = await res;
-          aiAssistant.setHtmlContext(html);
+          await aiAssistant.setHtmlContext(html);
         } catch (err) {
           output.print(output.styles.error(' ERROR '), 'Can\'t get HTML context', err.stack);
           return;

package/lib/plugin/heal.js

@@ -8,6 +8,7 @@ const output = require('../output');
 const supportedHelpers = require('./standardActingHelpers');
 
 const defaultConfig = {
+  healTries: 1,
   healLimit: 2,
   healSteps: [
     'click',
@@ -54,11 +55,14 @@ const defaultConfig = {
  *
  */
 module.exports = function (config = {}) {
-  const aiAssistant = new AiAssistant();
+  const aiAssistant = AiAssistant.getInstance();
 
   let currentTest = null;
   let currentStep = null;
   let healedSteps = 0;
+  let caughtError;
+  let healTries = 0;
+  let isHealing = false;
 
   const healSuggestions = [];
 
@@ -67,20 +71,35 @@ module.exports = function (config = {}) {
   event.dispatcher.on(event.test.before, (test) => {
     currentTest = test;
     healedSteps = 0;
+    caughtError = null;
   });
 
   event.dispatcher.on(event.step.started, step => currentStep = step);
 
-  event.dispatcher.on(event.step.before, () => {
+  event.dispatcher.on(event.step.after, (step) => {
+    if (isHealing) return;
     const store = require('../store');
     if (store.debugMode) return;
-
     recorder.catchWithoutStop(async (err) => {
-      if (!aiAssistant.isEnabled) throw err;
+      isHealing = true;
+      if (caughtError === err) throw err; // avoid double handling
+      caughtError = err;
+      if (!aiAssistant.isEnabled) {
+        output.print(colors.yellow('Heal plugin can\'t operate, AI assistant is disabled. Please set OPENAI_API_KEY env variable to enable it.'));
+        throw err;
+      }
       if (!currentStep) throw err;
       if (!config.healSteps.includes(currentStep.name)) throw err;
       const test = currentTest;
 
+      if (healTries >= config.healTries) {
+        output.print(colors.bold.red(`Healing failed for ${config.healTries} time(s)`));
+        output.print('AI couldn\'t identify the correct solution');
+        output.print('Probably the entire flow has changed and the test should be updated');
+
+        throw err;
+      }
+
       if (healedSteps >= config.healLimit) {
         output.print(colors.bold.red(`Can't heal more than ${config.healLimit} step(s) in a test`));
         output.print('Entire flow can be broken, please check it manually');
@@ -111,9 +130,17 @@ module.exports = function (config = {}) {
 
       if (!html) throw err;
 
-      aiAssistant.setHtmlContext(html);
+      healTries++;
+      await aiAssistant.setHtmlContext(html);
       await tryToHeal(step, err);
-      recorder.session.restore();
+
+      recorder.add('close healing session', () => {
+        recorder.session.restore('heal');
+        recorder.ignoreErr(err);
+      });
+      await recorder.promise();
+
+      isHealing = false;
     });
   });
 
@@ -155,6 +182,9 @@ module.exports = function (config = {}) {
     for (const codeSnippet of codeSnippets) {
       try {
         debug('Executing', codeSnippet);
+        recorder.catch((e) => {
+          console.log(e);
+        });
         await eval(codeSnippet); // eslint-disable-line
 
         healSuggestions.push({
@@ -163,14 +193,17 @@ module.exports = function (config = {}) {
           snippet: codeSnippet,
         });
 
-        output.print(colors.bold.green('  Code healed successfully'));
+        recorder.add('healed', () => output.print(colors.bold.green('  Code healed successfully')));
         healedSteps++;
         return;
       } catch (err) {
         debug('Failed to execute code', err);
+        recorder.ignoreErr(err); // healing ded not help
+        // recorder.catch(() => output.print(colors.bold.red('  Failed healing code')));
       }
     }
 
     output.debug(`Couldn't heal the code for ${failedStep.toCode()}`);
   }
+  return recorder.promise();
 };

package/lib/recorder.js

@@ -11,6 +11,7 @@ let errFn;
 let queueId = 0;
 let sessionId = null;
 let asyncErr = null;
+let ignoredErrs = [];
 
 let tasks = [];
 let oldPromises = [];
@@ -93,6 +94,7 @@ module.exports = {
     promise = Promise.resolve();
     oldPromises = [];
     tasks = [];
+    ignoredErrs = [];
     this.session.running = false;
     // reset this retries makes the retryFailedStep plugin won't work if there is Before/BeforeSuit block due to retries is undefined on Scenario
     // this.retries = [];
@@ -226,9 +228,10 @@ module.exports = {
    * @inner
    */
   catch(customErrFn) {
-    debug(`${currentQueue()}Queued | catch with error handler`);
+    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
+    debug(`${currentQueue()}Queued | catch with error handler ${fnDescription || ''}`);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err}`);
+      log(`${currentQueue()}Error | ${err} ${fnDescription}...`);
       if (!(err instanceof Error)) { // strange things may happen
         err = new Error(`[Wrapped Error] ${printObjectProperties(err)}`); // we should be prepared for them
       }
@@ -247,15 +250,15 @@ module.exports = {
    * @inner
    */
   catchWithoutStop(customErrFn) {
+    const fnDescription = customErrFn?.toString()?.replace(/\s{2,}/g, ' ').replace(/\n/g, ' ')?.slice(0, 50);
     return promise = promise.catch((err) => {
-      log(`${currentQueue()}Error | ${err}`);
+      if (ignoredErrs.includes(err)) return; // already caught
+      log(`${currentQueue()}Error (Non-Terminated) | ${err} | ${fnDescription || ''}...`);
       if (!(err instanceof Error)) { // strange things may happen
         err = new Error(`[Wrapped Error] ${JSON.stringify(err)}`); // we should be prepared for them
       }
       if (customErrFn) {
         return customErrFn(err);
-      } if (errFn) {
-        return errFn(err);
       }
     });
   },
@@ -274,6 +277,10 @@ module.exports = {
     });
   },
 
+  ignoreErr(err) {
+    ignoredErrs.push(err);
+  },
+
   /**
    * @param {*} err
    * @inner