Sam's Blog
A Comprehensive Appium Guide for Hybrid App Automation Testing

A Comprehensive Appium Guide for Hybrid App Automation Testing

Sam Atinkson's photo
Sam Atinkson
·

10 min read

Table of contents

Introduction

Companies strive to enhance customer engagement through frequent feature updates in today's fast-paced digital landscape. The imperative to deliver reliable, bug-free applications quickly is paramount. To meet these demands, a robust testing process is indispensable.

Mobile app testing is a cornerstone in ensuring seamless user experiences across diverse devices. As customer expectations continue escalating, companies increasingly turn to solutions like Appium, an open-source automation framework renowned for its scalability and flexibility.

Appium has swiftly emerged as a go-to choice in the mobile application industry, empowering developers to streamline testing processes and ensure cross-platform compatibility. Its comprehensive features have made it a favored tool for delivering high-performing applications within tight deadlines.

Why Appium Mobile Testing Excels

Appium has become a cornerstone in app testing for several reasons:

  • Cross-Platform Compatibility: Appium allows seamless testing across multiple platforms, saving time and resources.

  • Popular Programming Languages Support: Supports widely-used languages like Java, Ruby, and Python, ensuring a smooth transition for testers.

  • Free and Open Source: Accessible to all sizes of organizations, fostering innovation and transparency.

  • Compatibility with Testing Frameworks: Integrates smoothly with popular testing frameworks, enhancing efficiency.

  • Robust and Extensible Ecosystem: Easily customizable and expandable, promoting innovation and adaptability.

  • Native and Web Application Support: Handles native and web apps, offering a comprehensive solution for diverse testing needs.

Appium Framework Architecture

At its core, Appium operates as an HTTP server built on the Node.js platform. Its architecture revolves around a REST API and incorporates Selenium WebDriver, following a client/server model. Here's a breakdown of its essential components and functionalities:

REST API Operations:

  • Receives connections from client-side applications.

  • Listens for commands sent by clients.

  • Executes these commands on the targeted mobile device.

  • Returns the status of command execution to the client via HTTP responses.

‍Session Automation:

  • Appium enables automation within the context of a session.

  • Clients initiate sessions using various programming languages (Java, JavaScript, PHP, Ruby, Python, and C#).

  • This initiation involves sending a POST /session request to the server, accompanied by a JSON object known as the Desired Capabilities.

  • Upon receiving this request, the server commences the automation session and responds with a unique session ID.

  • Subsequent commands related to the session are then communicated using this session ID.

This architecture streamlines the interaction between clients and mobile devices, facilitating seamless automation and test execution.

Essential Prerequisites for Appium Automation

Before delving into Appium automation, have the following foundational elements:

  1. Programming Language Proficiency: Familiarity with a programming language like Python, Java, or JavaScript is fundamental for effectively utilizing Appium.

  2. Access to Mobile Devices: Ensure access to physical devices or emulators/simulators for automation tests.

  3. Appium Server Installation: Install the Appium server on your system or utilize remote servers like HeadSpin to execute automation scripts.

  4. Application for Testing: Have the mobile application you intend to test readily available.

  5. Platform-Specific SDK: Install the appropriate Software Development Kit (SDK) for your machine's target platform (Android or iOS).

  6. Appium Client Library: Include the Appium client library in your project, tailored to your chosen programming language, to facilitate automation.

  7. Appium Inspector: Leverage Appium Inspector to identify elements, view properties, and generate automation code snippets tailored to your application.

  8. Device or Emulator Configuration: Configure device or emulator settings as necessary, such as enabling developer mode and USB debugging.

  9. Optional Development Environment: Consider setting up a development environment optimized for your chosen programming language to maximize Appium's capabilities.

Ensuring these prerequisites are met establishes a strong foundation for seamless and successful mobile app automation testing using Appium.

Appium Operation on Android and iOS Platforms

‍● Appium Operation on Android:

Appium operates on Android devices by leveraging client libraries to translate test commands into REST API requests via the Mobile JSON Wire Protocol. The Appium server then forwards these requests to the Android device or emulator. Within the Android device, bootstrap.jar files interpret these commands, utilizing either Selendroid or UI Automator to execute them. The test results are relayed to the Appium server, which responds with an HTTP response containing relevant status codes to the Appium client.

● Appium Functionality on iOS:

Similarly, on iOS devices, Appium utilizes client libraries to convert test commands into REST API requests using the Mobile JSON Wire Protocol. The Appium server transmits these requests to an iOS device or simulator. Within the iOS device, WebDriverAgent.app files interpret these commands, employing XCUITest to execute the requests. Upon completion, the test results are communicated to the Appium server, which then issues an HTTP response with relevant status codes to the Appium client.

Navigating Hybrid App Automation Challenges

Navigating the complexities of mobile application testing presents its unique hurdles. One such challenge arises in automating functional regression test cases, which is crucial for optimizing testing efficiency. However, executing automated regression tests within tight deadlines can be daunting for hybrid mobile apps.

A prime example of this challenge surfaced during our testing endeavors within the hospice industry. In addressing this obstacle, we turned to Appium, leveraging its capabilities to craft a singular test script compatible across multiple platforms.

Here, we provide a comprehensive guide to implementing and utilizing the Appium server for hybrid mobile application development. We'll walk through the step-by-step process of installing Appium, which is noted for its compatibility with Android and iOS—the optimal solution for overcoming hybrid app automation hurdles.

Optimizing Appium for Hybrid App Automation

To conduct hybrid app testing across iOS and Android platforms efficiently, it's advisable to have Appium installed on a Mac system. Here's a concise guide to ensure a smooth setup:

1. System Requirements:

  • Ensure your Mac is updated to macOS 10.12 (Sierra) or later, as Appium 1.6.4 necessitates XCODE 8.2.

2. Java Development Kit (JDK):

  • Download and install JDK 7 or 8, with a preference for version 8 for optimal compatibility.

3. SDK Installation:

  • Obtain the latest SDK by downloading the command line tools from the designated downloads page.

4. Java Client Version:

  • Utilize Java client version 4.1.2, which is recommended for seamless integration with Appium.

5. Integrated Development Environment (IDE):

  • For automation script development, consider using IntelliJ IDEA 2017. Configure the JDK and SDK within the project structure for a streamlined workflow.

6. System Preferences Update:

  • Update system preferences to access bash_profile on Terminal by executing the command: nano ~/.bash_profile.
  • Example configurations:

export ANDROID_HOME=/Users/jenkins/Library/Android/sdk   //sdk path
export PATH=$ANDROID_HOME/platform-tools:$PATH
export JAVA_HOME=$(/usr/libexec/java_home)   //java path

These steps ensure a conducive environment for hybrid app automation using Appium on macOS.

Running Appium Tests on Android Devices

For successful execution of Appium tests on Android devices, follow these streamlined steps:

1. Installation Process:‍

  • Download the necessary components:

  1. Appium Jar files for Java

  2. Latest Appium Client Library

  3. Appium Server

  4. Java

  5. TestNG

2. Java Installation:

  • Ensure Java is installed on your system and set the environment variables accordingly.

3. Device Configuration:

  • Enable Developer Mode on your device for configuration readiness.

4. Test Script Demonstration:

  • Utilize the provided code snippet within your preferred IDE, such as Eclipse, to write and execute Appium test scripts on Android devices.

// Import necessary libraries
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.Assert;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;
import java.net.MalformedURLException;
import java.net.URL;

public class AppiumExample{
    WebDriver driver;
    WebDriverWait wait;
    String AppURL = "https://www.browserstack.com/";

    @BeforeTest
    public void setup() throws MalformedURLException {
        // Configure Desired Capabilities
        DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("GalaxyS4", "WKZLMJLB7L8TR8SW");
        capabilities.setCapability("platformName", "Android");
        capabilities.setCapability("appPackage", "com.android.chrome");
        capabilities.setCapability("appActivity", "com.google.android.apps.chrome.Main");

        // Initialize driver object with URL to Appium Server
        driver = new RemoteWebDriver(new URL("http://127.0.0.1:4723/wd/hub"), capabilities);
        wait = new WebDriverWait(driver, 5);
    }

    @Test
    public void testSearchAppium() {
        driver.get(AppURL);
        String homePageTitle = driver.getTitle();
        Assert.assertEquals(homePageTitle, "Most Reliable App & Cross Browser Testing Platform | Browserstack");

        WebElement linkElement = driver.findElement(By.xpath("//body[@class='page-template-default page page-id-593 page-parent live persistent-header wpb-js-composer js-comp-ver-6.0.5 vc_responsive']"));
        linkElement.click();
        wait.until(ExpectedConditions.presenceOfElementLocated(By.xpath("your_xpath_here")));
        String searchPageTitle = driver.findElement(By.xpath("your_xpath_here")).getText();
        Assert.assertEquals(searchPageTitle, "Search");
    }

    @AfterTest
    public void tearDown() {
        driver.quit();
    }
}

5. Desired Capabilities Configuration:

  • Specify desired capabilities within the test code or in separate appium.txt files.

  • Desired capabilities are JSON objects the client sends to the server, providing control over the automation session.

By following these steps, testers can seamlessly execute Appium tests on Android devices using the HeadSpin platform, ensuring efficient and reliable testing processes.

Understanding Appium iOS Testing

Appium facilitates iOS testing through RESTful services, utilizing JSON files to interact with iOS applications via Apple's UIAutomation API. The bootstrap.js file serves as a TCP server, transmitting test commands to execute actions on iOS devices through UI elements.

Benefits of Appium for iOS Testing:

  • Open-Source Framework: Appium eliminates costly licensing fees, providing a cost-effective solution for iOS testing.

  • Detailed Reporting with XCUITest Driver: Appium's XCUITest driver generates comprehensive information logs, enhancing test result analysis and debugging efforts.

  • Code Reusability: Test scripts written for iOS devices can be reused for Android devices, reducing development time and effort for hybrid apps.

  • Cross-Platform Compatibility: Appium supports testing across various versions of iOS devices, ensuring app compatibility across platforms.

  • Real-Time Monitoring: Appium offers real-time monitoring of tests on real devices, ensuring reliability and efficiency in testing processes.

Getting iOS Device Details:

Retrieve essential details of the iOS device, including device name, iOS version, and bundle ID, to configure desired capabilities. Set the automationName to XCUITest for iOS testing.

Writing Appium Test Script for iOS Devices:

In Eclipse, create a new project, package, and class to commence writing the test code. Configure desired capabilities and instantiate the Appium Driver using the provided code snippet.


// Import necessary libraries
import io.appium.java_client.ios.IOSDriver;
import java.net.MalformedURLException;
import java.net.URL;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.openqa.selenium.remote.DesiredCapabilities;

public class iOS_TestScript {
    private IOSDriver driver;

    @Before
    public void setUp() throws MalformedURLException {
        // Configure Desired Capabilities
        DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("platformName", "iOS");
        capabilities.setCapability("platformVersion", "12.4.7");
        capabilities.setCapability("deviceName", "iPhone 7");
        capabilities.setCapability("udid", "<your iPhone’s udid>");
        capabilities.setCapability("bundleId", "com.google.Chrome");
        capabilities.setCapability("xcodeOrgId", "<your org id>");
        capabilities.setCapability("xcodeSigningId", "<your signing id>");
        capabilities.setCapability("updatedWDABundleId", "com.google.chrome.ios");

        driver = new IOSDriver<>(new URL("http://localhost:4723/wd/hub"), capabilities);
    }

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

    @Test
    public void testOpeningGoogleChromeApp() {
        driver.findElementByAccessibilityId("Login Screen");
    }
}

Utilize the UDID of the iPhone, iOS version, and bundle ID details for the desired capabilities. Execute the script, and the Google Chrome App will launch on the connected iOS device.

By following these steps, testers can efficiently conduct iOS testing using Appium with HeadSpin, ensuring thorough and reliable testing processes.

Unlocking Seamless Test Automation with HeadSpin's Advanced Appium Capabilities

As a premier mobile app testing platform, HeadSpin offers robust support for Appium, including its latest iteration, Appium 2.0. This partnership empowers organizations with features, ensuring a smooth and efficient platform testing experience. Here's a glimpse of what HeadSpin's Appium capabilities bring:

  1. Cloud-Based Testing: HeadSpin's expansive global device infrastructure enables cloud-based testing with Appium. Testers can access a diverse range of real devices, eliminating the need for physical hardware and reducing testing time and infrastructure costs.
  1. Integrated Appium Inspector: Seamlessly integrated with Appium Inspector, HeadSpin's user interface simplifies element identification and script development. Testers can view hierarchies, identify selectors, and create Appium code templates directly within the HeadSpin cloud platform.
  1. Scalability and Performance Testing: Leveraging HeadSpin's robust infrastructure, testers can conduct scalability and performance testing with Appium. Simulating numerous concurrent users under diverse network conditions and geographical locations facilitates authentic performance evaluation.
  1. End-to-end Testing: HeadSpin facilitates end-to-end testing scenarios by seamlessly integrating mobile app testing with web application testing. This integrated method guarantees thorough coverage and maintains consistency in test outcomes.
  1. Extensive Device and OS Coverage: With a vast device inventory covering multiple manufacturers, models, and operating systems, HeadSpin provides testers access to many devices for Appium testing. This ensures thorough compatibility testing across diverse devices, enhancing app reliability and user experience.

The Way Forward

In fast-paced and dependable testing across diverse platforms and devices, Appium testing is an essential tool. Widely embraced in the industry, Appium offers feasibility, adaptability, and cost-effectiveness, aligning perfectly with continuous delivery principles and ensuring exceptional user experiences.

When paired with HeadSpin's unmatched capabilities, Appium becomes a formidable asset for mobile app automation testing. Empowered by HeadSpin's access to a vast device inventory, cloud-based testing, and integrated Appium Inspector, testers can fully utilize Appium for efficient and scalable automation testing.

Embrace the synergy of Appium and HeadSpin to unlock optimal automation testing outcomes and deliver top-notch, reliable apps to your user base.

Originally Published:- https://www.headspin.io/blog/a-step-by-step-guide-for-hybrid-app-testing-with-appium

automation testing Appium testingAppium automation