Skip to main content

Java With Appium

Tutorial To Run Your First Test On LambdaTest


In this topic, you will learn how to configure and run your Java 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 Java for application testing with Appium on LambdaTest.
  2. Learn more about Desired Capabilities for Appium testing.
  3. Explore advanced features of LambdaTest.
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

Pre-requisites


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

Clone The Sample Project

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

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 or access the Automation Dashboard.

Step-2: Set LambdaTest Username and Access Key in environment variables.

export LT_USERNAME="undefined" \
export LT_ACCESS_KEY="undefined"

Upload Your Application

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

curl -u "undefined:undefined" \
--location --request POST 'https://manual-api.lambdatest.com/app/upload/realDevice' \
--form 'name="Android_App"' \
--form '[email protected]"/Users/macuser/Downloads/proverbial_android.apk"'

Using App URL:

curl -u "undefined:undefined" \
--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"'
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.

Run Your First Test


Sample Test With Java

Here are sample JUnit automation scripts used to run on an Android app and iOS app. Ensure to update the APP_URL in the code scripts before running the tests.

vanilla_android.java
import io.appium.java_client.AppiumDriver;
import io.appium.java_client.MobileBy;
import io.appium.java_client.MobileElement;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.net.MalformedURLException;
import java.net.URL;

public class vanilla_android {
public static String userName = System.getenv("LT_USERNAME") == null ? "LT_USERNAME" //Add username here
: System.getenv("LT_USERNAME");
public static String accessKey = System.getenv("LT_ACCESS_KEY") == null ? "LT_ACCESS_KEY" //Add accessKey here
: System.getenv("LT_ACCESS_KEY");

private static AppiumDriver driver;

public static void main(String args[]) throws MalformedURLException, InterruptedException {

try {
DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setCapability("deviceName", "Galaxy S20");
capabilities.setCapability("platformVersion", "11");
capabilities.setCapability("platformName", "Android");
capabilities.setCapability("isRealMobile", true);
capabilities.setCapability("app", "APP_URL"); //Enter your app url
capabilities.setCapability("deviceOrientation", "PORTRAIT");
capabilities.setCapability("build", "Java Vanilla - Android");
capabilities.setCapability("name", "Sample Test Java");
capabilities.setCapability("console", true);
capabilities.setCapability("network", false);
capabilities.setCapability("visual", true);
capabilities.setCapability("devicelog", true);

driver = new AppiumDriver(new URL("https://" +userName + ":" + accessKey + "@mobile-hub.lambdatest.com/wd/hub"), capabilities);

MobileElement color = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/color"));
color.click();

MobileElement text = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/Text"));
//Changes the text to proverbial
text.click();

//toast is visible
MobileElement toast = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/toast"));
toast.click();

//notification is visible
MobileElement notification = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/notification"));
notification.click();

//Open the geolocation page
MobileElement geo = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/geoLocation"));
geo.click();
Thread.sleep(5000);

//takes back to home page
MobileElement el3 = (MobileElement) driver.findElementByAccessibilityId("Home");

driver.navigate().back();
Thread.sleep(2000);

//Takes to speed test page
MobileElement speedtest = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/speedTest"));
speedtest.click();
Thread.sleep(5000);

driver.navigate().back();

//Opens the browser
MobileElement browser = (MobileElement) driver.findElement(MobileBy.AccessibilityId("Browser"));
browser.click();

MobileElement url = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/url"));
url.sendKeys("https://www.lambdatest.com");
MobileElement find = (MobileElement) driver.findElement(MobileBy.id("com.lambdatest.proverbial:id/find"));
find.click();

} catch (AssertionError a) {
((JavascriptExecutor) driver).executeScript("lambda-status=failed");
a.printStackTrace();
}
// The driver.quit statement is required, otherwise the test continues to execute, leading to a timeout.
driver.quit();
}
}

Configuring Your Test Capabilities

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

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 - Android");
capabilities.setCapability("name", "Sample Test Java");
capabilities.setCapability("console", true);
capabilities.setCapability("network", false);
capabilities.setCapability("visual", true);
capabilities.setCapability("devicelog", 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. A more Detailed Capability Guide is available here.

Executing The Test

Step-5: Execute the following commands to install the required dependencies:

mvn clean install

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

mvn test -P android
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.


TestU Conf