Merge pull request #4 from browserstack/spec_v1

Spec v1

Author: tr4n2uil

.travis.yml

@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+  - "4.3"
+  - "4.0"
+  - "0.12"
+  - "0.10"
+
+before_install:
+  - true && `base64 --decode <<< ZXhwb3J0IEJST1dTRVJTVEFDS19BQ0NFU1NfS0VZPUh5VmZydXJvb3dYb041eGhLZEs2Cg==`
+

README.md

@@ -1,22 +1,31 @@
-wd-browserstack
-=========
-
-Sample for using [wd](https://github.com/admc/wd) with BrowserStack Automate.
-
-### Install dependencies for testing
-
-- `npm install`
-
-### Configuring the json
-
- - Open the test js files (`browserstack_async.js` or `browserstack_promises.js`)
- - Replace `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` with your BrowserStack credentials. Don't have one? Get one on BrowserStack [dashboard]
- - Add / customise more [capabilities] to `desired` object in the js files
-
-### Run the tests
-
- - To start a single test run: `npm test` or `npm run test_single` or `npm run test_async` or `npm run test_promises`
- - To start local tests run: `npm run test_local`
-
-[capabilities]:http://www.browserstack.com/automate/capabilities
-[dashboard]:https://www.browserstack.com/automate
+# wd-browserstack
+
+[WD](https://github.com/admc/wd) Integration with BrowserStack.
+
+![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
+
+## Setup
+* Clone the repo
+* Install dependencies `npm install`
+* Update `*.conf.js` files inside the `conf/` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
+
+## Running your tests
+- To run a single test, run `npm run single`
+- To run parallel tests, run `npm run parallel`
+- To run local tests, run `npm run local`
+
+## Notes
+* You can view your test results on the [BrowserStack automate dashboard](https://www.browserstack.com/automate)
+* To test on a different set of browsers, check out our [platform configurator](https://www.browserstack.com/automate/node#setting-os-and-browser)
+* You can export the environment variables for the Username and Access Key of your BrowserStack account
+  
+  ```
+  export BROWSERSTACK_USERNAME=<browserstack-username> &&
+  export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+  ```
+  
+## Additional Resources
+* [Documentation for writing automate test scripts in Node](https://www.browserstack.com/automate/node)
+* [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities)
+* [Browsers & mobile devices for selenium testing on BrowserStack](Browsers & Mobile Devices for Selenium Testing)
+* [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api)

browserstack_async.js

@@ -0,0 +1,16 @@
+exports.config = {
+  user: 'BROWSERSTACK_USERNAME',
+  key: 'BROWSERSTACK_ACCESS_KEY',
+
+  seleniumHost: 'hub-cloud.browserstack.com',
+  seleniumPort: 80,
+
+  test: '../tests/local_test.js',
+
+  capabilities: [{
+    browserName: 'chrome',
+    name: "local_test",
+    build: "wd-browserstack",
+    'browserstack.local': true
+  }]
+}

browserstack_local_async.js

@@ -0,0 +1,30 @@
+exports.config = {
+  user: 'BROWSERSTACK_USERNAME',
+  key: 'BROWSERSTACK_ACCESS_KEY',
+
+  seleniumHost: 'hub-cloud.browserstack.com',
+  seleniumPort: 80,
+
+  test: '../tests/single_test.js',
+
+  commonCapabilities: {
+    name: "parallel_test",
+    build: "wd-browserstack"
+  },
+
+  capabilities: [{
+    browserName: 'chrome'
+  },{
+    browserName: 'firefox'
+  },{
+    browserName: 'safari'
+  },{
+    browserName: 'internet explorer'
+  }]
+}
+
+// Code to support common capabilities
+exports.config.capabilities.forEach(function(caps){
+  for(var i in exports.config.commonCapabilities) caps[i] = caps[i] || exports.config.commonCapabilities[i];
+});
+

browserstack_promises.js

@@ -0,0 +1,15 @@
+exports.config = {
+  user: 'BROWSERSTACK_USERNAME',
+  key: 'BROWSERSTACK_ACCESS_KEY',
+
+  seleniumHost: 'hub-cloud.browserstack.com',
+  seleniumPort: 80,
+
+  test: '../tests/single_test.js',
+
+  capabilities: [{
+    browserName: 'chrome',
+    name: "single_test",
+    build: "wd-browserstack"
+  }]
+}

conf/local.conf.js

@@ -1,7 +1,8 @@
 {
   "name": "wd-browserstack",
-  "version": "1.0.0",
-  "description": "Test github.com:admc/wd.git with browserstack",
+  "version": "0.1.0",
+  "readme": "WD Integration with [BrowserStack](https://www.browserstack.com)",
+  "description": "Selenium examples for WD and BrowserStack Automate",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/browserstack/wd-browserstack.git"
@@ -19,14 +20,13 @@
   },
   "homepage": "https://github.com/browserstack/wd-browserstack#readme",
   "scripts": {
-    "test": "node browserstack_async.js",
-    "test_local": "node scripts/test_local.js",
-    "test_async": "node browserstack_async.js",
-    "test_single": "node browserstack_promises.js",
-    "test_promises": "node browserstack_promises.js"
+    "test": "npm run single && npm run local && npm run parallel",
+    "single": "node scripts/browserstack.js ../conf/single.conf.js",
+    "local": "node scripts/browserstack.js ../conf/local.conf.js",
+    "parallel": "node scripts/browserstack.js ../conf/parallel.conf.js"
   },
   "dependencies": {
-    "browserstack-local": "^0.1.0",
+    "browserstack-local": "^1.0.0",
     "chai": "^3.5.0",
     "chai-as-promised": "^5.2.0",
     "colors": "^1.1.2",

conf/parallel.conf.js

@@ -0,0 +1,60 @@
+var chai = require("chai"),
+    chaiAsPromised = require("chai-as-promised"),
+    wd = require('wd'),
+    colors = require('colors'),
+    child_process = require('child_process'),
+    browserstack = require('browserstack-local');
+
+chai.use(chaiAsPromised);
+chai.should();
+chaiAsPromised.transferPromiseness = wd.transferPromiseness;
+
+wd.addPromiseChainMethod(
+  'onQuit', function(done) {
+    if(done) done();
+    return this;
+  }
+);
+
+function runOnBrowserStack(caps, test, done){
+  console.log("Running Test: " + test.name.green + '\n');
+  var browser = wd.promiseChainRemote(config.seleniumHost, config.seleniumPort, username, accessKey);
+
+  // optional extra logging
+  browser.on('status', function(info) {
+    console.log(info.cyan);
+  });
+  browser.on('command', function(eventType, command, response) {
+    console.log(' > ' + eventType.green, command, (response || '').grey);
+  });
+  browser.on('http', function(meth, path, data) {
+    console.log(' > ' + meth.yellow, path, (data || '').grey);
+  });
+
+  test.run(browser.init(caps)).fin(function() { return browser.quit(); }).onQuit(done).done();
+}
+
+var config_file = process.argv[2] || 'conf.js'
+var config = require(config_file).config;
+var test = require(config.test);
+
+var username = process.env.BROWSERSTACK_USERNAME || config.user;
+var accessKey = process.env.BROWSERSTACK_ACCESS_KEY || config.key;
+
+for(var i in config.capabilities){
+  var caps = config.capabilities[i];
+  if(caps["browserstack.local"]){
+    // Code to start browserstack local before start of test and stop browserstack local after end of test
+    console.log("Connecting local");
+    var bs_local = new browserstack.Local();
+    bs_local.start({'key': accessKey }, function(error) {
+      if (error) return console.log(error.red);
+      console.log('Connected. Now testing...');
+
+      runOnBrowserStack(caps, test, function() { bs_local.stop(function() {}); });
+    });
+  }
+  else {
+    runOnBrowserStack(caps, test);
+  }
+}