codeceptjs

--- id: Appium title: Appium ---  ## Appium **Extends Webdriver** Appium helper extends [Webriver][1] 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 Installation 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][2] ```sh npm install -g appium ``` Launch the daemon: `appium` ## Helper configuration This helper should be configured in codecept.json 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.appPackage - `host`: (default: 'localhost') Appium host - `port`: (default: '4723') Appium port - `platform`: (Android or IOS), which mobile OS to use; alias to desiredCapabilities.platformName - `restart`: 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 below - `platformName` - Which mobile OS platform to use - `appPackage` - Java package of the Android app you want to run - `appActivity` - Activity name for the Android activity you want to launch from your package. - `deviceName`: The kind of mobile device or emulator to use - `platformVersion`: Mobile OS version - `app` - 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: ```js { 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: ```js { 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: ```js { 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][3] ## Access From Helpers Receive a Appium client from a custom helper by accessing `browser` property: ```js let browser = this.helpers['Appium'].browser ``` ## Methods ### Parameters - `config` ### _switchToContext Switch to the specified context. #### Parameters - `context` **any** the context to switch to ### appendField Appends text to a input field or textarea. Field is located by name, label, CSS or XPath ```js I.appendField('#myTextField', 'appended'); ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** located by label|name|CSS|XPath|strict locator - `value` **[string][4]** text value to append. ### checkOption 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. ```js I.checkOption('#agree'); I.checkOption('I Agree to Terms and Conditions'); I.checkOption('agree', '//form'); ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** checkbox located by label | name | CSS | XPath | strict locator. - `context` **CodeceptJS.LocatorOrString?** (optional, `null` by default) element located by CSS | XPath | strict locator. ### click 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. ```js // 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'}); ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** clickable link or button located by text, or any element located by CSS|XPath|strict locator. - `context` **CodeceptJS.LocatorOrString?** (optional, `null` by default) element to search in CSS|XPath|Strict locator. ### closeApp Close the given application. ```js I.closeApp(); ``` Appium: support only iOS ### dontSee Opposite to `see`. Checks that a text is not present on a page. Use context parameter to narrow down the search. ```js I.dontSee('Login'); // assume we are already logged in. I.dontSee('Login', '.nav'); // no login inside .nav element ``` #### Parameters - `text` **[string][4]** which is not present. - `context` **CodeceptJS.LocatorOrString?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. ### dontSeeCheckboxIsChecked Verifies that the specified checkbox is not checked. ```js I.dontSeeCheckboxIsChecked('#agree'); // located by ID I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label I.dontSeeCheckboxIsChecked('agree'); // located by name ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** located by label|name|CSS|XPath|strict locator. ### dontSeeElement Opposite to `seeElement`. Checks that element is not visible (or in DOM) ```js I.dontSeeElement('.modal'); // modal is not shown ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** located by CSS|XPath|Strict locator. ### dontSeeInField Checks that value of input field or textarea doesn't equal to given value Opposite to `seeInField`. ```js I.dontSeeInField('email', 'user@user.com'); // field by name I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** located by label|name|CSS|XPath|strict locator. - `value` **[string][4]** value to check. ### fillField Fills a text field or textarea, after clearing its value, with the given string. Field is located by name, label, CSS, or XPath. ```js // 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'); ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** located by label|name|CSS|XPath|strict locator. - `value` **[string][4]** text value to fill. ### grabAllContexts Get list of all available contexts let contexts = await I.grabAllContexts(); Appium: support Android and iOS ### grabContext Retrieve current context ```js let context = await I.grabContext(); ``` Appium: support Android and iOS ### grabCurrentActivity Get current device activity. ```js let activity = await I.grabCurrentActivity(); ``` Appium: support only Android ### grabNetworkConnection 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. ```js let con = await I.grabNetworkConnection(); ``` Appium: support only Android ### grabOrientation Get current orientation. ```js let orientation = await I.grabOrientation(); ``` Appium: support Android and iOS ### grabSettings Get all the currently specified settings. ```js let settings = await I.grabSettings(); ``` Appium: support Android and iOS ### grabTextFrom 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. ```js let pin = await I.grabTextFrom('#pin'); ``` If multiple elements found returns an array of texts. #### Parameters - `locator` **CodeceptJS.LocatorOrString** element located by CSS|XPath|strict locator. Returns **[Promise][5]<([string][4] | [Array][6]<[string][4]>)>** attribute value ### grabValueFrom 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. ```js let email = await I.grabValueFrom('input[name=email]'); ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** field located by label|name|CSS|XPath|strict locator. Returns **[Promise][5]<[string][4]>** attribute value ### hideDeviceKeyboard Hide the keyboard. ```js // taps outside to hide keyboard per default I.hideDeviceKeyboard(); I.hideDeviceKeyboard('tapOutside'); // or by pressing key I.hideDeviceKeyboard('pressKey', 'Done'); ``` #### Parameters - `strategy` **(`"tapOutside"` | `"pressKey"`)** desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)Appium: support Android and iOS - `key` ### installApp Install an app on device. ```js I.installApp('/path/to/file.apk'); ``` #### Parameters - `path` **[string][4]** path to apk fileAppium: support only Android ### makeTouchAction 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][7] ```js I.makeTouchAction("~buttonStartWebviewCD", 'tap'); ``` Appium: support Android and iOS #### Parameters - `locator` - `action` ### openNotifications Open the notifications panel on the device. ```js I.openNotifications(); ``` Appium: support only Android ### performSwipe Perform a swipe on the screen. ```js I.performswipe(100,200); ``` #### Parameters - `from` **[number][8]** - `to` **[number][8]** Appium: support Android and iOS ### pullFile Pulls a file from the device. ```js 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); ``` Appium: support Android and iOS #### Parameters - `path` - `dest` ### removeApp Remove an app from the device. ```js I.removeApp('appName', 'com.example.android.apis'); ``` #### Parameters - `appId` **[string][4]** - `bundleId` **[string][4]** String ID of bundleAppium: support only Android ### rotate Perform a rotation gesture centered on the specified element. ```js I.rotate(120, 120) ``` See corresponding [webdriverio reference][9]. Appium: support only iOS #### Parameters - `x` - `y` - `duration` - `radius` - `rotation` - `touchCount` ### runInWeb Execute code only in Web mode. ```js I.runInWeb(() => { I.waitForElement('#data'); I.seeInCurrentUrl('/data'); }); ``` #### Parameters - `fn` **any** ### runOnAndroid Execute code only on Android ```js 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: ```js I.runOnAndroid({platformVersion: '6.0'},() => { // ... }); ``` Also capabilities can be checked by a function. In this case, code will be executed only on Android >= 6. ```js I.runOnAndroid((caps) => { // caps is current config of desiredCapabiliites return caps.platformVersion >= 6 },() => { // ... }); ``` #### Parameters - `caps` **any** - `fn` **any** ### runOnIOS Execute code only on iOS ```js 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: ```js I.runOnIOS({deviceName: 'iPhone 5s'},() => { // ... }); ``` Also capabilities can be checked by a function. ```js I.runOnAndroid((caps) => { // caps is current config of desiredCapabiliites return caps.platformVersion >= 6 },() => { // ... }); ``` #### Parameters - `caps` **any** - `fn` **any** ### see Checks that a page contains a visible text. Use context parameter to narrow down the search. ```js 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 ``` #### Parameters - `text` **[string][4]** expected on page. - `context` **CodeceptJS.LocatorOrString?** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. ### seeAppIsInstalled Check if an app is installed. ```js I.seeAppIsInstalled("com.example.android.apis"); ``` #### Parameters - `bundleId` **[string][4]** String ID of bundled appAppium: support only Android ### seeAppIsNotInstalled Check if an app is not installed. ```js I.seeAppIsNotInstalled("com.example.android.apis"); ``` #### Parameters - `bundleId` **[string][4]** String ID of bundled appAppium: support only Android ### seeCheckboxIsChecked Verifies that the specified checkbox is checked. ```js I.seeCheckboxIsChecked('Agree'); I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'}); ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** located by label|name|CSS|XPath|strict locator. ### seeCurrentActivityIs Check current activity on an Android device. ```js I.seeCurrentActivityIs(".HomeScreenActivity") ``` #### Parameters - `currentActivity` **[string][4]** Appium: support only Android ### seeDeviceIsLocked Check whether the device is locked. ```js I.seeDeviceIsLocked(); ``` Appium: support only Android ### seeDeviceIsUnlocked Check whether the device is not locked. ```js I.seeDeviceIsUnlocked(); ``` Appium: support only Android ### seeElement Checks that a given Element is visible Element is located by CSS or XPath. ```js I.seeElement('#modal'); ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** located by CSS|XPath|strict locator. ### seeInField 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. ```js 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'); ``` #### Parameters - `field` **CodeceptJS.LocatorOrString** located by label|name|CSS|XPath|strict locator. - `value` **[string][4]** value to check. ### seeOrientationIs Check the device orientation ```js I.seeOrientationIs('PORTRAIT'); I.seeOrientationIs('LANDSCAPE') ``` #### Parameters - `orientation` **(`"LANDSCAPE"` | `"PORTRAIT"`)** LANDSCAPE or PORTRAITAppium: support Android and iOS ### selectOption 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. ```js 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. ```js I.selectOption('Which OS do you use?', ['Android', 'iOS']); ``` #### Parameters - `select` **CodeceptJS.LocatorOrString** field located by label|name|CSS|XPath|strict locator. - `option` **([string][4] | [Array][6]<any>)** visible text or value of option.- Supported on only for web testing! ### sendDeviceKeyEvent Send a key event to the device. List of keys: [https://developer.android.com/reference/android/view/KeyEvent.html][10] ```js I.sendDeviceKeyEvent(3); ``` #### Parameters - `keyValue` **[number][8]** Device specific key valueAppium: support only Android ### setImmediateValue Set immediate value in app. See corresponding [webdriverio reference][11]. Appium: support only iOS #### Parameters - `id` - `value` ### setNetworkConnection Set network connection mode. - airplane mode - wifi mode - data data ```js 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][12]. Appium: support only Android #### Parameters - `value` ### setOrientation Set a device orientation. Will fail, if app will not set orientation ```js I.setOrientation('PORTRAIT'); I.setOrientation('LANDSCAPE') ``` #### Parameters - `orientation` **(`"LANDSCAPE"` | `"PORTRAIT"`)** LANDSCAPE or PORTRAITAppium: support Android and iOS ### setSettings Update the current setting on the device ```js I.setSettings({cyberdelia: 'open'}); ``` #### Parameters - `settings` **[object][13]** objectAppium: support Android and iOS ### shakeDevice Perform a shake action on the device. ```js I.shakeDevice(); ``` Appium: support only iOS ### simulateTouchId Simulate Touch ID with either valid (match == true) or invalid (match == false) fingerprint. ```js I.touchId(); // simulates valid fingerprint I.touchId(true); // simulates valid fingerprint I.touchId(false); // simulates invalid fingerprint ``` Appium: support only iOS TODO: not tested #### Parameters - `match` ### startActivity Start an arbitrary Android activity during a session. ```js I.startActivity('io.selendroid.testapp', '.RegisterUserActivity'); ``` Appium: support only Android #### Parameters - `appPackage` - `appActivity` ### swipe Perform a swipe on the screen or an element. ```js let locator = "#io.selendroid.testapp:id/LinearLayout1"; I.swipe(locator, 800, 1200, 1000); ``` [See complete reference][14] #### Parameters - `locator` **CodeceptJS.LocatorOrString** - `xoffset` **[number][8]** - `yoffset` **[number][8]** - `speed` **[number][8]** (optional), 1000 by defaultAppium: support Android and iOS ### swipeDown Perform a swipe down on an element. ```js 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 ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** - `yoffset` **[number][8]?** (optional) - `speed` **[number][8]** (optional), 1000 by defaultAppium: support Android and iOS ### swipeLeft Perform a swipe left on an element. ```js 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 ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** - `xoffset` **[number][8]?** (optional) - `speed` **[number][8]** (optional), 1000 by defaultAppium: support Android and iOS ### swipeRight Perform a swipe right on an element. ```js 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 ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** - `xoffset` **[number][8]?** (optional) - `speed` **[number][8]** (optional), 1000 by defaultAppium: support Android and iOS ### swipeTo Perform a swipe in selected direction on an element to searchable element. ```js I.swipeTo( "android.widget.CheckBox", // searchable element "//android.widget.ScrollView/android.widget.LinearLayout", // scroll element "up", // direction 30, 100, 500); ``` #### Parameters - `searchableLocator` **[string][4]** - `scrollLocator` **[string][4]** - `direction` **[string][4]** - `timeout` **[number][8]** - `offset` **[number][8]** - `speed` **[number][8]** Appium: support Android and iOS ### swipeUp Perform a swipe up on an element. ```js 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 ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** - `yoffset` **[number][8]?** (optional) - `speed` **[number][8]** (optional), 1000 by defaultAppium: support Android and iOS ### switchToNative Switches to native context. By default switches to NATIVE_APP context unless other specified. ```js I.switchToNative(); // or set context explicitly I.switchToNative('SOME_OTHER_CONTEXT'); ``` #### Parameters - `context` **any** ### switchToWeb Switches to web context. If no context is provided switches to the first detected web context ```js // switch to first web context I.switchToWeb(); // or set the context explicitly I.switchToWeb('WEBVIEW_io.selendroid.testapp'); ``` #### Parameters - `context` **[string][4]?** ### tap Taps on element. ```js I.tap("~buttonStartWebviewCD"); ``` Shortcut for `makeTouchAction` #### Parameters - `locator` **any** ### touchPerform Performs a specific touch action. The action object need to contain the action name, x/y coordinates ```js 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 #### Parameters - `actions` ### waitForElement Waits for element to be present on page (by default waits for 1sec). Element can be located by CSS or XPath. ```js I.waitForElement('.btn.continue'); I.waitForElement('.btn.continue', 5); // wait for 5 secs ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** element located by CSS|XPath|strict locator. - `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait ### waitForInvisible 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. ```js I.waitForInvisible('#popup'); ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** element located by CSS|XPath|strict locator. - `sec` **[number][8]** (optional, `1` by default) time in seconds to wait ### waitForText 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. ```js I.waitForText('Thank you, form has been submitted'); I.waitForText('Thank you, form has been submitted', 5, '#modal'); ``` #### Parameters - `text` **[string][4]** to wait for. - `sec` **[number][8]** (optional, `1` by default) time in seconds to wait - `context` **CodeceptJS.LocatorOrString?** (optional) element located by CSS|XPath|strict locator. ### waitForVisible Waits for an element to become visible on a page (by default waits for 1sec). Element can be located by CSS or XPath. ```js I.waitForVisible('#popup'); ``` #### Parameters - `locator` **CodeceptJS.LocatorOrString** element located by CSS|XPath|strict locator. - `sec` **[number][8]** (optional, `1` by default) time in seconds to wait [1]: http://codecept.io/helpers/WebDriver/ [2]: http://appium.io/ [3]: https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array [7]: http://webdriver.io/api/mobile/touchAction.html [8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number [9]: http://webdriver.io/api/mobile/rotate.html [10]: https://developer.android.com/reference/android/view/KeyEvent.html [11]: http://webdriver.io/api/mobile/setImmediateValue.html [12]: http://webdriver.io/api/mobile/setNetworkConnection.html [13]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object [14]: http://webdriver.io/api/mobile/swipe.html