Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lambdatest/lt-appium-nodejs

Run Node.js and Appium scripts on LambdaTest automation cloud. A sample repo to help you run Node.js framework based test scripts in parallel with LambdaTest
https://github.com/lambdatest/lt-appium-nodejs

android-automation app-automation appium appium-node ios-automation javascript javascript-nodejs mobile-app-testing

Last synced: 20 days ago
JSON representation

Run Node.js and Appium scripts on LambdaTest automation cloud. A sample repo to help you run Node.js framework based test scripts in parallel with LambdaTest

Awesome Lists containing this project

README 

        
# Node.js With Appium ![pw](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)












  Blog

    ⋅  

  Docs

    ⋅  

  Learning Hub

    ⋅  

  Newsletter

    ⋅  

  Certifications

    ⋅  

  YouTube



 

 

 



_Appium is a tool for automating native, mobile web, and hybrid applications on iOS, Android, and Windows platforms. It supports iOS native apps written in Objective-C or Swift and Android native apps written in Java or Kotlin. It also supports mobile web apps accessed using a mobile browser (Appium supports Safari on iOS and Chrome or the built-in 'Browser' app on Android). Perform Appium automation tests on [LambdaTest's online cloud](https://www.lambdatest.com/mobile-app-testing/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs)._



_Learn the basics of [Appium testing on the LambdaTest platform](https://www.lambdatest.com/support/docs/getting-started-with-appium-testing/)._



[](https://accounts.lambdatest.com/register)



## Table of Contents



- [Pre-requisites](#pre-requisites)

- [Run Your First Test](#run-your-first-test)

- [Executing The Tests](#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](https://nodejs.org/en/) to download.

- Make sure you are using the latest version of **JavaScript**.

- Install **npm** from the official website by clicking [here](https://www.npmjs.com/).

- Note: WD only works with appium 1 for appium 2 please use WDIO https://github.com/admc/wd



### Clone The Sample Project



Clone the LambdaTest’s :link: [LT-appium-nodejs](https://github.com/LambdaTest/LT-appium-nodejs) repository and navigate to the code directory as shown below:



```bash

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

cd LT-appium-nodejs

```



### 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](https://billing.lambdatest.com/billing/plans/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs) or access the [Automation Dashboard](https://appautomation.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs).



Set LambdaTest `Username` and `Access Key` in environment variables.



**For Linux/macOS:**



```bash

export LT_USERNAME="YOUR_LAMBDATEST_USERNAME" \

export LT_ACCESS_KEY="YOUR_LAMBDATEST_ACCESS_KEY"

```



**For Windows:**



```powershell

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



```bash

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



```powershell

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



```bash

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



```powershell

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 :link: [Android app](https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk) or sample :link: [iOS app](https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_ios.ipa).

> - Response of above cURL will be a **JSON** object containing the `App URL` of the format -  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 JUnit test on LambdaTest.



Test Scenario: Check out [Android.js](https://github.com/LambdaTest/LT-appium-nodejs/blob/master/Android.js) file to view the sample test script for android and [iOS.js](https://github.com/LambdaTest/LT-appium-nodejs/blob/master/IOS.js) for iOS.



### Configuring Your 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:



**iOS:**



```javascript

desired_capabilities = {

  deviceName: "iPhone 12",

  platformVersion: "14",

  platformName: "iOS",

  isRealMobile: true,

  app: "lt://", //Enter the app_url here

  visual: true,

  video: true,

  build: "NodeJS Vanilla - iOS",

  name: "Sample Test - NodeJS",

};

```



**Android:**



```javascript

desired_capabilities = {

  deviceName: "Galaxy S20",

  platformVersion: "11",

  platformName: "android",

  isRealMobile: true,

  app: "lt://", //Enter the app_url here

  visual: true,

  video: true,

  build: "NodeJS Vanilla - Android",

  name: "Sample Test - NodeJS",

};

```



**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 :link: __[Capabilities Generator tool](https://www.lambdatest.com/capabilities-generator/beta/index.html)__. A more Detailed Capability Guide is available [here :page_facing_up:](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/) .



## Executing The Tests



Installing depencies:



```bash

npm i wd

```



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



**Android:**



```bash

node Android.js

```



**IOS:**



```bash

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 :link: [LambdaTest App Automation Dashboard](https://appautomation.lambdatest.com/build/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs).



## Additional Links



- [Advanced Configuration for Capabilities](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/)

- [How to test locally hosted apps](https://www.lambdatest.com/support/docs/testing-locally-hosted-pages/)

- [How to integrate LambdaTest with CI/CD](https://www.lambdatest.com/support/docs/integrations-with-ci-cd-tools/)



## Documentation & Resources :books:



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](https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs)

- [LambdaTest Blog](https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs)

- [LambdaTest Learning Hub](https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs)



## LambdaTest Community :busts_in_silhouette:



The [LambdaTest Community](https://community.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs) 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](https://changelog.lambdatest.com/)



## About LambdaTest



[LambdaTest](https://www.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs) 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



[](https://accounts.lambdatest.com/register)



## We are here to help you :headphones:



- Got a query? we are available 24x7 to help. [Contact Us](mailto:[email protected]/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs)

- For more info, visit - [LambdaTest](https://www.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-nodejs)