Merge pull request #42 from browserstack/config_parser

Config parser

Author: dhimil

bin/runner.js

@@ -2,13 +2,13 @@
 
 var BrowserStack = require('browserstack'),
     fs = require('fs'),
-    utils = require('../lib/utils');
-    Server = require('../lib/server').Server;
-    config = require('../lib/config');
-    Tunnel = require('../lib/local').Tunnel;
-
-var serverPort = 8888;
-var tunnel;
+    utils = require('../lib/utils'),
+    Server = require('../lib/server').Server,
+    config = require('../lib/config'),
+    Tunnel = require('../lib/local').Tunnel,
+    ConfigParser = require('../lib/configParser').ConfigParser,
+    serverPort = 8888,
+    tunnel;
 
 var client = BrowserStack.createClient({
   username: config.username,
@@ -168,22 +168,24 @@ var launchBrowsers = function(config, browser) {
 }
 
 if (config.browsers && config.browsers.length > 0) {
-  tunnel = new Tunnel(config.key, serverPort, config.tunnelIdentifier, function () {
-    console.log("Launching BrowserStack workers");
-    config.browsers.forEach(function(browser) {
-      if (browser.browser_version === "latest") {
-        console.log("[%s] Finding version.", utils.browserString(browser));
-
-        client.getLatest(browser, function(err, version) {
-          console.log("[%s] Version is %s.",
-                      utils.browserString(browser), version);
-          browser.browser_version = version;
-          // So that all latest logs come in together
+  ConfigParser.parse(client, config.browsers, function(browsers){
+    tunnel = new Tunnel(config.key, serverPort, config.tunnelIdentifier, function () {
+      console.log("Launching BrowserStack workers");
+      browsers.forEach(function(browser) {
+        if (browser.browser_version === "latest") {
+          console.log("[%s] Finding version.", utils.browserString(browser));
+
+          client.getLatest(browser, function(err, version) {
+            console.log("[%s] Version is %s.",
+                        utils.browserString(browser), version);
+                        browser.browser_version = version;
+                        // So that all latest logs come in together
+                        launchBrowsers(config, browser);
+          });
+        } else {
           launchBrowsers(config, browser);
-        });
-      } else {
-        launchBrowsers(config, browser);
-      }
+        }
+      });
     });
   });
 }

lib/_patch/mocha-plugin.js

@@ -1,4 +1,4 @@
-(function(){
+(function() {
   function stack(err) {
     var str = err.stack || err.toString();
 
@@ -20,39 +20,39 @@
     return test.fullTitle().replace(/#/g, '');
   }
 
-  return Mocha.BrowserStack = function (runner, root) {
+  return Mocha.BrowserStack = function(runner, root) {
     Mocha.reporters.HTML.call(this, runner, root);
 
     var count = 1,
-    that = this,
-    failures = 0,
-    passes = 0,
-    start = 0,
-    tracebacks = [];
+      that = this,
+      failures = 0,
+      passes = 0,
+      start = 0,
+      tracebacks = [];
 
-    runner.on('start', function () {
+    runner.on('start', function() {
       start = (new Date).getTime();
     });
-    
-    runner.on('test end', function (test) {
+
+    runner.on('test end', function(test) {
       count += 1;
     });
-    
-    runner.on('pass', function (test) {
+
+    runner.on('pass', function(test) {
       passes += 1;
     });
-    
-    runner.on('fail', function (test, err) {
+
+    runner.on('fail', function(test, err) {
       failures += 1;
-      
+
       if (err) {
-	tracebacks.push(err);
+        tracebacks.push(err);
       }
     });
-    
-    runner.on('end', function () {
-      results = {}
-      results.runtime = ((new Date).getTime() - start);
+
+    runner.on('end', function() {
+      results = {};
+      results.runtime = Date.now() - start;
       results.total = passes + failures;
       results.passed = passes;
       results.failed = failures;

lib/_patch/qunit-plugin.js

@@ -1,47 +1,58 @@
-// For logging assertions on the console, here's what grunt-contrib-qunit uses: 
+// For logging assertions on the console, here's what grunt-contrib-qunit uses:
 // https://github.com/gruntjs/grunt-contrib-qunit/blob/784597023e7235337ca9c0651aa45124a2d72341/tasks/qunit.js#L45
-(function(){
+(function() {
 
   var failedAssertions = [];
-  var options, currentModule, currentTest, setTimeoutVariable;
+  var options,
+    currentModule,
+    currentTest,
+    setTimeoutVariable;
   var pendingTest = {};
 
   var testTimeout = function() {
     var error = {
-      testName: currentTest, message: "Stuck on this test for 60 sec."
-    }
-    
-    BrowserStack.post('/_progress', {tracebacks: [error]}, function(){});    
-  }
+      testName: currentTest,
+      message: "Stuck on this test for 60 sec."
+    };
+
+    BrowserStack.post('/_progress', {
+      tracebacks: [error]
+    }, function(){});
+  };
 
-  QUnit.testDone(function( details ) {
+  QUnit.testDone(function(details) {
     var ct = details.module + " - " + details.name;
     clearTimeout(pendingTest[ct]);
   });
 
-  QUnit.testStart(function( details ) {
+  QUnit.testStart(function(details) {
     currentTest = details.module + " - " + details.name;
-    pendingTest[currentTest] = setTimeout(function(){
+    pendingTest[currentTest] = setTimeout(function() {
       testTimeout(currentTest);
     }, 60000);
   });
-  
-  QUnit.log(function( details ) {
-    if ( details.result ) {
+
+  QUnit.log(function(details) {
+    if (details.result) {
       return;
     }
-    
+
     var error = {
-      actual: details.actual, expected: encodeURIComponent(details.expected), message: encodeURIComponent(details.message), source: encodeURIComponent(details.source),
-      testName: (details.module + ": " + details.name)
-    }
-    
-    BrowserStack.post('/_progress', {tracebacks: [error]}, function(){});
+      actual: details.actual,
+      expected: encodeURIComponent(details.expected),
+      message: encodeURIComponent(details.message),
+      source: encodeURIComponent(details.source),
+      testName:( details.module + ": " + details.name)
+    };
+
+    BrowserStack.post('/_progress', {
+      tracebacks: [error]
+    }, function(){});
   });
-  
-  QUnit.done(function( results ) {
+
+  QUnit.done(function(results) {
     results.url = window.location.pathname;
     BrowserStack.post("/_report", results, function(){});
   });
-  
+
 })();

lib/config.js

@@ -1,5 +1,5 @@
 var path = require('path'),
-    fs = require('fs');
+  fs = require('fs');
 var pwd = process.cwd();
 
 config_path = process.env.BROWSERSTACK_JSON || 'browserstack.json';
@@ -46,10 +46,10 @@ if (!config.project) {
 var commit_id = process.env.TRAVIS_COMMIT;
 
 if (commit_id) {
-  config.build = "Commit-" + commit_id.slice(0, commit_id.length/2);
+  config.build = "Commit-" + commit_id.slice(0, commit_id.length / 2);
 }
 
-['username', 'key', 'test_path', 'browsers'].forEach(function (param) {
+['username', 'key', 'test_path', 'browsers'].forEach(function(param) {
   if (typeof config[param] === 'undefined') {
     console.error('Configuration parameter `%s` is required.', param);
     process.exit(1);
@@ -58,27 +58,27 @@ if (commit_id) {
 
 var formatPath = function(path) {
   if (path.indexOf(pwd) === 0) {
-    path= path.slice(pwd.length + 1);
+    path = path.slice(pwd.length + 1);
   }
-  if (!fs.existsSync(path)){
-    console.error('Test path: '+ path + ' is invalid.');
+  if (!fs.existsSync(path)) {
+    console.error('Test path: ' + path + ' is invalid.');
     process.exit(1);
   }
   return path;
-}
+};
 
 config.tunnelIdentifier = process.env.TUNNEL_ID || process.env.TRAVIS_JOB_ID || process.env.TRAVIS_BUILD_ID;
 
-if(Object.prototype.toString.call(config.test_path) === '[object Array]') {
-  config.test_path.forEach(function(path){
+if (Object.prototype.toString.call(config.test_path) === '[object Array]') {
+  config.test_path.forEach(function(path) {
     path = formatPath(path);
   });
 } else {
   //Backward Compatibility, if test_path is not array of path
   config.test_path = formatPath(config.test_path);
 }
 
-for (key in config) {
+for (var key in config) {
   if (config.hasOwnProperty(key)) {
     exports[key] = config[key];
   }

lib/configParser.js

@@ -0,0 +1,81 @@
+//beta browsers not handled
+//+ not handled
+var ConfigParser = {
+  finalBrowsers: [],
+
+  bsBrowsers: null,
+
+  parse: function(client, browser_config, callback) {
+    client.getBrowsers(function(error, browsers) {
+      if(error) {
+        console.log("Error getting browsers list from BrowserStack");
+        console.log(error);
+        process.exit(1);
+      }
+      ConfigParser.bsBrowsers = browsers;
+      for (var key in browser_config) {
+        var entry = browser_config[key];
+        ConfigParser.finalBrowsers.push(ConfigParser.getBrowserObject(entry));
+      }
+      callback(ConfigParser.finalBrowsers);
+    });
+    return
+  },
+
+  setBrowserVersion: function(browserObject, verStr) {
+    var filteredBrowsers = ConfigParser.bsBrowsers.map(function(currentValue, index, array) {
+      if (currentValue.browser == browserObject.browser) {
+        return currentValue.browser_version; 
+      }
+    }).filter(function(currentValue, index, array) {
+      return currentValue && array.indexOf(currentValue) === index;
+    }).sort(function(a, b) {
+      return parseFloat(a) - parseFloat(b);
+    });
+    if (verStr == 'current') {
+      return filteredBrowsers[filteredBrowsers.length - 1];
+    }
+    else if (verStr == 'previous') {
+      return filteredBrowsers[filteredBrowsers.length - 2];
+    }
+  },
+
+  populateOsAndOsVersion: function(browserObject) {
+    if (!(browserObject.os && browserObject.os_version)) {
+      var windowsFiltered = ConfigParser.bsBrowsers.filter(function(currentValue, index, array) {
+        return currentValue.os == 'Windows' && currentValue.browser == browserObject.browser && parseFloat(currentValue.browser_version).toPrecision(4) == parseFloat(browserObject.browser_version).toPrecision(4);
+      });
+      var osxFiltered = ConfigParser.bsBrowsers.filter(function(currentValue, index, array) {
+        return currentValue.os == 'OS X' && currentValue.browser == browserObject.browser && parseFloat(currentValue.browser_version).toPrecision(4) == parseFloat(browserObject.browser_version).toPrecision(4);
+      });
+      browserObject = windowsFiltered.length > 0 ? windowsFiltered[Math.floor(Math.random() * windowsFiltered.length)] : osxFiltered[Math.floor(Math.random() * osxFiltered.length)];
+    }
+    return browserObject;
+  },
+
+  getBrowserObject: function(entry) {
+    var browserObject = {};
+    if (typeof(entry) == 'string') {
+      var browserData = entry.split("_");
+      var lindex = browserData.length - 1;
+      browserObject.browser = browserData[0];
+      if (browserData[lindex] && browserData[lindex].indexOf("+") == -1) {
+        if (["current", "previous"].indexOf(browserData[1]) != -1) {
+          browserObject.browser_version = ConfigParser.setBrowserVersion(ConfigParser.bsBrowsers, browserObject, browserData[1]);
+        }
+        else {
+          browserObject.browser_version = browserData.slice(1, lindex + 1).join(".");
+        }
+      }
+      else {
+        browserObject.browser_version = browserData.slice(1, lindex + 1).join(".");
+      }
+    } else {
+      browserObject = entry;
+    }
+    browserObject = ConfigParser.populateOsAndOsVersion(browserObject);
+    return browserObject;
+  }
+};
+
+exports.ConfigParser = ConfigParser;