No Result Found

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+.

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.

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:

Platform

Select an OS to choose the devices from below
Parallel thread #1
Parallel thread #2
Parallel thread #3

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.

test.conf.js
Github icon View on Github
Copy icon Copy

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.

Execute the build on BrowserStack

You are now ready to run your build on BrowserStack. From the root directory of this project, run the following command.

Copy icon Copy

After you run your test, visit the App Automate dashboard to view your test results.

Next steps

Once you have successfully run the sample test on BrowserStack, you might want to check the following:

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

  • ON THIS PAGE

    Is this page helping you?

    Yes
    No

    We're sorry to hear that. Please share your feedback so we can do better

    Contact our Support team for immediate help while we work on improving our docs.

    We're continuously improving our docs. We'd love to know what you liked





    Thank you for your valuable feedback!

    Talk to an Expert
    Download Copy Check Circle