codeceptjs 3.6.4-beta.2 → 3.6.5-beta.1

package/lib/plugin/heal.js

@@ -1,14 +1,14 @@
-const debug = require('debug')('codeceptjs:heal');
-const colors = require('chalk');
-const recorder = require('../recorder');
-const event = require('../event');
-const output = require('../output');
-const heal = require('../heal');
-const store = require('../store');
+const debug = require('debug')('codeceptjs:heal')
+const colors = require('chalk')
+const recorder = require('../recorder')
+const event = require('../event')
+const output = require('../output')
+const heal = require('../heal')
+const store = require('../store')
 
 const defaultConfig = {
   healLimit: 2,
-};
+}
 
 /**
  * Self-healing tests with AI.
@@ -31,88 +31,91 @@ const defaultConfig = {
 module.exports = function (config = {}) {
   if (store.debugMode && !process.env.DEBUG) {
     event.dispatcher.on(event.test.failed, () => {
-      output.plugin('heal', 'Healing is disabled in --debug mode, use DEBUG="codeceptjs:heal" to enable it in debug mode');
-    });
-    return;
+      output.plugin(
+        'heal',
+        'Healing is disabled in --debug mode, use DEBUG="codeceptjs:heal" to enable it in debug mode',
+      )
+    })
+    return
   }
 
-  let currentTest = null;
-  let currentStep = null;
-  let healedSteps = 0;
-  let caughtError;
-  let healTries = 0;
-  let isHealing = false;
+  let currentTest = null
+  let currentStep = null
+  let healedSteps = 0
+  let caughtError
+  let healTries = 0
+  let isHealing = false
 
-  config = Object.assign(defaultConfig, config);
+  config = Object.assign(defaultConfig, config)
 
   event.dispatcher.on(event.test.before, (test) => {
-    currentTest = test;
-    healedSteps = 0;
-    caughtError = null;
-  });
+    currentTest = test
+    healedSteps = 0
+    caughtError = null
+  })
 
-  event.dispatcher.on(event.step.started, step => currentStep = step);
+  event.dispatcher.on(event.step.started, (step) => (currentStep = step))
 
   event.dispatcher.on(event.step.after, (step) => {
-    if (isHealing) return;
-    if (healTries >= config.healLimit) return; // out of limit
+    if (isHealing) return
+    if (healTries >= config.healLimit) return // out of limit
 
-    if (!heal.hasCorrespondingRecipes(step)) return;
+    if (!heal.hasCorrespondingRecipes(step)) return
 
     recorder.catchWithoutStop(async (err) => {
-      isHealing = true;
-      if (caughtError === err) throw err; // avoid double handling
-      caughtError = err;
+      isHealing = true
+      if (caughtError === err) throw err // avoid double handling
+      caughtError = err
 
-      const test = currentTest;
+      const test = currentTest
 
-      recorder.session.start('heal');
+      recorder.session.start('heal')
 
-      debug('Self-healing started', step.toCode());
+      debug('Self-healing started', step.toCode())
 
-      await heal.healStep(step, err, { test });
+      await heal.healStep(step, err, { test })
 
-      healTries++;
+      healTries++
 
       recorder.add('close healing session', () => {
-        recorder.reset();
-        recorder.session.restore('heal');
-        recorder.ignoreErr(err);
-      });
-      await recorder.promise();
+        recorder.reset()
+        recorder.session.restore('heal')
+        recorder.ignoreErr(err)
+      })
+      await recorder.promise()
 
-      isHealing = false;
-    });
-  });
+      isHealing = false
+    })
+  })
 
   event.dispatcher.on(event.all.result, () => {
-    if (!heal.fixes?.length) return;
+    if (!heal.fixes?.length) return
 
-    const { print } = output;
+    const { print } = output
 
-    print('');
-    print('===================');
-    print(colors.bold.green('Self-Healing Report:'));
+    print('')
+    print('===================')
+    print(colors.bold.green('Self-Healing Report:'))
 
-    print(`${colors.bold(heal.fixes.length)} ${heal.fixes.length === 1 ? 'step was' : 'steps were'} healed`);
+    print(`${colors.bold(heal.fixes.length)} ${heal.fixes.length === 1 ? 'step was' : 'steps were'} healed`)
 
-    const suggestions = heal.fixes.filter(fix => fix.recipe && heal.recipes[fix.recipe].suggest);
+    const suggestions = heal.fixes.filter((fix) => fix.recipe && heal.recipes[fix.recipe].suggest)
 
-    if (!suggestions.length) return;
+    if (!suggestions.length) return
 
-    let i = 1;
-    print('');
-    print('Suggested changes:');
-    print('');
+    let i = 1
+    print('')
+    print('Suggested changes:')
+    print('')
 
     for (const suggestion of suggestions) {
-      print(`${i}. To fix ${colors.bold.magenta(suggestion.test?.title)}`);
-      print('  Replace the failed code:', colors.gray(`(suggested by ${colors.bold(suggestion.recipe)})`));
-      print(colors.red(`- ${suggestion.step.toCode()}`));
-      print(colors.green(`+ ${suggestion.snippet}`));
-      print(suggestion.step.line());
-      print('');
-      i++;
+      print(`${i}. To fix ${colors.bold.magenta(suggestion.test?.title)}`)
+      print('  Replace the failed code:', colors.gray(`(suggested by ${colors.bold(suggestion.recipe)})`))
+      print(colors.red(`- ${suggestion.step.toCode()}`))
+      print(colors.green(`+ ${suggestion.snippet}`))
+      print(suggestion.step.line())
+      print('')
+      i++
     }
-  });
-};
+  })
+}

package/lib/plugin/pauseOnFail.js

@@ -1,5 +1,5 @@
-const event = require('../event');
-const pause = require('../pause');
+const event = require('../event')
+const pause = require('../pause')
 
 /**
  * Automatically launches [interactive pause](/basics/#pause) when a test fails.
@@ -22,17 +22,17 @@ const pause = require('../pause');
  *
  */
 module.exports = () => {
-  let failed = false;
+  let failed = false
 
   event.dispatcher.on(event.test.started, () => {
-    failed = false;
-  });
+    failed = false
+  })
 
   event.dispatcher.on(event.step.failed, () => {
-    failed = true;
-  });
+    failed = true
+  })
 
   event.dispatcher.on(event.test.after, () => {
-    if (failed) pause();
-  });
-};
+    if (failed) pause()
+  })
+}

package/lib/plugin/retryFailedStep.js

@@ -1,21 +1,14 @@
-const event = require('../event');
-const recorder = require('../recorder');
-const container = require('../container');
-const { log } = require('../output');
+const event = require('../event')
+const recorder = require('../recorder')
+const container = require('../container')
+const { log } = require('../output')
 
 const defaultConfig = {
   retries: 3,
-  defaultIgnoredSteps: [
-    'amOnPage',
-    'wait*',
-    'send*',
-    'execute*',
-    'run*',
-    'have*',
-  ],
+  defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
   factor: 1.5,
   ignoredSteps: [],
-};
+}
 
 /**
  * Retries each failed step in a test.
@@ -84,45 +77,45 @@ const defaultConfig = {
  *
  */
 module.exports = (config) => {
-  config = Object.assign(defaultConfig, config);
-  config.ignoredSteps = config.ignoredSteps.concat(config.defaultIgnoredSteps);
-  const customWhen = config.when;
+  config = Object.assign(defaultConfig, config)
+  config.ignoredSteps = config.ignoredSteps.concat(config.defaultIgnoredSteps)
+  const customWhen = config.when
 
-  let enableRetry = false;
+  let enableRetry = false
 
   const when = (err) => {
-    if (!enableRetry) return;
-    const store = require('../store');
-    if (store.debugMode) return false;
-    if (customWhen) return customWhen(err);
-    return true;
-  };
-  config.when = when;
+    if (!enableRetry) return
+    const store = require('../store')
+    if (store.debugMode) return false
+    if (customWhen) return customWhen(err)
+    return true
+  }
+  config.when = when
 
   event.dispatcher.on(event.step.started, (step) => {
     if (process.env.TRY_TO === 'true') {
-      log('Info: RetryFailedStep plugin is disabled inside tryTo block');
-      return;
+      log('Info: RetryFailedStep plugin is disabled inside tryTo block')
+      return
     }
 
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
-      if (step.name === ignored) return;
+      if (step.name === ignored) return
       if (ignored instanceof RegExp) {
-        if (step.name.match(ignored)) return;
-      } else if (ignored.indexOf('*') && step.name.startsWith(ignored.slice(0, -1))) return;
+        if (step.name.match(ignored)) return
+      } else if (ignored.indexOf('*') && step.name.startsWith(ignored.slice(0, -1))) return
     }
-    enableRetry = true; // enable retry for a step
-  });
+    enableRetry = true // enable retry for a step
+  })
 
   event.dispatcher.on(event.step.finished, () => {
-    enableRetry = false;
-  });
+    enableRetry = false
+  })
 
   event.dispatcher.on(event.test.before, (test) => {
-    if (test && test.disableRetryFailedStep) return; // disable retry when a test is not active
+    if (test && test.disableRetryFailedStep) return // disable retry when a test is not active
     // this env var is used to set the retries inside _before() block of helpers
-    process.env.FAILED_STEP_RETRIES = config.retries;
-    recorder.retry(config);
-  });
-};
+    process.env.FAILED_STEP_RETRIES = config.retries
+    recorder.retry(config)
+  })
+}

package/lib/plugin/retryTo.js

@@ -1,10 +1,10 @@
-const recorder = require('../recorder');
-const { debug } = require('../output');
+const recorder = require('../recorder')
+const { debug } = require('../output')
 
 const defaultConfig = {
   registerGlobal: true,
   pollInterval: 200,
-};
+}
 
 /**
  *
@@ -74,54 +74,54 @@ const defaultConfig = {
  *
  */
 module.exports = function (config) {
-  config = Object.assign(defaultConfig, config);
+  config = Object.assign(defaultConfig, config)
   function retryTo(callback, maxTries, pollInterval = config.pollInterval) {
     return new Promise((done, reject) => {
-      let tries = 1;
+      let tries = 1
 
       function handleRetryException(err) {
-        recorder.throw(err);
-        reject(err);
+        recorder.throw(err)
+        reject(err)
       }
 
       const tryBlock = async () => {
-        tries++;
-        recorder.session.start(`retryTo ${tries}`);
+        tries++
+        recorder.session.start(`retryTo ${tries}`)
         try {
-          await callback(tries);
+          await callback(tries)
         } catch (err) {
-          handleRetryException(err);
+          handleRetryException(err)
         }
 
         // Call done if no errors
         recorder.add(() => {
-          recorder.session.restore(`retryTo ${tries}`);
-          done(null);
-        });
+          recorder.session.restore(`retryTo ${tries}`)
+          done(null)
+        })
 
         // Catch errors and retry
         recorder.session.catch((err) => {
-          recorder.session.restore(`retryTo ${tries}`);
+          recorder.session.restore(`retryTo ${tries}`)
           if (tries <= maxTries) {
-            debug(`Error ${err}... Retrying`);
-            recorder.add(`retryTo ${tries}`, () => setTimeout(tryBlock, pollInterval));
+            debug(`Error ${err}... Retrying`)
+            recorder.add(`retryTo ${tries}`, () => setTimeout(tryBlock, pollInterval))
           } else {
             // if maxTries reached
-            handleRetryException(err);
+            handleRetryException(err)
           }
-        });
-      };
+        })
+      }
 
-      recorder.add('retryTo', tryBlock).catch(err => {
-        console.error('An error occurred:', err);
-        done(null);
-      });
-    });
+      recorder.add('retryTo', tryBlock).catch((err) => {
+        console.error('An error occurred:', err)
+        done(null)
+      })
+    })
   }
 
   if (config.registerGlobal) {
-    global.retryTo = retryTo;
+    global.retryTo = retryTo
   }
 
-  return retryTo;
-};
+  return retryTo
+}

package/lib/plugin/screenshotOnFail.js

@@ -1,20 +1,20 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require('fs')
+const path = require('path')
 
-const Container = require('../container');
-const recorder = require('../recorder');
-const event = require('../event');
-const output = require('../output');
-const { fileExists, clearString } = require('../utils');
-const Codeceptjs = require('../index');
+const Container = require('../container')
+const recorder = require('../recorder')
+const event = require('../event')
+const output = require('../output')
+const { fileExists, clearString } = require('../utils')
+const Codeceptjs = require('../index')
 
 const defaultConfig = {
   uniqueScreenshotNames: false,
   disableScreenshots: false,
   fullPageScreenshots: false,
-};
+}
 
-const supportedHelpers = require('./standardActingHelpers');
+const supportedHelpers = require('./standardActingHelpers')
 
 /**
  * Creates screenshot on failure. Screenshot is saved into `output` directory.
@@ -43,118 +43,139 @@ const supportedHelpers = require('./standardActingHelpers');
  *
  */
 module.exports = function (config) {
-  const helpers = Container.helpers();
-  let helper;
+  const helpers = Container.helpers()
+  let helper
 
   for (const helperName of supportedHelpers) {
     if (Object.keys(helpers).indexOf(helperName) > -1) {
-      helper = helpers[helperName];
+      helper = helpers[helperName]
     }
   }
 
-  if (!helper) return; // no helpers for screenshot
+  if (!helper) return // no helpers for screenshot
 
-  const options = Object.assign(defaultConfig, helper.options, config);
+  const options = Object.assign(defaultConfig, helper.options, config)
 
   if (helpers.Mochawesome) {
     if (helpers.Mochawesome.config) {
-      options.uniqueScreenshotNames = helpers.Mochawesome.config.uniqueScreenshotNames;
+      options.uniqueScreenshotNames = helpers.Mochawesome.config.uniqueScreenshotNames
     }
   }
 
   if (Codeceptjs.container.mocha()) {
-    options.reportDir = Codeceptjs.container.mocha().options.reporterOptions
-      && Codeceptjs.container.mocha().options.reporterOptions.reportDir;
+    options.reportDir =
+      Codeceptjs.container.mocha().options.reporterOptions &&
+      Codeceptjs.container.mocha().options.reporterOptions.reportDir
   }
 
   if (options.disableScreenshots) {
     // old version of disabling screenshots
-    return;
+    return
   }
 
   event.dispatcher.on(event.test.failed, (test) => {
     if (test.ctx?._runnable.title.includes('hook: ')) {
-      output.plugin('screenshotOnFail', 'BeforeSuite/AfterSuite do not have any access to the browser, hence it could not take screenshot.');
-      return;
+      output.plugin(
+        'screenshotOnFail',
+        'BeforeSuite/AfterSuite do not have any access to the browser, hence it could not take screenshot.',
+      )
+      return
     }
-    recorder.add('screenshot of failed test', async () => {
-      let fileName = clearString(test.title);
-      const dataType = 'image/png';
-      // This prevents data driven to be included in the failed screenshot file name
-      if (fileName.indexOf('{') !== -1) {
-        fileName = fileName.substr(0, (fileName.indexOf('{') - 3)).trim();
-      }
-      if (test.ctx && test.ctx.test && test.ctx.test.type === 'hook') fileName = clearString(`${test.title}_${test.ctx.test.title}`);
-      if (options.uniqueScreenshotNames && test) {
-        const uuid = _getUUID(test);
-        fileName = `${fileName.substring(0, 10)}_${uuid}.failed.png`;
-      } else {
-        fileName += '.failed.png';
-      }
-      output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot');
-
-      try {
-        if (options.reportDir) {
-          fileName = path.join(options.reportDir, fileName);
-          const mochaReportDir = path.resolve(process.cwd(), options.reportDir);
-          if (!fileExists(mochaReportDir)) {
-            fs.mkdirSync(mochaReportDir);
-          }
+    recorder.add(
+      'screenshot of failed test',
+      async () => {
+        let fileName = clearString(test.title)
+        const dataType = 'image/png'
+        // This prevents data driven to be included in the failed screenshot file name
+        if (fileName.indexOf('{') !== -1) {
+          fileName = fileName.substr(0, fileName.indexOf('{') - 3).trim()
         }
-        await helper.saveScreenshot(fileName, options.fullPageScreenshots);
-
-        if (!test.artifacts) test.artifacts = {};
-        test.artifacts.screenshot = path.join(global.output_dir, fileName);
-        if (Container.mocha().options.reporterOptions['mocha-junit-reporter'] && Container.mocha().options.reporterOptions['mocha-junit-reporter'].options.attachments) {
-          test.attachments = [path.join(global.output_dir, fileName)];
+        if (test.ctx && test.ctx.test && test.ctx.test.type === 'hook')
+          fileName = clearString(`${test.title}_${test.ctx.test.title}`)
+        if (options.uniqueScreenshotNames && test) {
+          const uuid = _getUUID(test)
+          fileName = `${fileName.substring(0, 10)}_${uuid}.failed.png`
+        } else {
+          fileName += '.failed.png'
         }
+        output.plugin('screenshotOnFail', 'Test failed, try to save a screenshot')
+
+        try {
+          if (options.reportDir) {
+            fileName = path.join(options.reportDir, fileName)
+            const mochaReportDir = path.resolve(process.cwd(), options.reportDir)
+            if (!fileExists(mochaReportDir)) {
+              fs.mkdirSync(mochaReportDir)
+            }
+          }
+          await helper.saveScreenshot(fileName, options.fullPageScreenshots)
+
+          if (!test.artifacts) test.artifacts = {}
+          test.artifacts.screenshot = path.join(global.output_dir, fileName)
+          if (
+            Container.mocha().options.reporterOptions['mocha-junit-reporter'] &&
+            Container.mocha().options.reporterOptions['mocha-junit-reporter'].options.attachments
+          ) {
+            test.attachments = [path.join(global.output_dir, fileName)]
+          }
 
-        const allureReporter = Container.plugins('allure');
-        if (allureReporter) {
-          allureReporter.addAttachment('Main session - Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), dataType);
-
-          if (helper.activeSessionName) {
-            const sessions = helper.sessionPages || helper.sessionWindows;
-            for (const sessionName in sessions) {
-              const screenshotFileName = `${sessionName}_${fileName}`;
-              test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(global.output_dir, screenshotFileName);
-              allureReporter.addAttachment(`${sessionName} - Last Seen Screenshot`, fs.readFileSync(path.join(global.output_dir, screenshotFileName)), dataType);
+          const allureReporter = Container.plugins('allure')
+          if (allureReporter) {
+            allureReporter.addAttachment(
+              'Main session - Last Seen Screenshot',
+              fs.readFileSync(path.join(global.output_dir, fileName)),
+              dataType,
+            )
+
+            if (helper.activeSessionName) {
+              const sessions = helper.sessionPages || helper.sessionWindows
+              for (const sessionName in sessions) {
+                const screenshotFileName = `${sessionName}_${fileName}`
+                test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(
+                  global.output_dir,
+                  screenshotFileName,
+                )
+                allureReporter.addAttachment(
+                  `${sessionName} - Last Seen Screenshot`,
+                  fs.readFileSync(path.join(global.output_dir, screenshotFileName)),
+                  dataType,
+                )
+              }
             }
           }
-        }
 
-        const cucumberReporter = Container.plugins('cucumberJsonReporter');
-        if (cucumberReporter) {
-          cucumberReporter.addScreenshot(test.artifacts.screenshot);
-        }
-      } catch (err) {
-        output.plugin(err);
-        if (
-          err
-          && err.type
-          && err.type === 'RuntimeError'
-          && err.message
-          && (
-            err.message.indexOf('was terminated due to') > -1
-            || err.message.indexOf('no such window: target window already closed') > -1
-          )
-        ) {
-          output.log(`Can't make screenshot, ${err}`);
-          helper.isRunning = false;
+          const cucumberReporter = Container.plugins('cucumberJsonReporter')
+          if (cucumberReporter) {
+            cucumberReporter.addScreenshot(test.artifacts.screenshot)
+          }
+        } catch (err) {
+          output.plugin(err)
+          if (
+            err &&
+            err.type &&
+            err.type === 'RuntimeError' &&
+            err.message &&
+            (err.message.indexOf('was terminated due to') > -1 ||
+              err.message.indexOf('no such window: target window already closed') > -1)
+          ) {
+            output.log(`Can't make screenshot, ${err}`)
+            helper.isRunning = false
+          }
         }
-      }
-    }, true);
-  });
+      },
+      true,
+    )
+  })
 
   function _getUUID(test) {
     if (test.uuid) {
-      return test.uuid;
+      return test.uuid
     }
 
     if (test.ctx && test.ctx.test.uuid) {
-      return test.ctx.test.uuid;
+      return test.ctx.test.uuid
     }
 
-    return Math.floor(new Date().getTime() / 1000);
+    return Math.floor(new Date().getTime() / 1000)
   }
-};
+}