Extends Webdriver
Appium helper extends Webriver helper. It supports all browser methods and also includes special methods for mobile apps testing. You can use this helper to test Web on desktop and mobile devices and mobile apps.
Appium is an open source test automation framework for use with native, hybrid and mobile web apps that implements the WebDriver protocol. It allows you to run Selenium tests on mobile devices and also test native, hybrid and mobile web apps.
Download and install Appium
npm install -g appium
Launch the daemon: appium
This helper should be configured in codecept.conf.ts or codecept.conf.js
app
: Application path. Local path or remote URL to an .ipa or .apk file, or a .zip containing one of these. Alias to desiredCapabilities.appPackagehost
: (default: 'localhost') Appium hostport
: (default: '4723') Appium portplatform
: (Android or IOS), which mobile OS to use; alias to desiredCapabilities.platformNamerestart
: restart browser or app between tests (default: true), if set to false cookies will be cleaned but browser window will be kept and for apps nothing will be changed.desiredCapabilities
: [], Appium capabilities, see belowplatformName
- Which mobile OS platform to useappPackage
- Java package of the Android app you want to runappActivity
- Activity name for the Android activity you want to launch from your package.deviceName
: The kind of mobile device or emulator to useplatformVersion
: Mobile OS versionapp
- The absolute local path or remote http URL to an .ipa or .apk file, or a .zip containing one of these. Appium will attempt to install this app binary on the appropriate device first.browserName
: Name of mobile web browser to automate. Should be an empty string if automating an app instead.
Example Android App:
{
helpers: {
Appium: {
platform: "Android",
desiredCapabilities: {
appPackage: "com.example.android.myApp",
appActivity: "MainActivity",
deviceName: "OnePlus3",
platformVersion: "6.0.1"
}
}
}
}
Example iOS Mobile Web with local Appium:
{
helpers: {
Appium: {
platform: "iOS",
url: "https://the-internet.herokuapp.com/",
desiredCapabilities: {
deviceName: "iPhone X",
platformVersion: "12.0",
browserName: "safari"
}
}
}
}
Example iOS Mobile Web on BrowserStack:
{
helpers: {
Appium: {
host: "hub-cloud.browserstack.com",
port: 4444,
user: process.env.BROWSERSTACK_USER,
key: process.env.BROWSERSTACK_KEY,
platform: "iOS",
url: "https://the-internet.herokuapp.com/",
desiredCapabilities: {
realMobile: "true",
device: "iPhone 8",
os_version: "12",
browserName: "safari"
}
}
}
}
Additional configuration params can be used from https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md
Receive a Appium client from a custom helper by accessing browser
property:
let browser = this.helpers['Appium'].browser
config
Execute code only on iOS
I.runOnIOS(() => {
I.click('//UIAApplication[1]/UIAWindow[1]/UIAButton[1]');
I.see('Hi, IOS', '~welcome');
});
Additional filter can be applied by checking for capabilities. For instance, this code will be executed only on iPhone 5s:
I.runOnIOS({deviceName: 'iPhone 5s'},() => {
// ...
});
Also capabilities can be checked by a function.
I.runOnAndroid((caps) => {
// caps is current config of desiredCapabiliites
return caps.platformVersion >= 6
},() => {
// ...
});
caps
anyfn
any
Execute code only on Android
I.runOnAndroid(() => {
I.click('io.selendroid.testapp:id/buttonTest');
});
Additional filter can be applied by checking for capabilities. For instance, this code will be executed only on Android 6.0:
I.runOnAndroid({platformVersion: '6.0'},() => {
// ...
});
Also capabilities can be checked by a function. In this case, code will be executed only on Android >= 6.
I.runOnAndroid((caps) => {
// caps is current config of desiredCapabiliites
return caps.platformVersion >= 6
},() => {
// ...
});
caps
anyfn
any
Execute code only in Web mode.
I.runInWeb(() => {
I.waitForElement('#data');
I.seeInCurrentUrl('/data');
});
fn
any
Returns app installation status.
I.checkIfAppIsInstalled("com.example.android.apis");
bundleId
string String ID of bundled app
Returns Promise<boolean> Appium: support only Android
Check if an app is installed.
I.seeAppIsInstalled("com.example.android.apis");
bundleId
string String ID of bundled app
Returns Promise<void> Appium: support only Android
Check if an app is not installed.
I.seeAppIsNotInstalled("com.example.android.apis");
bundleId
string String ID of bundled app
Returns Promise<void> Appium: support only Android
Install an app on device.
I.installApp('/path/to/file.apk');
path
string path to apk file
Returns Promise<void> Appium: support only Android
Remove an app from the device.
I.removeApp('appName', 'com.example.android.apis');
Appium: support only Android
Reset the currently running app for current session.
I.resetApp();
Check current activity on an Android device.
I.seeCurrentActivityIs(".HomeScreenActivity")
currentActivity
string
Returns Promise<void> Appium: support only Android
Check whether the device is locked.
I.seeDeviceIsLocked();
Returns Promise<void> Appium: support only Android
Check whether the device is not locked.
I.seeDeviceIsUnlocked();
Returns Promise<void> Appium: support only Android
Check the device orientation
I.seeOrientationIs('PORTRAIT');
I.seeOrientationIs('LANDSCAPE')
orientation
("LANDSCAPE"
|"PORTRAIT"
) LANDSCAPE or PORTRAITAppium: support Android and iOS
Returns Promise<void>
Set a device orientation. Will fail, if app will not set orientation
I.setOrientation('PORTRAIT');
I.setOrientation('LANDSCAPE')
orientation
("LANDSCAPE"
|"PORTRAIT"
) LANDSCAPE or PORTRAITAppium: support Android and iOS
Get list of all available contexts
let contexts = await I.grabAllContexts();
Returns Promise<Array<string>> Appium: support Android and iOS
Retrieve current context
let context = await I.grabContext();
Returns Promise<(string | null)> Appium: support Android and iOS
Get current device activity.
let activity = await I.grabCurrentActivity();
Returns Promise<string> Appium: support only Android
Get information about the current network connection (Data/WIFI/Airplane). The actual server value will be a number. However WebdriverIO additional properties to the response object to allow easier assertions.
let con = await I.grabNetworkConnection();
Returns Promise<{}> Appium: support only Android
Get current orientation.
let orientation = await I.grabOrientation();
Returns Promise<string> Appium: support Android and iOS
Get all the currently specified settings.
let settings = await I.grabSettings();
Returns Promise<string> Appium: support Android and iOS
Switch to the specified context.
context
any the context to switch to
Switches to web context. If no context is provided switches to the first detected web context
// switch to first web context
I.switchToWeb();
// or set the context explicitly
I.switchToWeb('WEBVIEW_io.selendroid.testapp');
context
string?
Returns Promise<void>
Switches to native context. By default switches to NATIVE_APP context unless other specified.
I.switchToNative();
// or set context explicitly
I.switchToNative('SOME_OTHER_CONTEXT');
context
any? (optional, defaultnull
)
Returns Promise<void>
Start an arbitrary Android activity during a session.
I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
Appium: support only Android
Returns Promise<void>
Set network connection mode.
- airplane mode
- wifi mode
- data data
I.setNetworkConnection(0) // airplane mode off, wifi off, data off
I.setNetworkConnection(1) // airplane mode on, wifi off, data off
I.setNetworkConnection(2) // airplane mode off, wifi on, data off
I.setNetworkConnection(4) // airplane mode off, wifi off, data on
I.setNetworkConnection(6) // airplane mode off, wifi on, data on
See corresponding webdriverio reference.
value
Returns Promise<{}> Appium: support only Android
Update the current setting on the device
I.setSettings({cyberdelia: 'open'});
settings
object objectAppium: support Android and iOS
Hide the keyboard.
// taps outside to hide keyboard per default
I.hideDeviceKeyboard();
I.hideDeviceKeyboard('tapOutside');
// or by pressing key
I.hideDeviceKeyboard('pressKey', 'Done');
Appium: support Android and iOS
strategy
("tapOutside"
|"pressKey"
)? Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)key
string? Optional key
Send a key event to the device. List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
I.sendDeviceKeyEvent(3);
keyValue
number Device specific key value
Returns Promise<void> Appium: support only Android
Open the notifications panel on the device.
I.openNotifications();
Returns Promise<void> Appium: support only Android
The Touch Action API provides the basis of all gestures that can be automated in Appium. At its core is the ability to chain together ad hoc individual actions, which will then be applied to an element in the application on the device. See complete documentation
I.makeTouchAction("~buttonStartWebviewCD", 'tap');
locator
action
Returns Promise<void> Appium: support Android and iOS
Taps on element.
I.tap("~buttonStartWebviewCD");
Shortcut for makeTouchAction
locator
any
Returns Promise<void>
Perform a swipe on the screen or an element.
let locator = "#io.selendroid.testapp:id/LinearLayout1";
I.swipe(locator, 800, 1200, 1000);
locator
(string | object)xoffset
numberyoffset
numberspeed
number (optional), 1000 by default (optional, default1000
)
Returns Promise<void> Appium: support Android and iOS
Perform a swipe on the screen.
I.performSwipe({ x: 300, y: 100 }, { x: 200, y: 100 });
Perform a swipe down on an element.
let locator = "#io.selendroid.testapp:id/LinearLayout1";
I.swipeDown(locator); // simple swipe
I.swipeDown(locator, 500); // set speed
I.swipeDown(locator, 1200, 1000); // set offset and speed
locator
(string | object)yoffset
number? (optional) (optional, default1000
)speed
number (optional), 1000 by default (optional, default1000
)
Returns Promise<void> Appium: support Android and iOS
Perform a swipe left on an element.
let locator = "#io.selendroid.testapp:id/LinearLayout1";
I.swipeLeft(locator); // simple swipe
I.swipeLeft(locator, 500); // set speed
I.swipeLeft(locator, 1200, 1000); // set offset and speed
locator
(string | object)xoffset
number? (optional) (optional, default1000
)speed
number (optional), 1000 by default (optional, default1000
)
Returns Promise<void> Appium: support Android and iOS
Perform a swipe right on an element.
let locator = "#io.selendroid.testapp:id/LinearLayout1";
I.swipeRight(locator); // simple swipe
I.swipeRight(locator, 500); // set speed
I.swipeRight(locator, 1200, 1000); // set offset and speed
locator
(string | object)xoffset
number? (optional) (optional, default1000
)speed
number (optional), 1000 by default (optional, default1000
)
Returns Promise<void> Appium: support Android and iOS
Perform a swipe up on an element.
let locator = "#io.selendroid.testapp:id/LinearLayout1";
I.swipeUp(locator); // simple swipe
I.swipeUp(locator, 500); // set speed
I.swipeUp(locator, 1200, 1000); // set offset and speed
locator
(string | object)yoffset
number? (optional) (optional, default1000
)speed
number (optional), 1000 by default (optional, default1000
)
Returns Promise<void> Appium: support Android and iOS
Perform a swipe in selected direction on an element to searchable element.
I.swipeTo(
"android.widget.CheckBox", // searchable element
"//android.widget.ScrollView/android.widget.LinearLayout", // scroll element
"up", // direction
30,
100,
500);
searchableLocator
stringscrollLocator
stringdirection
stringtimeout
numberoffset
numberspeed
number
Returns Promise<void> Appium: support Android and iOS
Performs a specific touch action. The action object need to contain the action name, x/y coordinates
I.touchPerform([{
action: 'press',
options: {
x: 100,
y: 200
}
}, {action: 'release'}])
I.touchPerform([{
action: 'tap',
options: {
element: '1', // json web element was queried before
x: 10, // x offset
y: 20, // y offset
count: 1 // number of touches
}
}]);
Appium: support Android and iOS
actions
Array Array of touch actions
Pulls a file from the device.
I.pullFile('/storage/emulated/0/DCIM/logo.png', 'my/path');
// save file to output dir
I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir);
Returns Promise<string> Appium: support Android and iOS
Perform a shake action on the device.
I.shakeDevice();
Returns Promise<void> Appium: support only iOS
Perform a rotation gesture centered on the specified element.
I.rotate(120, 120)
See corresponding webdriverio reference.
x
y
duration
radius
rotation
touchCount
Returns Promise<void> Appium: support only iOS
Set immediate value in app.
See corresponding webdriverio reference.
id
value
Returns Promise<void> Appium: support only iOS
Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint.
I.touchId(); // simulates valid fingerprint
I.touchId(true); // simulates valid fingerprint
I.touchId(false); // simulates invalid fingerprint
match
Returns Promise<void> Appium: support only iOS TODO: not tested
Close the given application.
I.closeApp();
Returns Promise<void> Appium: support only iOS
Appends text to a input field or textarea. Field is located by name, label, CSS or XPath
I.appendField('#myTextField', 'appended');
field
(string | object) located by label|name|CSS|XPath|strict locatorvalue
string text value to append.⚠️ returns a promise which is synchronized internally by recorder
Selects a checkbox or radio button. Element is located by label or name or CSS or XPath.
The second parameter is a context (CSS or XPath locator) to narrow the search.
I.checkOption('#agree');
I.checkOption('I Agree to Terms and Conditions');
I.checkOption('agree', '//form');
field
(string | object) checkbox located by label | name | CSS | XPath | strict locator.context
(string? | object) (optional,null
by default) element located by CSS | XPath | strict locator.⚠️ returns a promise which is synchronized internally by recorder (optional, defaultnull
)
Perform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched. For images, the "alt" attribute and inner text of any parent links are searched.
The second parameter is a context (CSS or XPath locator) to narrow the search.
// simple link
I.click('Logout');
// button of form
I.click('Submit');
// CSS button
I.click('#form input[type=submit]');
// XPath
I.click('//form/*[@type=submit]');
// link in context
I.click('Logout', '#nav');
// using strict locator
I.click({css: 'nav a.login'});
locator
(string | object) clickable link or button located by text, or any element located by CSS|XPath|strict locator.context
(string? | object | null) (optional,null
by default) element to search in CSS|XPath|Strict locator.⚠️ returns a promise which is synchronized internally by recorder (optional, defaultnull
)
Verifies that the specified checkbox is not checked.
I.dontSeeCheckboxIsChecked('#agree'); // located by ID
I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
I.dontSeeCheckboxIsChecked('agree'); // located by name
field
(string | object) located by label|name|CSS|XPath|strict locator.⚠️ returns a promise which is synchronized internally by recorder
Opposite to seeElement
. Checks that element is not visible (or in DOM)
I.dontSeeElement('.modal'); // modal is not shown
locator
(string | object) located by CSS|XPath|Strict locator.⚠️ returns a promise which is synchronized internally by recorder
Checks that value of input field or textarea doesn't equal to given value
Opposite to seeInField
.
I.dontSeeInField('email', 'user@user.com'); // field by name
I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
field
(string | object) located by label|name|CSS|XPath|strict locator.value
string value to check.⚠️ returns a promise which is synchronized internally by recorder
Opposite to see
. Checks that a text is not present on a page.
Use context parameter to narrow down the search.
I.dontSee('Login'); // assume we are already logged in.
I.dontSee('Login', '.nav'); // no login inside .nav element
text
string which is not present.context
(string | object)? (optional) element located by CSS|XPath|strict locator in which to perfrom search.⚠️ returns a promise which is synchronized internally by recorder (optional, defaultnull
)
Fills a text field or textarea, after clearing its value, with the given string. Field is located by name, label, CSS, or XPath.
// by label
I.fillField('Email', 'hello@world.com');
// by name
I.fillField('password', secret('123456'));
// by CSS
I.fillField('form#login input[name=username]', 'John');
// or by strict locator
I.fillField({css: 'form#login input[name=username]'}, 'John');
field
(string | object) located by label|name|CSS|XPath|strict locator.value
(string | object) text value to fill.⚠️ returns a promise which is synchronized internally by recorder
Retrieves all texts from an element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async with await
operator.
let pins = await I.grabTextFromAll('#pin li');
Returns Promise<Array<string>> attribute value
Retrieves a text from an element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async with await
operator.
let pin = await I.grabTextFrom('#pin');
If multiple elements found returns first element.
Returns Promise<string> attribute value
Grab number of visible elements by locator.
Resumes test execution, so should be used inside async function with await
operator.
let numOfElements = await I.grabNumberOfVisibleElements('p');
Returns Promise<number> number of visible elements
Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
Retrieves an attribute from an element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async with await
operator.
If more than one element is found - attribute of first element is returned.
let hint = await I.grabAttributeFrom('#tooltip', 'title');
Returns Promise<string> attribute value
Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async with await
operator.
let hints = await I.grabAttributeFromAll('.tooltip', 'title');
Returns Promise<Array<string>> attribute value
Retrieves an array of value from a form located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async function with await
operator.
let inputs = await I.grabValueFromAll('//form/input');
Returns Promise<Array<string>> attribute value
Retrieves a value from a form element located by CSS or XPath and returns it to test.
Resumes test execution, so should be used inside async function with await
operator.
If more than one element is found - value of first element is returned.
let email = await I.grabValueFrom('input[name=email]');
Returns Promise<string> attribute value
Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js). Filename is relative to output folder.
I.saveScreenshot('debug.png');
fileName
string file name to save.
Returns Promise<void>
Scroll element into viewport.
I.scrollIntoView('#submit');
I.scrollIntoView('#submit', true);
I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
locator
(string | object) located by CSS|XPath|strict locator.scrollIntoViewOptions
ScrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.⚠️ returns a promise which is synchronized internally by recorderSupported only for web testing
Verifies that the specified checkbox is checked.
I.seeCheckboxIsChecked('Agree');
I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
field
(string | object) located by label|name|CSS|XPath|strict locator.⚠️ returns a promise which is synchronized internally by recorder
Checks that a given Element is visible Element is located by CSS or XPath.
I.seeElement('#modal');
locator
(string | object) located by CSS|XPath|strict locator.⚠️ returns a promise which is synchronized internally by recorder
Checks that the given input field or textarea equals to given value. For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
I.seeInField('Username', 'davert');
I.seeInField({css: 'form textarea'},'Type your comment here');
I.seeInField('form input[type=hidden]','hidden_value');
I.seeInField('#searchform input','Search');
field
(string | object) located by label|name|CSS|XPath|strict locator.value
string value to check.⚠️ returns a promise which is synchronized internally by recorder
Checks that a page contains a visible text. Use context parameter to narrow down the search.
I.see('Welcome'); // text welcome on a page
I.see('Welcome', '.content'); // text inside .content div
I.see('Register', {css: 'form.register'}); // use strict locator
text
string expected on page.context
(string? | object) (optional,null
by default) element located by CSS|Xpath|strict locator in which to search for text.⚠️ returns a promise which is synchronized internally by recorder (optional, defaultnull
)
Selects an option in a drop-down select. Field is searched by label | name | CSS | XPath. Option is selected by visible text or by value.
I.selectOption('Choose Plan', 'Monthly'); // select by label
I.selectOption('subscription', 'Monthly'); // match option by text
I.selectOption('subscription', '0'); // or by value
I.selectOption('//form/select[@name=account]','Premium');
I.selectOption('form select[name=account]', 'Premium');
I.selectOption({css: 'form select[name=account]'}, 'Premium');
Provide an array for the second argument to select multiple options.
I.selectOption('Which OS do you use?', ['Android', 'iOS']);
select
(string | object) field located by label|name|CSS|XPath|strict locator.option
(string | Array<any>) visible text or value of option.⚠️ returns a promise which is synchronized internally by recorderSupported only for web testing
Waits for element to be present on page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForElement('.btn.continue');
I.waitForElement('.btn.continue', 5); // wait for 5 secs
locator
(string | object) element located by CSS|XPath|strict locator.sec
number? (optional,1
by default) time in seconds to wait⚠️ returns a promise which is synchronized internally by recorder (optional, defaultnull
)
Waits for an element to become visible on a page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForVisible('#popup');
locator
(string | object) element located by CSS|XPath|strict locator.sec
number (optional,1
by default) time in seconds to wait⚠️ returns a promise which is synchronized internally by recorder (optional, default1
)
Waits for an element to be removed or become invisible on a page (by default waits for 1sec). Element can be located by CSS or XPath.
I.waitForInvisible('#popup');
locator
(string | object) element located by CSS|XPath|strict locator.sec
number (optional,1
by default) time in seconds to wait⚠️ returns a promise which is synchronized internally by recorder (optional, default1
)
Waits for a text to appear (by default waits for 1sec). Element can be located by CSS or XPath. Narrow down search results by providing context.
I.waitForText('Thank you, form has been submitted');
I.waitForText('Thank you, form has been submitted', 5, '#modal');