@kronoslive/codeceptjs/lib/data/dataScenarioConfig.js

Supercharged End 2 End Testing Framework for NodeJS

class DataScenarioConfig {
  constructor(scenarios) {
    this.scenarios = scenarios;
  }

  /**
     * Declares that test throws error.
     * Can pass an Error object or regex matching expected message.
     *
     * @param {*} err
     */
  throws(err) {
    this.scenarios.forEach(scenario => scenario.throws(err));
    return this;
  }

  /**
     * Declares that test should fail.
     * If test passes - throws an error.
     * Can pass an Error object or regex matching expected message.
     *
     */
  fails() {
    this.scenarios.forEach(scenario => scenario.fails());
    return this;
  }

  /**
     * Retry this test for x times
     *
     * @param {*} retries
     */
  retry(retries) {
    this.scenarios.forEach(scenario => scenario.retry(retries));
    return this;
  }

  /**
     * Set timeout for this test
     * @param {*} timeout
     */
  timeout(timeout) {
    this.scenarios.forEach(scenario => scenario.timeout(timeout));
    return this;
  }

  /**
     * Configures a helper.
     * Helper name can be omitted and values will be applied to first helper.
     */
  config(helper, obj) {
    this.scenarios.forEach(scenario => scenario.config(helper, obj));
    return this;
  }

  /**
     * Append a tag name to scenario title
     * @param {*} tagName
     */
  tag(tagName) {
    this.scenarios.forEach(scenario => scenario.tag(tagName));
    return this;
  }

  /**
     * Pass in additional objects to inject into test
     * @param {*} obj
     */
  inject(obj) {
    this.scenarios.forEach(scenario => scenario.inject(obj));
    return this;
  }

  /**
     * Dynamically injects dependencies, see https://codecept.io/pageobjects/#dynamic-injection
     * @param {*} dependencies
     */
  injectDependencies(dependencies) {
    this.scenarios.forEach(scenario => scenario.injectDependencies(dependencies));
    return this;
  }
}

module.exports = DataScenarioConfig;