unexpected/lib/notifyPendingPromise.js

Extensible BDD assertion toolkit

/*global afterEach, jasmine*/
var pendingPromisesForTheCurrentTest = [];
var afterEachRegistered = false;

var currentSpec = null;

if (typeof jasmine === 'object') {
    // Add a custom reporter that allows us to capture the name of the currently executing spec:
    jasmine.getEnv().addReporter({
        specStarted: function (spec) {
            currentSpec = spec;
        },
        specDone: function (spec) {
            currentSpec = null;
        }
    });
}

function registerAfterEachHook() {
    if (typeof afterEach === 'function' && !afterEachRegistered) {
        afterEachRegistered = true;
        try {
            afterEach(function () {
                var error;
                if (pendingPromisesForTheCurrentTest.some(function (promise) {return promise.isPending();})) {
                    var displayName;
                    if (this.currentTest) {
                        // mocha
                        displayName = this.currentTest.title;
                    } else if (currentSpec) {
                        displayName = currentSpec.fullName;
                    }
                    error = new Error(displayName + ': You have created a promise that was not returned from the it block');
                }
                pendingPromisesForTheCurrentTest = [];
                if (error) {
                    throw error;
                }
            });
        } catch (e) {
            // The benchmark suite fails when attempting to add an afterEach
        }
    }
}

// When running in jasmine/node.js, afterEach is available immediately,
// but doesn't work within the it block. Register the hook immediately:
registerAfterEachHook();

module.exports = function notifyPendingPromise(promise) {
    pendingPromisesForTheCurrentTest.push(promise);
    // Register the afterEach hook lazily (mocha/node.js):
    registerAfterEachHook();
};