codeceptjs 3.7.0-beta.3 → 3.7.0-beta.5

package/lib/output.js

@@ -1,6 +1,6 @@
-const colors = require('chalk');
-const figures = require('figures');
-const { maskSensitiveData } = require('invisi-data');
+const colors = require('chalk')
+const figures = require('figures')
+const { maskSensitiveData } = require('invisi-data')
 
 const styles = {
   error: colors.bgRed.white.bold,
@@ -10,11 +10,12 @@ const styles = {
   debug: colors.cyan,
   log: colors.grey,
   bold: colors.bold,
-};
+  section: colors.white.dim.bold,
+}
 
-let outputLevel = 0;
-let outputProcess = '';
-let newline = true;
+let outputLevel = 0
+let outputProcess = ''
+let newline = true
 
 /**
  * @alias output
@@ -28,7 +29,7 @@ module.exports = {
   stepShift: 0,
 
   standWithUkraine() {
-    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`;
+    return `#${colors.bold.yellow('StandWith')}${colors.bold.cyan('Ukraine')}`
   },
 
   /**
@@ -37,8 +38,8 @@ module.exports = {
    * @returns {number}
    */
   level(level) {
-    if (level !== undefined) outputLevel = level;
-    return outputLevel;
+    if (level !== undefined) outputLevel = level
+    return outputLevel
   },
 
   /**
@@ -48,9 +49,9 @@ module.exports = {
    * @returns {string}
    */
   process(process) {
-    if (process === null) return (outputProcess = '');
-    if (process) outputProcess = String(process).length === 1 ? `[0${process}]` : `[${process}]`;
-    return outputProcess;
+    if (process === null) return (outputProcess = '')
+    if (process) outputProcess = String(process).length === 1 ? `[0${process}]` : `[${process}]`
+    return outputProcess
   },
 
   /**
@@ -58,9 +59,9 @@ module.exports = {
    * @param {string} msg
    */
   debug(msg) {
-    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg;
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 2) {
-      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`));
+      print(' '.repeat(this.stepShift), styles.debug(`${figures.pointerSmall} ${_msg}`))
     }
   },
 
@@ -69,9 +70,9 @@ module.exports = {
    * @param {string} msg
    */
   log(msg) {
-    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg;
+    const _msg = isMaskedData() ? maskSensitiveData(msg) : msg
     if (outputLevel >= 3) {
-      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)));
+      print(' '.repeat(this.stepShift), styles.log(truncate(`   ${_msg}`, this.spaceShift)))
     }
   },
 
@@ -80,7 +81,7 @@ module.exports = {
    * @param {string} msg
    */
   error(msg) {
-    print(styles.error(msg));
+    print(styles.error(msg))
   },
 
   /**
@@ -88,7 +89,7 @@ module.exports = {
    * @param {string} msg
    */
   success(msg) {
-    print(styles.success(msg));
+    print(styles.success(msg))
   },
 
   /**
@@ -97,7 +98,7 @@ module.exports = {
    * @param {string} msg
    */
   plugin(pluginName, msg = '') {
-    this.debug(`<${pluginName}> ${msg}`);
+    this.debug(`<${pluginName}> ${msg}`)
   },
 
   /**
@@ -105,26 +106,26 @@ module.exports = {
    * @param {CodeceptJS.Step} step
    */
   step(step) {
-    if (outputLevel === 0) return;
-    if (!step) return;
+    if (outputLevel === 0) return
+    if (!step) return
     // Avoid to print non-gherkin steps, when gherkin is running for --steps mode
     if (outputLevel === 1) {
       if (typeof step === 'object' && step.hasBDDAncestor()) {
-        return;
+        return
       }
     }
 
-    let stepLine = step.toCliStyled();
+    let stepLine = step.toCliStyled()
     if (step.metaStep && outputLevel >= 1) {
       // this.stepShift += 2;
-      stepLine = colors.dim(truncate(stepLine, this.spaceShift));
+      stepLine = colors.dim(truncate(stepLine, this.spaceShift))
     }
     if (step.comment) {
-      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)));
+      stepLine += colors.grey(step.comment.split('\n').join('\n' + ' '.repeat(4)))
     }
 
-    const _stepLine = isMaskedData() ? maskSensitiveData(stepLine) : stepLine;
-    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift));
+    const _stepLine = isMaskedData() ? maskSensitiveData(stepLine) : stepLine
+    print(' '.repeat(this.stepShift), truncate(_stepLine, this.spaceShift))
   },
 
   /** @namespace */
@@ -133,9 +134,9 @@ module.exports = {
      * @param {Mocha.Suite} suite
      */
     started: suite => {
-      if (!suite.title) return;
-      print(`${colors.bold(suite.title)} --`);
-      if (suite.comment) print(suite.comment);
+      if (!suite.title) return
+      print(`${colors.bold(suite.title)} --`)
+      if (suite.comment) print(suite.comment)
     },
   },
 
@@ -145,25 +146,25 @@ module.exports = {
      * @param {Mocha.Test} test
      */
     started(test) {
-      print(`  ${colors.magenta.bold(test.title)}`);
+      print(`  ${colors.magenta.bold(test.title)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     passed(test) {
-      print(`  ${colors.green.bold(figures.tick)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`);
+      print(`  ${colors.green.bold(figures.tick)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     failed(test) {
-      print(`  ${colors.red.bold(figures.cross)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`);
+      print(`  ${colors.red.bold(figures.cross)} ${test.title} ${colors.grey(`in ${test.duration}ms`)}`)
     },
     /**
      * @param {Mocha.Test} test
      */
     skipped(test) {
-      print(`  ${colors.yellow.bold('S')} ${test.title}`);
+      print(`  ${colors.yellow.bold('S')} ${test.title}`)
     },
   },
 
@@ -174,38 +175,38 @@ module.exports = {
      */
 
     started(test) {
-      if (outputLevel < 1) return;
-      print(`  ${colors.dim.bold('Scenario()')}`);
+      if (outputLevel < 1) return
+      print(`  ${colors.dim.bold('Scenario()')}`)
     },
 
     /**
      * @param {Mocha.Test} test
      */
     passed(test) {
-      print(`  ${colors.green.bold(`${figures.tick} OK`)} ${colors.grey(`in ${test.duration}ms`)}`);
-      print();
+      print(`  ${colors.green.bold(`${figures.tick} OK`)} ${colors.grey(`in ${test.duration}ms`)}`)
+      print()
     },
     /**
      * @param {Mocha.Test} test
      */
     failed(test) {
-      print(`  ${colors.red.bold(`${figures.cross} FAILED`)} ${colors.grey(`in ${test.duration}ms`)}`);
-      print();
+      print(`  ${colors.red.bold(`${figures.cross} FAILED`)} ${colors.grey(`in ${test.duration}ms`)}`)
+      print()
     },
   },
 
   hook: {
     started(hook) {
-      if (outputLevel < 1) return;
-      print(`  ${colors.dim.bold(hook.toCode())}`);
+      if (outputLevel < 1) return
+      print(`  ${colors.dim.bold(hook.toCode())}`)
     },
     passed(hook) {
-      if (outputLevel < 1) return;
-      print();
+      if (outputLevel < 1) return
+      print()
     },
     failed(hook) {
-      if (outputLevel < 1) return;
-      print(`  ${colors.red.bold(hook.toCode())}`);
+      if (outputLevel < 1) return
+      print(`  ${colors.red.bold(hook.toCode())}`)
     },
   },
 
@@ -217,9 +218,9 @@ module.exports = {
    */
   say(message, color = 'cyan') {
     if (colors[color] === undefined) {
-      color = 'cyan';
+      color = 'cyan'
     }
-    if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`);
+    if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`)
   },
 
   /**
@@ -229,54 +230,54 @@ module.exports = {
    * @param {number|string} duration
    */
   result(passed, failed, skipped, duration, failedHooks = 0) {
-    let style = colors.bgGreen;
-    let msg = ` ${passed || 0} passed`;
-    let status = style.bold('  OK ');
+    let style = colors.bgGreen
+    let msg = ` ${passed || 0} passed`
+    let status = style.bold('  OK ')
     if (failed) {
-      style = style.bgRed;
-      status = style.bold('  FAIL ');
-      msg += `, ${failed} failed`;
+      style = style.bgRed
+      status = style.bold('  FAIL ')
+      msg += `, ${failed} failed`
     }
 
     if (failedHooks > 0) {
-      style = style.bgRed;
-      status = style.bold('  FAIL ');
-      msg += `, ${failedHooks} failedHooks`;
+      style = style.bgRed
+      status = style.bold('  FAIL ')
+      msg += `, ${failedHooks} failedHooks`
     }
-    status += style.grey(' |');
+    status += style.grey(' |')
 
     if (skipped) {
-      if (!failed) style = style.bgYellow;
-      msg += `, ${skipped} skipped`;
+      if (!failed) style = style.bgYellow
+      msg += `, ${skipped} skipped`
     }
-    msg += '  ';
-    print(status + style(msg) + colors.grey(` // ${duration}`));
+    msg += '  '
+    print(status + style(msg) + colors.grey(` // ${duration}`))
   },
-};
+}
 
 function print(...msg) {
   if (outputProcess) {
-    msg.unshift(outputProcess);
+    msg.unshift(outputProcess)
   }
   if (!newline) {
-    console.log();
-    newline = true;
+    console.log()
+    newline = true
   }
 
-  console.log.apply(this, msg);
+  console.log.apply(this, msg)
 }
 
 function truncate(msg, gap = 0) {
   if (msg.indexOf('\n') > 0 || outputLevel >= 3) {
-    return msg; // don't cut multi line steps or on verbose log level
+    return msg // don't cut multi line steps or on verbose log level
   }
-  const width = (process.stdout.columns || 200) - gap - 4;
+  const width = (process.stdout.columns || 200) - gap - 4
   if (msg.length > width) {
-    msg = msg.substr(0, width - 1) + figures.ellipsis;
+    msg = msg.substr(0, width - 1) + figures.ellipsis
   }
-  return msg;
+  return msg
 }
 
 function isMaskedData() {
-  return global.maskSensitiveData === true || false;
+  return global.maskSensitiveData === true || false
 }

package/lib/pause.js

@@ -2,7 +2,6 @@ const colors = require('chalk')
 const readline = require('readline')
 const ora = require('ora-classic')
 const debug = require('debug')('codeceptjs:pause')
-const Fuse = require('fuse.js')
 
 const container = require('./container')
 const history = require('./history')
@@ -11,7 +10,7 @@ const aiAssistant = require('./ai')
 const recorder = require('./recorder')
 const event = require('./event')
 const output = require('./output')
-const { methodsOfObject } = require('./utils')
+const { methodsOfObject, searchWithFusejs } = require('./utils')
 
 // npm install colors
 let rl
@@ -218,15 +217,12 @@ function completer(line) {
     return [completions, line]
   }
 
-  // Initialize Fuse with completions
-  const fuse = new Fuse(completions, {
+  // Search using Fuse.js
+  const searchResults = searchWithFusejs(completions, line, {
     threshold: 0.3,
     distance: 100,
     minMatchCharLength: 1,
   })
-
-  // Search using Fuse.js
-  const searchResults = fuse.search(line)
   const hits = searchResults.map(result => result.item)
 
   return [hits, line]

package/lib/plugin/heal.js

@@ -5,6 +5,7 @@ const event = require('../event')
 const output = require('../output')
 const heal = require('../heal')
 const store = require('../store')
+const container = require('../container')
 
 const defaultConfig = {
   healLimit: 2,
@@ -115,4 +116,33 @@ module.exports = function (config = {}) {
       i++
     }
   })
+
+  event.dispatcher.on(event.workers.result, ({ tests }) => {
+    const { print } = output
+
+    const healedTests = Object.values(tests)
+      .flat()
+      .filter(test => test.notes.some(note => note.type === 'heal'))
+    if (!healedTests.length) return
+
+    setTimeout(() => {
+      print('')
+      print('===================')
+      print(colors.bold.green('Self-Healing Report:'))
+
+      print('')
+      print('Suggested changes:')
+      print('')
+
+      healedTests.forEach(test => {
+        print(`${colors.bold.magenta(test.title)}`)
+        test.notes
+          .filter(note => note.type === 'heal')
+          .forEach(note => {
+            print(note.text)
+            print('')
+          })
+      })
+    }, 0)
+  })
 }

package/lib/plugin/stepTimeout.js

@@ -1,5 +1,5 @@
 const event = require('../event')
-const TIMEOUT_ORDER = require('../step').TIMEOUT_ORDER
+const { TIMEOUT_ORDER } = require('../step/timeout')
 
 const defaultConfig = {
   timeout: 150,

package/lib/recorder.js

@@ -179,7 +179,7 @@ module.exports = {
     }
     if (retry === undefined) retry = true
     if (!running && !force) {
-      return
+      return Promise.resolve()
     }
     tasks.push(taskName)
     debug(chalk.gray(`${currentQueue()} Queued | ${taskName}`))

package/lib/step/base.js

@@ -0,0 +1,180 @@
+const color = require('chalk')
+const Secret = require('../secret')
+const { getCurrentTimeout } = require('./timeout')
+const { ucfirst, humanizeString } = require('../utils')
+
+const STACK_LINE = 4
+
+/**
+ * Each command in test executed through `I.` object is wrapped in Step.
+ * Step allows logging executed commands and triggers hook before and after step execution.
+ * @param {string} name
+ */
+class Step {
+  constructor(name) {
+    /** @member {string} */
+    this.name = name
+    /** @member {Map<number, number>} */
+    this.timeouts = new Map()
+
+    /** @member {Array<*>} */
+    this.args = []
+
+    /** @member {Record<string,any>} */
+    this.opts = {}
+    /** @member {string} */
+    this.actor = 'I' // I = actor
+    /** @member {string} */
+    this.helperMethod = name // helper method
+    /** @member {string} */
+    this.status = 'pending'
+    /** @member {string} */
+    this.prefix = this.suffix = ''
+    /** @member {string} */
+    this.comment = ''
+    /** @member {any} */
+    this.metaStep = undefined
+    /** @member {string} */
+    this.stack = ''
+
+    this.setTrace()
+  }
+
+  setMetaStep(metaStep) {
+    this.metaStep = metaStep
+  }
+
+  run() {
+    throw new Error('Not implemented')
+  }
+
+  /**
+   * @returns {number|undefined}
+   */
+  get timeout() {
+    return getCurrentTimeout(this.timeouts)
+  }
+
+  /**
+   * @param {number} timeout - timeout in milliseconds or 0 if no timeout
+   * @param {number} order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
+   *                         When order below 0 value of timeout only override if new value is lower
+   */
+  setTimeout(timeout, order) {
+    this.timeouts.set(order, timeout)
+  }
+
+  /** @function */
+  setTrace() {
+    Error.captureStackTrace(this)
+  }
+
+  /** @param {Array<*>} args */
+  setArguments(args) {
+    this.args = args
+  }
+
+  setActor(actor) {
+    this.actor = actor || ''
+  }
+
+  /** @param {string} status */
+  setStatus(status) {
+    this.status = status
+    if (this.metaStep) {
+      this.metaStep.setStatus(status)
+    }
+  }
+
+  /** @return {string} */
+  humanize() {
+    return humanizeString(this.name)
+  }
+
+  /** @return {string} */
+  humanizeArgs() {
+    return this.args
+      .map(arg => {
+        if (!arg) {
+          return ''
+        }
+        if (typeof arg === 'string') {
+          return `"${arg}"`
+        }
+        if (Array.isArray(arg)) {
+          try {
+            const res = JSON.stringify(arg)
+            return res
+          } catch (err) {
+            return `[${arg.toString()}]`
+          }
+        } else if (typeof arg === 'function') {
+          return arg.toString()
+        } else if (typeof arg === 'undefined') {
+          return `${arg}`
+        } else if (arg instanceof Secret) {
+          return arg.getMasked()
+        } else if (arg.toString && arg.toString() !== '[object Object]') {
+          return arg.toString()
+        } else if (typeof arg === 'object') {
+          const returnedArg = {}
+          for (const [key, value] of Object.entries(arg)) {
+            returnedArg[key] = value
+            if (value instanceof Secret) returnedArg[key] = value.getMasked()
+          }
+          return JSON.stringify(returnedArg)
+        }
+        return arg
+      })
+      .join(', ')
+  }
+
+  /** @return {string} */
+  line() {
+    const lines = this.stack.split('\n')
+    if (lines[STACK_LINE]) {
+      return lines[STACK_LINE].trim()
+        .replace(global.codecept_dir || '', '.')
+        .trim()
+    }
+    return ''
+  }
+
+  /** @return {string} */
+  toString() {
+    return ucfirst(`${this.prefix}${this.actor} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`).trim()
+  }
+
+  /** @return {string} */
+  toCliStyled() {
+    return `${this.prefix}${this.actor} ${color.italic(this.humanize())} ${color.yellow(this.humanizeArgs())}${this.suffix}`
+  }
+
+  /** @return {string} */
+  toCode() {
+    return `${this.prefix}${this.actor}.${this.name}(${this.humanizeArgs()})${this.suffix}`
+  }
+
+  isMetaStep() {
+    return this.constructor.name === 'MetaStep'
+  }
+
+  /** @return {boolean} */
+  hasBDDAncestor() {
+    let hasBDD = false
+    let processingStep
+    processingStep = this
+
+    while (processingStep.metaStep) {
+      if (processingStep.metaStep.actor.match(/^(Given|When|Then|And)/)) {
+        hasBDD = true
+        break
+      } else {
+        processingStep = processingStep.metaStep
+      }
+    }
+    return hasBDD
+  }
+}
+
+module.exports = Step

package/lib/step/config.js

@@ -0,0 +1,50 @@
+/**
+ * StepConfig is a configuration object for a step.
+ * It is used to create a new step that is a combination of other steps.
+ */
+class StepConfig {
+  constructor(opts = {}) {
+    /** @member {{ opts: Record<string, any>, timeout: number|undefined, retry: number|undefined }} */
+    this.config = {
+      opts,
+      timeout: undefined,
+      retry: undefined,
+    }
+  }
+
+  /**
+   * Set the options for the step.
+   * @param {object} opts - The options for the step.
+   * @returns {StepConfig} - The step configuration object.
+   */
+  opts(opts) {
+    this.config.opts = opts
+    return this
+  }
+
+  /**
+   * Set the timeout for the step.
+   * @param {number} timeout - The timeout for the step.
+   * @returns {StepConfig} - The step configuration object.
+   */
+  timeout(timeout) {
+    this.config.timeout = timeout
+    return this
+  }
+
+  /**
+   * Set the retry for the step.
+   * @param {number} retry - The retry for the step.
+   * @returns {StepConfig} - The step configuration object.
+   */
+  retry(retry) {
+    this.config.retry = retry
+    return this
+  }
+
+  getConfig() {
+    return this.config
+  }
+}
+
+module.exports = StepConfig

package/lib/step/helper.js

@@ -0,0 +1,47 @@
+const Step = require('./base')
+const store = require('../store')
+
+class HelperStep extends Step {
+  constructor(helper, name) {
+    super(name)
+    /** @member {CodeceptJS.Helper} helper corresponding helper */
+    this.helper = helper
+    /** @member {string} helperMethod name of method to be executed */
+    this.helperMethod = name
+  }
+
+  /**
+   * @param {...any} args
+   * @return {*}
+   */
+  run() {
+    this.args = Array.prototype.slice.call(arguments)
+
+    if (store.dryRun) {
+      this.setStatus('success')
+      return Promise.resolve(new Proxy({}, dryRunResolver()))
+    }
+    let result
+    try {
+      if (this.helperMethod !== 'say') {
+        result = this.helper[this.helperMethod].apply(this.helper, this.args)
+      }
+      this.setStatus('success')
+    } catch (err) {
+      this.setStatus('failed')
+      throw err
+    }
+    return result
+  }
+}
+
+module.exports = HelperStep
+
+function dryRunResolver() {
+  return {
+    get(target, prop) {
+      if (prop === 'toString') return () => '<VALUE>'
+      return new Proxy({}, dryRunResolver())
+    },
+  }
+}