Skip to main content

Appium With WebDriverIO

In this documentation, you will learn how to configure and run your WebdriverIO automation testing scripts with Appium on LambdaTest, set the desired capabilities for appium testing, and other advanced features of LambdaTest.

Prerequisites​

  • Your LambdaTest Username and Access key.
  • Install npm from the official npm website.
  • Download and install NodeJS from official NodeJS website. You should be having NodeJS v6 or newer.
  • Make sure you are using the latest version of JavaScript.

Try our Sample Repository​

Step 1: Get a Sample Project​

You can use your own project to configure and test it. For demo purposes, we are using the sample repository.

Sample repo

All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. Image View on GitHub

Step 2: Setup the Environment Variables​

You need to export your environment variables LT_USERNAME and LT_ACCESS_KEY that are available in your LambdaTest Profile page. Run the below mentioned commands in your terminal to setup the environment variables.

export LT_USERNAME="undefined"
export LT_ACCESS_KEY="undefined"

Step 3: Upload your Application​

Upload your iOS application (.ipa file) or android application (.apk or .aab 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. Below is an example cURL request to upload your app using our REST API:

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

  • If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample apps, 🔗 Android app or 🔗 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.

Step 4: Update your Automation Script​

An automation script for the sample application available above has been provided here. Ensure to update the APP_URL, username and accesKey in your scripts inside specs directory the before running the tests.

specs/ios-test.js
describe("Proverbial APK", () => {
  it("Changes color", async () => {
    var color = await $("id=color");
    await color.waitForDisplayed({ timeout: 30000 });
    await color.click();
    await color.click();
  });

  it("Changes text", async () => {
    var text = await $("id=Text");
    await text.waitForDisplayed({ timeout: 30000 });
    await text.click();
  });

  it("Toast", async () => {
    var toast = await $("id=toast");
    await toast.waitForDisplayed({ timeout: 30000 });
    await toast.click();
  });

  it("Notification", async () => {
    var nf = await $("id=notification");
    await nf.waitForDisplayed({ timeout: 30000 });
    await nf.click();
  });

  it("Geolocation", async () => {
    var geo = await $("id=geoLocation");
    await geo.waitForDisplayed({ timeout: 30000 });
    await geo.click();

    driver.back();
  });

  it("SpeedTest", async () => {
    var st = await $("id=speedTest");
    await st.waitForDisplayed({ timeout: 30000 });
    await st.click();

    await browser.pause(10000);
    driver.back();
  });

  it("Browser", async () => {
    var browser = await $("id=Browser");
    await browser.waitForDisplayed({ timeout: 30000 });
    await browser.click();

    let el7 = await $("id=url");
    await el7.click();
    await el7.setValue("https://www.lambdatest.com/");
    driver.back();
  });
});

Step 5: Configure the Test Capabilities​

You need to update your capabilities in *.conf.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:

ios-sample/ios-single.conf.js
exports.config = {
  user: process.env.LT_USERNAME || "YOUR_USERNAME",
  key: process.env.LT_ACCESS_KEY || "YOUR_ACCESS_KEY",

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

  capabilities: [
    {
      build: "NodeJS WebDriverIO iOS",
      name: "Sample Test - WebDriverIO",
      isRealMobile: true,
      deviceName: "iPhone 13 Pro",
      platformVersion: "15",
      platformName: "iOS",
      app: "YOUR_APP_URL", //Enter your app (.ipa) url
    },
  ],

  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

Step 6: Execute and Monitor your Tests​

  • Navigate to the corresponding directory based on your app.
cd ios
  • Install the required dependencies using the following command:
npm i
  • Execute the following command to run your test on LambdaTest platform:
npm run single

Your test results would be displayed on the test console (or CLI if you are using terminal/cmd) and on the LambdaTest App Automation Dashboard.

Reference Guides​

Last updated on

Test across 3000+ combinations of browsers, real devices & OS.

Book Demo

Help and Support

Related Articles