Merge pull request #1 from browserstack/develop

Initial release

Author: mohitmun

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -1 +1,55 @@
-# protractor-browserstack-reporter
+# protractor-browserstack-reporter
+
+A Protractor plugin which enables BrowserStack reports on CI servers
+
+![Browserstack reports on Jenkins](screenshots/jenkins_report.png)
+
+## Installation
+
+Add `protractor-browserstack-reporter` as a dependency in your `package.json`.
+
+```json
+{
+  "dependencies": {
+    "protractor-browserstack-reporter": "~0.1.0"
+  }
+}
+```
+
+## Configuration
+
+Add `browserstack` as a plugin in your conf file.
+
+```js
+// conf.js
+'plugins': [{
+  'package': "browserstack-protractor-reporter"
+}]
+```
+
+The following options are supported(optional):
+
+### outputDir
+Define a directory where your browserstack report files should get stored.
+
+Type: `String`<br>
+
+## Jenkins Setup
+
+You will have to configure your Jenkins CI server to embed all the BrowserStack Selenium reports and logs in Jenkins.
+  1. Click on Add post-build action in Post-build Actions.
+  2. Click on Publish JUnit test result report
+  3. In the Test report XMLs, enter */*browserstack-reports/REPORT-\*.xml
+  4. In the Additional test report features section, add Embed BrowserStack Report.
+
+This is how your configuration should look like
+![Jenkins Setup](screenshots/jenkins_setup.png)
+
+## Related links
+
+[Guide to running Selenium Webdriver tests with Protractor on BrowserStack](https://www.browserstack.com/automate/protractor)
+
+[Browserstack Jenkins page](https://www.browserstack.com/automate/jenkins)
+
+[Protractor](https://www.protractortest.org).
+

index.js

@@ -0,0 +1,86 @@
+var path = require('path'),
+  fs = require('fs'),
+  mkdirp = require('mkdirp');
+
+var suites = {};
+var specs = {};
+var myReporter = {
+
+  suiteStarted: function(suite){
+    currentSuite = suite;
+    currentSuite.specs = []
+  },
+
+  suiteDone: function(suite) {
+    suites[suite.id] = suite
+  },
+
+  jasmineDone: function(){
+    this.onSingleFileOutput(suites)
+  },
+
+  specDone: function(spec) {
+    browser.getSession().then(function(session) {
+      spec.sessionID = session.getId();
+      currentSuite.specs.push(spec)
+      specs[spec.id] = spec
+    });
+  },
+
+  onSingleFileOutput: function (suites) {
+    const xml = this.prepareXml(suites)
+    let filename = `REPORT-browserstack.all.xml`
+    this.write(filename, xml)
+  },
+
+  prepareName: function(name = 'Skipped test') {
+    return name.split(/[^a-zA-Z0-9]+/).filter(
+      (item) => item && item.length
+    ).join('_')
+  },
+
+  prepareXml: function(suites){
+    var xmlbuilder = require('xmlbuilder');
+    const builder = xmlbuilder.create('testsuites', {encoding: 'UTF-8', allowSurrogateChars: true})
+    for (let suiteIndex in suites) {
+      const suite = suites[suiteIndex]
+      const suiteName = this.prepareName(suite.description)
+      const testSuite = builder.ele("testsuite", {name: suiteName})
+      for (let specIndex in suite.specs) {
+        const test = suite.specs[specIndex]
+        const testName = this.prepareName(test.description)
+        const testCase = testSuite.ele("testcase",{name: testName, id: `${suiteName}.${testName}{0}`, index: 0 });
+        testCase.ele("session", {}, test.sessionID);
+      }
+    }
+    return builder.end({ pretty: true});
+  },
+
+  write: function(filename, xml) {
+    var outputDir = "./browserstack-reports"
+    try {
+      const dir = path.resolve(outputDir)
+      const filepath = path.join(dir, filename)
+      mkdirp.sync(dir)
+      fs.writeFileSync(filepath, xml)
+      console.log(`Wrote xunit report "${filename}" to [${outputDir}].`)
+    } catch (e) {
+      console.log(`Failed to write xunit report "${filename}"
+       to [${outputDir}]. Error: ${e}`)
+    }
+  },
+
+  format: function(val) {
+      return JSON.stringify(baseReporter.limit(val))
+  }
+}
+
+var BrowserStackReporter = {
+  name: "browserstack-protractor-plugin",
+
+  onPrepare: function() {
+    jasmine.getEnv().addReporter(myReporter);
+  },
+}
+
+module.exports = BrowserStackReporter

package-lock.json

@@ -0,0 +1,23 @@
+{
+  "name": "browserstack-protractor-reporter",
+  "version": "0.1.0",
+  "description": "A Protractor plugin which enables BrowserStack reports on CI",
+  "main": "index.js",
+  "keywords": [
+    "protractor",
+    "browserstack",
+    "ci",
+    "selenium",
+    "report"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/browserstack/browserstack-protractor-reporter.git"
+  },
+  "author": "BrowserStack",
+  "license": "ISC",
+  "dependencies": {
+    "junit-report-builder": "^1.3.1",
+    "xmlbuilder": "^10.0.0"
+  }
+}