karma.conf.js

'use strict';

var fs = require('fs');
var path = require('path');
var mkdirp = require('mkdirp');
var baseBundleDirpath = path.join(__dirname, '.karma');
var osName = require('os-name');

module.exports = function (config) {
  var bundleDirpath;
  var cfg = {
    frameworks: [
      'browserify',
      'expect',
      'mocha'
    ],
    files: [
      // we use the BDD interface for all of the tests that
      // aren't interface-specific.
      'test/browser-fixtures/bdd.fixture.js',
      'test/acceptance/*.spec.js'
    ],
    exclude: [
      'test/acceptance/http.spec.js',
      'test/acceptance/fs.spec.js',
      'test/acceptance/file-utils.spec.js',
      'test/acceptance/require/**/*.js',
      'test/acceptance/misc/**/*.js'
    ],
    preprocessors: {
      'test/**/*.js': ['browserify']
    },
    browserify: {
      debug: true,
      configure: function configure (b) {
        b.ignore('glob')
          .ignore('fs')
          .ignore('path')
          .ignore('supports-color')
          .on('bundled', function (err, content) {
            if (!err && bundleDirpath) {
              // write bundle to directory for debugging
              fs.writeFileSync(path.join(bundleDirpath,
                'bundle.' + Date.now() + '.js'), content);
            }
          });
      }
    },
    reporters: ['spec'],
    colors: true,
    browsers: [osName() === 'macOS Sierra' ? 'Chrome' : 'PhantomJS'], // This is the default browser to run, locally
    logLevel: config.LOG_INFO,
    client: {
      mocha: {
        reporter: 'html'
      }
    }
  };

  // see https://github.com/saucelabs/karma-sauce-example

  // We define the browser to run on the Saucelabs Infrastructure
  // via the environment variables BROWSER and PLATFORM.
  // PLATFORM is e.g. "Windows"
  // BROWSER is expected to be in the format "<name>@<version>",
  // e.g. "MicrosoftEdge@latest"
  // See https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/
  // for available browsers.

  // TO RUN LOCALLY, execute:
  // `CI=1 SAUCE_USERNAME=<user> SAUCE_ACCESS_KEY=<key> BROWSER=<browser> PLATFORM=<platform> make test-browser`
  var env = process.env;
  var sauceConfig;

  if (env.CI) {
    console.error('CI mode enabled');
    if (env.TRAVIS) {
      console.error('Travis-CI detected');
      bundleDirpath = path.join(baseBundleDirpath, process.env.TRAVIS_BUILD_ID);
      if (env.BROWSER && env.PLATFORM) {
        if (env.SAUCE_USERNAME && env.SAUCE_ACCESS_KEY) {
          // correlate build/tunnel with Travis
          sauceConfig = {
            build: 'TRAVIS #' + env.TRAVIS_BUILD_NUMBER +
            ' (' + env.TRAVIS_BUILD_ID + ')',
            tunnelIdentifier: env.TRAVIS_JOB_NUMBER
          };
          console.error('Configured SauceLabs');
        } else {
          console.error('No SauceLabs credentials present');
        }
      }
    } else if (env.APPVEYOR) {
      console.error('AppVeyor detected');
      bundleDirpath = path.join(baseBundleDirpath, process.env.APPVEYOR_BUILD_ID);
    } else {
      console.error('Local/unknown environment detected');
      bundleDirpath = path.join(baseBundleDirpath, 'local');
      // don't need to run sauce from appveyor b/c travis does it.
      if (!(env.SAUCE_USERNAME || env.SAUCE_ACCESS_KEY)) {
        console.error('No SauceLabs credentials present');
      } else {
        sauceConfig = {
          build: require('os').hostname() + ' (' + Date.now() + ')'
        };
        console.error('Configured SauceLabs');
      }
    }
    mkdirp.sync(bundleDirpath);
  } else {
    console.error('CI mode disabled');
  }

  if (sauceConfig) {
    cfg.sauceLabs = sauceConfig;
    addSauceTests(cfg);
  }

  // the MOCHA_UI env var will determine if we're running interface-specific
  // tets.  since you can only load one at a time, each must be run separately.
  // each has its own set of acceptance tests and a fixture.
  // the "bdd" fixture is used by default.
  var ui = env.MOCHA_UI;
  if (ui) {
    if (cfg.sauceLabs) {
      cfg.sauceLabs.testName = 'Interface "' + ui + '" integration tests';
    }
    cfg.files = [
      'test/browser-fixtures/' + ui + '.fixture.js',
      'test/acceptance/interfaces/' + ui + '.spec.js'
    ];
  } else if (cfg.sauceLabs) {
    cfg.sauceLabs.testName = 'Unit Tests';
  }

  config.set(cfg);
};

function addSauceTests (cfg) {
  var env = process.env;
  cfg.reporters.push('saucelabs');
  cfg.customLaunchers = {};
  cfg.customLaunchers[env.BROWSER] = {
    base: 'SauceLabs',
    browserName: env.BROWSER.split('@')[0],
    version: env.BROWSER.split('@')[1],
    platform: env.PLATFORM
  };
  cfg.browsers = [env.BROWSER];

  // See https://github.com/karma-runner/karma-sauce-launcher
  // See https://github.com/bermi/sauce-connect-launcher#advanced-usage
  cfg.sauceLabs = {
    public: 'public',
    startConnect: true,
    connectOptions: {
      connectRetries: 10,
      connectRetryTimeout: 60000
    }
  };

  cfg.concurrency = 5;

  cfg.retryLimit = 5;

  // for slow browser booting, ostensibly
  cfg.captureTimeout = 120000;
  cfg.browserNoActivityTimeout = 20000;
}