Robot Framework Appium Library

Common errors

• ModuleNotFoundError: No module named 'AppiumLibrary'

  cause The `robotframework-appiumlibrary` Python package is not installed in the active Python environment, or the Robot Framework interpreter cannot find it.
  fix Ensure `robotframework-appiumlibrary` is installed using `pip install robotframework-appiumlibrary`. If using a virtual environment or IDE (like PyCharm), verify that Robot Framework is configured to use the correct Python interpreter where the library is installed. Sometimes clearing Robot Framework caches and restarting the IDE helps.

• [ WARN ] Keyword 'AppiumLibrary.Click A Point' is deprecated. Since selenium v4, use other keywords.

  cause Using a deprecated keyword that has been removed or replaced in newer versions of `robotframework-appiumlibrary`, especially after the updates for Selenium 4 and Appium 2.
  fix Update your Robot Framework tests to use the recommended alternative keywords. For 'Click A Point' or 'Click Element At Coordinates', newer methods or combinations of `Tap` with coordinates might be needed, or consider using `Click Element` with appropriate locators. Refer to the latest AppiumLibrary keyword documentation for alternatives.

• WebDriverException: Message: An unknown server-side error occurred while processing the command.

  cause This generic error often indicates an issue with the Appium server, device setup, or incorrect desired capabilities provided during `Open Application`. Common causes include an Appium server not running, an invalid device UDID, an app not found, or a mismatched `platformVersion`.
  fix Verify that your Appium server is running and accessible at the specified URL. Double-check device connectivity (`adb devices` for Android, Xcode/instruments for iOS). Ensure all desired capabilities passed to `Open Application` are correct and match your target device and application configuration. Check Appium server logs for more specific error details.

Warnings

• breaking Keywords like `Reset Application`, `Element Name Should Be`, `Element Value Should Be`, `Zoom`, and `Long Press` were removed in AppiumLibrary v3.2.1/v3.2. Existing tests using these will fail.
  Fix: Migrate to new assertion keywords like `Expect Element` and `Expect Text` (replacing `Element Should Be Enabled/Disabled/Visible`, `Text Should Be Visible`). For element attribute checks, use `Element Attribute Should Match`. For `Long Press`, the `Tap` keyword now supports a time parameter.
• breaking AppiumLibrary v3.0.0 removed several keywords including `Click A Point`, `Click Element At Coordinates`, `Launch Application`, `Quit Application`, `Background App`, `Click Button`, and `Pinch`. The `Swipe` keyword now strictly requires named arguments.
  Fix: Replace removed keywords with their modern alternatives (e.g., `Click Button` -> `Click Element`). For `Launch Application` and `Quit Application`, consider `Activate Application` and `Close Application` respectively. Adjust `Swipe` calls to use named arguments.
• breaking In AppiumLibrary v2.0.0, `TouchAction` keywords were deprecated, and application management keywords like `launch_application`, `quit_application`, `reset_application` were deprecated/renamed (`Activate App` to `Activate Application`, etc.) to align with Appium Python Client changes.
  Fix: Refactor tests to use newer W3C ActionChain-based keywords for complex gestures and adopt the renamed application management keywords. For newer AppiumLibrary versions (v3.0.0+), `TouchAction` based keywords are completely removed.
• gotcha Using older `robotframework-appiumlibrary` versions (pre-3.0.0) with `Appium-Python-Client==4.0.0` or higher can lead to `ModuleNotFoundError: No module named 'appium.webdriver.common.touch_action'` errors due to changes in the underlying Appium Python Client.
  Fix: Upgrade `robotframework-appiumlibrary` to version 3.0.0 or later, as it addresses this incompatibility. Alternatively, downgrade `Appium-Python-Client` to a version less than 4.0.0 (e.g., `pip install --force-reinstall "Appium-Python-Client<4.0.0"`).

Install

• pip install robotframework-appiumlibrary Install latest version

Imports

• AppiumLibrary

  *** Settings ***
  Library    AppiumLibrary

  Imported in the 'Settings' section of a Robot Framework test file.

Quickstart

This Robot Framework example demonstrates opening and closing a sample Android application using AppiumLibrary. Before running, ensure an Appium server is running (e.g., on http://127.0.0.1:4723) and a compatible Android emulator/device is set up with developer options enabled. The `ANDROID_APP` variable should point to your application's `.apk` file. The `Open Application` keyword initializes the session with desired capabilities.

*** Settings ***
Documentation    Simple example using AppiumLibrary.
Library          AppiumLibrary

*** Variables ***
${APPIUM_SERVER_URL}      http://127.0.0.1:4723/wd/hub
${ANDROID_AUTOMATION_NAME}    UIAutomator2
${ANDROID_PLATFORM_NAME}      Android
${ANDROID_PLATFORM_VERSION}    %{ANDROID_PLATFORM_VERSION=11}  # Example: read from ENV or default to 11
${ANDROID_APP}            ${CURDIR}/demoapp/ApiDemos-debug.apk  # Replace with your app path

*** Test Cases ***
Should Open And Close Test Application
    Open Test Application
    Sleep    3s
    Close Application

*** Keywords ***
Open Test Application
    Open Application    ${APPIUM_SERVER_URL}
    ...    automationName=${ANDROID_AUTOMATION_NAME}
    ...    platformName=${ANDROID_PLATFORM_NAME}
    ...    platformVersion=${ANDROID_PLATFORM_VERSION}
    ...    app=${ANDROID_APP}
    ...    appPackage=io.appium.android.apis
    ...    appActivity=.app.SearchInvoke