QUnit.on()

добавлено в версии: 2.2.0.

Описание

QUnit.on( eventName, callback )

Регистрирует функцию обратного вызова, которая будет вызвана после возникновения указанного события.

Этот эмиттер событий — основной интерфейс для репортёров QUnit, плагинов и поддержки непрерывной интеграции. Он основан на стандарте CRI js-reporters и включает API репортера.

Событие runStart

Событие runStart указывает на начало запуска тестов. Оно возникает ровно один раз и перед всеми остальными событиями.

QUnit.on('runStart', runStart => {
  console.log(`Test plan: ${runStart.testCounts.total}`);
});

Событие suiteStart

Событие suiteStart указывает на начало модуля. Впоследствии за ним последует соответствующее событие suiteEnd.

QUnit.on('suiteStart', suiteStart => {
  console.log('suiteStart', suiteStart);
  // name: 'my module'
  // fullName: ['grandparent', 'parent', 'my module']
});

Событие suiteEnd

Событие suiteEnd указывает на завершение модуля. Оно возникает после соответствующего события suiteStart.

QUnit.on('suiteEnd', suiteEnd => {
  console.log(suiteEnd);
  // …
});

Событие testStart

Событие testStart указывает на начало теста. Впоследствии за ним последует соответствующее событие testEnd.

QUnit.on('testStart', testStart => {
  console.log(testStart);
  // name: 'my test'
  // moduleName: 'my module'
  // fullName: ['parent', 'my module', 'my test']

  // name: 'global test'
  // moduleName: null
  // fullName: ['global test']
});

Событие testEnd

Событие testEnd указывает на завершение теста. Оно возникает после соответствующего события testStart.

Свойства объекта testEnd:

Свойства объекта FailedAssertion:

QUnit.on('testEnd', testEnd => {
  if (testEnd.status === 'failed') {
    console.error('Failed! ' + testEnd.fullName.join(' > '));
    testEnd.errors.forEach(assertion => {
      console.error(assertion);
      // message: speedometer
      // actual: 75
      // expected: 88
      // stack: at dmc.test.js:12
    });
  }
});

Событие runEnd

Событие runEnd указывает на завершение запуска тестов. Оно возникает ровно один раз.

Событие runEnd обладает памятью (начиная с QUnit 2.24.0). Это означает, что можно подписаться на это событие, даже если оно уже возникло. Например, если вы создаёте систему интеграции, которая автоматизирует запуск тестов в браузере, и не можете надёжно добавить обработчик до завершения тестов. Вы можете добавить обработчик события runEnd позже. В этом случае он будет вызван немедленно. Это избавляет от необходимости разбирать HTML.

QUnit.on('runEnd', runEnd => {
  console.log(`Passed: ${runEnd.passed}`);
  console.log(`Failed: ${runEnd.failed}`);
  console.log(`Skipped: ${runEnd.skipped}`);
  console.log(`Todo: ${runEnd.todo}`);
  console.log(`Total: ${runEnd.total}`);
});

Событие error

Добавлено в версии: QUnit 2.17.0.

Событие error уведомляет плагины о неперехваченных глобальных ошибках во время запуска тестов.

См. также QUnit.onUncaughtException() — с его помощью можно сообщать о собственных неперехваченных ошибках.

Событие error обладает памятью (начиная с QUnit 2.24.1). Это означает, что можно подписаться на это событие, даже если оно уже возникло. Это повышает надёжность репортёров в системах автоматизации браузеров, где бывает трудно надёжно добавить обработчик между qunit.js и любым другим кодом.

QUnit.on('error', error => {
  console.error(error);
});

API репортера

Интерфейс командной строки QUnit принимает параметр --reporter, который загружает репортёр из модуля Node (например, пакета npm). Такой модуль должен экспортировать функцию init, которую вызовет QUnit и которой передаст объект QUnit; затем с его помощью можно вызвать QUnit.on(). Этот контракт называется API репортера.

Репортёр можно реализовать как обычную экспортируемую функцию или как класс со статическим методом init.

Пример: класс репортера

class MyReporter {
  static init (QUnit) {
    return new MyReporter(QUnit);
  }

  constructor (QUnit) {
    QUnit.on('error', this.onError.bind(this));
    QUnit.on('testEnd', this.onTestEnd.bind(this));
    QUnit.on('runEnd', this.onRunEnd.bind(this));
  }

  onError (error) {
  }

  onTestEnd (testEnd) {
  }

  onRunEnd (runEnd) {
  }
}

// CommonJS, or ES Module
module.exports = MyReporter;
export default MyReporter;

Пример: функция репортера

function init (QUnit) {
  QUnit.on('error', onError);
  QUnit.on('testEnd', onTestEnd);
  QUnit.on('runEnd', onRunEnd);

  function onError (error) {
  }
  function onTestEnd (testEnd) {
  }
  function onRunEnd (runEnd) {
  }
}

// CommonJS, or ES Module
module.exports.init = init;
export default { init };