/wdio-lambdatest-service

WebdriverIO LambdaTest Service

Primary LanguageTypeScript

WebdriverIO LambdaTest Service

WDIO health check

A WebdriverIO service that manages tunnel and job metadata for LambdaTest users.

This is a fork of the wdio-lambdatest-service service that adds session naming options from the wdio-browserstack-service service.

Installation

npm i @scg82/wdio-lambdatest-service --save-dev

Instructions on how to install WebdriverIO can be found here.

Configuration

WebdriverIO has LambdaTest support out of the box. You should simply set user and key in your wdio.conf.js file. To enable the feature for app automation, set product: 'appAutomation' in your wdio.conf.js file. This service plugin provides supports for LambdaTest Tunnel. Set tunnel: true also to activate this feature.

// wdio.conf.js
exports.config = {
    // ...
    user: process.env.LT_USERNAME,
    key: process.env.LT_ACCESS_KEY,
    logFile : './logDir/api.log',
    services: [
        ['lambdatest', {
            tunnel: true
        }]
    ],
    // ...
};

Options

In order to authorize to the LambdaTest service your config needs to contain a user and 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
Default: false

lambdatestOpts

Specified optional will be passed down to LambdaTest Tunnel. See this list for details.

Type: Object
Default: {}

preferScenarioName

Cucumber only. Set the session name to the Scenario name if only a single Scenario ran. Useful when running in parallel with wdio-cucumber-parallel-execution.

Type: Boolean
Default: false

sessionNameFormat

Customize the session name format.

Type: Function
Default (Cucumber/Jasmine): (config, capabilities, suiteTitle) => suiteTitle
Default (Mocha): (config, capabilities, suiteTitle, testTitle) => suiteTitle + ' - ' + testTitle

sessionNameOmitTestTitle

Mocha only. Do not append the test title to the session name.

Type: Boolean
Default: false

sessionNamePrependTopLevelSuiteTitle

Mocha only. Prepend the top level suite title to the session name.

Type: Boolean
Default: false

setSessionName

Automatically set the session name.

Type: Boolean
Default: true

setSessionStatus

Automatically set the session status (passed/failed).

Type: Boolean
Default: true

Steps to compile and publish

  1. git clone this repository.
  2. run "npm install"
  3. run "npm run build"
  4. Steps to Publish: run "npm login"
  5. run "npm publish --access public"

For more information on WebdriverIO see the homepage.