wdio-lambdatest-service for webdriverio

Author: kanhaiya

.eslintrc.js

@@ -0,0 +1,44 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:import/errors',
+    'plugin:import/warnings'
+  ],
+  env: {
+    node: true,
+    es6: true
+  },
+  parser: 'babel-eslint',
+  parserOptions: {
+    ecmaVersion: 2016,
+    sourceType: 'module'
+  },
+  rules: {
+    semi: ['error', 'never'],
+    quotes: ['error', 'single'],
+    indent: [2, 4],
+
+    'import/no-unresolved': [2, { commonjs: true, amd: true }],
+    'import/named': 2,
+    'import/namespace': 2,
+    'import/default': 2,
+    'import/export': 2,
+
+    'no-multiple-empty-lines': [2, {'max': 1, 'maxEOF': 1}],
+    'array-bracket-spacing': ['error', 'never'],
+    'brace-style': ['error', '1tbs', { allowSingleLine: true }],
+    camelcase: ['error', { properties: 'never' }],
+    'comma-spacing': ['error', { before: false, after: true }],
+    'no-lonely-if': 'error',
+    'no-else-return': 'error',
+    'no-tabs': 'error',
+    'no-trailing-spaces': ['error', {
+      skipBlankLines: false,
+      ignoreComments: false
+    }],
+    quotes: ['error', 'single', { avoidEscape: true }],
+    'unicode-bom': ['error', 'never'],
+    'object-curly-spacing': ['error', 'always'],
+    'require-atomic-updates': 0
+  }
+}

.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+*.log
+build/
+coverage/
+.eslintcache

.npmignore

@@ -0,0 +1,6 @@
+src
+coverage
+node_modules
+tests
+*.log
+.eslintcache

.npmrc

@@ -0,0 +1 @@
+message = "wdio-lambdatest-service: bump version %s"

README.md

@@ -1,2 +1,65 @@
-# wdio-lambdatest-service
 WebdriverIO LambdaTest Service
+========================
+
+> A WebdriverIO service that manages tunnel and job metadata for LambdaTest users.
+
+## Installation
+
+
+The easiest way is to keep `wdio-lambdatest-service` as a devDependency in your `package.json`.
+
+```json
+{
+    "devDependencies": {
+        "wdio-lambdatest-service": "^1.0.0"
+    }
+}
+```
+
+You can simple do it by:
+
+```bash
+npm i wdio-lambdatest-service --save-dev
+```
+
+Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html)
+
+
+## Configuration
+
+WebdriverIO has LambdaTest support out of the box. You should simply set `user` and `key` in your `wdio.conf.js` file. This service plugin provides supports for [LambdaTest Tunnel](https://www.lambdatest.com/support/docs/troubleshooting-lambda-tunnel/). Set `tunnel: true` also to activate this feature.
+
+```js
+// wdio.conf.js
+export.config = {
+    // ...
+    user: process.env.LT_USERNAME,
+    key: process.env.LT_ACCESS_KEY,
+    services: [
+        ['lambdatest', {
+            tunnel: true
+        }]
+    ],
+    // ...
+};
+```
+
+## Options
+
+In order to authorize to the LambdaTest service your config needs to contain a [`user`](https://webdriver.io/docs/options.html#user) and [`key`](https://webdriver.io/docs/options.html#key) option.
+
+### tunnel
+Set this to true to enable routing connections from LambdaTest cloud through your computer. You will also need to set `tunnel` to true in browser capabilities.
+
+Type: `Boolean`<br>
+Default: `false`
+
+### lambdatestOpts
+Specified optional will be passed down to LambdaTest Tunnel. See [this list](https://www.lambdatest.com/support/docs/lambda-tunnel-modifiers/) for details.
+
+Type: `Object`<br>
+Default: `{}`
+
+----
+
+For more information on WebdriverIO see the [homepage](https://webdriver.io).

babel.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+    presets: [
+        ['@babel/preset-env', {
+            targets: {
+                node: 8
+            }
+        }]
+    ],
+    plugins: [
+        '@babel/plugin-proposal-function-bind',
+        '@babel/plugin-proposal-class-properties',
+        '@babel/plugin-proposal-optional-catch-binding'
+    ],
+    env: {
+        development: {
+            sourceMaps: 'inline',
+            plugins: ['source-map-support']
+        }
+    },
+    comments: false
+}

package.json

@@ -0,0 +1,118 @@
+{
+  "name": "wdio-lambdatest-service",
+  "version": "1.0.0",
+  "description": "A WebdriverIO service that manages tunnel and job metadata for LambdaTest.",
+  "author": "LambdaTest <[email protected]>",
+  "contributors": [
+    "LambdaTest <[email protected]> (https://www.npmjs.com/~lambdatestdev)"
+  ],
+  "homepage": "https://github.com/LambdaTest/wdio-lambdatest-service",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/LambdaTest/wdio-lambdatest-service.git"
+  },
+  "license": "MIT",
+  "main": "./build/index",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "scripts": {
+    "build": "run-s clean compile",
+    "clean": "rimraf ./build",
+    "compile": "babel src/ -d build/ --config-file ./babel.config.js",
+    "test": "run-s test:*",
+    "test:eslint": "eslint --cache src tests",
+    "test:coverage": "jest --coverage"
+  },
+  "keywords": [
+    "webdriver",
+    "wdio",
+    "wdio-service",
+    "lambdatest"
+  ],
+  "bugs": {
+    "url": "https://github.com/LambdaTest/wdio-lambdatest-service/issues"
+  },
+  "dependencies": {
+    "@wdio/logger": "6.0.0-alpha.0",
+    "@lambdatest/node-tunnel": "*",
+    "@lambdatest/node-rest-client": "*"
+  },
+  "peerDependencies": {
+    "@wdio/cli": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.6.2",
+    "@babel/core": "^7.6.2",
+    "@babel/node": "^7.6.2",
+    "@babel/plugin-proposal-class-properties": "^7.5.5",
+    "@babel/plugin-proposal-function-bind": "^7.2.0",
+    "@babel/plugin-proposal-optional-catch-binding": "^7.2.0",
+    "@babel/plugin-syntax-export-default-from": "^7.2.0",
+    "@babel/preset-env": "^7.6.2",
+    "@babel/register": "^7.6.2",
+    "@octokit/rest": "^16.35.2",
+    "@types/jest": "^24.0.18",
+    "aws-sdk": "^2.539.0",
+    "babel-core": "^6.26.3",
+    "babel-eslint": "^10.0.3",
+    "babel-jest": "^24.9.0",
+    "babel-plugin-source-map-support": "^2.1.1",
+    "cheerio": "^1.0.0-rc.3",
+    "codecov": "^3.6.1",
+    "copyfiles": "^2.1.1",
+    "cucumber": "^5.1.0",
+    "del": "^5.1.0",
+    "dox": "^0.9.0",
+    "eslint": "^6.5.1",
+    "eslint-plugin-import": "^2.18.2",
+    "husky": "^3.0.7",
+    "inquirer": "^7.0.0",
+    "jest": "^24.9.0",
+    "lerna": "^3.16.4",
+    "lerna-changelog": "^1.0.0",
+    "markdox": "^0.1.10",
+    "mime-types": "^2.1.24",
+    "np": "^5.1.0",
+    "npm-run-all": "^4.1.5",
+    "recursive-readdir": "^2.2.2",
+    "rimraf": "^3.0.0",
+    "shelljs": "^0.8.3",
+    "source-map-support": "^0.5.13",
+    "tempy": "^0.3.0",
+    "typescript": "^3.6.3"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "git diff-index --name-only --diff-filter=d HEAD | grep -E \"(.*)\\.js$\" | xargs node_modules/eslint/bin/eslint.js -c .eslintrc.js",
+      "pre-push": "npm run test:eslint"
+    }
+  },
+  "jest": {
+    "testMatch": [
+      "<rootDir>/tests/*.test.js"
+    ],
+    "coverageDirectory": "./coverage/",
+    "collectCoverage": true,
+    "coverageThreshold": {
+      "global": {
+        "branches": 80,
+        "functions": 95,
+        "lines": 95,
+        "statements": 95
+      }
+    },
+    "testEnvironment": "node",
+    "coveragePathIgnorePatterns": [
+      "node_modules/"
+    ]
+  },
+  "greenkeeper": {
+    "lockfiles": {
+      "outOfRangeUpdatesOnly": true
+    }
+  }
+}

src/constants.js

@@ -0,0 +1,3 @@
+export const TUNNEL_STOP_FAILED = 'LambdaTest Tunnel failed to stop within 60 seconds!'
+export const TUNNEL_START_FAILED = 'LambdaTest Tunnel failed to start within 60 seconds!'
+export const TUNNEL_STOP_TIMEOUT = 60000

src/index.js

@@ -0,0 +1,5 @@
+import LambdaTestLauncher from './launcher'
+import LambdaTestService from './service'
+
+export default LambdaTestService
+export const launcher = LambdaTestLauncher

src/launcher.js

@@ -0,0 +1,112 @@
+import { performance, PerformanceObserver } from 'perf_hooks'
+import logger from '@wdio/logger'
+import LambdaTestTunnelLauncher from '@lambdatest/node-tunnel'
+import { TUNNEL_START_FAILED, TUNNEL_STOP_FAILED, TUNNEL_STOP_TIMEOUT } from './constants'
+const log = logger('@wdio/lambdatest-service')
+export default class LambdaTestLauncher {
+    constructor(options) {
+        this.options = options
+    }
+
+    // modify config and launch tunnel
+    onPrepare(config, capabilities) {
+        if (!this.options.tunnel) {
+            return
+        }
+
+        const tunnelArguments = {
+            user: config.user,
+            key: config.key,
+            ...this.options.lambdatestOpts
+        }
+
+        this.lambdatestTunnelProcess = new LambdaTestTunnelLauncher()
+
+        if (Array.isArray(capabilities)) {
+            capabilities.forEach(capability => {
+                capability.tunnel = true
+            })
+        } else if (typeof capabilities === 'object') {
+            capabilities.tunnel = true
+        }
+        // measure LT boot time
+        const obs = new PerformanceObserver(list => {
+            const entry = list.getEntries()[0]
+            log.info(
+                `LambdaTest Tunnel successfully started after ${entry.duration}ms`
+            )
+        })
+        obs.observe({ entryTypes: ['measure'], buffered: false })
+
+        let timer
+        performance.mark('ltTunnelStart')
+        return Promise.race([
+            new Promise((resolve, reject) => {
+                this.lambdatestTunnelProcess.start(tunnelArguments, err => {
+                    if (err) return reject(err)
+                    /* istanbul ignore next */
+                    this.lambdatestTunnelProcess.getTunnelName(tunnelName => {
+                        if (Array.isArray(capabilities)) {
+                            capabilities.forEach(capability => {
+                                capability.tunnelName = tunnelName
+                            })
+                        } else if (typeof capabilities === 'object') {
+                            capabilities.tunnelName = tunnelName
+                        }
+                        resolve()
+                    })
+                })
+            }),
+            new Promise((resolve, reject) => {
+                /* istanbul ignore next */
+                timer = setTimeout(() => { reject( new Error(TUNNEL_START_FAILED)) }, TUNNEL_STOP_TIMEOUT)
+            })
+        ]).then(
+            /* istanbul ignore next */
+            (result) => {
+                clearTimeout(timer)
+                performance.mark('ltTunnelEnd')
+                performance.measure('bootTime', 'ltTunnelStart', 'ltTunnelEnd')
+                return Promise.resolve(result)
+            },
+            (err) => {
+                clearTimeout(timer)
+                return Promise.reject(err)
+            }
+        )
+    }
+
+    onComplete() {
+        if (
+            !this.lambdatestTunnelProcess ||
+            typeof this.lambdatestTunnelProcess.isRunning !== 'function' ||
+            !this.lambdatestTunnelProcess.isRunning()
+        ) {
+            return
+        }
+
+        let timer
+        return Promise.race([
+            new Promise((resolve, reject) => {
+                this.lambdatestTunnelProcess.stop(err => {
+                    if (err) return reject(err)
+                    resolve()
+                })
+            }),
+            new Promise((resolve, reject) => {
+                /* istanbul ignore next */
+                timer = setTimeout(() => reject( new Error(TUNNEL_STOP_FAILED)), TUNNEL_STOP_TIMEOUT)
+            })
+        ]).then(
+            () => {
+                clearTimeout(timer)
+                return Promise.resolve()
+            },
+            /* istanbul ignore next */
+            (err) => {
+                clearTimeout(timer)
+                return Promise.reject(err)
+            }
+        )
+    }
+}