Refactored the build/test/CI scripts

Author: JamesMessinger

.jshintrc

@@ -80,5 +80,6 @@
   // Custom Globals
   "globals": {
   }
+
 }
 

.npmignore

@@ -5,6 +5,9 @@ npm-debug.log
 /.idea
 /coverage
 /dist/*.test.js
+karma.conf.js
 /tests
 /www
+bower.json
+index.html
 /.*

.travis.yml

@@ -3,18 +3,43 @@
 
 sudo: false
 language: node_js
-node_js:
-  - 'iojs'
-  - '0.10'
-  - '0.11'
-  - '0.12'
-branches:
-  only:
-    - /^v\d\.\d\.\d/    # only build tagged versions (rather than EVERY push)
-    - /^PR /            # also build pull requests
+matrix:
+  include:
+    # IO.js
+    - node_js: iojs
+      env: KARMA=false
+    
+    # Node
+    - node_js: 0.10
+      env: KARMA=false
+    - node_js: 0.11
+      env: KARMA=false
+    - node_js: 0.12
+      env: KARMA=false
+
+    # Local Browsers
+    - node_js: 0.12
+      env: KARMA_COVERAGE=true KARMA_SAUCE=false
+
+    # Sauce Labs
+    - node_js: 0.12
+      env: KARMA_SAUCE=true KARMA_COVERAGE=false
+
+  fast_finish: true
+  allow_failures:
+    - node_js: 0.12
+      env: KARMA_SAUCE=true KARMA_COVERAGE=false
+
 before_script:
   - export DISPLAY=:99.0
   - sh -e /etc/init.d/xvfb start
-  - npm run build
+  - npm update -g npm
+branches:
+  only:
+    - master            # only run CI on the master branch
+    - /^PR /            # also build pull requests
 after_success:
-  - cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js
+  - cat coverage/*/lcov.info > coveralls.txt                    # concatenate all code-coverage data into a single file
+  - cat coveralls.txt                                           # output the file contents (for debugging)
+  - ls -R1 coverage/*/lcov.info                                 # list the files (for debugging)
+  - cat coveralls.txt | node_modules/coveralls/bin/coveralls.js # send code-coverage data to Coveralls

karma.conf.js

@@ -1,35 +1,74 @@
-'use strict';
-
 // Karma config
 // https://karma-runner.github.io/0.12/config/configuration-file.html
+'use strict';
+
+var baseConfig = {
+  frameworks: ['mocha'],
+  reporters: ['mocha'],
+  files: [
+    // Third-Party Libraries
+    'tests/bower_components/chai/chai.js',
+    'tests/bower_components/sinon-js/sinon.js',
+    'tests/bower_components/useragent-parser/src/useragent-parser.js',
+
+    // Ono
+    'dist/ono.min.js',
+    {pattern: 'dist/*.map', included: false, served: true},
+
+    // Test Fixtures
+    'tests/fixtures/**/*.js',
+
+    // Tests
+    'tests/specs/**/*.spec.js'
+  ]
+};
+
 module.exports = function(config) {
-  var baseConfig = {
-    frameworks: ['mocha'],
-    reporters: ['mocha'],
-    files: [
-      // Third-Party Libraries
-      'www/bower_components/chai/chai.js',
-      'www/bower_components/sinon-js/sinon.js',
-      'www/bower_components/useragent-parser/src/useragent-parser.js',
-
-      // Ono
-      'dist/ono.min.js',
-
-      // Unit Tests
-      'tests/**/_*.js',
-      'tests/**/*.spec.js'
-    ]
-  };
+  var karma = process.env.KARMA ? process.env.KARMA === 'true' : true;
+  var coverage = process.env.KARMA_COVERAGE ? process.env.KARMA_COVERAGE === 'true' : true;
+  var sauce = process.env.KARMA_SAUCE ? process.env.KARMA_SAUCE === 'true' : true;
+  var sauceUsername = process.env.SAUCE_USERNAME;
+  var sauceAccessKey = process.env.SAUCE_ACCESS_KEY;
 
-  configureBrowsers(baseConfig);
-  configureSauceLabs(baseConfig);
+  if (!karma) {
+    // Karma is disabled, so abort immediately
+    process.exit();
+    return;
+  }
+
+  if (coverage) {
+    configureCodeCoverage(baseConfig);
+  }
+
+  if (sauce && sauceUsername && sauceAccessKey) {
+    configureSauceLabs(baseConfig);
+  }
+  else {
+    configureLocalBrowsers(baseConfig);
+  }
+
+  console.log('Karma Config:\n', JSON.stringify(baseConfig, null, 2));
   config.set(baseConfig);
 };
 
+/**
+ * Configures the code-coverage reporter
+ */
+function configureCodeCoverage(config) {
+  config.reporters.push('coverage');
+  config.files.splice(config.files.indexOf('dist/ono.min.js'), 1, 'dist/ono.test.js');
+  config.coverageReporter = {
+    reporters: [
+      {type: 'text-summary'},
+      {type: 'lcov'}
+    ]
+  };
+}
+
 /**
  * Configures the browsers for the current platform
  */
-function configureBrowsers(config) {
+function configureLocalBrowsers(config) {
   var isMac     = /^darwin/.test(process.platform),
       isWindows = /^win/.test(process.platform),
       isLinux   = !(isMac || isWindows);
@@ -42,9 +81,8 @@ function configureBrowsers(config) {
   }
   else if (isWindows) {
     config.browsers = ['PhantomJS', 'Firefox', 'Chrome', 'Safari', 'IE9', 'IE10', 'IE'];
-
-    // NOTE: IE 6, 7, 8 are not supported by Chai
     config.customLaunchers = {
+      // NOTE: IE 6, 7, 8 are not supported by Chai
       IE9: {
         base: 'IE',
         'x-ua-compatible': 'IE=EmulateIE9'
@@ -62,114 +100,83 @@ function configureBrowsers(config) {
  * https://github.com/karma-runner/karma-sauce-launcher
  */
 function configureSauceLabs(config) {
-  var username = process.env.SAUCE_USERNAME;
-  var accessKey = process.env.SAUCE_ACCESS_KEY;
-  var jobNumber = getJobNumber(process.env.TRAVIS_JOB_NUMBER);
-
-  // Only run Sauce Labs if we have the username & access key.
-  // And only run it for the first job in a build. No need to run it for every job.
-  if (username && accessKey && jobNumber <= 1) {
-    var project = require('./package.json');
-    var testName = project.name + ' v' + project.version;
-    var build = testName + ' Build #' + process.env.TRAVIS_JOB_NUMBER + ' @ ' + new Date();
-
-    config.sauceLabs = {
-      build: build,
-      testName: testName,
-      tags: [project.name],
-      recordVideo: true,
-      recordScreenshots: true
-    };
+  var project = require('./package.json');
+  var testName = project.name + ' v' + project.version;
+  var build = testName + ' Build #' + process.env.TRAVIS_JOB_NUMBER + ' @ ' + new Date();
 
-    config.customLaunchers = {
-      'IE-9': {
-        base: 'SauceLabs',
-        platform: 'Windows 7',
-        browserName: 'internet explorer',
-        version: '9'
-      },
-      'IE-10': {
-        base: 'SauceLabs',
-        platform: 'Windows 7',
-        browserName: 'internet explorer',
-        version: '10'
-      },
-      'IE-11': {
-        base: 'SauceLabs',
-        platform: 'Windows 7',
-        browserName: 'internet explorer',
-        version: '11'
-      },
-      'Chrome-Latest': {
-        base: 'SauceLabs',
-        platform: 'Windows 7',
-        browserName: 'chrome'
-      },
-      'Firefox-Latest': {
-        base: 'SauceLabs',
-        platform: 'Windows 7',
-        browserName: 'firefox'
-      },
-      'Opera-Latest': {
-        base: 'SauceLabs',
-        platform: 'Windows 7',
-        browserName: 'opera'
-      },
-      'Safari-Latest': {
-        base: 'SauceLabs',
-        platform: 'OS X 10.10',
-        browserName: 'safari'
-      },
-      'iOS-6': {
-        base: 'SauceLabs',
-        platform: 'OS X 10.10',
-        browserName: 'iphone',
-        version: '6'
-      },
-      'iOS-8': {
-        base: 'SauceLabs',
-        platform: 'OS X 10.10',
-        browserName: 'iphone',
-        version: '8'
-      },
-      'Android-4-4': {
-        base: 'SauceLabs',
-        platform: 'Linux',
-        browserName: 'android',
-        version: '4.4'
-      },
-      'Android-5': {
-        base: 'SauceLabs',
-        platform: 'Linux',
-        browserName: 'android',
-        version: '5'
-      }
-    };
-
-    config.reporters.push('saucelabs');
-    config.browsers = Object.keys(config.customLaunchers);
+  config.sauceLabs = {
+    build: build,
+    testName: testName,
+    tags: [project.name],
+    recordVideo: true,
+    recordScreenshots: true
+  };
 
-    // Sauce Connect sometimes hangs (https://github.com/karma-runner/karma-sauce-launcher/issues/14)
-    // So terminate the process after a few minutes
-    setTimeout(function() {
-      console.warn('\nWARNING: Sauce Connect appears to have hung. Forcefully terminating.\n');
-      process.exit();
-    }, 1000 * 60 * 8); // 8 minutes
-  }
-}
+  config.customLaunchers = {
+    'IE-9': {
+      base: 'SauceLabs',
+      platform: 'Windows 7',
+      browserName: 'internet explorer',
+      version: '9'
+    },
+    'IE-10': {
+      base: 'SauceLabs',
+      platform: 'Windows 7',
+      browserName: 'internet explorer',
+      version: '10'
+    },
+    'IE-11': {
+      base: 'SauceLabs',
+      platform: 'Windows 7',
+      browserName: 'internet explorer',
+      version: '11'
+    },
+    'Chrome-Latest': {
+      base: 'SauceLabs',
+      platform: 'Windows 7',
+      browserName: 'chrome'
+    },
+    'Firefox-Latest': {
+      base: 'SauceLabs',
+      platform: 'Windows 7',
+      browserName: 'firefox'
+    },
+    'Opera-Latest': {
+      base: 'SauceLabs',
+      platform: 'Windows 7',
+      browserName: 'opera'
+    },
+    'Safari-Latest': {
+      base: 'SauceLabs',
+      platform: 'OS X 10.10',
+      browserName: 'safari'
+    },
+    'iOS-6': {
+      base: 'SauceLabs',
+      platform: 'OS X 10.10',
+      browserName: 'iphone',
+      version: '6'
+    },
+    'iOS-8': {
+      base: 'SauceLabs',
+      platform: 'OS X 10.10',
+      browserName: 'iphone',
+      version: '8'
+    },
+    'Android-4-4': {
+      base: 'SauceLabs',
+      platform: 'Linux',
+      browserName: 'android',
+      version: '4.4'
+    },
+    'Android-5': {
+      base: 'SauceLabs',
+      platform: 'Linux',
+      browserName: 'android',
+      version: '5'
+    }
+  };
 
-/**
- * Returns the Travis CI job number, or 1 if there is no job number.
- *
- * Examples:
- *  - "4.1"   ->  1
- *  - "16.2"  ->  2
- *  - "16"    ->  1
- *  - ""      ->  1
- *  - null    ->  1
- */
-function getJobNumber(number) {
-  var match = /\.(\d+)/.exec(number);
-  var job = match ? match[1] || '1' : '1';
-  return parseInt(job);
+  config.reporters.push('saucelabs');
+  config.browsers = Object.keys(config.customLaunchers);
 }