run tests in browser with karma

Summary:
- Add karma and related dependencies to make running tests in the browser easy.
  Also update browserify, since the old version was not producing a working
  build.

- Running "npm test" locally runs both the node tests and browser tests (in
  Chrome, since that's what most people already have installed). If you want to
  run the node tests only, run "npm run test-node". For browser tests only,
  "npm run test-browser".

- Make travis only run the node tests, "npm run test-node", since although it
  is supposed to be able to run karma tests in Firefox, it had issues with
  that.

- Update the Oauth and BitGo Express tests not to run in the browser. The Oauth
  tests fail because of cross-origin policy. The BitGo Express tests fail
  because BitGo Express is not intended to work in the browser (at this time).

- You can also run the tests in the browser without karma by running "npm run
  compile-test" and opening up test/index.html in your browser.

- Move the BitGoJS.js build file to the browser folder, next to the tests file
  tests.js, so we don't clutter the main directory (the browser directory only
  appears if you actually build these files).

Reviewers: gavin

Reviewed By: gavin

Subscribers: benchan, ben

Differential Revision: https://phabricator.bitgo.com/D890

Author: Ryan X. Charles

.gitignore

@@ -7,8 +7,9 @@ npm-debug.log
 node_modules
 coverage
 *.swp
-BitGoJS-min.js
-BitGoJS.js
+browser
+browser/BitGoJS-min.js
+browser/BitGoJS.js
 example/sandbox.js
 bin/server.key
 bin/server.crt

.karma.conf.js

@@ -0,0 +1,70 @@
+// Karma configuration
+// Generated on Tue Jan 06 2015 16:30:03 GMT-0800 (PST)
+
+module.exports = function(config) {
+  config.set({
+
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: '',
+
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['mocha'],
+
+
+    // list of files / patterns to load in the browser
+    files: [
+      'browser/tests.js'
+    ],
+
+    client: {
+      mocha: {
+        timeout: '10000'
+      }
+    },
+
+    // list of files to exclude
+    exclude: [
+    ],
+
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+    },
+
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ['progress'],
+
+
+    // web server port
+    port: 9876,
+
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: ['Chrome'],
+
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: false
+  });
+};

.travis.yml

@@ -5,7 +5,7 @@ node_js:
   - '0.10.37'
 env:
   matrix:
-    - TEST_SUITE=unit
+    - TEST_SUITE=test-node
   global:
     secure: gbQ8VqPQWU19sPvCQy0YUdgrdOK/zPPS9oBm0DQrL06mue5sd+IXGOUH/hqgSGNJxR/CbNQt7dTC6Ex0mTXHUasFlrrQUKn1Hr4Esqqqog1A2PgnuXK7AmHuXI18Cva4f8wU1h+HVMLfW9MJ+r1WtwyIg+DAdxWwDKUbIvCtIto=
-script: npm run-script $TEST_SUITE
+script: npm run $TEST_SUITE

package.json

@@ -13,7 +13,11 @@
     "url": "https://github.com/BitGo/BitGoJS.git"
   },
   "devDependencies": {
-    "browserify": "~4.1.5",
+    "karma": "^0.12.31",
+    "karma-chrome-launcher": "^0.1.7",
+    "karma-mocha": "^0.1.10",
+    "browserify": "~9.0.7",
+    "envify": "^3.4.0",
     "coveralls": "~2.10.0",
     "istanbul": "0.1.30",
     "mocha": "1.18.2",
@@ -41,25 +45,27 @@
   "scripts": {
     "coverage": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- --timeout 10000 --reporter list test/*.js test/bitcoin/*.js",
     "coveralls": "sleep 300; ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --report lcovonly -- --timeout 50000 -R spec test/*.js test/bitcoin/*.js && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
-    "compile": "./node_modules/.bin/browserify ./src/index.js -s Bitcoin | ./node_modules/.bin/uglifyjs > BitGoJS-min.js",
-    "compile-dbg": "./node_modules/.bin/browserify ./src/index.js -s Bitcoin | ./node_modules/.bin/uglifyjs --beautify > BitGoJS.js",
-    "test": "npm run-script unit",
-    "unit": "./node_modules/.bin/istanbul test ./node_modules/.bin/_mocha -- --timeout 10000 --reporter list test/*.js"
+    "compile": "mkdir -p browser && ./node_modules/.bin/browserify ./src/index.js -s Bitcoin | ./node_modules/.bin/uglifyjs > browser/BitGoJS-min.js",
+    "compile-dbg": "mkdir -p browser && ./node_modules/.bin/browserify ./src/index.js -s Bitcoin | ./node_modules/.bin/uglifyjs --beautify > browser/BitGoJS.js",
+    "compile-test": "mkdir -p browser && ./node_modules/.bin/browserify -t envify ./test/*.js > ./browser/tests.js",
+    "test": "npm run test-node && npm run test-browser",
+    "test-node": "./node_modules/.bin/istanbul test ./node_modules/.bin/_mocha -- --timeout 10000 --reporter list test/*.js",
+    "test-browser": "npm run compile-test && ./node_modules/karma/bin/karma start .karma.conf.js --log-level debug --single-run"
   },
   "dependencies": {
+    "argparse": "^0.1.16",
+    "bigi": "1.4.0",
     "bitcoinjs-lib": "1.5.4",
+    "body-parser": "^1.10.2",
     "bs58": "2.0.1",
     "bs58check": "1.0.4",
-    "bigi": "1.4.0",
     "chain-node": "0.0.17",
-    "minimist": "0.2.0",
-    "superagent": "0.18.0",
-    "q": "1.1.2",
-    "lodash": "2.4.1",
-    "argparse": "^0.1.16",
-    "body-parser": "^1.10.2",
     "express": "^4.11.1",
     "http-proxy": "^1.8.1",
+    "lodash": "2.4.1",
+    "minimist": "0.2.0",
+    "q": "1.1.2",
+    "superagent": "0.18.0",
     "underscore.string": "2.4.0"
   }
 }

test/bitgo.js

@@ -440,6 +440,10 @@ describe('BitGo', function() {
 
   var refreshToken;
   describe('Oauth test', function() {
+    if (process.browser) {
+      // Oauth tests not supported in browser due to same-origin policy
+      return;
+    };
     var bitgo;
 
     before(function (done) {

test/bitgoExpress.js

@@ -1,3 +1,8 @@
+if (process.browser) {
+  // Bitgo Express tests not supported in browser
+  return;
+};
+
 var assert = require('assert');
 var should = require('should');
 var request = require('supertest');

test/index.html

@@ -1,10 +1,18 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>BitGoJs Sample Page</title>
-  <script type="text/javascript" src="../BitGoJS-min.js"></script>
-</head>
-<body>
-  This page intentionally left blank.
-</body>
+  <head>
+    <title>Mocha</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="stylesheet" href="../node_modules/mocha/mocha.css" />
+  </head>
+  <body>
+    <div id="mocha"></div>
+    <script src="../node_modules/mocha/mocha.js"></script>
+    <script>mocha.setup('bdd')</script>
+    <script src="../browser/tests.js"></script>
+    <script>
+      mocha.run();
+    </script>
+  </body>
 </html>