codeceptjs 3.5.9 → 3.5.11

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/command/run-multiple.js

@@ -124,7 +124,7 @@ function executeRun(runName, runConfig) {
   if (browserConfig.outputName) {
     outputDir += typeof browserConfig.outputName === 'function' ? browserConfig.outputName() : browserConfig.outputName;
   } else {
-    const hash = crypto.createHash('md5');
+    const hash = crypto.createHash('sha256');
     hash.update(JSON.stringify(browserConfig));
     outputDir += hash.digest('hex');
   }

package/lib/command/run-workers.js

@@ -7,6 +7,11 @@ const Workers = require('../workers');
 module.exports = async function (workerCount, selectedRuns, options) {
   process.env.profile = options.profile;
 
+  const suiteArr = [];
+  const passedTestArr = [];
+  const failedTestArr = [];
+  const skippedTestArr = [];
+
   const { config: testConfig, override = '' } = options;
   const overrideConfigs = tryOrDefault(() => JSON.parse(override), {});
   const by = options.suites ? 'suite' : 'test';
@@ -26,15 +31,36 @@ module.exports = async function (workerCount, selectedRuns, options) {
 
   const workers = new Workers(numberOfWorkers, config);
   workers.overrideConfig(overrideConfigs);
-  workers.on(event.test.failed, (failedTest) => {
-    output.test.failed(failedTest);
+
+  workers.on(event.suite.before, (suite) => {
+    suiteArr.push(suite);
+  });
+
+  workers.on(event.test.failed, (test) => {
+    failedTestArr.push(test);
+    output.test.failed(test);
+  });
+
+  workers.on(event.test.passed, (test) => {
+    passedTestArr.push(test);
+    output.test.passed(test);
   });
 
-  workers.on(event.test.passed, (successTest) => {
-    output.test.passed(successTest);
+  workers.on(event.test.skipped, (test) => {
+    skippedTestArr.push(test);
+    output.test.passed(test);
   });
 
   workers.on(event.all.result, () => {
+    // expose test stats after all workers finished their execution
+    event.dispatcher.emit(event.workers.result, {
+      suites: suiteArr,
+      tests: {
+        passed: passedTestArr,
+        failed: failedTestArr,
+        skipped: skippedTestArr,
+      },
+    });
     workers.printResults();
   });
 

package/lib/command/workers/runTests.js

@@ -132,9 +132,48 @@ function initializeListeners() {
       duration: test.duration || 0,
       err,
       parent,
+      steps: test.steps ? simplifyStepsInTestObject(test.steps, err) : [],
     };
   }
 
+  function simplifyStepsInTestObject(steps, err) {
+    steps = [...steps];
+    const _steps = [];
+
+    for (step of steps) {
+      const _args = [];
+
+      if (step.args) {
+        for (const arg of step.args) {
+          // check if arg is a JOI object
+          if (arg && arg.$_root) {
+            _args.push(JSON.stringify(arg).slice(0, 300));
+          // check if arg is a function
+          } else if (arg && typeof arg === 'function') {
+            _args.push(arg.name);
+          } else {
+            _args.push(arg);
+          }
+        }
+      }
+
+      _steps.push({
+        actor: step.actor,
+        name: step.name,
+        status: step.status,
+        agrs: _args,
+        startedAt: step.startedAt,
+        startTime: step.startTime,
+        endTime: step.endTime,
+        finishedAt: step.finishedAt,
+        duration: step.duration,
+        err,
+      });
+    }
+
+    return _steps;
+  }
+
   function simplifyStep(step, err = null) {
     step = { ...step };
 

package/lib/event.js

@@ -127,10 +127,12 @@ module.exports = {
    * @inner
    * @property {'workers.before'} before
    * @property {'workers.after'} after
+   * @property {'workers.result'} result
    */
   workers: {
     before: 'workers.before',
     after: 'workers.after',
+    result: 'workers.result',
   },
 
   /**

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;
@@ -368,7 +368,7 @@ class Appium extends Webdriver {
       if (context.web) return this.switchToWeb(context.web);
       if (context.webview) return this.switchToWeb(context.webview);
     }
-    return this._switchToContext(context);
+    return this.switchToContext(context);
   }
 
   _withinEnd() {
@@ -423,8 +423,8 @@ class Appium extends Webdriver {
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
     recorder.session.start('iOS-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from iOS session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from iOS session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -465,8 +465,8 @@ class Appium extends Webdriver {
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
     recorder.session.start('Android-only actions');
-    this._runWithCaps(caps, fn);
-    recorder.add('restore from Android session', () => recorder.session.restore());
+    await this._runWithCaps(caps, fn);
+    await recorder.add('restore from Android session', () => recorder.session.restore());
     return recorder.promise();
   }
 
@@ -834,7 +834,7 @@ class Appium extends Webdriver {
    *
    * @param {*} context the context to switch to
    */
-  async _switchToContext(context) {
+  async switchToContext(context) {
     return this.browser.switchContext(context);
   }
 
@@ -858,11 +858,11 @@ class Appium extends Webdriver {
     this.isWeb = true;
     this.defaultContext = 'body';
 
-    if (context) return this._switchToContext(context);
+    if (context) return this.switchToContext(context);
     const contexts = await this.grabAllContexts();
     this.debugSection('Contexts', contexts.toString());
     for (const idx in contexts) {
-      if (contexts[idx].match(/^WEBVIEW/)) return this._switchToContext(contexts[idx]);
+      if (contexts[idx].match(/^WEBVIEW/)) return this.switchToContext(contexts[idx]);
     }
 
     throw new Error('No WEBVIEW could be guessed, please specify one in params');
@@ -885,8 +885,8 @@ class Appium extends Webdriver {
     this.isWeb = false;
     this.defaultContext = '//*';
 
-    if (context) return this._switchToContext(context);
-    return this._switchToContext('NATIVE_APP');
+    if (context) return this.switchToContext(context);
+    return this.switchToContext('NATIVE_APP');
   }
 
   /**
@@ -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/Expect.js

@@ -20,7 +20,7 @@ chai.use(require('chai-match-pattern'));
  *{
  *   helpers: {
  *     Playwright: {...},
- *     ExpectHelper: {},
+ *     Expect: {},
  *   }
  *}
  * ```
@@ -32,7 +32,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -44,7 +44,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -56,7 +56,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
 
      */
   expectDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
@@ -69,7 +69,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotDeepEqual(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -81,7 +81,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToContain
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectContain(actualValue, expectedValueToContain, customErrorMsg = '') {
     // @ts-ignore
@@ -95,7 +95,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToNotContain
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotContain(
     actualValue,
@@ -113,7 +113,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToStartWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectStartsWith(actualValue, expectedValueToStartWith, customErrorMsg = '') {
     // @ts-ignore
@@ -127,7 +127,7 @@ class ExpectHelper {
      *
      * @param {*} actualValue
      * @param {*} expectedValueToNotStartWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotStartsWith(
     actualValue,
@@ -144,7 +144,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValueToEndWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEndsWith(actualValue, expectedValueToEndWith, customErrorMsg = '') {
     // @ts-ignore
@@ -157,7 +157,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValueToNotEndWith
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectNotEndsWith(
     actualValue,
@@ -174,7 +174,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} jsonSchema
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectJsonSchema(targetData, jsonSchema, customErrorMsg = '') {
     // @ts-ignore
@@ -186,7 +186,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} jsonSchema
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      * @param {*} ajvOptions Pass AJV options
      */
   expectJsonSchemaUsingAJV(
@@ -204,7 +204,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} propertyName
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectHasProperty(targetData, propertyName, customErrorMsg = '') {
     // @ts-ignore
@@ -215,7 +215,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} propertyName
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectHasAProperty(targetData, propertyName, customErrorMsg = '') {
     // @ts-ignore
@@ -226,7 +226,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} type
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectToBeA(targetData, type, customErrorMsg = '') {
     // @ts-ignore
@@ -237,7 +237,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} type
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectToBeAn(targetData, type, customErrorMsg = '') {
     // @ts-ignore
@@ -248,7 +248,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} regex
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectMatchRegex(targetData, regex, customErrorMsg = '') {
     // @ts-ignore
@@ -259,7 +259,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} length
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthOf(targetData, length, customErrorMsg = '') {
     // @ts-ignore
@@ -269,7 +269,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEmpty(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -279,7 +279,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectTrue(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -289,7 +289,7 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectFalse(targetData, customErrorMsg = '') {
     // @ts-ignore
@@ -299,8 +299,8 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} aboveThan number | Date
-     * @param {*} customErrorMsg
+     * @param {*} aboveThan
+     * @param {*} [customErrorMsg]
      */
   expectAbove(targetData, aboveThan, customErrorMsg = '') {
     // @ts-ignore
@@ -310,8 +310,8 @@ class ExpectHelper {
 
   /**
      * @param {*} targetData
-     * @param {*} belowThan number | Date
-     * @param {*} customErrorMsg
+     * @param {*} belowThan
+     * @param {*} [customErrorMsg]
      */
   expectBelow(targetData, belowThan, customErrorMsg = '') {
     // @ts-ignore
@@ -322,7 +322,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} lengthAboveThan
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthAboveThan(targetData, lengthAboveThan, customErrorMsg = '') {
     // @ts-ignore
@@ -335,7 +335,7 @@ class ExpectHelper {
   /**
      * @param {*} targetData
      * @param {*} lengthBelowThan
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectLengthBelowThan(targetData, lengthBelowThan, customErrorMsg = '') {
     // @ts-ignore
@@ -348,7 +348,7 @@ class ExpectHelper {
   /**
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectEqualIgnoreCase(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -362,7 +362,7 @@ class ExpectHelper {
      * expects members of two arrays are deeply equal
      * @param {*} actualValue
      * @param {*} expectedValue
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepMembers(actualValue, expectedValue, customErrorMsg = '') {
     // @ts-ignore
@@ -376,7 +376,7 @@ class ExpectHelper {
      * expects an array to be a superset of another array
      * @param {*} superset
      * @param {*} set
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepIncludeMembers(superset, set, customErrorMsg = '') {
     // @ts-ignore
@@ -391,7 +391,7 @@ class ExpectHelper {
      * @param {*} actualValue
      * @param {*} expectedValue
      * @param {*} fieldsToExclude
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectDeepEqualExcluding(
     actualValue,
@@ -410,7 +410,7 @@ class ExpectHelper {
      * expects a JSON object matches a provided pattern
      * @param {*} actualValue
      * @param {*} expectedPattern
-     * @param {*} customErrorMsg
+     * @param {*} [customErrorMsg]
      */
   expectMatchesPattern(actualValue, expectedPattern, customErrorMsg = '') {
     // @ts-ignore