repository·master·Indexed 19 days ago
https://github.com/serhatbolsu/robotframework-appiumlibraryA Robot Framework library for automated mobile app testing of Android and iOS applications using Appium. It acts as a bridge between Robot Framework keywords and the Appium server, supporting gestures like Drag And Drop and Flick, as well as Appium v2 iOS Alert handling. Requires Python 3.9+ and Appium Python Client 5.1.1+.
To use AppiumLibrary, ensure your environment meets the following compatibility requirements:
The recommended way to install AppiumLibrary is using pip. This will install the library from PyPI.
Ensure you have Python and Robot Framework installed following the official Robot Framework installation instructions before proceeding.
pip install --upgrade robotframework-appiumlibraryWhen reporting a bug, you must provide a detailed environment description and steps to reproduce the issue to help maintainers. Include the following technical details:
Warning: Do not include any private or confidential information, as all submissions are public.
**Environment:**
- Python: 3.11.4
- Appium Server: 2.5.1
- Appium Python Client: 5.1.1
- AppiumLibrary: 3.1
- Platform: Android 14
- Driver: UIAutomator2 2.34.1
- Device: Pixel 7 (emulator)
**Keyword:**
`Open Application`
**Description:**
[Describe the issue here]
**Steps to Reproduce:**
1. [Step 1]
2. [Step 2]
**Expected Result:**
[What should happen]
**Actual Result:**
[What actually happens]
**Error Message:** [Stack trace here]
**Minimal Example:**
```robotframework
*** Test Cases ***
Example
Open Application http://127.0.0.1:4723
... platformName=AndroidIf you are contributing to the library, follow these steps to set up your local development environment:
test_require.txt and dev_requirements.txt.# 1. Clone
git clone https://github.com/YOUR_USERNAME/robotframework-appiumlibrary.git
cd robotframework-appiumlibrary
# 2. Virtual Environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# 3. Dependencies
pip install -r test_require.txt
pip install -r dev_requirements.txt
pip install -e .To request a feature or enhancement:
enhancement.After installing the library, you must set up a simulator/emulator or a real device. The setup process differs for iOS and Android.
It is recommended to follow the Driver-Specific Setup instructions provided by the Appium project to ensure your development environment (including the Appium server and drivers) is correctly configured.
To use the library, import AppiumLibrary in your Robot Framework test suite's *** Settings *** section.
Because AppiumLibrary keywords are relatively low-level, it is a best practice to wrap them in higher-level custom keywords to make your tests more readable and maintainable.
Note: You must provide the Appium server URL (e.g., http://127.0.0.1:4723/wd/hub) and platform-specific capabilities (like automationName, platformName, app, etc.) when calling Open Application.
*** Settings ***
Documentation Simple example using AppiumLibrary
Library AppiumLibrary
*** Variables ***
${ANDROID_AUTOMATION_NAME} UIAutomator2
${ANDROID_APP} ${CURDIR}/demoapp/ApiDemos-debug.apk
${ANDROID_PLATFORM_NAME} Android
${ANDROID_PLATFORM_VERSION} %{ANDROID_PLATFORM_VERSION=11}
*** Test Cases ***
Should send keys to search box and then check the value
Open Test Application
Input Search Query Hello World!
Submit Search
Search Query Should Be Matching Hello World!
*** Keywords ***
Open Test Application
Open Application http://127.0.0.1:4723/wd/hub automationName=${ANDROID_AUTOMATION_NAME}
... platformName=${ANDROID_PLATFORM_NAME} platformVersion=${ANDROID_PLATFORM_VERSION}
... app=${ANDROID_APP} appPackage=io.appium.android.apis appActivity=.app.SearchInvoke
Input Search Query
[Arguments] ${query}
Input Text txt_query_prefill ${query}
Submit Search
Click Element btn_start_search
Search Query Should Be Matching
[Arguments] ${text}
Wait Until Page Contains Element android:id/search_src_text
Element Text Should Be android:id/search_src_text ${text}To regenerate the HTML keyword documentation for the library, use the robot.libdoc module:
python -m robot.libdoc ./AppiumLibrary/ ./docs/AppiumLibrary.htmlFollow these steps to contribute code to the repository:
git checkout -b my-feature-branchgit push origin my-feature-branchgit checkout -b my-feature-branch
git push origin my-feature-branchIf you need the latest source from the master branch, you can install directly from the GitHub repository using pip. Note that this may take longer as pip clones the repository to a temporary directory before installation.
pip install git+https://github.com/serhatbolsu/robotframework-appiumlibrary.gitYou can configure the amount of time the library sleeps between iterations of a Wait Until... loop. This can be set globally when importing the library or dynamically during test execution using keywords.
sleep_between_wait_loop argument when importing the library.Get Sleep Between Wait to retrieve the current sleep duration.# Example: Setting sleep during library import
Library AppiumLibrary sleep_between_wait_loop=0.5The Get Text keyword has been updated with an optional first_only parameter. By default, it behaves as before, but you can now use this parameter to retrieve text from all elements that match a single locator.
# Example usage concept
# Get Text locator first_only=False