codeceptjs/lib/mocha/featureConfig.js

Supercharged End 2 End Testing Framework for NodeJS

/**
 * Configuration for a Feature.
 * Can inject values and add custom configuration.
 */
class FeatureConfig {
  /**
   * @param {CodeceptJS.Suite} suite
   */
  constructor(suite) {
    this.suite = suite
  }

  /**
   * Set metadata for this suite
   * @param {string} key
   * @param {string} value
   * @returns {this}
   */
  meta(key, value) {
    this.suite.tests.forEach(test => {
      test.meta[key] = value
    })
    return this
  }

  /**
   * Retry this test for number of times
   *
   * @param {number} retries
   * @returns {this}
   */
  retry(retries) {
    this.suite.retries(retries)
    return this
  }

  /**
   * Set timeout for this test
   * @param {number} timeout
   * @returns {this}
   */
  timeout(timeout) {
    this.suite.timeout(timeout)
    return this
  }

  /**
   * @callback FeatureConfigCallback
   * @param {CodeceptJS.Suite} suite
   * @returns {Object<string, any>}
   */

  /**
   * Configures a helper.
   * Helper name can be omitted and values will be applied to first helper.
   * @param {string | Object<string, any> | FeatureConfigCallback} helper
   * @param {Object<string, any>} [obj]
   * @returns {this}
   */
  config(helper, obj) {
    if (!obj) {
      obj = helper
      helper = 0
    }
    if (typeof obj === 'function') {
      obj = obj(this.suite)
    }
    if (!this.suite.config) {
      this.suite.config = {}
    }
    this.suite.config[helper] = obj
    return this
  }

  /**
   * Append a tag name to scenario title
   * @param {string} tagName
   * @returns {this}
   */
  tag(tagName) {
    if (tagName[0] !== '@') tagName = `@${tagName}`
    if (!this.suite.tags) this.suite.tags = []
    this.suite.tags.push(tagName)
    this.suite.title = `${this.suite.title.trim()} ${tagName}`
    return this
  }
}

module.exports = FeatureConfig