Skip to content

Files

Latest commit

 

History

History
453 lines (369 loc) · 14.1 KB

appium-nodejs.md

File metadata and controls

453 lines (369 loc) · 14.1 KB
id title sidebar_label description keywords image url site_name slug
appium-nodejs
NodeJS With Appium
NodeJS
Optimize your Appium automation with Node.js using LambdaTest's comprehensive support documentation.
appium
java
lambdatest java
framework on lambdatest
testng
app testing
real devices
/assets/images/og-images/appium-testing-og-image.jpg
LambdaTest
appium-nodejs/
<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify({ "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{ "@type": "ListItem", "position": 1, "name": "Home", "item": "https://www.lambdatest.com" },{ "@type": "ListItem", "position": 2, "name": "Support", "item": "https://www.lambdatest.com/support/docs/" },{ "@type": "ListItem", "position": 3, "name": "WebDriverIO With Appium", "item": "https://www.lambdatest.com/support/docs/appium-nodejs/" }] }) }} ></script>

import CodeBlock from '@theme/CodeBlock'; import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Tutorial To Run Your First Test On LambdaTest

In this topic, you will learn how to configure and run your NodeJS automation testing scripts with Appium on LambdaTest Real Device Cloud platform.

Objective

By the end of this topic, you will be able to:

  1. Run a sample automation script of NodeJS for application testing with Appium on LambdaTest.
  2. Learn more about Desired Capabilities for Appium testing.
  3. Explore advanced features of LambdaTest.

:::tip 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. <img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub

:::

Pre-requisites

Before you can start performing App automation testing with Appium, please make sure:

  • You have access to LambdaTest username and accessKey. If you have not registered yet, you can do the same by visiting our website. You will be able to access the credentials in the LambdaTest Profile
  • 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.
  • Install npm from the official npm website.

Run your first test

1. 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 from System:

{`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"" -F "name="proverbial_app"" `}

Using App URL:

{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=:https://prod-mobile-artefacts.lambdatest.com/assets/docs/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 🔗 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.

:::

2. Clone the sample project

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

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

3. Set 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. Then, set LambdaTest Username and Access Key in environment variables with following commands.

{`export LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \\ export LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}
{`set LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \` set LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}

4. Write 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.

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

desired_capabilities = {
  deviceName: "iPhone 12",
  platformVersion: "14",
  platformName: "iOS",
  isRealMobile: true,
  //highlight-next-line
  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();
const wd = require("wd");
//highlight-next-line
const username = process.env.LT_USERNAME || "username"; //Add username here

const accessKey = process.env.LT_ACCESS_KEY || "accessKey"; //Add accessKey here

const desiredCapabilities = {
  app: "APP_URL", // Enter the app (.apk) url
  build: "NodeJS - Android",
  name: "Sample Test NodeJS",
  deviceName: "Galaxy S20",
  isRealMobile: true,
  platformName: "android",
  platformVersion: "11",
  video: true,
  visual: true,
};

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

const DEFAULT_TIMEOUT = 10000;

async function runAndroidTest() {
  try {
    driver
      .init(desiredCapabilities)
      .then(function () {
        return driver.waitForElementById("color", DEFAULT_TIMEOUT);
      })
      .then(function (colorButton) {
        return colorButton.click();
      })
      .then(function () {
        return driver.waitForElementById("Text", DEFAULT_TIMEOUT);
      })
      .then(function (text) {
        text.click();
        return driver.waitForElementById("toast", DEFAULT_TIMEOUT);
      })
      .then(function (toast) {
        toast.click();
        return driver.waitForElementById("notification", DEFAULT_TIMEOUT);
      })
      .then(function (notification) {
        notification.click();
        return driver.waitForElementById("geoLocation", DEFAULT_TIMEOUT);
      })
      .then(function (geoLocation) {
        geoLocation.click();
        return driver.waitForElementById("buttonPage", DEFAULT_TIMEOUT);
      })
      .then(function (Home) {
        Home.click();
        return driver.waitForElementById("speedTest", DEFAULT_TIMEOUT);
      })
      .then(function (speedTest) {
        speedTest.click();
        return driver.waitForElementById("webview", DEFAULT_TIMEOUT);
      })
      .then(function (Browser) {
        Browser.click();
        return driver.waitForElementById("url", DEFAULT_TIMEOUT);
      })
      .then(function (url) {
        url.type("https://www.lambdatest.com");
        return driver.waitForElementById("find", DEFAULT_TIMEOUT);
      })
      .then(function (find) {
        find.click();
        driver.quit();
      });
  } catch (e) {
    driver.quit();
  }
}

runAndroidTest();

Configure the test capabilities

You can update your custom capabilities in the scripts. In our sample script, 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 for a single test are defined as:

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

:::info Note

:::

5. Execute your test case

  1. Execute the following commands to install the required dependencies:
npm i wd
  1. The tests can be executed in the terminal using the following command:
node Android.js
node IOS.js

:::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