Skip to main content

Appium with Nodejs

In this documentation, you will learn how to configure and run your NodeJS 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 the code scripts before running the tests.

iOS.js
var wd = require("wd");
var assert = require("assert");
var asserter = wd.asserters;
username =
process.env.LT_USERNAME == undefined
? "username" //Enter the username here
: process.env.LT_USERNAME;
accesskey =
process.env.LT_ACCESS_KEY == undefined
? "access_key" //Enter the access_key here
: process.env.LT_ACCESS_KEY;

desired_capabilities = {
deviceName: "iPhone 12",
platformVersion: "14",
platformName: "iOS",
isRealMobile: true,
app: "APP_URL", //Enter the app (.ipa) url
visual: true,
video: true,
build: "NodeJS Vanilla - iOS",
name: "Sample Test - NodeJS",
};

driver = wd.promiseRemote(
`https://${username}:${accesskey}@mobile-hub.lambdatest.com/wd/hub`
);

async function iOStest() {
try {
driver
.init(desired_capabilities)
.then(function () {
return driver.waitForElementById("color", 10000);
})
.then(function (color) {
return color.click();
})
.then(function () {
return driver.waitForElementById("Text", 10000);
})
.then(function (text) {
text.click();
return driver.waitForElementById("toast", 10000);
})
.then(function (toast) {
toast.click();
return driver.waitForElementById("notification", 10000);
})
.then(function (notification) {
notification.click();
return driver.waitForElementById("geoLocation", 10000);
})
.then(function (geoLocation) {
return geoLocation.click();
})
.then(async function () {
return driver.waitForElementById("Back", 10000);
})
.then(function (Back) {
Back.click();
return driver.waitForElementById("speedTest", 10000);
})
.then(async function (speedTest) {
speedTest.click();
return driver.waitForElementById("Back", 10000);
})
.then(function (back) {
back.click();
return driver.waitForElementById("Browser", 10000);
})
.then(function (Browser) {
Browser.click();
return driver.waitForElementById("url", 10000);
})
.then(function (url) {
url.type("https://www.lambdatest.com");
return driver.waitForElementById("find", 10000);
})
.then(function (find) {
find.click();
driver.quit();
});
} catch (e) {
driver.quit();
}
}

iOStest();

Step 5: Configure the Test Capabilities

You can update your custom capabilities in test scripts. In this sample project, 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.

The capabilities object in the sample code are defined as:

desired_capabilities = {
deviceName: "iPhone 12",
platformVersion: "14",
platformName: "iOS",
isRealMobile: true,
app: "APP_URL", //Enter the app (.ipa) url
visual: true,
video: true,
build: "NodeJS Vanilla - iOS",
name: "Sample Test - NodeJS",
};
info

Step 6: Execute and Monitor your Tests

  • Run the following commands to install the required dependencies:

    npm i wd
  • The tests can be executed in the terminal using the following command:

    node IOS.js

    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

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

Book Demo