Appium
Mobile Automation Testing Tutorial

// Get all available contexts in the app
Set<String> contexts = driver.getContextHandles();
// Prints: [NATIVE_APP, WEBVIEW_com.example.app]

// Switch TO WebView to interact with web content
driver.context("WEBVIEW_com.example.app");
driver.findElement(By.cssSelector("#login-btn")).click();

// Switch BACK to native context
driver.context("NATIVE_APP");
driver.findElement(By.id("com.example:id/back_btn")).click();

# Step 1: Install Appium server globally
npm install -g appium

# Step 2: Install Android driver (Appium 2.x — required!)
appium driver install uiautomator2

# Step 3: Install iOS driver (macOS only)
appium driver install xcuitest

# Step 4: Check all drivers installed
appium driver list

# Step 5: Install and run Appium Doctor (check dependencies)
npm install -g appium-doctor
appium-doctor --android   # Check Android setup
appium-doctor --ios       # Check iOS setup (macOS only)

# Step 6: Start Appium Server
appium

# Step 7: Verify ADB can see your device/emulator
adb devices

import io.appium.java_client.android.options.UiAutomator2Options;
import io.appium.java_client.android.AndroidDriver;
import java.net.URL;

// Create UiAutomator2Options (recommended for Appium 2.x)
UiAutomator2Options options = new UiAutomator2Options();

options.setPlatformName("Android");
options.setPlatformVersion("14");
options.setDeviceName("emulator-5554");
options.setAutomationName("UiAutomator2");
options.setApp("/path/to/MyApp.apk");          // install & open this APK
options.setAppPackage("com.mycompany.myapp");
options.setAppActivity("com.mycompany.myapp.MainActivity");
options.setNoReset(true);                     // don't reinstall between sessions

// Create driver — connects to Appium Server
AndroidDriver driver = new AndroidDriver(
    new URL("http://127.0.0.1:4723"),  // Appium server URL
    options
);

import io.appium.java_client.ios.options.XCUITestOptions;
import io.appium.java_client.ios.IOSDriver;

XCUITestOptions options = new XCUITestOptions();

options.setPlatformName("iOS");
options.setPlatformVersion("17.0");
options.setDeviceName("iPhone 15");
options.setAutomationName("XCUITest");
options.setApp("/path/to/MyApp.app");            // .app for simulator, .ipa for real device
options.setBundleId("com.mycompany.myapp");        // iOS app bundle identifier
options.setNoReset(true);

IOSDriver driver = new IOSDriver(
    new URL("http://127.0.0.1:4723"),
    options
);

{
  "platformName": "Android",
  "appium:automationName": "UiAutomator2",
  "appium:deviceName": "emulator-5554",
  "appium:platformVersion": "14",
  "appium:app": "/path/to/MyApp.apk",
  "appium:noReset": true
}

import org.openqa.selenium.By;
import io.appium.java_client.AppiumBy;

// ── 1. ID (resource-id) — ⭐ BEST for Android ─────────────────
// Android: uses resource-id like "com.package:id/elementId"
WebElement loginBtn = driver.findElement(
    By.id("com.myapp:id/login_button")
);

// ── 2. Accessibility ID — ⭐ BEST (cross-platform) ────────────
// Android: content-desc attribute | iOS: accessibility-id label
WebElement backBtn = driver.findElement(
    AppiumBy.accessibilityId("Go Back")
);

// ── 3. Android UIAutomator — ✅ GOOD Android-specific ─────────
// Use text(), resourceId(), className(), contentDesc()
WebElement item = driver.findElement(
    AppiumBy.androidUIAutomator("new UiSelector().text(\"Login\")")
);
// Find by resource ID using UIAutomator
WebElement pwd = driver.findElement(
    AppiumBy.androidUIAutomator(
        "new UiSelector().resourceId(\"com.myapp:id/password\")")
);

// ── 4. iOS Predicate String — ✅ GOOD iOS-specific ────────────
WebElement field = driver.findElement(
    AppiumBy.iOSNsPredicateString("type == 'XCUIElementTypeButton' AND label == 'Login'")
);

// ── 5. Class Name — ⚠️ USE CAREFULLY ─────────────────────────
// Android: "android.widget.Button", "android.widget.EditText"
WebElement btn = driver.findElement(
    By.className("android.widget.Button")   // finds FIRST button
);

// ── 6. XPath — 🔴 LAST RESORT (slow, fragile) ────────────────
WebElement el = driver.findElement(
    By.xpath("//android.widget.Button[@text='Login']")
);

// Find MULTIPLE elements (returns a list)
List<WebElement> allItems = driver.findElements(
    By.id("com.myapp:id/list_item")
);
System.out.println("Total items: " + allItems.size());

<dependencies>
  <!-- Appium Java Client -->
  <dependency>
    <groupId>io.appium</groupId>
    <artifactId>java-client</artifactId>
    <version>9.3.0</version>
  </dependency>
  <!-- TestNG for test structure -->
  <dependency>
    <groupId>org.testng</groupId>
    <artifactId>testng</artifactId>
    <version>7.10.2</version>
  </dependency>
</dependencies>

package tests;

import io.appium.java_client.AppiumBy;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.android.options.UiAutomator2Options;
import org.openqa.selenium.By;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.annotations.*;
import java.net.URL;
import java.time.Duration;

public class LoginTest {

    private AndroidDriver driver;

    @BeforeMethod
    public void setUp() throws Exception {
        // Define capabilities
        UiAutomator2Options options = new UiAutomator2Options();
        options.setPlatformName("Android");
        options.setPlatformVersion("14");
        options.setDeviceName("emulator-5554");
        options.setAutomationName("UiAutomator2");
        options.setApp(System.getProperty("user.dir") + "/apps/MyApp.apk");
        options.setAppPackage("com.mycompany.myapp");
        options.setAppActivity("com.mycompany.myapp.LoginActivity");
        options.setNoReset(false);

        // Connect to Appium Server
        driver = new AndroidDriver(
            new URL("http://127.0.0.1:4723"), options
        );
    }

    @Test
    public void testValidLogin() {
        // Wait for email field then type email
        WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(10));
        WebElement emailField = wait.until(
            ExpectedConditions.visibilityOfElementLocated(
                By.id("com.mycompany.myapp:id/et_email")
            )
        );
        emailField.sendKeys("[email protected]");

        // Find and fill password field
        driver.findElement(
            By.id("com.mycompany.myapp:id/et_password")
        ).sendKeys("Test@123");

        // Click Login button
        driver.findElement(
            AppiumBy.accessibilityId("Login Button")
        ).click();

        // Verify dashboard screen appeared
        WebElement dashboardTitle = wait.until(
            ExpectedConditions.visibilityOfElementLocated(
                By.id("com.mycompany.myapp:id/tv_welcome")
            )
        );
        // Assert welcome message is displayed
        assert dashboardTitle.isDisplayed() : "Dashboard not loaded!";
        System.out.println("Login test PASSED. Welcome: " + dashboardTitle.getText());
    }

    @AfterMethod
    public void tearDown() {
        if (driver != null) {
            driver.quit();  // ends session, closes app
        }
    }
}

// ── CLICK ────────────────────────────────────────────────────
driver.findElement(By.id("com.myapp:id/login_btn")).click();

// ── TYPE TEXT ────────────────────────────────────────────────
driver.findElement(By.id("com.myapp:id/et_email"))
      .sendKeys("[email protected]");

// ── CLEAR FIELD then TYPE ────────────────────────────────────
WebElement field = driver.findElement(By.id("com.myapp:id/et_email"));
field.clear();
field.sendKeys("[email protected]");

// ── READ TEXT from element ───────────────────────────────────
String welcomeMsg = driver
    .findElement(By.id("com.myapp:id/tv_welcome"))
    .getText();  // returns "Welcome, Priya!"

// ── CHECK if element is displayed ───────────────────────────
boolean isVisible = driver
    .findElement(By.id("com.myapp:id/error_msg"))
    .isDisplayed();

// ── CHECK if element is ENABLED (interactive) ───────────────
boolean isEnabled = driver
    .findElement(By.id("com.myapp:id/submit_btn"))
    .isEnabled();

// ── GET attribute value ─────────────────────────────────────
String hint = driver
    .findElement(By.id("com.myapp:id/et_email"))
    .getAttribute("hint");  // gets placeholder text

// ── NAVIGATE BACK (Android hardware back button) ─────────────
driver.navigate().back();

// ── HIDE KEYBOARD ───────────────────────────────────────────
driver.hideKeyboard();

// ── TAKE SCREENSHOT ─────────────────────────────────────────
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.apache.commons.io.FileUtils;
import java.io.File;

File screenshot = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
FileUtils.copyFile(screenshot, new File("screenshots/login_test.png"));

import java.util.HashMap;
import java.util.Map;

// ── SWIPE GESTURE (using mobile: swipeGesture) ───────────────
// Swipe UP on the screen (scroll down content)
Map<String, Object> swipeArgs = new HashMap<>();
swipeArgs.put("left", 100);
swipeArgs.put("top", 700);
swipeArgs.put("width", 400);
swipeArgs.put("height", 500);
swipeArgs.put("direction", "up");   // up, down, left, right
swipeArgs.put("percent", 0.75);    // swipe 75% of the area
driver.executeScript("mobile: swipeGesture", swipeArgs);

// ── SCROLL TO ELEMENT (UIScrollable — Android only) ──────────
// Scrolls the list until element with text "Settings" is found
driver.findElement(
    AppiumBy.androidUIAutomator(
        "new UiScrollable(new UiSelector().scrollable(true))" +
        ".scrollIntoView(new UiSelector().text(\"Settings\"))"
    )
);

// ── LONG PRESS (using mobile: longClickGesture) ──────────────
WebElement element = driver.findElement(
    By.id("com.myapp:id/item_card")
);
Map<String, Object> longPressArgs = new HashMap<>();
longPressArgs.put("elementId",
    ((RemoteWebElement) element).getId());
longPressArgs.put("duration", 2000);    // hold for 2 seconds
driver.executeScript("mobile: longClickGesture", longPressArgs);

// ── TAP at specific coordinates ──────────────────────────────
Map<String, Object> tapArgs = new HashMap<>();
tapArgs.put("x", 540);
tapArgs.put("y", 1200);
driver.executeScript("mobile: clickGesture", tapArgs);

// ── LEGACY TouchAction (older style, still used in many projects) ──
import io.appium.java_client.TouchAction;
import io.appium.java_client.touch.WaitOptions;
import io.appium.java_client.touch.offset.PointOption;

new TouchAction(driver)
    .press(PointOption.point(540, 1500))   // start point
    .waitAction(WaitOptions.waitOptions(Duration.ofMillis(500)))
    .moveTo(PointOption.point(540, 600))   // end point (scroll up)
    .release()
    .perform();

// ── 1. IMPLICIT WAIT — set once for whole session ─────────────
driver.manage().timeouts().implicitlyWait(Duration.ofSeconds(10));
// Now every findElement waits up to 10 seconds before failing

// ── 2. EXPLICIT WAIT — wait for specific condition ────────────
WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(15));

// Wait until element is VISIBLE
WebElement el = wait.until(
    ExpectedConditions.visibilityOfElementLocated(
        By.id("com.myapp:id/dashboard_title")
    )
);

// Wait until element is CLICKABLE
WebElement btn = wait.until(
    ExpectedConditions.elementToBeClickable(
        AppiumBy.accessibilityId("Checkout Button")
    )
);
btn.click();

// Wait until text matches exactly
wait.until(
    ExpectedConditions.textToBePresentInElementLocated(
        By.id("com.myapp:id/status_msg"),
        "Order Confirmed!"
    )
);

// Wait until element is NOT visible (e.g. loading spinner disappears)
wait.until(
    ExpectedConditions.invisibilityOfElementLocated(
        By.id("com.myapp:id/loading_spinner")
    )
);

// ── 3. FLUENT WAIT — custom polling + ignore exceptions ───────
import org.openqa.selenium.support.ui.FluentWait;
import org.openqa.selenium.NoSuchElementException;

FluentWait<AndroidDriver> fluentWait = new FluentWait<>(driver)
    .withTimeout(Duration.ofSeconds(20))
    .pollingEvery(Duration.ofMillis(500))   // check every 500ms
    .ignoring(NoSuchElementException.class);

WebElement dynamicEl = fluentWait.until(d ->
    d.findElement(By.id("com.myapp:id/dynamic_content"))
);