Skip to main content

Robot Framework Mobile app testing library for Appium Client Android & iOS & Web

Project description

Introduction

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

Keyword Documentation

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

Installation

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.

Device Setup

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 Driver Setup Guide. Please follow the Driver-Specific Setup according to platform.

Usage

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 Documentation

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.

Contributing

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

Project Contributors

William Zhang

akupahkala

Arnaud Ruffin

Serhat Bolsu

soukingang

Junuen Villa

Xie Lieping

Erik Bartalos

Tanakiat Srisaranyakul

Joshua Rivera

Minh Nguyen

Thiago Paiva Brito

js361014

Sadik Kuzu

Jonathan Gayvallet

matthew-dahm

KumarS

jennyw1

JMcn

Xia Clark

ac-simoes

Ulhas Deshmukh

Leon Guo

Pramod

smaspe

eXtReMaL

Erol Selitektay

Filipe Arruda

Felipe Luiz Tortella

Filipe Henrique Benjamim de Arruda

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

Project details


Release history Release notifications | RSS feed

This version

2.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotframework-appiumlibrary-2.1.0.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

robotframework_appiumlibrary-2.1.0-py2.py3-none-any.whl (38.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file robotframework-appiumlibrary-2.1.0.tar.gz.

File metadata

File hashes

Hashes for robotframework-appiumlibrary-2.1.0.tar.gz
Algorithm Hash digest
SHA256 d01b1ed21e79996a790ffb7ad475862f6e9427770a9c88314065b1c59ce2d52c
MD5 80d6490d5ba585f484e0745220906d61
BLAKE2b-256 2e4e4378308ac3f638cdee4a7c7e2b5e09d4937d40dd9d8cfbeefdde5d8db300

See more details on using hashes here.

Provenance

File details

Details for the file robotframework_appiumlibrary-2.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_appiumlibrary-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 34038656beff3915be3621828d74ada55f959c9f618518a9c387134424914016
MD5 83d2d44cf7a8e68c87b82c3f0b23f4db
BLAKE2b-256 869f139e757743762569c70519714b31f4d3d61b2ad93d78f803f6097dc9ed16

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page