assert.step()

Categories: Assertions.

version added: 2.2.0.

Description

step( value )

Record a step for later verification.

name description
value (string) Relevant string value, or short description, to mark this step.

This and any later steps must be verified before the end of the test via assert.verifySteps().

The Step API provides an easy way to verify execution logic to a high degree of accuracy and precision, whether for asynchronous code, event-driven code, or callback-driven code.

Changelog

UNRELEASED assert.expect() now counts assert.verifySteps() as one assertion. Steps no longer count separately.

Examples

QUnit.test('example', function (assert) {
  const finder = new WordFinder();
  finder.on('start', () => {
    assert.step('start');
  });
  finder.on('data', (word) => {
    assert.step(word);
  });
  finder.on('end', () => {
    assert.step('end');
  });
  finder.on('error', message => {
    assert.step('error: ' + message);
  });

  finder.process('Hello, 3.1. Great!');

  assert.verifySteps(['start', 'Hello', 'Great', 'end']);
});

Note: See assert.verifySteps() for more detailed examples.