codeceptjs/lib/listener/steps.js

Modern Era Acceptance Testing Framework for NodeJS

const event = require('../event');
const store = require('../store');

let currentTest;
let currentHook;

/**
 * Register steps inside tests
 */
module.exports = function () {
  event.dispatcher.on(event.test.started, (test) => {
    currentTest = test;
    currentTest.steps = [];
    if (!('retryNum' in currentTest)) currentTest.retryNum = 0;
    else currentTest.retryNum += 1;
  });

  event.dispatcher.on(event.test.after, () => {
    currentTest = null;
  });

  event.dispatcher.on(event.hook.passed, () => {
    currentHook = null;
  });

  event.dispatcher.on(event.hook.started, (suite) => {
    currentHook = suite.ctx.test;
    currentHook.steps = [];
  });

  event.dispatcher.on(event.test.failed, (test) => {
    const cutSteps = function (current) {
      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;
      return current;
    };
    if (currentHook && Array.isArray(currentHook.steps) && currentHook.steps.length) {
      currentHook = cutSteps(currentHook);
      return currentHook = null;
    }
    if (!currentTest) return;
    // last step is failing step
    if (!currentTest.steps.length) return;
    return currentTest = cutSteps(currentTest);
  });

  event.dispatcher.on(event.test.passed, (test) => {
    // To be sure that passed test will be passed in report
    delete currentTest.err;
    currentTest.state = 'passed';
  });

  event.dispatcher.on(event.step.started, (step) => {
    if (store.debugMode) return;
    if (currentHook && Array.isArray(currentHook.steps)) {
      return currentHook.steps.push(step);
    }
    if (!currentTest || !currentTest.steps) return;
    currentTest.steps.push(step);
  });
};