test-isolation-validation-test.js

import Ember from 'ember';
import { later, _backburner as backburner } from '@ember/runloop';
import { module, test } from 'qunit';
import { installTestNotIsolatedHook } from 'ember-qunit/test-isolation-validation';
import { getDebugInfo } from '@ember/test-helpers';
import patchAssert from './utils/patch-assert-helper';

backburner.DEBUG = true;

if (getDebugInfo()) {
  module('test isolation validation', function (hooks) {
    let isWaiterPending = false;
    let waiter = () => {
      return !isWaiterPending;
    };

    // In Ember < 2.8 `registerWaiter` expected to be bound to
    // `Ember.Test` 😭
    //
    // Once we have dropped support for < 2.8 we should swap this to
    // use:
    //
    // import { registerWaiter } from '@ember/test';
    Ember.Test.registerWaiter(waiter);

    QUnit.on('testEnd', function () {
      Ember.Test.unregisterWaiter(this._waiter);
    });

    hooks.beforeEach(function () {
      this.cancelId = 0;
      backburner.DEBUG = true;

      installTestNotIsolatedHook();
    });

    test('detectIfTestNotIsolated does not add failing assertion when test is isolated', function (assert) {
      assert.expect(1);

      assert.ok(true);
    });

    test('detectIfTestNotIsolated adds failing assertion when test has pending timers', function (assert) {
      assert.expect(1);
      patchAssert(assert);

      this.cancelId = later(() => {}, 1000);
    });

    test('detectIfTestNotIsolated adds failing assertion when test has test waiters', function (assert) {
      assert.expect(1);
      patchAssert(assert);

      isWaiterPending = true;
    });

    test('detectIfTestNotIsolated allows for a small window (e.g. an autorun to flush)', function (assert) {
      assert.expect(0);

      isWaiterPending = true;
      setTimeout(() => (isWaiterPending = false), 0);
    });

    module('timeouts', function (hooks) {
      hooks.afterEach(function (assert) {
        assert.test._originalPushResult({
          result:
            assert.test.assertions[0].message.indexOf(
              'Failed: Test took longer than 50ms'
            ) === 0,
        });
      });

      test('detectIfTestNotIsolated outputs debug info on test timeout', function (assert) {
        assert.expect(1);
        assert.timeout(50);

        assert.async();

        let testPushFailure = assert.test.pushFailure;

        patchAssert(assert);

        assert.test.pushFailure = testPushFailure;

        later(() => {}, 100);
      });
    });
  });
}