codeceptjs 4.0.0-beta.4 → 4.0.0-beta.5

package/lib/listener/steps.js

@@ -2,47 +2,55 @@ const debug = require('debug')('codeceptjs:steps')
 const event = require('../event')
 const store = require('../store')
 const output = require('../output')
+const { BeforeHook, AfterHook, BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
+const recorder = require('../recorder')
 
 let currentTest
 let currentHook
 
+// Session names that should not contribute steps to the main test trace
+const EXCLUDED_SESSIONS = ['tryTo', 'hopeThat']
+
 /**
  * Register steps inside tests
  */
 module.exports = function () {
-  event.dispatcher.on(event.test.before, (test) => {
+  event.dispatcher.on(event.test.before, test => {
     test.startedAt = +new Date()
-    test.artifacts = {}
   })
 
-  event.dispatcher.on(event.test.started, (test) => {
+  event.dispatcher.on(event.test.started, test => {
     currentTest = test
     currentTest.steps = []
     if (!('retryNum' in currentTest)) currentTest.retryNum = 0
     else currentTest.retryNum += 1
+    output.scenario.started(test)
   })
 
-  event.dispatcher.on(event.test.after, (test) => {
+  event.dispatcher.on(event.test.after, test => {
     currentTest = null
   })
 
-  event.dispatcher.on(event.test.finished, (test) => {})
+  event.dispatcher.on(event.test.finished, test => {})
 
-  event.dispatcher.on(event.hook.started, (suite) => {
-    currentHook = suite.ctx.test
+  event.dispatcher.on(event.hook.started, hook => {
+    currentHook = hook.ctx.test
     currentHook.steps = []
 
-    if (suite.ctx && suite.ctx.test) output.log(`--- STARTED ${suite.ctx.test.title} ---`)
+    output.hook.started(hook)
+
+    if (hook.ctx && hook.ctx.test) debug(`--- STARTED ${hook.ctx.test.title} ---`)
   })
 
-  event.dispatcher.on(event.hook.passed, (suite) => {
+  event.dispatcher.on(event.hook.passed, hook => {
     currentHook = null
-    if (suite.ctx && suite.ctx.test) output.log(`--- ENDED ${suite.ctx.test.title} ---`)
+    output.hook.passed(hook)
+    if (hook.ctx && hook.ctx.test) debug(`--- ENDED ${hook.ctx.test.title} ---`)
   })
 
   event.dispatcher.on(event.test.failed, () => {
     const cutSteps = function (current) {
-      const failureIndex = current.steps.findIndex((el) => el.status === 'failed')
+      const failureIndex = current.steps.findIndex(el => el.status === 'failed')
       // To be sure that failed test will be failed in report
       current.state = 'failed'
       current.steps.length = failureIndex + 1
@@ -65,19 +73,25 @@ module.exports = function () {
     currentTest.state = 'passed'
   })
 
-  event.dispatcher.on(event.step.started, (step) => {
-    step.startedAt = +new Date()
-    step.test = currentTest
+  event.dispatcher.on(event.step.started, step => {
+    store.currentStep = step
     if (currentHook && Array.isArray(currentHook.steps)) {
       return currentHook.steps.push(step)
     }
     if (!currentTest || !currentTest.steps) return
+    
+    // Check if we're in a session that should be excluded from main test steps
+    const currentSessionId = recorder.getCurrentSessionId()
+    if (currentSessionId && EXCLUDED_SESSIONS.includes(currentSessionId)) {
+      // Skip adding this step to the main test steps
+      return
+    }
+    
     currentTest.steps.push(step)
   })
 
-  event.dispatcher.on(event.step.finished, (step) => {
-    step.finishedAt = +new Date()
-    if (step.startedAt) step.duration = step.finishedAt - step.startedAt
-    debug(`Step '${step}' finished; Duration: ${step.duration || 0}ms`)
+  event.dispatcher.on(event.step.finished, step => {
+    store.currentStep = null
+    store.stepOptions = null
   })
 }

package/lib/listener/store.js

@@ -0,0 +1,20 @@
+const event = require('../event')
+const store = require('../store')
+
+module.exports = function () {
+  event.dispatcher.on(event.suite.before, suite => {
+    store.currentSuite = suite
+  })
+
+  event.dispatcher.on(event.suite.after, () => {
+    store.currentSuite = null
+  })
+
+  event.dispatcher.on(event.test.before, test => {
+    store.currentTest = test
+  })
+
+  event.dispatcher.on(event.test.finished, () => {
+    store.currentTest = null
+  })
+}

package/lib/mocha/asyncWrapper.js

@@ -0,0 +1,231 @@
+const promiseRetry = require('promise-retry')
+const event = require('../event')
+const recorder = require('../recorder')
+const assertThrown = require('../assert/throws')
+const { ucfirst, isAsyncFunction } = require('../utils')
+const { getInjectedArguments } = require('./inject')
+const { fireHook } = require('./hooks')
+
+const injectHook = function (inject, suite) {
+  try {
+    inject()
+  } catch (err) {
+    recorder.throw(err)
+  }
+  recorder.catch(err => {
+    suiteTestFailedHookError(suite, err)
+    throw err
+  })
+  return recorder.promise()
+}
+
+function suiteTestFailedHookError(suite, err, hookName) {
+  suite.eachTest(test => {
+    test.err = err
+    if (hookName) hookName = ucfirst(hookName)
+    event.emit(event.test.failed, test, err, hookName)
+  })
+}
+
+function makeDoneCallableOnce(done) {
+  let called = false
+  return function (err) {
+    if (called) {
+      return
+    }
+    called = true
+    return done(err)
+  }
+}
+
+/**
+ * Wraps test function, injects support objects from container,
+ * starts promise chain with recorder, performs before/after hooks
+ * through event system.
+ */
+module.exports.test = test => {
+  const testFn = test.fn
+  if (!testFn) {
+    return test
+  }
+
+  test.timeout(0)
+  test.async = true
+
+  test.fn = function (done) {
+    const doneFn = makeDoneCallableOnce(done)
+    recorder.errHandler(err => {
+      recorder.session.start('teardown')
+      recorder.cleanAsyncErr()
+      if (test.throws) {
+        // check that test should actually fail
+        try {
+          assertThrown(err, test.throws)
+          event.emit(event.test.passed, test)
+          event.emit(event.test.finished, test)
+          recorder.add(doneFn)
+          return
+        } catch (newErr) {
+          err = newErr
+        }
+      }
+      test.err = err
+      event.emit(event.test.failed, test, err)
+      event.emit(event.test.finished, test)
+      recorder.add(() => doneFn(err))
+    })
+
+    if (isAsyncFunction(testFn)) {
+      event.emit(event.test.started, test)
+      testFn
+        .call(test, getInjectedArguments(testFn, test))
+        .then(() => {
+          recorder.add('fire test.passed', () => {
+            event.emit(event.test.passed, test)
+            event.emit(event.test.finished, test)
+          })
+          recorder.add('finish test', doneFn)
+        })
+        .catch(err => {
+          recorder.throw(err)
+        })
+        .finally(() => {
+          recorder.catch()
+        })
+      return
+    }
+
+    try {
+      event.emit(event.test.started, test)
+      testFn.call(test, getInjectedArguments(testFn, test))
+    } catch (err) {
+      recorder.throw(err)
+    } finally {
+      recorder.add('fire test.passed', () => {
+        event.emit(event.test.passed, test)
+        event.emit(event.test.finished, test)
+      })
+      recorder.add('finish test', doneFn)
+      recorder.catch()
+    }
+  }
+  return test
+}
+
+/**
+ * Injects arguments to function from controller
+ */
+module.exports.injected = function (fn, suite, hookName) {
+  return function (done) {
+    const doneFn = makeDoneCallableOnce(done)
+    const errHandler = err => {
+      recorder.session.start('teardown')
+      recorder.cleanAsyncErr()
+      if (['before', 'beforeSuite'].includes(hookName)) {
+        suiteTestFailedHookError(suite, err, hookName)
+      }
+      if (hookName === 'after') {
+        suiteTestFailedHookError(suite, err, hookName)
+        suite.eachTest(test => {
+          event.emit(event.test.after, test)
+        })
+      }
+      if (hookName === 'afterSuite') {
+        suiteTestFailedHookError(suite, err, hookName)
+        event.emit(event.suite.after, suite)
+      }
+      recorder.add(() => doneFn(err))
+    }
+
+    recorder.errHandler(err => {
+      errHandler(err)
+    })
+
+    if (!fn) throw new Error('fn is not defined')
+
+    fireHook(event.hook.started, suite)
+
+    this.test.body = fn.toString()
+
+    if (!recorder.isRunning()) {
+      recorder.errHandler(err => {
+        errHandler(err)
+      })
+    }
+
+    const opts = suite.opts || {}
+    const retries = opts[`retry${ucfirst(hookName)}`] || 0
+
+    const currentTest = hookName === 'before' || hookName === 'after' ? suite?.ctx?.currentTest : null
+
+    promiseRetry(
+      async (retry, number) => {
+        try {
+          recorder.startUnlessRunning()
+          await fn.call(this, { ...getInjectedArguments(fn), suite, test: currentTest })
+          await recorder.promise().catch(err => retry(err))
+        } catch (err) {
+          retry(err)
+        } finally {
+          if (number < retries) {
+            recorder.stop()
+            recorder.start()
+          }
+        }
+      },
+      { retries },
+    )
+      .then(() => {
+        recorder.add('fire hook.passed', () => fireHook(event.hook.passed, suite))
+        recorder.add('fire hook.finished', () => fireHook(event.hook.finished, suite))
+        recorder.add(`finish ${hookName} hook`, doneFn)
+        recorder.catch()
+      })
+      .catch(e => {
+        recorder.throw(e)
+        recorder.catch(e => {
+          const err = recorder.getAsyncErr() === null ? e : recorder.getAsyncErr()
+          errHandler(err)
+        })
+        recorder.add('fire hook.failed', () => fireHook(event.hook.failed, suite, e))
+        recorder.add('fire hook.finished', () => fireHook(event.hook.finished, suite))
+      })
+  }
+}
+
+/**
+ * Starts promise chain, so helpers could enqueue their hooks
+ */
+module.exports.setup = function (suite) {
+  const { enhanceMochaTest } = require('./test')
+  return injectHook(() => {
+    recorder.startUnlessRunning()
+    event.emit(event.test.before, enhanceMochaTest(suite?.ctx?.currentTest))
+  }, suite)
+}
+
+module.exports.teardown = function (suite) {
+  const { enhanceMochaTest } = require('./test')
+  return injectHook(() => {
+    recorder.startUnlessRunning()
+    event.emit(event.test.after, enhanceMochaTest(suite?.ctx?.currentTest))
+  }, suite)
+}
+
+module.exports.suiteSetup = function (suite) {
+  const { enhanceMochaSuite } = require('./suite')
+  return injectHook(() => {
+    recorder.startUnlessRunning()
+    event.emit(event.suite.before, enhanceMochaSuite(suite))
+  }, suite)
+}
+
+module.exports.suiteTeardown = function (suite) {
+  const { enhanceMochaSuite } = require('./suite')
+  return injectHook(() => {
+    recorder.startUnlessRunning()
+    event.emit(event.suite.after, enhanceMochaSuite(suite))
+  }, suite)
+}
+
+module.exports.getInjectedArguments = getInjectedArguments

package/lib/{interfaces → mocha}/bdd.js

@@ -27,7 +27,7 @@ const addStep = (step, fn) => {
 
 const parameterTypeRegistry = new ParameterTypeRegistry()
 
-const matchStep = (step) => {
+const matchStep = step => {
   for (const stepName in steps) {
     if (stepName.indexOf('/') === 0) {
       const regExpArr = stepName.match(/^\/(.*?)\/([gimy]*)$/) || []
@@ -43,7 +43,7 @@ const matchStep = (step) => {
     const res = expression.match(step)
     if (res) {
       const fn = steps[stepName]
-      fn.params = res.map((arg) => arg.getValue())
+      fn.params = res.map(arg => arg.getValue())
       return fn
     }
   }
@@ -58,7 +58,7 @@ const getSteps = () => {
   return steps
 }
 
-const defineParameterType = (options) => {
+const defineParameterType = options => {
   const parameterType = buildParameterType(options)
   parameterTypeRegistry.defineParameterType(parameterType)
 }

package/lib/mocha/cli.js

@@ -0,0 +1,308 @@
+const {
+  reporters: { Base },
+} = require('mocha')
+const ms = require('ms')
+const figures = require('figures')
+const event = require('../event')
+const AssertionFailedError = require('../assert/error')
+const output = require('../output')
+const { cloneTest } = require('./test')
+const cursor = Base.cursor
+let currentMetaStep = []
+let codeceptjsEventDispatchersRegistered = false
+
+class Cli extends Base {
+  constructor(runner, opts) {
+    super(runner)
+    let level = 0
+    this.loadedTests = []
+    opts = opts.reporterOptions || opts
+    if (opts.steps) level = 1
+    if (opts.debug) level = 2
+    if (opts.verbose) level = 3
+    output.level(level)
+    output.print(`CodeceptJS v${require('../codecept').version()} ${output.standWithUkraine()}`)
+    output.print(`Using test root "${global.codecept_dir}"`)
+
+    const showSteps = level >= 1
+
+    if (level >= 2) {
+      const Containter = require('../container')
+      output.print(output.styles.debug(`Helpers: ${Object.keys(Containter.helpers()).join(', ')}`))
+      output.print(output.styles.debug(`Plugins: ${Object.keys(Containter.plugins()).join(', ')}`))
+    }
+
+    if (level >= 3) {
+      process.on('warning', warning => {
+        console.log('\nWarning Details:')
+        console.log('Name:', warning.name)
+        console.log('Message:', warning.message)
+        console.log('Stack:', warning.stack)
+        console.log('-------------------')
+      })
+    }
+
+    runner.on('start', () => {
+      console.log()
+    })
+
+    runner.on('suite', suite => {
+      output.suite.started(suite)
+    })
+
+    runner.on('fail', test => {
+      if (test.ctx.currentTest) {
+        this.loadedTests.push(test.ctx.currentTest.uid)
+      }
+      if (showSteps && test.steps) {
+        return output.scenario.failed(test)
+      }
+      cursor.CR()
+      output.test.failed(test)
+    })
+
+    runner.on('pending', test => {
+      if (test.parent && test.parent.pending) {
+        const suite = test.parent
+        const skipInfo = suite.opts.skipInfo || {}
+        skipTestConfig(test, skipInfo.message)
+      } else {
+        skipTestConfig(test, null)
+      }
+      this.loadedTests.push(test.uid)
+      cursor.CR()
+      output.test.skipped(test)
+    })
+
+    runner.on('pass', test => {
+      if (showSteps && test.steps) {
+        return output.scenario.passed(test)
+      }
+      cursor.CR()
+      output.test.passed(test)
+    })
+
+    if (showSteps) {
+      runner.on('test', test => {
+        currentMetaStep = []
+        if (test.steps) {
+          output.test.started(test)
+        }
+      })
+
+      if (!codeceptjsEventDispatchersRegistered) {
+        codeceptjsEventDispatchersRegistered = true
+
+        event.dispatcher.on(event.bddStep.started, step => {
+          output.stepShift = 2
+          output.step(step)
+        })
+
+        event.dispatcher.on(event.step.started, step => {
+          let processingStep = step
+          const metaSteps = []
+          let isHidden = false
+          while (processingStep.metaStep) {
+            metaSteps.unshift(processingStep.metaStep)
+            processingStep = processingStep.metaStep
+            if (processingStep.collapsed) isHidden = true
+          }
+          const shift = metaSteps.length
+
+          for (let i = 0; i < Math.max(currentMetaStep.length, metaSteps.length); i++) {
+            if (currentMetaStep[i] !== metaSteps[i]) {
+              output.stepShift = 3 + 2 * i
+              if (!metaSteps[i]) continue
+              // bdd steps are handled by bddStep.started
+              if (metaSteps[i].isBDD()) continue
+              output.step(metaSteps[i])
+            }
+          }
+          currentMetaStep = metaSteps
+          if (isHidden) return
+          output.stepShift = 3 + 2 * shift
+          output.step(step)
+        })
+
+        event.dispatcher.on(event.step.finished, () => {
+          output.stepShift = 0
+        })
+      }
+    }
+
+    runner.on('suite end', suite => {
+      let skippedCount = 0
+      const grep = runner._grep
+      for (const test of suite.tests) {
+        if (!test.state && !this.loadedTests.includes(test.uid)) {
+          if (matchTest(grep, test.title)) {
+            if (!test.opts) {
+              test.opts = {}
+            }
+            if (!test.opts.skipInfo) {
+              test.opts.skipInfo = {}
+            }
+            skipTestConfig(test, "Skipped due to failure in 'before' hook")
+            output.test.skipped(test)
+            skippedCount += 1
+          }
+        }
+      }
+
+      const container = require('../container')
+      container.result().addStats({ pending: skippedCount, tests: skippedCount })
+    })
+
+    runner.on('end', this.result.bind(this))
+  }
+
+  result() {
+    const container = require('../container')
+    container.result().addStats(this.stats)
+    container.result().finish()
+
+    const stats = container.result().stats
+    console.log()
+
+    // passes
+    if (stats.failures) {
+      output.print(output.styles.bold('-- FAILURES:'))
+    }
+
+    const failuresLog = []
+
+    // failures
+    if (stats.failures) {
+      // append step traces
+      this.failures = this.failures.map(test => {
+        // we will change the stack trace, so we need to clone the test
+        const err = test.err
+
+        let log = ''
+        let originalMessage = err.message
+
+        if (err instanceof AssertionFailedError) {
+          err.message = err.inspect()
+        }
+
+        // multi-line error messages (for Playwright)
+        if (err.message && err.message.includes('\n')) {
+          const lines = err.message.split('\n')
+          const truncatedLines = lines.slice(0, 5)
+          if (lines.length > 5) {
+            truncatedLines.push('...')
+          }
+          err.message = truncatedLines.join('\n').replace(/^/gm, '  ').trim()
+        }
+
+        // add new line before the message
+        err.message = '\n  ' + err.message
+
+        // explicitly show file with error
+        if (test.file) {
+          log += `\n${output.styles.basic(figures.circle)} ${output.styles.section('File:')} file://${test.file}\n`
+        }
+
+        const steps = test.steps || (test.ctx && test.ctx.test.steps)
+
+        if (steps && steps.length) {
+          let scenarioTrace = ''
+          steps
+            .reverse()
+            .slice(0, 10)
+            .forEach(step => {
+              const hasFailed = step.status === 'failed'
+              let line = `${hasFailed ? output.styles.bold(figures.cross) : figures.tick} ${step.toCode()} ${step.line()}`
+              if (hasFailed) line = output.styles.bold(line)
+              scenarioTrace += `\n${line}`
+            })
+          log += `\n${output.styles.basic(figures.circle)} ${output.styles.section('Scenario Steps')}:${scenarioTrace}\n`
+        }
+
+        // display artifacts in debug mode
+        if (test?.artifacts && Object.keys(test.artifacts).length) {
+          log += `\n${output.styles.basic(figures.circle)} ${output.styles.section('Artifacts:')}`
+          for (const artifact of Object.keys(test.artifacts)) {
+            log += `\n- ${artifact}: ${test.artifacts[artifact]}`
+          }
+        }
+
+        // display metadata
+        if (test.meta && Object.keys(test.meta).length) {
+          log += `\n\n${output.styles.basic(figures.circle)} ${output.styles.section('Metadata:')}`
+          for (const [key, value] of Object.entries(test.meta)) {
+            log += `\n- ${key}: ${value}`
+          }
+        }
+
+        try {
+          let stack = err.stack
+          stack = (stack || '').replace(originalMessage, '')
+          stack = stack ? stack.split('\n') : []
+
+          if (stack[0] && stack[0].includes(err.message)) {
+            stack.shift()
+          }
+
+          if (stack[0] && stack[0].trim() == 'Error:') {
+            stack.shift()
+          }
+
+          if (output.level() < 3) {
+            stack = stack.slice(0, 3)
+          }
+
+          err.stack = `${stack.join('\n')}\n\n${output.colors.blue(log)}`
+        } catch (e) {
+          console.error(e)
+        }
+
+        // we will change the stack trace, so we need to clone the test
+        test = cloneTest(test)
+        test.err = err
+        return test
+      })
+
+      const originalLog = Base.consoleLog
+      Base.consoleLog = (...data) => {
+        failuresLog.push([...data])
+        originalLog(...data)
+      }
+      Base.list(this.failures)
+      Base.consoleLog = originalLog
+      console.log()
+    }
+
+    container.result().addFailures(failuresLog)
+
+    output.result(stats.passes, stats.failures, stats.pending, ms(stats.duration), stats.failedHooks)
+
+    if (stats.failures && output.level() < 3) {
+      output.print(output.styles.debug('Run with --verbose flag to see complete NodeJS stacktrace'))
+    }
+  }
+}
+
+function matchTest(grep, test) {
+  if (grep) {
+    return grep.test(test)
+  }
+  return true
+}
+
+function skipTestConfig(test, message) {
+  if (!test.opts) {
+    test.opts = {}
+  }
+  if (!test.opts.skipInfo) {
+    test.opts.skipInfo = {}
+  }
+  test.opts.skipInfo.message = test.opts.skipInfo.message || message
+  test.opts.skipInfo.isFastSkipped = true
+  event.emit(event.test.skipped, test)
+  test.state = 'skipped'
+}
+
+module.exports = function (runner, opts) {
+  return new Cli(runner, opts)
+}