Added basic tests

Author: vedharish

bin/cli.js

@@ -1,5 +1,5 @@
 var Log = require('../lib/logger'),
-    logger = new Log(global.logLevel),
+    logger = new Log(global.logLevel || 'info'),
     BrowserStack = require('browserstack'),
     qs = require('querystring'),
     chalk = require('chalk'),
@@ -62,8 +62,9 @@ function terminateAllWorkers(callback) {
   }
 }
 
-function cleanUpAndExit(signal, callback) {
+function cleanUpAndExit(signal, report, callback) {
   callback = callback || function() {};
+  report = report || {};
   logger.trace('cleanUpAndExit: signal: %s', signal);
 
   try {
@@ -84,11 +85,11 @@ function cleanUpAndExit(signal, callback) {
 
   if (signal === 'SIGTERM') {
     logger.debug('Exiting');
-    callback(null, config.status);
+    callback(null, report);
   } else {
     terminateAllWorkers(function() {
       logger.debug('Exiting');
-      callback(null, 1);
+      callback(null, report);
     });
   }
 }
@@ -396,21 +397,21 @@ function runTests(config, callback) {
   }
 }
 
-exports.test = function(config_file, callback) {
+exports.run = function(user_config, callback) {
   callback = callback || function() {};
 
   try {
-    config = new (require('../lib/config').config)(config_file);
+    config = new (require('../lib/config').config)(user_config);
 
     client = BrowserStack.createClient({
       username: config.username,
       password: config.key
     });
-    runTests(config, function(error) {
+    runTests(config, function(error, report) {
       if(error) {
         callback(error);
       } else {
-        cleanUpAndExit('SIGTERM', callback);
+        cleanUpAndExit('SIGTERM', report, callback);
       }
     });
   } catch (e) {

bin/runner.js

@@ -1,6 +1,8 @@
 #! /usr/bin/env node
 
-var todo = process.argv[2];
+var todo = process.argv[2],
+  path = require('path'),
+  config;
 
 if (todo === '--verbose') {
   global.logLevel = process.env.LOG_LEVEL || 'debug';
@@ -16,11 +18,31 @@ if (todo === 'init') {
   return;
 }
 
+var config_path = process.env.BROWSERSTACK_JSON || 'browserstack.json';
+config_path = path.resolve(path.relative(process.cwd(), config_path));
+
+console.log('Using config:', config_path);
+try {
+  config = require(config_path);
+} catch (e) {
+  if (e.code === 'MODULE_NOT_FOUND') {
+    console.err('Configuration file `browserstack.json` is missing.');
+    throw new Error('Configuration file `browserstack.json` is missing.');
+  } else {
+    console.err('Invalid configuration in `browserstack.json` file');
+    console.err(e.message);
+    console.err(e.stack);
+    throw new Error('Invalid configuration in `browserstack.json` file');
+  }
+}
+
 var runner = require('./cli.js');
-runner.test(process.env.BROWSERSTACK_JSON || 'browserstack.json', function(err) {
+runner.run(config, function(err) {
   if(err) {
-    console.log(err);
-    console.log(err.stack);
-    console.log('Invalid Command');
+    console.err(err);
+    console.err(err.stack);
+    console.err('Invalid Command');
+    process.exit(1);
   }
+  process.exit(0);
 });

lib/config.js

@@ -1,7 +1,4 @@
-var Log = require('./logger'),
-  logger = new Log(global.logLevel),
-  path = require('path'),
-  fs = require('fs'),
+var fs = require('fs'),
   pwd = process.cwd();
 
 var formatPath = function(path) {
@@ -13,32 +10,12 @@ var formatPath = function(path) {
     path = path.slice(pwd.length + 1);
   }
   if (!fs.existsSync(path) && !fs.existsSync(path.split('?')[0])) {
-    console.error('Test path: ' + path + ' is invalid.');
     throw new Error('Test path: ' + path + ' is invalid.');
   }
   return path;
 };
 
-exports.config = function(config_path) {
-  var config;
-
-  config_path = path.resolve(path.relative(process.cwd(), config_path));
-  logger.debug('Using config:', config_path);
-
-  try {
-    config = require(config_path);
-  } catch (e) {
-    if (e.code === 'MODULE_NOT_FOUND') {
-      logger.info('Configuration file `browserstack.json` is missing.');
-      throw new Error('Configuration file `browserstack.json` is missing.');
-    } else {
-      logger.info('Invalid configuration in `browserstack.json` file');
-      logger.info(e.message);
-      logger.info(e.stack);
-      throw new Error('Invalid configuration in `browserstack.json` file');
-    }
-  }
-
+exports.config = function(config) {
   var package_json = {};
   try {
     package_json = require(process.cwd() + '/package.json');
@@ -79,8 +56,7 @@ exports.config = function(config_path) {
   var that = this;
   ['username', 'key', 'browsers', 'test_path'].forEach(function(param) {
     if (typeof config[param] === 'undefined' && typeof that[param] === 'undefined') {
-      console.error('Configuration parameter `%s` is required.', param);
-      throw new Error('Configuration parameter `%s` is required.', param);
+      throw new Error('Configuration parameter ' + param + ' is required.');
     }
   });
 

lib/configParser.js

@@ -1,7 +1,7 @@
 //beta browsers not handled
 //+ not handled
 var Log = require('./logger'),
-    logger = new Log(global.logLevel);
+    logger = new Log(global.logLevel || 'info');
 
 var ConfigParser = {
   finalBrowsers: [],

lib/local.js

@@ -1,5 +1,5 @@
 var Log = require('./logger'),
-  logger = new Log(global.logLevel),
+  logger = new Log(global.logLevel || 'info'),
   exec = require('child_process').execFile,
   fs = require('fs'),
   https = require('https'),

lib/logger.js

@@ -1,5 +1,5 @@
 var fmt = require('util').format;
-var logLevels = {ERROR: 3, INFO: 6, DEBUG: 7, TRACE: 8};
+var logLevels = { SILENT: 0, ERROR: 3, INFO: 6, DEBUG: 7, TRACE: 8 };
 
 function Log(level){
   if ('string' === typeof level) {

lib/server.js

@@ -1,5 +1,5 @@
 var Log = require('./logger'),
-  logger = new Log(global.logLevel),
+  logger = new Log(global.logLevel || 'info'),
   http = require('http'),
   url = require('url'),
   path = require('path'),
@@ -11,7 +11,8 @@ var Log = require('./logger'),
   chalk = require('chalk'),
   mime = require('mime'),
   send = require('send'),
-  vm = require('vm');
+  vm = require('vm'),
+  report = {};
 
 exports.Server = function Server(bsClient, workers, config, callback) {
   var testFilePaths = (Array.isArray(config.test_path) ? config.test_path : [ config.test_path ])
@@ -222,6 +223,7 @@ exports.Server = function Server(bsClient, workers, config, callback) {
       }
 
       var worker = workers[uuid];
+      var browserInfo = worker.getTestBrowserInfo();
       var query = null;
 
       try {
@@ -231,11 +233,15 @@ exports.Server = function Server(bsClient, workers, config, callback) {
         logger.info('[%s] Log: ' + qs.parse(body).data, worker.string);
       }
 
+
+      report[browserInfo] = report[browserInfo] || { assertions: [], tests: [] };
+
       logger.trace('[%s] _progress', worker.id, query);
 
       if (query && query.tracebacks) {
         query.tracebacks.forEach(function(traceback) {
-          logger.info('[%s] ' + chalk.red('Error:'), worker.getTestBrowserInfo(), formatTraceback(traceback));
+          report[browserInfo]['assertions'].push(traceback);
+          logger.info('[%s] ' + chalk.red('Error:'), browserInfo, formatTraceback(traceback));
         });
       }
       response.end();
@@ -250,6 +256,7 @@ exports.Server = function Server(bsClient, workers, config, callback) {
 
       var worker = workers[uuid];
       worker._worker_key = uuid;
+      var browserInfo = worker.getTestBrowserInfo();
 
       var query = null;
       try {
@@ -261,14 +268,17 @@ exports.Server = function Server(bsClient, workers, config, callback) {
       if (query === null) {
         logger.info('[%s] Null response from remote Browser', request.headers['x-browser-string']);
       } else {
+        report[browserInfo] = report[browserInfo] || { assertions: [], tests: [] };
+        report[browserInfo]['tests'].push(query);
+
         if (query.tracebacks && query.tracebacks.length > 0) {
-          logger.info('[%s] ' + chalk['red']('Tracebacks:'), worker.getTestBrowserInfo());
+          logger.info('[%s] ' + chalk['red']('Tracebacks:'), browserInfo);
           query.tracebacks.forEach(function(traceback) {
             logger.info(traceback);
           });
         }
         var color = query.failed ? 'red' : 'green';
-        logger.info('[%s] ' + chalk[color](query.failed ? 'Failed:' : 'Passed:') + ' %d tests, %d passed, %d failed; ran for %dms', worker.getTestBrowserInfo(), query.total, query.passed, query.failed, query.runtime);
+        logger.info('[%s] ' + chalk[color](query.failed ? 'Failed:' : 'Passed:') + ' %d tests, %d passed, %d failed; ran for %dms', browserInfo, query.total, query.passed, query.failed, query.runtime);
         config.status += query.failed;
       }
 
@@ -278,7 +288,7 @@ exports.Server = function Server(bsClient, workers, config, callback) {
         logger.trace('[%s] _report: client.takeScreenshot | response:', worker.id, screenshot, error);
 
         if (!error && screenshot.url && query && query.failed) {
-          logger.info('[%s] ' + chalk.yellow('Screenshot:') + ' %s', worker.getTestBrowserInfo(), screenshot.url);
+          logger.info('[%s] ' + chalk.yellow('Screenshot:') + ' %s', browserInfo, screenshot.url);
         }
 
         checkAndTerminateWorker(worker, function(reusedWorker) {
@@ -289,14 +299,14 @@ exports.Server = function Server(bsClient, workers, config, callback) {
 
           if (reusedWorker) {
             logger.trace('[%s] _report: checkAndTerminateWorker: reused worker', worker.id);
-            logger.debug('[%s] Reused', worker.getTestBrowserInfo());
+            logger.debug('[%s] Reused', browserInfo);
             worker.resetAck();
             worker.awaitAck();
             return;
           }
 
           logger.trace('[%s] _report: checkAndTerminateWorker: terminated', worker.id);
-          logger.debug('[%s] Terminated', worker.getTestBrowserInfo());
+          logger.debug('[%s] Terminated', browserInfo);
 
           clearTimeout(workers[uuid].ackTimeout);
           clearTimeout(workers[uuid].activityTimeout);
@@ -312,7 +322,7 @@ exports.Server = function Server(bsClient, workers, config, callback) {
             }
 
             logger.trace('[%s] _report: checkAndTerminateWorker: all tests done', worker.id, config.status && 'with failures');
-            callback(null, 'All Tests Done');
+            callback(null, JSON.stringify(report));
           }
         });
       });

package.json

@@ -17,7 +17,8 @@
   },
   "devDependencies": {
     "jshint": "2.5.6",
-    "mocha": "1.15.1"
+    "mocha": "1.15.1",
+    "sinon": "^1.17.5"
   },
   "licenses": [
     {
@@ -32,8 +33,9 @@
   "scripts": {
     "lint": "node_modules/.bin/jshint lib/*.js bin/ tests/*.js",
     "test-unit": "node_modules/.bin/mocha tests/unit",
-    "test-ci": "npm run lint && npm run test-unit && TEST_MODE=all tests/external-tests.js",
-    "test": "npm run lint && npm run test-unit && TEST_MODE=required tests/external-tests.js",
+    "test-behaviour": "node_modules/.bin/mocha tests/behaviour -R Spec",
+    "test-ci": "npm run lint && npm run test-unit && npm run test-behaviour && TEST_MODE=all tests/external-tests.js",
+    "test": "npm run lint && npm run test-unit && npm run test-behaviour && TEST_MODE=required tests/external-tests.js",
     "update-util": "webpack"
   }
 }

tests/behaviour/resources/even.js

@@ -0,0 +1,3 @@
+function isEven(val) {
+    return val % 2 === 0;
+}

tests/behaviour/resources/odd.js

@@ -0,0 +1,3 @@
+function isOdd(val) {
+    return val % 2 === 1;
+}