Appium with WebdriverIO

Your guide to running tests using WebdriverIO on BrowserStack’s Appium Grid of 3000+ real devices.

Run tests on 3000+ real devices and desktop browsers

Prerequisites

You need to have BrowserStack Username and Access key, which you can find in your account settings. If you have not created an account yet, you can sign up for a Free Trial
Node.js 8.11.2+ installed on your system. You can download updated Node version from nodejs.org

Run sample build

Here’s how you can run a sample WebdriverIO test build in three simple steps on BrowserStack:

Clone the sample repository

Clone our sample repository and install the dependencies. You’ll need a developer environment with Node 12+.

      
            iOS
          
            android
          
          Copy
        
# Clone our sample repo and install dependencies
git clone -b sdk https://github.com/browserstack/webdriverio-appium-app-browserstack
cd webdriverio-appium-app-browserstack/ios
npm install
# Clone our sample repo and install dependencies
git clone -b sdk https://github.com/browserstack/webdriverio-appium-app-browserstack
cd webdriverio-appium-app-browserstack/android
npm install

Configure the test script

In order to test, you will need to configure a few parameters in the sample repository.

Set access credentials

Set userName and accessKey parameters using environment variables to authenticate your tests.

      
            macOS or Linux
          
            Windows
          
          Copy
        
# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
setx BROWSERSTACK_USERNAME "YOUR_USERNAME" 
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY" 
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

Select Android or iOS devices from a list of 150+ available combinations

Use one of our sample apps to run your first Appium test on BrowserStack App Automate. Choose from the options below:

Update the `test.conf.js` config file

The test.conf.js file located in the /examples/run-sample-test folder of your preferred project(android/ios) holds all the required capabilities to run your tests on BrowserStack. We recommend you to export your BrowserStack credentials using environment variables as mentioned in Step. 2.

Copy snippet

You can also pass regular expressions (regex) in deviceName and platformVersion capabilities if your device selection is more flexible. Check out how to use regular expressions to specify device attributes.