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

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

android-automation app-automation appium appium-java ios-automation java mobile-app-testing testing-tools

Last synced: 20 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
# Java With Appium ![pw](https://img.shields.io/badge/Java-ED8B00?style=for-the-badge&logo=java&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/appium-mobile-testing)._



_Learn the basics of [Appium testing on the LambdaTest platform](https://www.lambdatest.com/support/docs/getting-started-with-appium-testing/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java)._



[](https://accounts.lambdatest.com/register?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java)



## Table of Contents



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

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

- [Executing The Test](#executing-the-test)



## Pre-requisites



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



- Ensure you have the [Java client library](https://github.com/appium/java-client) installed for Selenium and Appium.

- Download and install **Maven** following the steps from [the official website](https://maven.apache.org/). Maven can also be installed easily on **Linux/MacOS** using [**Homebrew**](https://brew.sh/) package manager.



### Clone The Sample Project



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



```bash

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

cd LT-appium-java

```



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



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



```bash

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



**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"'

```



**Windows:**



```bash

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



**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"'

```



**Windows:**



```bash

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



**Test Scenario:** Check out [vanila_android.java](https://github.com/LambdaTest/LT-appium-java/blob/master/src/test/java/vanilla_android.java) file to view the sample test script for android and [vanilla_ios.java](https://github.com/LambdaTest/LT-appium-java/blob/master/src/test/java/vanilla_ios.java) for iOS.



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



```java

DesiredCapabilities capabilities = new DesiredCapabilities();

            capabilities.setCapability("deviceName", "Galaxy S20");

            capabilities.setCapability("platformVersion", "11");

            capabilities.setCapability("platformName", "Android");

            capabilities.setCapability("isRealMobile", true);

            capabilities.setCapability("app", "YOUR_APP_URL"); //Enter your app url

            capabilities.setCapability("deviceOrientation", "PORTRAIT");

            capabilities.setCapability("build", "Java Vanilla - iOS");

            capabilities.setCapability("name", "Sample Test Java");

            capabilities.setCapability("console", true);

            capabilities.setCapability("network", false);

            capabilities.setCapability("visual", true);

            capabilities.setCapability("devicelog", true);

```



```java

DesiredCapabilities caps = new DesiredCapabilities();

            caps.setCapability("platformVersion", "15");

            caps.setCapability("deviceName", "iPhone 12");

            caps.setCapability("isRealMobile", true);

            caps.setCapability("app", "YOUR_APP_URL"); //Enter your app url

            caps.setCapability("platformName", "iOS");

            caps.setCapability("build", "Java Vanilla - iOS");

            caps.setCapability("name", "Sample Test Java");

            caps.setCapability("devicelog", true);

            caps.setCapability("network", true);

```



**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](https://www.lambdatest.com/capabilities-generator/beta/index.html?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java)**. A more Detailed Capability Guide is available [here](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java).



## Executing The Test



Execute the following commands to install the required dependencies:



```bash

mvn clean install

```



The tests can be executed in the terminal using the following command:



**Android:**



```bash

mvn test -P android

```



**iOS:**



```bash

mvn test -P ios

```



**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-java).



## Additional Links



- [Advanced Configuration for Capabilities](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java)

- [How to test locally hosted apps](https://www.lambdatest.com/support/docs/testing-locally-hosted-pages/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java)

- [How to integrate LambdaTest with CI/CD](https://www.lambdatest.com/support/docs/integrations-with-ci-cd-tools/?utm_source=github&utm_medium=repo&utm_campaign=LT-appium-java)



## 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-java)

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

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



## LambdaTest Community :busts_in_silhouette:



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



## We are here to help you :headphones:



- Got a query? we are available 24x7 to help. [Contact Us](mailto:[email protected])

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