No longer need to launch Appium manually for Webdriver.io
Switch branches/tags
Nothing to show
Clone or download
Latest commit 699837b Jan 24, 2018

README.md

Webdriver.io service plugin for Appium

Build Status

webdriver.io service plugin for Appium. With this service installed, you need not to run Appium manually.

Installation

The easiest way is to keep wdio-appium-service as a devDependency in your package.json.

{
  "devDependencies": {
    "wdio-appium-service": "~0.2.2"
  }
}

You can do this simply by adding it with:

npm install wdio-appium-service --save-dev

How to Use

Please register this package as service plugin and specify command line arguments in wdio.conf. 'appium' is used for command. If command key is provided in the configuration, it will be used.

{
  ... // Other config

  services: ['appium'],

  appium: {
    args: {
      address: '127.0.0.1',
      commandTimeout: '7200',
      sessionOverride: true,
      debugLogSpacing: true,
      platformVersion: '9.1',
      platformName: 'iOS',
      showIosLog: true,
      deviceName: 'iPhone 6',
      nativeInstrumentsLib: true,
      isolateSimDevice: true,
      app: APP_PATH
    }
  }
}

For args, you can specify keys in lowerCamel. Its values are interpreted as its value. If value is boolean, true means specifying the key and false means not specifying. More information about available args can be found in appium github.

In Appium 1.5 new default capablities flag was introduced whcih simplify settings.

For example, platformVersion: '9.1' will be converted to --platform-version=9.1, sessionOverride: true will be --session-override, showIosLog: false will specify nothing.

Debug Log

If NODE_ENV environment variable is set to debug, this service plugin dumps debug log to wdio_appium_service_debug_log.txt.

License

This software is distributed under the MIT license.