grunt-mocha-blanket/phantomjs/bridge.js

Headless Blanket.js code coverage and Mocha testing via PhantomJS

/*
 * Is injected into the spec runner file

 * Copyright (c) 2012 Kelly Miyashiro
 * Copyright (c) 2012 "Cowboy" Ben Alman
 * Licensed under the MIT license.
 * http://benalman.com/about/license/
 */

/*global mocha:true, alert:true, window:true */

(function() {
    // 1.4.2 moved reporters to Mocha instead of mocha
    var mochaInstance = window.Mocha || window.mocha;
    if (!mochaInstance) {
      throw new Error('Mocha was not found, make sure you include Mocha in your HTML spec file.');
    }

    if (!window.blanket) {
      throw new Error('Blanket was not found, make sure you include Blanket in your HTML spec file.');
    }

    // Send messages to the parent phantom.js process via alert! Good times!!
    function sendMessage() {
      var args = [].slice.call(arguments);
      alert(JSON.stringify(args));
    }

    // Create a listener who'll bubble events from Phantomjs to Grunt
    function createGruntListener(ev, runner) {

      runner.on(ev, function(test, err) {
        var data = {
          err: err
        };

        if (test) {
          data.title = test.title;
          data.fullTitle = test.fullTitle();
          data.state = test.state;
          data.duration = test.duration;
          data.slow = test.slow;
        }

        sendMessage('mocha.' + ev, data);
      });
    }

    function createBlanketReporter(runner) {
      runner.on('start', function() {
        window.blanket.setupCoverage();
      });

      runner.on('end', function() {
        window.blanket.onTestsDone();
      });

      runner.on('suite', function() {
        window.blanket.onModuleStart();
      });

      runner.on('test', function() {
        window.blanket.onTestStart();
      });

      runner.on('test end', function(test) {
        window.blanket.onTestDone(test.parent.tests.length, test.state === 'passed');
      });

      //I dont know why these became global leaks
      runner.globals(['stats', 'failures', 'runner']);
    }

    var GruntReporter = function(runner) {
      // Setup HTML reporter to output data on the screen
      mochaInstance.reporters.HTML.call(this, runner);

      // Create a Grunt listener for each Mocha events
      var events = [
        'start',
        'test',
        'test end',
        'suite',
        'suite end',
        'fail',
        'pass',
        'pending',
        'end'
      ];

      for (var i = 0; i < events.length; i++) {
        createGruntListener(events[i], runner);
      }

      createBlanketReporter(runner);
    };

    var Klass = function () {};
    Klass.prototype = mochaInstance.reporters.HTML.prototype;
    GruntReporter.prototype = new Klass();

    var options = window.PHANTOMJS;
    // Default mocha options
    var config = {
        ui: 'bdd',
        ignoreLeaks: true,
        reporter: GruntReporter
      };

    if (options) {
      // If options is a string, assume it is to set the UI (bdd/tdd etc)
      if (typeof options === "string") {
        config.ui = options;
      } else {
        // Extend defaults with passed options
        for (var key in options.mocha) {
          config[key] = options.mocha[key];
        }
      }
    }

    mocha.setup(config);
    mocha.run();
}());