Module 2 – Android Appium Mobile Emulator Tests

Android Appium Tutorial

In this module, you will be walked through an example of setting up and running an Appium Java test with Android, covering two specific cases:

Testing an Android mobile application on Sauce Labs Emulators
Testing an Android mobile web application on the Sauce Labs Emulators

Both of these tests will be created using the Appium driver, Java, and the TestNG test runner, and will be run locally and using the virtual devices on the Sauce Labs Cloud.

Skills & Knowledge

Learn about how to set up your environment to run an Appium mobile app or mobile browser test
Understand the elements of an Appium Android mobile app test suite and run it locally
Run tests using Maven and TestNG
Update the configuration to run an Appium Android Mobile app test suite on Sauce Labs
Update capabilities and test code to run both an Appium Android mobile app test and an Appium Android mobile browser test on Sauce Labs
Add features to your test suite using the Sauce Options (capabilities) that allow you to add names, session IDs, and pass fail conditions
Add in the capabilities extendedDebugging and capturePerformance == "true", to use Sauce Performance
Set your test to run tests in parallel using the TestNG xml file

This module is created to walk you through the steps you need to take to get a test running on Sauce Labs. In this lesson you will:

Install dependencies to run local Appium tests
Configure and run Appium Desktop
Start an Android Emulator

If you would like to follow along, you can start here with the example application and Appium Test code to run on your local machine, or skip ahead to the next module to start running tests on Sauce Labs.

Video

Android Appium Project Setup

Resources

Download the following resources on your computer:

Download or fork and clone the Android Test Code. See the /Mod2/2.03 folder to follow along starting on the next module.
Download the Swag Labs Android Native Demo App mobile app.
Scroll down and find the Android.SauceLabs.Mobile.Sample.app.x.x.x.apk file. Choose the latest version you can find.

Swag Labs Mobile App Repo

Dependencies

To run a local test, you will need to set up and install the following:

Appium
- Appium Desktop App or
- Appium Server: Set it up with Android Studio
Java JDK 8 or higher
Maven build tool
An IDE to edit test code like IntelliJ Community Edition

Negative : If you would like step-by-step instructions to help with the dependencies below, there are lessons in the Selenium Java Course on how to set up your MacOS environment with Java, Maven, and IntelliJ (or set up your Windows environment.), then learn to create your first project file in IntelliJ

Android Studio
Appium Doctor
- npm install appium-doctor -g

About Appium

Appium was built off of the Selenium library to extend testing capabilities to include things you can only do on a mobile device or application. With Appium you are able to do more, with capabilities like pinching and zooming the way you would on a mobile device screen, and scanning a QR code with a native mobile application.

You can see Appium commands within the BasicTest.java class, such as

WebElement passwordEdit = driver.findElementByAccessibilityId(passwordID);
    passwordEdit.click();
    passwordEdit.sendKeys(pass);

Notice how in this example, you find an element by the accessibility ID, which is a unique locator for Appium.

Appium is also using the new W3C WebDriver Protocol (changed from the JSON Wire Protocol) This is an agreed-upon protocol to support web automation that means that commands sent will be implemented in the same way for different browsers. It also makes it easier to use Appium because a new set of functionality such as multi-touch actions and zooming are supported.

Troubleshooting Appium Environment Setup

Appium Doctor

Appium Doctor is a useful tool for checking to make sure that the dependencies and necessary variables are set correctly for your native test to run. Simply install it and run the command appium-doctor.

Appium Doctor Interface

Check to make sure all your dependencies for Appium are installed, such as NodeJS and the ANDROID_HOME and JAVA_HOME variables are correct. In this example, the xcrun dependency isn't installed, which is a necessary dependency for iOS tests.

Appium Environment Setup Steps

Before you can run the elements in your Appium environment, you first need to download the resources and install all the dependencies.

For in-depth configuration insturctions, see the Cheat Sheet

Cheat Sheet

Quickstart – Android Studio and Appium Environment Setup

Start Appium Desktop

Find the Appium desktop on your local machine, and double-click to open the APP

Click the Start Server button

Start Server

Click Edit Configurations in Appium and make sure you have the JAVA_HOME and ANDROID_HOME paths set.

Start Android Studio

Once you have everything downloaded and installed, you need to do the following before you can run your code:

Open Android Studio and start an emulator.

Go to Tools > AVD Manager

Appium Doctor Interface

In the AVD manager window, click on the green run arrow next to one of the emulators you have set up. Note the version of Android in the Target column.

Start Server

Now you are ready to get your first local test running for an Android test.

Test Suite Components

In this module, you will learn about the files in this Appium test suite. You will understand:

Which capabilities are required for an app tests
How to use Appium Desktop and Android Studio to run a local test
How to modify the <properties> tag in the TestNG xml file.
How to identify the main test file
How and why you update pom.xml

This lesson will show you which code to add to tests/BasicTest.java, pom.xml, and /resources/config/basic_test.xml to create an appium test you can run on your local machine.

Video

Android Appium Code Overview

TLDR

If you are familiar with running app tests, simply:

Start the Appium Server
Start the Emulator
Open Mod2/2.03/src/test/java/tests/BasicTest.java
Update the path to your app file & capabilities in BasicTest.java to match your Emulator
Run mvn clean test from the 2.03 directory

Appium Doctor

About Capabilities

Capabilities are sets of settings that you can pass along to the environment your test is being run, using the JSON wire protocol. W3C has a set of capabilities you can use.

Other vendors, such as Chrome, Firefox, and Sauce Labs have created other pre-defined subsets of capabilities that you can set, which are useful when you need to set specific capabilities such as extensions for Chrome, or the Sauce username.

Appium has a certain set of capabilities that must be included in your test code, so your test knows which device and simulator (and sometimes web browser) it should run on. Learn more about capabilities in Sauce Labs Docs.

Appium Capabilities

The first thing you need to know is which capabilities are required to run a test using Appium and a local Android Device:

PlatformName (Android)
PlatformVersion (‘9.0')
deviceName (Android Emulator or ‘Pixel 4')
app (path to where app is stored)
automationName (which driver you are using to run the test)

Note

Negative : React Native apps (which is the type of app you are using in this example) also require the appWaitActivity or appActivity set to the the name of the first activity (the "screen" or class that is invoked when the app is started) that your application lands on. With this capability your app knows which view should be loaded before initializing the test, which is not always communicated with React applications.

The Appium Server

You can use the Start Inspector Session button to test your capabilities in Appium Desktop before trying to run your test. This way you can see if the set of capabilities you are using will work without having to debug a test.

Appium Doctor

Test Code Overview

pom.xml – This file contains the libraries and configurations used by Maven to build the project. The versions for important dependencies, such as Appium, TestNG, logging, and Sauce Labs are included in this file. Any dependency you want to import in your project classes are specified here. You can easily update the variable with the version number in the properties tag at the top.

Appium Doctor

mobile_native_local_test.xml – This is a file used by the TestNG framework to organize how tests are executed, and which tests in your suite are run. With this file you can set the order of tests run, add parallelization, reporting, and more.

Mobile_Native_Local_Test.java – This is the main test file where all capabilities are set. Although it is not good practice, for the sake of a simple example, this includes all capabilities that communicate information about where and how the test is run, as well as all test method declaration and implementation.

Access the Base Code in this GitHub repo, or create a new Maven project like the one pictured below. Note that /test/java/tests/config will be added to later. If you are using IntelliJ to set up your project, pom.xml should be created for you.

AAppium Project

Create Your Project

Options for Setting up the project:

You can copy example of the project code here. Make sure that you add Maven support if you use a copy of the code.
Create your own project using IntelliJ IDE and add the code with the instructions below.

Make sure either way, you have set up your project with Maven as a build tool and choosen a Java SDK you have as you set up the project.

Add to `pom.xml`

Add your configuration into pom.xml.

Negative : The latest versions for the <properties> tags can be found in the Maven Repositories like this one for the Appium Java client

You may need to invalidate and restart again to activate the imports:

// filename: pom.xml
// ...
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>SauceAppiumSample</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <testngXmlDir>src/test/resources/config</testngXmlDir>
        <testngXmlFile>basic_test.xml</testngXmlFile>
        <testng.version>6.14.3</testng.version>
        <commons-logging.version>1.2</commons-logging.version>
        <selenium.version>3.141.59</selenium.version>
        <maven-failsafe-plugin.version>2.19.1</maven-failsafe-plugin.version>
        <sauce.version>1.0.44</sauce.version>
        <appium.version>7.2.0</appium.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.testng</groupId>
            <artifactId>testng</artifactId>
            <version>${testng.version}</version>
        </dependency>

        <!-- Selenium -->
        <dependency>
            <groupId>org.seleniumhq.selenium</groupId>
            <artifactId>selenium-api</artifactId>
            <version>${selenium.version}</version>
        </dependency>

        <dependency>
            <groupId>org.seleniumhq.selenium</groupId>
            <artifactId>selenium-java</artifactId>
            <version>${selenium.version}</version>
        </dependency>

        <!-- Apache Commons Logging -->
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>${commons-logging.version}</version>
        </dependency>

        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
            <version>1.3</version>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <dependency>
            <groupId>org.assertj</groupId>
            <artifactId>assertj-core</artifactId>
            <version>3.10.0</version>
        </dependency>

        <dependency>
            <groupId>com.saucelabs</groupId>
            <artifactId>saucerest</artifactId>
            <version>${sauce.version}</version>
        </dependency>

        <dependency>
            <groupId>io.appium</groupId>
            <artifactId>java-client</artifactId>
            <version>${appium.version}</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.0.0-M4</version>
                <configuration>
                    <suiteXmlFiles>
                        <suiteXmlFile>${testngXmlDir}/${testngXmlFile}</suiteXmlFile>
                    </suiteXmlFiles>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

Update Test Files

Once you have all your directories and files set up, add the following code to your test files.

Note

Negative : You will have to modify the APP variable, adding the absolute file path to where the .apk file for the Swag Labs App is stored on your local machine.

If you didn't clone the repo, you can create and copy the following to BasicTest.java:

// filename: /test/java/tests/BasicTest.java
// ...
package tests;

import io.appium.java_client.MobileBy;
import io.appium.java_client.android.AndroidDriver;
import org.openqa.selenium.By;
import org.openqa.selenium.TimeoutException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.Assert;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.net.URL;


public class BasicTest {

    private static final String APP = "/Users/lindsaywalker/Documents/Example_Tests/Android.SauceLabs.Mobile.Sample.app.2.7.0.apk";
    private static final String APPIUM = "http://localhost:4723/wd/hub";

    private String sessionId;
    private AndroidDriver driver;

    String usernameID = "test-Username";
    String passwordID = "test-Password";
    String submitButtonID = "test-LOGIN";
    By ProductTitle = By.xpath("//android.widget.TextView[@text='PRODUCTS']");

    @BeforeMethod
    public void setUp() throws Exception {
        DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("deviceName", "Android Emulator"); //This will change to type of device e.g. Pixel 4 on Saucelabs
        capabilities.setCapability("platformName", "Android");
        capabilities.setCapability("platformVersion","9.0" ); //add platformVersion
        capabilities.setCapability("automationName", "UiAutomator2");
        capabilities.setCapability("appWaitActivity", "com.swaglabsmobileapp.MainActivity");
        capabilities.setCapability("app", APP);


        driver = new AndroidDriver(new URL(APPIUM), capabilities);

    }

    @AfterMethod
    public void tearDown() {
        if (driver != null) {
            driver.quit();
        }

    }

    @Test
    public void loginToSwagLabsTestValid() {
        System.out.println("Sauce - Start loginToSwagLabsTestValid test");

        login("standard_user", "secret_sauce");

        // Verification
        Assert.assertTrue(isOnProductsPage());
    }

    @Test
    public void loginTestValidProblem() {
        System.out.println("Sauce - Start loginTestValidProblem test");

        login("problem_user", "secret_sauce");

        // Verification - we on Product page
        Assert.assertTrue(isOnProductsPage());
    }

    public void login(String user, String pass){

        WebDriverWait wait = new WebDriverWait(driver, 5);
        final WebElement usernameEdit = wait.until(ExpectedConditions.visibilityOfElementLocated(new MobileBy.ByAccessibilityId(usernameID)));

            usernameEdit.click();
            usernameEdit.sendKeys(user);

        WebElement passwordEdit = driver.findElementByAccessibilityId(passwordID);
            passwordEdit.click();
            passwordEdit.sendKeys(pass);

        WebElement submitButton = driver.findElementByAccessibilityId(submitButtonID);
            submitButton.click();
    }

    public boolean isOnProductsPage() {
        //Create an instance of a Appium explicit wait so that we can dynamically wait for an element
        WebDriverWait wait = new WebDriverWait(driver, 5);

        //wait for the product field to be visible and store that element into a variable
        try {
            wait.until(ExpectedConditions.visibilityOfElementLocated(ProductTitle));
        } catch (TimeoutException e){
            System.out.println("*** Timed out waiting for product page to load.");
            return false;
        }
        return true;
    }
}

If you didn't clone the repo, you can create and copy the following in basic_test.xml:

// filename: basic_test.xml
// ...
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Mobile Demo Suite">

    <test name="Simple execution tests Android">
        <classes>
            <class name="tests.BasicTest"/>
        </classes>
    </test>
</suite>

Once you have the first project configured, you can start Appium desktop and an Android emulator and run your test, using the command mvn clean test.

Note

Negative : If you are simply modifying an Appium test that is already configured to run on an Emulator on Sauce Labs, all you need to do is remove the "app" and "appWaitActivity" capabilities, then add in a mobile_android_browser_test.xml file and update the pom.xml to run based on that file.

In the lesson, you will modify BasicTest is to add the configurations and capabilities and run that test on an app test on a Sauce Labs emulator. You will:

Create Environment variables for Sauce Sauce Labs credentials
Upload your app file to Sauce Labs & update the APP variable
Create a new test and xml file for your Sauce Labs app test, including
- Updating capabilities for Sauce Labs
- Adding Sauce Labs credentials and data center
- Adding a urlendpoint to test on Sauce labs
- Adding test logging to help with debugging
- Delete the APPIUM variable used for local tests
- Add a config file to set a region variable

To do this tutorial, start with the Basic Test and follow along to make the changes.

Video

Sauce Labs Android Appium Emulator Test

Create Environment Variables for Sauce Labs

The first thing you should do when creating a test is set up environment variables on your local machine in the (.zshrc or .bash profile). It is important to save your Sauce username and access key as environment variables, instead of coding them into your test, so that when you share your tests or upload them to Github, your private access keys aren't shared.

It will also make transitioning to a continuous integration pipeline easier, since they will use the same environment variables. Watch this video to learn how to set up environment variables with your Sauce Labs credentials on a Mac, or view the instructions for Windows.

Upload the .apk File to Mobile-Apps

To upload the .apk project file, click Live > Mobile APP > App Upload.

App Upload

In the dropdown that appears, click and drag the .apk file for your mobile test.

Add .apk file

Once you have uploaded the .apk file, you can hover over it in the list below and then click Settings.

See App Upload Settings

Here you can see the ID for the app, which can be used in your test code to identify the app, though you can also use the name of the file that you uploaded.

App Details

Create a New Test

First, we will create a separate test file, based on BasicTest.java. The first thing you need to do is create a new class and a new xml file. Name the test Mobile_Android_EMU_Test.java (create a new Java class) within the config folder. The EMU stands for emulator, which is what we will be running our test on (as opposed to a real device). Name the TestNG xml file mobile_android_EMU_test.xml.

New Android Emulator Test

Lastly, update the pom.xml in the properties tag where you see the <testNGxml file> tag to say mobile_android_EMU_test.xml. Now, TestNG will run that test when you run the mvn clean test command in terminal.

Emulator Test TestNG File Set Region in config file

Copy Code

Now, you will copy the code from the original BasicTest and the TestNG XML file, and update it to work for the new test. Copy all the code inside basic_test.xml, and paste it inside mobile_android_EMU_test.xml

Inside the mobile_android_EMU_text.xml file in the class name tag, edit the test name to be your new test name:

// filename resources/config/mobile_android_EMU_text.xml
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Mobile Demo Suite">

    <test name="Simple Emulator Test Android" >
        <classes>
            <class name="tests.Mobile_Android_EMU_Test"/>
        </classes>
    </test>
</suite>

Next, copy all the code inside public class BasicTest, and paste it inside public class Mobile_Android_EMU_Test.java (everything should be the same except for the class name):

// filename test/java/tests/Mobile_Android_EMU_Test.java
package tests;

import io.appium.java_client.MobileBy;
import io.appium.java_client.android.AndroidDriver;
import org.openqa.selenium.By;
import org.openqa.selenium.TimeoutException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.Assert;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.net.URL;


public class Mobile_Android_EMU_Test {

    private static final String APP = "/Users/lindsaywalker/Documents/Example_Tests/Android.SauceLabs.Mobile.Sample.app.2.7.0.apk";
    private static final String APPIUM = "http://localhost:4723/wd/hub";

    private AndroidDriver driver;

// ...

Now we will add some elements to our test so it can run on Sauce Labs.

Configure for Sauce Labs

One important thing that you need to add to this is the data center that your test is going to run on. When you log into Sauce Labs, you will see there are different options for where to run your test.

Choose a Sauce data center

We will add these options in the test/Config.java file first to set it to run in the US:

// filename test/java/tests/Config.java
package tests;

public class Config {
    public static final String region = System.getProperty("region", "us");

}

Next, in Mobile_Android_EMU_Test.java under import java.net.URL, add in the following:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
import java.net.URL;

import static tests.Config.region; // added

public class Mobile_Android_EMU_Test {
// ...

Later on, in the @BeforeMethod annotation, we will set up the url to point to the correct region.

Next you are going to change the variables APP and APPIUM. You will no longer need the APPIUM link, since we will be connecting to Sauce Labs and constructing the URL in the @BeforeMethod. We will change the APP variable to simply read the name of the app that you uploaded to Sauce Lab. The first four lines of the class should now look like this:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
public class Mobile_Android_EMU_Test {
    private static final String APP = "Android.SauceLabs.Mobile.Sample.app.2.7.0.apk"; // changed from local
    URL url; //added, deleted APPIUM
    private AndroidDriver driver;
// ...

Note that your app name may be different. Check to see what the name of it is when you upload it to Sauce Labs.

Next you will update the @BeforeMethod with some information to print to the console with the System.out.println()method and configurations to connect to Sauce Labs. In the setup() method, add in the following, above the DesiredCapabilities:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
    public void setUp () throws Exception {
        System.out.println("Sauce Android EMU App Test - Parallel - BeforeMethod hook");       
        String username = System.getenv("SAUCE_USERNAME"); // added
        String accesskey = System.getenv("SAUCE_ACCESS_KEY"); /added
        String sauceUrl;
            if (region.equalsIgnoreCase("eu")) {
                sauceUrl = "@ondemand.eu-central-1.saucelabs.com:443";
            } else {
                sauceUrl = "@ondemand.us-west-1.saucelabs.com:443";
            }
        String SAUCE_REMOTE_URL = "https://" + username + ":" + accesskey + sauceUrl + "/wd/hub"; // if else statement added
        url = new URL(SAUCE_REMOTE_URL); /added
// ...

Notice how in the variable SAUCE_REMOTE_URL the username, access key, and sauceURL are all put together to create the access point, and then how a url is instantiated using SAUCE_REMOTE_URL for each test. After you set the correct capabilities for Sauce Labs, you will use the url variable when we instantiate a driver for the test.

Capabilities

The capabilities that you have in BasicTest.java are very similar to the capabilities you need to run an Android emulator test on Sauce Labs. Not much has changed, since you were essentially running the same thing on your computer.

Update the DesiredCapabilities in the before() method to edit the following two things:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
  DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("deviceName", "Android GoogleAPI Emulator"); //Changed to GoogleAPI Emu
        capabilities.setCapability("platformName", "Android");
        capabilities.setCapability("platformVersion", "8.0");
        capabilities.setCapability("automationName", "UiAutomator2");
        capabilities.setCapability("appWaitActivity", "com.swaglabsmobileapp.MainActivity");
        capabilities.setCapability("app", "storage:filename=" + APP); //changed
        driver = new AndroidDriver(url, capabilities); // changed, removed APPIUM and replaced with url

// ...

The "app" capability has changed to add in the sterling "Storage:filename=" and concatenates together with the APP variable. Secondly, the driver instantiation has changed from driver = new AndroidDriver(new URL(APPIUM), capabilities); to driver = new AndroidDriver(url, capabilities);.
The driver is now created for each, and instead of having to declare a new URL class, we can use the url variable that creates a new SAUCE_REMOTE_URL.
The capabilities "deviceName", "platformName", and "platformVersion" are the other required capabilities.

Add Test Log Information

The last thing you will do is add some simple outputs for when your test is run, and help you debug. This way you will know if your before() and after() methods are being run for each test, and give you some feedback to help you debug.

Test suite run

At the beginning of your setup() method, add in a println() like so:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
     public void setUp () throws Exception {
        System.out.println("Sauce Android Mobile - BeforeMethod hook"); //added

// ...

Do the same for your teardown() method:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
    public void teardown() {
            System.out.println("Sauce Android Mobile EMU Test - AfterMethod hook");// added

// ...

Now you can run your tests in the terminal using mvn clean test and login to the Sauce Labs Automated Test Results dashboard and see the results.

Test results page

Final Code

You can see an example of the project code here.

Quickstart 2.04 final code

Quiz

In this lesson, you will configure and running a local test to run on an Android web browser.

Create Environment variables for Sauce Sauce Labs credentials
Remove the APP and Appium variables
Create a new test and xml file for your Sauce Labs app test, including
- Adding Sauce Labs credentials and data center
- Adding a url endpoint to test on Sauce Labs
- Update capabilities for a web browser, removing capabilities for app tests
- Update test methods to work with a web browser
- Add a config file to set a region variable
- Add test log information

To do this tutorial, start with the Basic Test and follow along to make the changes.

Video

Android Appium Mobile Browser Test

Create Environment Variables for Sauce Labs

Before you can run your test you have to make sure that you have Set up environment variables for your Sauce Labs username and access key. Watch this video to learn how to set up environment variables with your Sauce Labs credentials on a Mac, or view the instructions for Windows.

Create a New Test

First, we will create a separate test file, based on BasicTest.java. The first thing you need to do is create a new class and a new xml file. Name the test Mobile_Android_Browser_Test.java (create a new Java class) within the config folder. You will also need to create an xml file in the /resources/config directory named mobile_android_browser_test.xml.

Add browser test and xml file

Copy Code

In the mobile_android_browser_text.xml file, inside the class name, edit the test name to be your new test name:

// filename resources/config/mobile_android_browser_text.xml
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Demo Suite">

    <test name="Simple Emulator Test Android" >
        <classes>
            <class name="tests.Mobile_Android_Browser_Test"/>
        </classes>
    </test>
</suite>

Copy the code (except for the class name) from BasicTest.java and paste it inside of Mobile_Android_Browser_Test.java:

// filename test/java/tests/Mobile_Android_EMU_Test.java
package tests;

import io.appium.java_client.MobileBy;
import io.appium.java_client.android.AndroidDriver;
import org.openqa.selenium.By;
import org.openqa.selenium.TimeoutException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.Assert;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.net.URL;


public class Mobile_Android_Browser_Test {

    private static final String APP = "/Users/lindsaywalker/Documents/Example_Tests/Android.SauceLabs.Mobile.Sample.app.2.7.0.apk";
    private static final String APPIUM = "http://localhost:4723/wd/hub";

    private AndroidDriver driver;

// ...

Configure for Sauce Labs

One important thing that you need to add to this is the data center that your test is going to run on. When you log into the Sauce Labs, you will see there are different options for where to run your test.

Sauce Labs data centers

We will add these options in the test/Config.java file first to set it to run in the US:

// filename test/java/tests/Config.java
package tests;

public class Config {
    public static final String region = System.getProperty("region", "us");

}

Next, in Mobile_Android_Browser_Test.java under import java.net.URL, add in the following:

// filename test/java/tests/Mobile_Android_Browser_Test.java
//...
import java.net.URL;

import static tests.Config.region; // added

public class Mobile_Android_EMU_Test {
// ...

Later on, in the @BeforeMethod annotation, we will set up the url to point to the correct region.

Next you are going to delete the variables APP and APPIUM. You will no longer need these since you will be testing an app at a URL, since we will be connecting to Sauce Labs and constructing the URL in the @BeforeMethod. We will also instantiate the url variable

// filename test/java/tests/Mobile_Android_Browser_Test.java
//...
public class Mobile_Android_EMU_Test {
    // Deleted APP and APPIUM
    String appUrl = "https://www.saucedemo.com/"; //added
    private AndroidDriver driver;
// ...

Since you are now testing on a bowser application, you will need to create a new variable called appUrl that points to the app you will be testing against.

// filename test/java/tests/Mobile_Android_Browser_Test.java
//...
    public void setUp () throws Exception {
        System.out.println("Sauce Android Mobile Browser EMU - BeforeMethod hook"); //added       
        String username = System.getenv("SAUCE_USERNAME"); // added
        String accesskey = System.getenv("SAUCE_ACCESS_KEY"); /added
        String sauceUrl;
            if (region.equalsIgnoreCase("eu")) {
                sauceUrl = "@ondemand.eu-central-1.saucelabs.com:443";
            } else {
                sauceUrl = "@ondemand.us-west-1.saucelabs.com:443";
            }
        String SAUCE_REMOTE_URL = "https://" + username + ":" + accesskey + sauceUrl + "/wd/hub"; // if else statement added
        url = new URL(SAUCE_REMOTE_URL); /added
// ...

Capabilities

The capabilities that you have in BasicTest.java use some of the same variables to run a mobile browser test on Sauce Labs.

Update the DesiredCapabilities in the before() method to edit the following two things:

// filename test/java/tests/Mobile_Android_Browser_Test.java
//...
  DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("deviceName", "Android Emulator"); // added
        capabilities.setCapability("platformName", "Android");
        capabilities.setCapability("platformVersion","8.0" );
        capabilities.setCapability("automationName", "UiAutomator2");
//        capabilities.setCapability("appWaitActivity", "com.swaglabsmobileapp.MainActivity"); //removed
        capabilities.setCapability("browserName", "Chrome");// added
//        driver = new AndroidDriver(new URL(APPIUM), capabilities); //removed
        driver = new AndroidDriver(url, capabilities); //added


// ...

Remove the "AppWaitActivity" capability, you will be testing in a browser, not an app, so there is no need for it.
Remove the "app" capability, again don't want to specify it since you will be testing in a browser.
Add the "browserName" capability, since you are testing in a browser you will need it. For now you can set it to chrome.

Edit Locators and Test Methods

The way that Selenium locates element for app tests and mobile browser tests are very different, even though it's the same app, so you will have to change a few things:

At the top of the Method, change the variables that we use to locate items on the page:

// filename test/java/tests/Mobile_Android_Browser_Test.java
// ...
public class Mobile_Android_Browser_Test {
     URL url; //added

    private AndroidDriver driver;

    By usernameInput = By.id("user-name");
    By passwordInput = By.id("password");
    By submitButton = By.className("btn_action");
    By productTitle = By.className("product_label");

The username, input, and submit button, and product page locators all have new variables declared for them, and they will be located by either ID or className.

Update Test Methods

Next, you will modify the tests you have. Since Appium is an extension of Selenium with specific methods added on to test against mobile apps, the locators and methods that you use for your tests are completely different.

The library of commands that you use in an Appium test on an app are different that you would use for a browser test. Essentially, the commands for a mobile browser are not much different than Selenium commands.

Replace the login() and loginToSwagLabsTestValid() methods with the following:

// filename test/java/tests/Mobile_Android_Browser_Test.java
// ...
public void login(String user, String pass){
        driver.get(appUrl);
        driver.findElement(usernameInput).sendKeys(user);
        driver.findElement(passwordInput).sendKeys(pass);

        driver.findElement(submitButton).click();

    }

    public boolean isOnProductsPage() {

        return driver.findElement(productTitle).isDisplayed();
    }
// ...

Note

Negative : Since you are using different methods, many of the methods you imported will no longer be used, and will be grey in the imports list. You can remove those now. imports for the test

Add Test Log Information

Tests running with logging

At the beginning of your setup() method, add in a println() like so:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
     public void setUp () throws Exception {
        System.out.println("Sauce Android Mobile Browser EMU Test - AfterMethod Hook"); //added

// ...

Do the same for your teardown() method:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
    public void teardown() {
            System.out.println("Sauce Android Mobile Browser EMU Test - AfterMethod Hook");// added

// ...

Now you should be able to run your tests by either updating the testngXmlFile tag in your pom.xml to read:

// filename pom.xml
// ...
      <properties>
          <testngXmlFile>mobile_android_browser_test.xml</testngXmlFile>
// ..

Another option is to run the command mvn clean test -DtestngXmlFile to run the Android mobile browser test from the terminal without having to update pom.xml

Final Code

You can see an example of the project code here.

Mobile Android browser test code

This module will use the test code from the Mobile_Android_EMU_Test.java. You can also add the same features to your Mobile_Android_Browser_Test.java, however, and get the same reporting on Sauce Labs. In this lesson you will learn to:

Update the setup to get the method name and pass it as a capability
Use the ITestResult interface and JavaScript to pass the test result information to Sauce Labs using SauceREST API

Video

Sauce Labs Mobile Test Reporting – Appium Test

One of the most important things you need to do when running a test, especially on a cloud provider, is to add a name and a pass-fail status. Without it is hard to view your test results on the dashboard, and also impossible to know whether or not the test code you wrote detected a failure or problem with the app.

Test with a complete status

By using a reflection and an interface with your test methods, you will be able to

Pass the name as a capability to Sauce Labs
Send a pass or fail status using the Sauce Labs REST API using JavaScript

Without a Pass or Fail status, you simply see whether or not the test was able to complete without showing an exception (Complete or Error on Sauce Labs). Without a name, it's very difficult to understand which test you are debugging.

To follow along with this course, you can use the Mobile_Android_EMU_Test from the last module – you can use it with the Mobile_Android_Browser_Test as well

Pass the Test Name

The parameter Method method allows you to use reflection and gather information when your test methods are passed to setUp() at the beginning of each test, which you will later use to pass the "name" capability. First, add the Method method parameters to the setUp class to use reflection on the Java Method class:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
    @BeforeMethod
    public void setUp (Method method) throws Exception {

// ...

You will also need to add java.lang.reflect.Method to the imports:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
import java.lang.reflect.Method; //added
// ...

Declare the variable methodName near the top of the setUp() method to use the Java Method class reflection:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
    public void setUp (Method method) throws Exception {
            System.out.println("Sauce Android EMU App Test with Reporting - BeforeMethod hook");
            String methodName = method.getName(); //added

// ...

Next, use the Method to pass the testName for the test annotation as a capability:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
    capabilities.setCapability("name", methodName); //Method added as parameter
        driver = new AndroidDriver(url, capabilities);
    }

// ...

This way, when you run your test, the method names will show up on your Sauce Labs Test dashboard.

Test names being passed to Sauce Labs

Get the Test Status

In order to retrieve the test result status, you will use the ITestresult Java interface. When the test method is passed into ITestResult, you can gather the pass or fail status of the test. First, use ITestResult when you pass in the test method to the tearDown() method:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
@AfterMethod
    public void teardown(ITestResult result) {

// ...

Make sure you import the ITestResult interface is in the list of imports at the top of the page:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
import org.testng.ITestResult; //added
// ...

Next, we will add a simple bit of validation to make sure we have a driver instantiated. After the println() for the AfterMethod hook, create a try, finally statement, placing the if (driver != null) check inside the try statement, and the driver.quit() method inside of the finally statement:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
@AfterMethod
        public void tearDown(ITestResult result) {
            System.out.println("Sauce Android App EMU Test - AfterMethod hook");               
        try {
            if (driver != null) {
                // ...
            }
        }finally {
             driver.quit
        }
     }
// ...

Add in a System.out.println("Sauce- release driver") inside of the finally statement so we can see a log if a driver was successfully created and quit. You should also update the println() for the AfterMethod hook to add in the world Reporting.

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
@AfterMethod
    public void teardown(ITestResult result) {
        System.out.println("Sauce Android Mobile EMU Reporting Test - AfterMethod hook"); // added
        try {
            if (driver != null) {
                //...    
            }
        }finally {
            System.out.println("Sauce - released driver");
            driver.quit();
        }
    }


// ...

Last, we will add in JavaScriptExecutor to pass in the sauce:job-result to the Sauce Rest API:

// filename test/java/tests/Mobile_Android_EMU_Test.java
//...
@AfterMethod
    public void teardown(ITestResult result) {
        System.out.println("Sauce - AfterMethod hook");
        try {
            if (driver != null) {
                ((JavascriptExecutor) driver).executeScript("sauce:job-result=" + (result.isSuccess() ? "passed" : "failed"));
            }
        }finally {
            System.out.println("Sauce - release driver");
            driver.quit();
        }
    }

// ...

Note

Negative : You need to have the SauceREST API specified in your pom.xml file so that you can access the endpoint, so make sure you have the following dependency with an updated version included in your dependencies:

// filename pom.xml
//...
    dependency
        groupId com.saucelabs groupId
        artifactId saucerest artifactId
        version ${sauce.version} version
    dependency

// ...

Now to run your test, creating a new TestNG xml file entitled mobile_android_EMU_reporting_test.xml :

<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Mobile Demo Suite">

    <test name="Simple Emulator Test Android" >
        <classes>
            <class name="tests.Mobile_Android_EMU_Reporting_Test"/>
        </classes>
    </test>
</suite>

Then update your pom.xml with:

 mobile_android_EMU_reporting_test.xml

Note

Negative : As an alternative to updating your pom.xml with a new TestNG xml file each time, you can use a flag to run a certain TestNG xml file in terminal: run mvn clean test -DtestngXmlFile=mobile_android_EMU_reporting_test.xml in terminal.

Now when you run your tests, you will see the test names as well as a passing or failing status:

Tests run with passing status

Final Code

You can see an example of the project code here.

Final Android Appium Reporting test code part 1

The last thing we will do in this module is show you how to modify your TestNG test so that it can be run in parallel. To do this, you will:

Add a couple elements to your TestNG xml file
Refactor the driver instantiation for each test to create threads
Update to add logging for before and after methods

Video

Sauce Labs Parallel Appium Tests

To follow along, you can make a copy of the Mobile_Android_EMU_Reporting_Test.java and rename the class to Mobile_Android_EMU_Parallel_Test.java, and do the same with themobile_android_EMU_parallel_test.xmlfile:

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
package tests;

// ...

import java.lang.reflect.Method;
import java.net.URL;

import static tests.Config.region;


public class Mobile_Android_EMU_Parallel_Test {
    private static final String APP = "Android.SauceLabs.Mobile.Sample.app.2.7.0.apk";
// ...

Next, make a copy of any of the TestNG xml files, and name this one mobile_android_EMU_parallel_test.xml, then update it so that it runs the new class you created :

// filename test/java/resources/mobile_android_EMU_parallel_test.xml
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Mobile Demo Suite">

    <test name="Simple Emulator Test Android">
        <classes>
            <class name="tests.Mobile_Android_EMU_Parallel_Test"/>
        </classes>
    </test>
</suite>

Update the TestNG xml File

The first thing you will need to do is update the TestNg xml file to enable your tests to run in parallel. Inside of the <suite> tag you will add three fields, parallel="methods" to enable you to run the methods in parallel threads, thread-count="10" to run 10 threads at once, and verbose="1" to run the lowest level of reporting. This allows you to run up to 10 methods in your test suite at once in parallel.

// filename test/java/resources/mobile_android_EMU_parallel_test.xml
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Mobile Demo Suite" parallel="methods" thread-count="10" verbose="1">

    <test name="Simple Emulator Test Android">
        <classes>
            <class name="tests.Mobile_Android_EMU_Parallel_Test"/>
        </classes>
    </test>
</suite>

TestNG allows you to output report files to be used with other tools to send information when a test fails, however since you are using Sauce Labs for reporting, we won't cover this in detail.

Next you want to add in the fields parallel="methods" and enabled="true" to the <test> tag so that you can run methods within the same test class in parallel. This is a bit redundant as we are only running one suite at first, but can come in handy later.

// filename test/java/resources/mobile_android_EMU_parallel_test.xml
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="Android Mobile Demo Suite" parallel="methods" thread-count="10" verbose="0">

    <test name="Simple Emulator Test Android" parallel="methods" enabled="true">
        <classes>
            <class name="tests.Mobile_Android_EMU_Parallel_Test"/>
        </classes>
    </test>
</suite>

Once you start to build out your test, you can add different <tests> containing multiple <classes> and use enabled="true" to run them, or switch certain tests off by setting enabled="false".

You can also run classes, tests, and suites in parallel using TestNG.

Create Threads for Each Test

Since TestNG is not thread safe, you need to instantiate a new driver in a separate thread for each test you run. This will require some refactoring of your test code.

If you try to run more than one test in the same thread, multiple tests will try to access the same driver, and your tests will error and fail, since TestNG isn't thread safe. In order to make it possible to run tests in parallel, we will need to add ThreadLocal.

First, you will replace the driver instantiation with a new one using the Java ThreadLocal object:

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
public class  Mobile_Android_EMU_Parallel_Test {

    private static final String APP = "Android.SauceLabs.Mobile.Sample.app.2.7.0.apk";
    URL url;
    private static ThreadLocal<AndroidDriver> androidDriver = new ThreadLocal<AndroidDriver>(); //added
//    private AndroidDriver driver; //deleted

//...

Next, you need to go in, and in the setUp() method where you instantiated a driver with the driver = new keyword, you need to replace it with a with androidDriver.set(new AndroidDriver(url, capabilities));

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
 @BeforeMethod
    public void setUp (Method method) throws Exception {
// ...

        androidDriver.set(new AndroidDriver(url, capabilities));// updated
    }
//...

In the teardown() method you will need to replace the use of all the diver keywords with androidDriver.get() methods to access the androidDriver thread that was created and set with values in the setUp () method.. This is allowing you to get the instance of the Android driver the thread is running on.

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
 @AfterMethod
        public void tearDown(ITestResult result) {
            System.out.println("Sauce Android Mobile EMU Reporting Test - AfterMethod hook"); // added
            try {
                if (androidDriver.get() != null) { //updated
                    ((JavascriptExecutor) androidDriver.get()).executeScript("sauce:job-result=" + (result.isSuccess() ? "passed" : "failed")); //updated
                }
            }finally {
                System.out.println("Sauce- released driver");
                androidDriver.get().quit(); //updated
            }
        }

//...

Replace the driver keyword in the login() method with androidDriver.get():

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
public void login (String user, String pass){

            WebDriverWait wait = new WebDriverWait(androidDriver.get(), 5); //updated
            final WebElement usernameEdit = wait.until(ExpectedConditions.visibilityOfElementLocated(new MobileBy.ByAccessibilityId(usernameID)));

            usernameEdit.click();
            usernameEdit.sendKeys(user);

            WebElement passwordEdit = androidDriver.get().findElementByAccessibilityId(passwordID); //updated
            passwordEdit.click();
            passwordEdit.sendKeys(pass);

            WebElement submitButton = androidDriver.get().findElementByAccessibilityId(submitButtonID); //updated
            submitButton.click();
        }

//...

And lastly, change the driver keyword in the lisOnProductsPage() method with androidDriver.get():

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
public boolean isOnProductsPage () {
            //Create an instance of a Appium explicit wait so that we can dynamically wait for an element
            WebDriverWait wait = new WebDriverWait(androidDriver.get(), 5); //updated

            //wait for the product field to be visible and store that element into a variable
            try {
                wait.until(ExpectedConditions.visibilityOfElementLocated(ProductTitle));
            } catch (TimeoutException e) {
                System.out.println("*** Timed out waiting for product page to load.");
                return false;
            }
            return true;
        }

//...

Update Reporting

Now so you can make sure you are running the correct test, update the annotation in the setUp() and tearDown() methods to reflect the new parallel test name:

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
 @BeforeMethod
    public void setUp (Method method) throws Exception { //updated
        System.out.println("Sauce Android App EMU Parallel Test - BeforeMethod hook"); //updated

//...

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
@AfterMethod
        public void tearDown(ITestResult result) {
            System.out.println("Sauce Android Mobile EMU Parallel Test - AfterMethod hook"); // added

//...

Update the pom.xml file with the new TestNG xml file name or run the command mvn clean test -DtestngXmlFile=mobile_android_EMU_parallel_test.xml. If you login to Sauce Labs, you should see both tests running at once.

Paralllel tests running

If you would like, you can copy paste the two @Test annotations, renaming them to see what running more than two tests at once looks like, and even adding some elements to them:

// filename test/java/tests/Mobile_Android_EMU_Parallel_Test.java
//...
  @Test
    public void loginToSwagLabsTestValid2 () {
        System.out.println("Sauce - Start loginToSwagLabsTestValid2 test");

        login("standard_user", "secret_sauce");

        // Verification
        Assert.assertTrue(isOnProductsPage());
    }

    @Test
    public void loginTestValidProblem2 () {
        System.out.println("Sauce - Start loginTestValidProblem2
        login("problem_user", "secret_sauce");

        // Verification - we on Product page
        Assert.assertTrue(isOnProductsPage());
    }

//...

Final Code

You can see an example of the project code here.

Parallel tests TestNG xml file Parallel tests code

Android Appium Tutorial

Skills & Knowledge

Video

Resources

Dependencies

About Appium

Troubleshooting Appium Environment Setup

Appium Doctor

Appium Environment Setup Steps

Cheat Sheet

Start Appium Desktop

Start Android Studio

Test Suite Components

Video

TLDR

About Capabilities

Appium Capabilities

Note

The Appium Server

Test Code Overview

Create Your Project

Add to pom.xml

Update Test Files

Note

Note

Video

Create Environment Variables for Sauce Labs

Upload the .apk File to Mobile-Apps

Create a New Test

Copy Code

Configure for Sauce Labs

Capabilities

Add Test Log Information

Final Code

Quiz

Video

Create Environment Variables for Sauce Labs

Create a New Test

Copy Code

Configure for Sauce Labs

Capabilities

Edit Locators and Test Methods

Update Test Methods

Note

Add Test Log Information

Final Code

Video

Pass the Test Name

Get the Test Status

Note

Note

Final Code

Video

Update the TestNG xml File

Create Threads for Each Test

Update Reporting

Final Code

Add to `pom.xml`