WebDriverIO With Appium

Blog   ⋅   Docs   ⋅   Learning Hub   ⋅   Newsletter   ⋅   Certifications   ⋅   YouTube

     

WebdriverIO is a framework for automating web and mobile applications. It makes it easier to interact with your app, and provides a set of plugins that help you create a scalable, robust and stable test suite. Perform WebDriverIO tests on LambdaTest's online cloud..

Learn the basics of Appium testing on the LambdaTest platform.

Table of Contents

• Pre-requisites
• Run Your First Test
• Executing The Tests

Pre-requisites

Before you can start performing App automation testing with Appium, you would need to follow these steps:

• Download and install NodeJS. You should be having NodeJS v6 or newer. Click here to download.
• Make sure you are using the latest version of JavaScript.
• Install npm from the official website by clicking here.

Clone The Sample Project

Clone the LambdaTest’s 🔗 LT-appium-nodejs-webdriverio repository and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/LT-appium-nodejs-webdriverio
cd LT-appium-nodejs-webdriverio

Setting Up Your Authentication

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest. To obtain your access credentials, purchase a plan or access the Automation Dashboard.

Set LambdaTest Username and Access Key in environment variables.

For Linux/macOS:

export LT_USERNAME=YOUR_LAMBDATEST_USERNAME \
export LT_ACCESS_KEY=YOUR_LAMBDATEST_ACCESS_KEY

For Windows:

set LT_USERNAME=YOUR_LAMBDATEST_USERNAME `
set LT_ACCESS_KEY=YOUR_LAMBDATEST_ACCESS_KEY

Upload Your Application

Upload your iOS application (.ipa file) or android application (.apk file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey in the cURL command for authentication. Make sure to add the path of the appFile in the cURL request. Here is an example cURL request to upload your app using our REST API:

Using App File:

For Linux/macOS:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" \
--location --request POST 'https://manual-api.lambdatest.com/app/upload/realDevice' \
--form 'name="Android_App"' \
--form 'appFile=@"/Users/macuser/Downloads/proverbial_android.apk"'

For Windows:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk""

Using App URL:

For Linux/macOS:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" \
--location --request POST 'https://manual-api.lambdatest.com/app/upload/realDevice' \
--form 'name="Android_App"' \
--form 'url="https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk"'

For Windows:

curl -u "YOUR_LAMBDATEST_USERNAME:YOUR_LAMBDATEST_ACCESS_KEY" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -d "{"url":"https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk","name":"sample.apk"}"

Tip:

• If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample 🔗 Android app or sample 🔗 iOS app.
• Response of above cURL will be a JSON object containing the App URL of the format - lt://APP123456789123456789 and will be used in the next step.

Run Your First Test

Once you are done with the above-mentioned steps, you can initiate your first WebDriverIO test on LambdaTest.

Test Scenario: Check out Android-test.js file to view the sample test script for android and iOS-test.js for iOS.

Configuring Your Test Capabilities

You need to update your capabilities in *.config.js files. In this sample project, we have provided the examples for running tests on both Android and iOS apps. You can find the configs for both iOS and Android in the iOS-sample and android-sample directories correspondingly. We are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object. You need to pass the path of your test script in specs object to run your own automation script. The capabilities object in the sample code for a single test are defined as:

exports.config = {
  user: process.env.LT_USERNAME || "YOUR_USERNAME",
  key: process.env.LT_ACCESS_KEY || "YOUR_ACCESS_KEY",

  updateJob: false,
  //highlight-next-line
  specs: ["specs/ios-test.js"], //path of your test script
  exclude: [],

  //highlight-start
  capabilities: [
    {
      build: "NodeJS WebDriverIO iOS",
      name: "Sample Test - WebDriverIO",
      isRealMobile: true,
      deviceName: "iPhone 13 Pro",
      platformVersion: "15",
      platformName: "iOS",
      app: "YOUR_APP_URL",
    },
  ],
  //highlight-end

  logLevel: "info",
  coloredLogs: true,
  screenshotPath: "./errorShots/",
  baseUrl: "",
  waitforTimeout: 10000,
  connectionRetryTimeout: 90000,
  connectionRetryCount: 3,
  path: "/wd/hub",
  hostname: "mobile-hub.lambdatest.com",
  port: 80,

  framework: "mocha",
  mochaOpts: {
    ui: "bdd",
    timeout: 20000,
  },
};

exports.config = {
  user: process.env.LT_USERNAME || "YOUR_USERNAME",
  key: process.env.LT_ACCESS_KEY || "YOUR_ACCESS_KEY",

  updateJob: false,
  //highlight-next-line
  specs: ["specs/android-test.js"], //path of your test script
  exclude: [],

  //highlight-start
  capabilities: [
    {
      build: "NodeJS WebDriverIO Android",
      name: "Sample Test - WebDriverIO",
      isRealMobile: true,
      platformName: "Android",
      deviceName: "Galaxy S9",
      platformVersion: "10",
      app: "YOUR_APP_URL",
    },
  ],
  //highlight-end

  logLevel: "info",
  coloredLogs: true,
  screenshotPath: "./errorShots/",
  baseUrl: "",
  waitforTimeout: 10000,
  connectionRetryTimeout: 90000,
  connectionRetryCount: 3,
  path: "/wd/hub",
  hostname: "mobile-hub.lambdatest.com",
  port: 80,

  framework: "mocha",
  mochaOpts: {
    ui: "bdd",
    timeout: 20000,
  },
};

Info Note:

• You must add the generated APP_URL to the "app" capability in the config file.
• You can generate capabilities for your test requirements with the help of our inbuilt 🔗 Capabilities Generator tool. A more Detailed Capability Guide is available here 📄 .

Executing The Tests

Step-5: To Run Android Test

cd android-sample

Step-6: Install the required dependencies using the following command:

npm i

Step-7: Execute the following command to run your test on LambdaTest platform:

Single:

• MacOS/Linux/Windows*

npm run SingleAndroidApp

Parallel:

• MacOS/Linux/Windows*

npm run parallel

Info: Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on the 🔗 LambdaTest App Automation Dashboard.

Additional Links

• Advanced Configuration for Capabilities
• How to test locally hosted apps
• How to integrate LambdaTest with CI/CD

Documentation & Resources 📚

Visit the following links to learn more about LambdaTest's features, setup and tutorials around test automation, mobile app testing, responsive testing, and manual testing.

• LambdaTest Documentation
• LambdaTest Blog
• LambdaTest Learning Hub

LambdaTest Community 👥

The LambdaTest Community allows people to interact with tech enthusiasts. Connect, ask questions, and learn from tech-savvy people. Discuss best practises in web development, testing, and DevOps with professionals from across the globe 🌎

What's New At LambdaTest ❓

To stay updated with the latest features and product add-ons, visit Changelog

About LambdaTest

LambdaTest is a leading test execution and orchestration platform that is fast, reliable, scalable, and secure. It allows users to run both manual and automated testing of web and mobile apps across 3000+ different browsers, operating systems, and real device combinations. Using LambdaTest, businesses can ensure quicker developer feedback and hence achieve faster go to market. Over 500 enterprises and 1 Million + users across 130+ countries rely on LambdaTest for their testing needs.

Features

• Run Selenium, Cypress, Puppeteer, Playwright, and Appium automation tests across 3000+ real desktop and mobile environments.
• Real-time cross browser testing on 3000+ environments.
• Test on Real device cloud
• Blazing fast test automation with HyperExecute
• Accelerate testing, shorten job times and get faster feedback on code changes with Test At Scale.
• Smart Visual Regression Testing on cloud
• 120+ third-party integrations with your favorite tool for CI/CD, Project Management, Codeless Automation, and more.
• Automated Screenshot testing across multiple browsers in a single click.
• Local testing of web and mobile apps.
• Online Accessibility Testing across 3000+ desktop and mobile browsers, browser versions, and operating systems.
• Geolocation testing of web and mobile apps across 53+ countries.
• LT Browser - for responsive testing across 50+ pre-installed mobile, tablets, desktop, and laptop viewports

We are here to help you 🎧

• Got a query? we are available 24x7 to help. Contact Us
• For more info, visit - LambdaTest