Skip to content

serhatbolsu/robotframework-appiumlibrary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Appium library for RobotFramework

AppiumLibrary is an appium testing library for Robot Framework. Library can be downloaded from PyPI.

It uses Appium to communicate with Android and iOS application similar to how Selenium WebDriver talks to web browser.

It is supporting Python 3.7+ (since Appium Python Client doesn't support Python 2.7 anymore)

Latest PyPI version Number of PyPI downloads License

See Keyword Documentation for available keywords and more information about the library in general.

Option 1 (recommended)

The recommended installation method is using pip:

pip install --upgrade robotframework-appiumlibrary

Option 2

It is possible to install directly from GitHub repository. To Install latest source from the master branch, use this command: pip:

pip install git+https://github.com/serhatbolsu/robotframework-appiumlibrary.git

Please note that installation will take some time, because pip will clone the AppiumLibrary project to a temporary directory and then perform the installation.

See Robot Framework installation instructions for detailed information about installing Python and Robot Framework itself.

After installing the library, you still need to setup an simulator/emulator or real device to use in tests. iOS and Android have separate paths to follow, and those steps better explained in Appium Quickstart Intro. Please follow the Driver-Specific Setup according to platform.

[As we make updates to the AppiumLibrary we want to provide current and helpful documentation with regards to setting up not only devices but the full development environment. I'll note personally I found this to be a bit overwhelming and complex - doable but lengthy. Once source which greatly helped me is the RoboCon 2024 workshop notes provide by the team at Eficode. This information may be incorporated here in the future.]

To write tests with Robot Framework and AppiumLibrary, AppiumLibrary must be imported into your RF test suite. See Robot Framework User Guide for more information.

As it uses Appium make sure your Appium server is up and running. For how to use Appium please refer to Appium Quickstart Intro.

When using Robot Framework, it is generally recommended to write tests easy to read/modify. The keywords provided in AppiumLibrary are pretty low level. It is thus typically a good idea to write tests using Robot Framework's higher level keywords that utilize AppiumLibrary keywords internally. This is illustrated by the following example where AppiumLibrary keywords like Input Text are primarily used by higher level keywords like Input Search Query.

*** 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}

Create a file with the content above (name it: test_file.robot) and execute:

robot test_file.robot

The above example is single file test case, more examples can be found in a sample project that illustrates using Robot Framework and AppiumLibrary. Check the sample project that you can find examples of mobile web & ios & android.

Fork the project, make a change, and send a pull request!

William Zhang
William Zhang

πŸ’»
Serhat Bolsu
Serhat Bolsu

πŸ’»
Jari Nurminen
Jari Nurminen

πŸ’»
Xie Lieping
Xie Lieping

πŸ’»
Joshua Rivera
Joshua Rivera

πŸ’»
js361014
js361014

πŸ’»
matthew-dahm
matthew-dahm

πŸ’»
akupahkala
akupahkala

πŸ’»
soukingang
soukingang

πŸ’»
erik1510
Erik Bartalos

πŸ’»
minhnguyenphuonghoang
Minh Nguyen

πŸ’»
sadikkuzu
Sadik Kuzu

πŸ’»
kshrestha99
KumarS

πŸ’»
lucyking
Xia Clark

πŸ’»
arnaudruffin
Arnaud Ruffin

πŸ’»
jvilla17
Junuen Villa

πŸ’»
idxn
Tanakiat Srisaranyakul

πŸ’»
tbrito-daitan
Thiago Paiva Brito

πŸ’»
Meallia
Jonathan Gayvallet

πŸ’»
jennyw1
jennyw1

πŸ’»
ac-simoes
ac-simoes

πŸ’»
JMcn
JMcn

πŸ’»
UlhasDeshmukh
Ulhas Deshmukh

πŸ’»
smaspe
smaspe

πŸ’»
leongxf
Leon Guo

πŸ’»
extr3mal
eXtReMaL

πŸ’»
babarpramod
Pramod

πŸ’»
erolstt
Erol Selitektay

πŸ’»
filipehb
Filipe Henrique Benjamim de Arruda

πŸ’»
filipehba
Filipe Arruda

πŸ’»
felipetortella
Felipe Luiz Tortella

πŸ’»

AppiumLibrary is modeled after (and forked from) appiumandroidlibrary, but re-implemented to use appium 1.X technologies.