codeceptjs/lib/plugin/pauseOnFail.js

Supercharged End 2 End Testing Framework for NodeJS

const event = require('../event')
const pause = require('../pause')

/**
 * Automatically launches [interactive pause](/basics/#pause) when a test fails.
 *
 * Useful for debugging flaky tests on local environment.
 * Add this plugin to config file:
 *
 * ```js
 * plugins: {
 *   pauseOnFail: {},
 * }
 * ```
 *
 * Unlike other plugins, `pauseOnFail` is not recommended to be enabled by default.
 * Enable it manually on each run via `-p` option:
 *
 * ```
 * npx codeceptjs run -p pauseOnFail
 * ```
 *
 */
module.exports = () => {
  let failed = false

  event.dispatcher.on(event.test.started, () => {
    failed = false
  })

  event.dispatcher.on(event.step.failed, () => {
    failed = true
  })

  event.dispatcher.on(event.test.after, () => {
    if (failed) pause()
  })
}