initialize the bs helper

Author: kobenguyent

.DS_Store

@@ -0,0 +1,61 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 PeterNgTr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,88 @@
+/**
+ * Browserstack Helper for Codeceptjs
+ *
+ * @author PeterNgTr
+ */
+class BrowserstackHelper extends Helper {
+
+    constructor(config) {
+        super(config);
+    }
+
+    /**
+     *
+     * @param sessionId Session ID for current Test browser session
+     * @param data      Test name, etc
+     * @private
+     */
+    _updateBuild(sessionId, data) {
+        this.helpers['REST']._executeRequest({
+            url: `https://api.browserstack.com/automate/sessions/${sessionId}.json`,
+            method: 'put',
+            data: data,
+            auth: {
+                'username': this.config.user,
+                'password': this.config.key
+            }
+        });
+
+        this._exposeBuildLink(sessionId);
+    }
+
+    /**
+     *
+     * @param sessionId Session ID for current Test browser session
+     * @private
+     */
+    _exposeBuildLink(sessionId) {
+        this.helpers['REST']._executeRequest({
+            url: `https://api.browserstack.com/automate/sessions/${sessionId}.json`,
+            method: 'get',
+            auth: {
+                'username': this.config.user,
+                'password': this.config.key
+            }
+        }).then(res => {
+            const bs_url = `Test finished. Link to job: ${res.data.automation_session.public_url}`;
+            console.log(bs_url);
+        });
+    }
+
+    /**
+     * Helper function gets called if the test is passing
+     * @param test
+     * @private
+     */
+    _passed(test) {
+        console.log("Test has Passed");
+        const sessionId = this._getSessionId();
+        this._updateBuild(sessionId, { 'status': 'passed', 'name': test.title });
+    }
+
+    /**
+     * Helper function gets called if the test execution fails
+     * @param test
+     * @param error
+     * @private
+     */
+    _failed(test, error) {
+        console.log("Test has failed");
+        const sessionId = this._getSessionId();
+        this._updateBuild(sessionId, { 'status': 'failed', 'name': test.title });
+    }
+
+    _getSessionId() {
+        if (this.helpers['WebDriver']) {
+            return this.helpers['WebDriver'].browser.sessionId;
+        }
+        if (this.helpers['Appium']) {
+            return this.helpers['Appium'].browser.sessionId;
+        }
+        if (this.helpers['WebDriverIO']) {
+            return this.helpers['WebDriverIO'].browser.requestHandler.sessionID;
+        }
+        throw new Error('No matching helper found. Supported helpers: WebDriver/Appium/WebDriverIO');
+    }
+}
+
+module.exports = BrowserstackHelper;

index.js

@@ -0,0 +1,18 @@
+{
+  "name": "codeceptjs-bshelper",
+  "version": "1.0.0",
+  "description": "Browserstack Result Publisher for Codecept JS tests",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:PeterNgTr/codeceptjs-bshelper.git"
+  },
+  "keywords": [
+    "codeceptJS",
+    "codeceptjs",
+    "browserstack",
+    "codeceptjs-browserstack",
+    "codeceptjs-bs"
+  ],
+  "author": "Thanh Nguyen <peter.nguyentr@gmail.com>",
+  "license": "MIT"
+}

package.json

@@ -0,0 +1,27 @@
+# codeceptjs-bshelper
+CodeceptJS Browserstack helper, to update Test Names, Test Results after execution 
+
+codeceptjs-bshelper is [CodeceptJS](https://codecept.io/) helper which is to complete tests results on Browserstack after execution. The helper allows to update test name and
+test results on Browserstack using the `_passed` and `_failed` hooks accessible in the helper.
+
+NPM package: https://www.npmjs.com/package/codeceptjs-bshelper
+
+### Configuration
+
+This helper should be added in codecept.json/codecept.conf.js
+
+Example:
+
+```json
+{
+   "helpers": {
+     "BrowserstackHelper": {
+      "require": "codeceptjs-bshelper",
+      "user": "BROWSERSTACK_USERNAME",
+      "key": "BROWSERSTACK_ACCESS_KEY"
+    },
+    "REST: {}
+   }
+}
+```
+To use this helper, users must provide the Browserstack User, Key & Host as part of the configuration.