id

title

sidebar_label

description

keywords

url

site_name

slug

appium-java-junit

JUnit With Appium

JUnit

Now you can run your Appium automation scripts using JUnit on LambdaTest Real Device Cloud Platform of 3000+ real mobile devices.

appium

java

junit

lambdatest java junit

framework on lambdatest

testng

app testing

real devices

https://www.lambdatest.com/support/docs/appium-java-junit/

LambdaTest

appium-java-junit/

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 be able to learn how to configure and run your JUnit automation testing scripts with Appium on LambdaTest Real Device Cloud Platform.

Objective

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

Run sample automation script of JUnit for application testing with Appium on LambdaTest.
Learn more about Desired Capabilities for Appium testing.
Explore advanced features of LambdaTest software.

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

You have access to LambdaTest username and accessKey. If you haven't registered yet, you can do the same by visiting our website. You will be able to access the credentials in the LambdaTest Profile
Ensure you have Appium’s Java client library installed.
Download and install Maven following the steps from the official website. Maven can also be installed easily on Linux/MacOS using Homebrew package manager.

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 LambdaTest Username and AccessKey in the format Username:AccessKey in the cURL command for the authentication. Make sure to add the path of the appFile in the cURL request if required. 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 application 🔗 Android app or sample 🔗 iOS app.
Response of above cURL will be a JSON object containing the App URL of the format - lt://APP1234567891234567890 and will be used in the next steps.

:::

2. Clone the sample project

Clone the LambdaTest’s 🔗 LT-appium-java-junit repository and navigate to the code directory as illustrated below:

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

3. Set up your authentication

Make sure you have your LambdaTest credentials with you to run a 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 the 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 that your update the APP_URL, username and accesKey in the code scripts before running the tests.

package com.lambdatest;

import io.appium.java_client.MobileBy;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.By;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import java.net.MalformedURLException;
import java.net.URL;

public class android {
  //highlight-next-line
    String username = System.getenv("LT_USERNAME") == null ? "LT_USERNAME" //Enter the Username here
            : System.getenv("LT_USERNAME");
  //highlight-next-line
    String accessKey = System.getenv("LT_ACCESS_KEY") == null ? "LT_ACCESS_KEY"  //Enter the accessKey here
            : System.getenv("LT_ACCESS_KEY");
    public static RemoteWebDriver driver = null;
    public String gridURL = "@mobile-hub.lambdatest.com/wd/hub";
    public String status = "passed";
    @Before
    public void setUp() throws Exception {
        DesiredCapabilities capabilities = new DesiredCapabilities();

        capabilities.setCapability("build", "JUNIT Native App automation");
        capabilities.setCapability("name", "Java JUnit Android Pixel 6");
        capabilities.setCapability("platformName", "android");
        capabilities.setCapability("deviceName", "Pixel 6"); 
        capabilities.setCapability("isRealMobile", true);
        capabilities.setCapability("platformVersion","12");
        //highlight-next-line
        capabilities.setCapability("app","APP_URL"); //Enter your app (.apk) url
        capabilities.setCapability("deviceOrientation", "PORTRAIT");
        capabilities.setCapability("console",true);
        capabilities.setCapability("network",false);
        capabilities.setCapability("visual",true);
        try
        {
            driver = new RemoteWebDriver(new URL("https://" + username + ":" + accessKey + gridURL), capabilities);
        }
        catch (MalformedURLException e)
        {
            System.out.println("Invalid grid URL");
        } catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }

    @Test
    public void testSimple() throws Exception
    {
        try
        {
            WebDriverWait wait = new WebDriverWait(driver, 30);
            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("color"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("geoLocation"))).click();;
            Thread.sleep(5000);
            driver.navigate().back();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("Text"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("notification"))).click();;

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("toast"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(By.id("Browser"))).click();;
            Thread.sleep(10000);

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("url"))).sendKeys("https://www.lambdatest.com/");

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("find"))).click();
            Thread.sleep(5000);
            driver.navigate().back();

            status="passed";
        }
            catch (Exception e)
             {
                System.out.println(e.getMessage());
                status="failed";
             }
    }
    @After
    public void tearDown() throws Exception
    {
        if (driver != null)
        {
            driver.executeScript("lambda-status=" + status);
            driver.quit();
        }
    }
}

package com.lambdatest;

import io.appium.java_client.MobileBy;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.By;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import java.net.MalformedURLException;
import java.net.URL;

public class ios {
   //highlight-next-line
    String username = System.getenv("LT_USERNAME") == null ? "LT_USERNAME"   //Add username here
            : System.getenv("LT_USERNAME");
  //highlight-next-line
    String accessKey = System.getenv("LT_ACCESS_KEY") == null ? "LT_ACCESS_KEY"   //Add accessKey here
            : System.getenv("LT_ACCESS_KEY");
    public static RemoteWebDriver driver = null;
    public String gridURL = "@mobile-hub.lambdatest.com/wd/hub";
    public String status = "passed";
    @Before
    public void setUp() throws Exception {
        DesiredCapabilities capabilities = new DesiredCapabilities();

        capabilities.setCapability("build", "JUNIT Native App automation");
        capabilities.setCapability("name", "Java JUnit iOS iPhone 12");
        capabilities.setCapability("platformName", "ios");
        capabilities.setCapability("deviceName", "iPhone 12");
        capabilities.setCapability("isRealMobile", true);
        capabilities.setCapability("platformVersion","15");
        //highlight-next-line
        capabilities.setCapability("app","APP_URL"); //Enter your app (.ipa) url
        capabilities.setCapability("deviceOrientation", "PORTRAIT");
        capabilities.setCapability("console",true);
        capabilities.setCapability("network",false);
        capabilities.setCapability("visual",true);
        try
        {
            driver = new RemoteWebDriver(new URL("https://" + username + ":" + accessKey + gridURL), capabilities);
        }
        catch (MalformedURLException e)
        {
            System.out.println("Invalid grid URL");
        } catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }

    @Test
    public void testSimple() throws Exception
    {
        try
        {
            WebDriverWait wait = new WebDriverWait(driver, 30);
            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("color"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("geoLocation"))).click();
            Thread.sleep(5000);
            driver.navigate().back();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("Text"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("notification"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("toast"))).click();

            wait.until(ExpectedConditions.elementToBeClickable(By.id("Browser"))).click();
            Thread.sleep(10000);

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("url"))).sendKeys("https://www.lambdatest.com/");;

            wait.until(ExpectedConditions.elementToBeClickable(MobileBy.id("find"))).click();
            Thread.sleep(5000);
            driver.navigate().back();

            status="passed";
        }
            catch (Exception e)
             {
                System.out.println(e.getMessage());
                status="failed";
             }
    }
    @After
    public void tearDown() throws Exception
    {
        if (driver != null)
        {
            driver.executeScript("lambda-status=" + status);
            driver.quit();
        }
    }
}

Configure the test capabilities

You can update the custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and the app url (generated earlier) along with other capabilities like build name and test name via capabilities object. The capabilities object in the sample code can be defined as:

DesiredCapabilities capabilities = new DesiredCapabilities();

        capabilities.setCapability("build", "JUNIT Native App automation");
        capabilities.setCapability("name", "Java JUnit Android Pixel 6");
        capabilities.setCapability("platformName", "android");
        capabilities.setCapability("deviceName", "Pixel 6");
        capabilities.setCapability("isRealMobile", true);
        capabilities.setCapability("platformVersion","12");
      //highlight-next-line
        capabilities.setCapability("app","YOUR_APP_URL");  //Enter your app (.apk) url
        capabilities.setCapability("deviceOrientation", "PORTRAIT");
        capabilities.setCapability("console",true);
        capabilities.setCapability("network",false);
        capabilities.setCapability("visual",true);

DesiredCapabilities capabilities = new DesiredCapabilities();

        capabilities.setCapability("build", "JUNIT Native App automation");
        capabilities.setCapability("name", "Java JUnit iOS iPhone 12");
        capabilities.setCapability("platformName", "ios");
        capabilities.setCapability("deviceName", "iPhone 12");
        capabilities.setCapability("isRealMobile", true);
        capabilities.setCapability("platformVersion","15");
      //highlight-next-line
        capabilities.setCapability("app","YOUR_APP_URL");  //Enter your app (.ipa) url
        capabilities.setCapability("deviceOrientation", "PORTRAIT");
        capabilities.setCapability("console",true);
        capabilities.setCapability("network",false);
        capabilities.setCapability("visual",true);

:::info Note

You need to 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.For more details, please refer to our guide on Desired Capabilities in Appium.

:::

5. Execute your test case

Execute following command to install the required dependencies:

mvn clean

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

mvn test -P android

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 🔗 LambdaTest App Automation Dashboard.

:::

Additional Links

Advanced Configuration for Capabilities
How to test locally hosted apps
How to integrate LambdaTest with CI/CD

Home
Support
JUnit With Appium

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

appium-java-junit.md

appium-java-junit.md

Tutorial to Run Your First Test on LambdaTest

Objective

Pre-requisites

Run your first test

1. Upload your application

2. Clone the sample project

3. Set up your authentication

4. Write your automation script

Configure the test capabilities

5. Execute your test case

Additional Links

Files

appium-java-junit.md

Latest commit

History

appium-java-junit.md

File metadata and controls

Tutorial to Run Your First Test on LambdaTest

Objective

Pre-requisites

Run your first test

1. Upload your application

2. Clone the sample project

3. Set up your authentication

4. Write your automation script

Configure the test capabilities

5. Execute your test case

Additional Links