codeceptjs 3.7.0-beta.4 → 3.7.0-beta.6

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())
+    },
+  }
+}

package/lib/step/meta.js

@@ -0,0 +1,91 @@
+const Step = require('./base')
+const event = require('../event')
+const { humanizeString } = require('../utils')
+
+class MetaStep extends Step {
+  constructor(actor, method) {
+    if (!method) method = ''
+    super(method)
+    this.actor = actor
+  }
+
+  /** @return {boolean} */
+  isBDD() {
+    if (this.actor && this.actor.match && this.actor.match(/^(Given|When|Then|And)/)) {
+      return true
+    }
+    return false
+  }
+
+  toCliStyled() {
+    return this.toString()
+  }
+
+  toString() {
+    const actorText = this.actor
+
+    if (this.isBDD()) {
+      return `${this.prefix}${actorText} ${this.name} "${this.humanizeArgs()}${this.suffix}"`
+    }
+
+    if (actorText === 'I') {
+      return `${this.prefix}${actorText} ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`
+    }
+
+    return `On ${this.prefix}${actorText}: ${this.humanize()} ${this.humanizeArgs()}${this.suffix}`
+  }
+
+  humanize() {
+    return humanizeString(this.name)
+  }
+
+  setTrace() {}
+
+  setContext(context) {
+    this.context = context
+  }
+
+  /** @return {*} */
+  run(fn) {
+    this.status = 'queued'
+    this.setArguments(Array.from(arguments).slice(1))
+    let result
+
+    const registerStep = step => {
+      this.setMetaStep(null)
+      step.setMetaStep(this)
+    }
+    event.dispatcher.prependListener(event.step.before, registerStep)
+    // Handle async and sync methods.
+    if (fn.constructor.name === 'AsyncFunction') {
+      result = fn
+        .apply(this.context, this.args)
+        .then(result => {
+          return result
+        })
+        .catch(error => {
+          this.setStatus('failed')
+          throw error
+        })
+        .finally(() => {
+          this.endTime = Date.now()
+          event.dispatcher.removeListener(event.step.before, registerStep)
+        })
+    } else {
+      try {
+        this.startTime = Date.now()
+        result = fn.apply(this.context, this.args)
+      } catch (error) {
+        this.setStatus('failed')
+        throw error
+      } finally {
+        this.endTime = Date.now()
+        event.dispatcher.removeListener(event.step.before, registerStep)
+      }
+    }
+
+    return result
+  }
+}
+
+module.exports = MetaStep

package/lib/step/record.js

@@ -0,0 +1,74 @@
+const event = require('../event')
+const recorder = require('../recorder')
+const StepConfig = require('./config')
+const { debug } = require('../output')
+const store = require('../store')
+const { TIMEOUT_ORDER } = require('./timeout')
+const retryStep = require('./retry')
+function recordStep(step, args) {
+  step.status = 'queued'
+
+  // apply step configuration
+  const lastArg = args[args.length - 1]
+  if (lastArg instanceof StepConfig) {
+    const stepConfig = args.pop()
+    const { opts, timeout, retry } = stepConfig.getConfig()
+
+    if (opts) {
+      debug(`Step ${step.name}: options applied ${JSON.stringify(opts)}`)
+      store.stepOptions = opts
+      step.opts = opts
+    }
+    if (timeout) {
+      debug(`Step ${step.name} timeout ${timeout}s`)
+      step.setTimeout(timeout * 1000, TIMEOUT_ORDER.codeLimitTime)
+    }
+    if (retry) retryStep(retry)
+  }
+
+  step.setArguments(args)
+  // run async before step hooks
+  event.emit(event.step.before, step)
+
+  const task = `${step.name}: ${step.humanizeArgs()}`
+  let val
+
+  // run step inside promise
+  recorder.add(
+    task,
+    () => {
+      if (!step.startTime) {
+        // step can be retries
+        event.emit(event.step.started, step)
+        step.startTime = Date.now()
+      }
+      return (val = step.run(...args))
+    },
+    false,
+    undefined,
+    step.timeout,
+  )
+
+  event.emit(event.step.after, step)
+
+  recorder.add('step passed', () => {
+    step.endTime = Date.now()
+    event.emit(event.step.passed, step, val)
+    event.emit(event.step.finished, step)
+  })
+
+  recorder.catchWithoutStop(err => {
+    step.status = 'failed'
+    step.endTime = Date.now()
+    event.emit(event.step.failed, step)
+    event.emit(event.step.finished, step)
+    throw err
+  })
+
+  recorder.add('return result', () => val)
+  // run async after step hooks
+
+  return recorder.promise()
+}
+
+module.exports = recordStep

package/lib/step/retry.js

@@ -0,0 +1,11 @@
+const recorder = require('../recorder')
+const event = require('../event')
+
+function retryStep(opts) {
+  if (opts === undefined) opts = 1
+  recorder.retry(opts)
+  // remove retry once the step passed
+  recorder.add(() => event.dispatcher.once(event.step.finished, () => recorder.retries.pop()))
+}
+
+module.exports = retryStep

package/lib/step/timeout.js

@@ -0,0 +1,42 @@
+const TIMEOUT_ORDER = {
+  /**
+   * timeouts set with order below zero only override timeouts of higher order if their value is smaller
+   */
+  testOrSuite: -5,
+  /**
+   * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
+   */
+  stepTimeoutHard: 5,
+  /**
+   * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+   */
+  codeLimitTime: 15,
+  /**
+   * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+   */
+  stepTimeoutSoft: 25,
+}
+
+function getCurrentTimeout(timeouts) {
+  let totalTimeout
+  // iterate over all timeouts starting from highest values of order
+  new Map([...timeouts.entries()].sort().reverse()).forEach((timeout, order) => {
+    if (
+      timeout !== undefined &&
+      // when orders >= 0 - timeout value overrides those set with higher order elements
+      (order >= 0 ||
+        // when `order < 0 && totalTimeout === undefined` - timeout is used when nothing is set by elements with higher order
+        totalTimeout === undefined ||
+        // when `order < 0` - timeout overrides higher values of timeout or 'no timeout' (totalTimeout === 0) set by elements with higher order
+        (timeout > 0 && (timeout < totalTimeout || totalTimeout === 0)))
+    ) {
+      totalTimeout = timeout
+    }
+  })
+  return totalTimeout
+}
+
+module.exports = {
+  TIMEOUT_ORDER,
+  getCurrentTimeout,
+}