• Stars
    star
    142
  • Rank 258,495 (Top 6 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created over 9 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The obsolete driver for iOS versions 9.3 and below (pre-XCTest era)

Appium iOS Driver

NPM version Downloads Dependency Status devDependency Status

Build Status

Appium iOS Driver is a test automation tool for iOS devices up to an including iOS 9.3. Appium iOS Driver automates native, hybrid and mobile web apps, tested on simulators and real devices, using Apples' UI Automation framework. Appium iOS Driver is part of the Appium mobile test automation tool.

To automate iOS devices with a version of iOS greater than 9.3, see appium-xcuitest-driver.

Note: Issue tracking for this repo has been disabled. Please use the main Appium issue tracker instead.

iOS Support

Appium iOS Driver supports iOS versions 8+

Installation

npm install appium-ios-driver

Authorization for automation support

On some systems Instruments is not authorized to automate iOS devices. This package comes with a little utility that pre-authorizes Instruments to run UIAutomation scripts.

Running the authorization script will bring up an alert that prompts the user to input their sudo password. There is no way around this.

Command line usage

If this package has been installed globally (either as part of an Appium installation, with npm install -g appium, or individually, with npm install -g appium-ios-driver), a global command line utility will be installed, so you simply need to invoke it:

$ authorize-ios

Programmatic usage

To invoke programmatically (in, for instance, a test runner) is as simple as importing and invoking the authorize function, which returns a Promise:

npm install -S appium-ios-driver
import { authorize } from 'appium-ios-driver';

authorize()
  .then(function () {
    console.log('iOS authorized!');
  })
  .catch(function (err) {
    console.error(`Error authorizing: ${err.message}`);
  });

Usage

Import iOS Driver, set desired capabilities and create a session:

import { IosDriver } from `appium-ios-driver`

let defaultCaps = {
  app: 'path/to/your.app',
  platformName: 'iOS',
  deviceName: 'iPhone 6'
};

let driver = new IosDriver();
await driver.createSession(defaultCaps);

Run commands:

await driver.setOrientation('LANDSCAPE');
console.log(await driver.getOrientation()); // -> 'LANDSCAPE'

Commands

Command
active
asyncScriptTimeout
back
background
checkForAlert
clear
click
clickButtonToLaunchSafari
clickCoords
clickCurrent
clickWebCoords
closeAlertBeforeTest
closeApp
closeWindow
convertElementsForAtoms
deleteCookie
deleteCookies
elementDisplayed
elementEnabled
elementSelected
execute
executeAsync
executeAtom
executeAtomAsync
executeMobile
findElOrEls
findUIElementOrElements
findUIElementsByXpath
findWebElementOrElements
flick
flickElement
forward
getAlertText
getAtomsElement
getAttribute
getContexts
getContextsAndViews
getCookies
getCssProperty
getCurrentContext
getDeviceTime
getLatestWebviewContextForTitle
getLocation
getLocationInView
getLog
getLogTypes
getName
getOrientation
getPageSource
getScreenshot
getSimFileFullPath
getSize
getText
getUrl
getWindowHandle
getWindowHandles
getWindowSize
getWindowRect
handleTap
hideKeyboard
initAutoWebview
isWebContext
keys
launchApp
listWebFrames
lock
mobileRotation
mobileScroll
mobileShake
mobileWebNav
moveTo
nativeTap
nativeWebTap
navToInitialWebview
navToViewThroughFavorites
navToViewWithTitle
onPageChange
parseElementResponse
parseExecuteResponse
parseTouch
performMultiAction
performTouch
postAcceptAlert
postDismissAlert
pullFile
pullFolder
pushFile
receiveAsyncResponse
refresh
setAlertText
setContext
setCookie
setFrame
setGeoLocation
setOrientation
setUrl
setValue
setValueImmediate
setWindow
stopRemote
submit
title
translateWebCoords
typeAndNavToUrl
useAtomsElement
useNewSafari
waitForAtom
webContextIndex
webFlickElement
xySpeedFlick

Insecure Features

These can be enabled when running this driver through Appium, via the --allow-insecure or --relaxed-security flags.

Feature Name Description
get_server_logs Allows retrieving of Appium server logs via the Webdriver log interface

Watch code for changes, re-transpile and run unit tests:

gulp watch

Test

For tests, the default sims required are an iOS 9.2 iPhone 6 and iPad 2, which you can create as follows if one doesn't already exist on your system (use xcrun simctl list to check first):

xcrun simctl create "iPhone 6" "iPhone 6" 9.2
xcrun simctl create "iPad 2" "iPad 2" 9.2

Then you can run unit and e2e tests:

// unit tests:
gulp once

// e2e tests - specify your desired iOS version, for example iOS8.4:
DEVICE=ios84 gulp e2e-test

More Repositories

1

sample-code

appium sample code (dotnet, java, node, perl, php, python, ruby, etc.)
HTML
1,621
star
2

sign

Sign.jar automatically signs an apk with the Android test certificate.
Java
402
star
3

appium-dot-app

The Mac GUI for Appium
Objective-C
190
star
4

selenium-objective-c

Selenium WebDriver Bindings for Objective-C
Objective-C
81
star
5

php-client

PHP client library for Appium
PHP
71
star
6

tutorial

tutorials for appium
Ruby
59
star
7

appium-dot-exe

the Windows GUI for Appium
C#
56
star
8

appium-android-bootstrap

Npm module for androidBootstrap, the java project which appium uses to interact with UiAutomator
Java
54
star
9

robots

Robots for Appium
JavaScript
49
star
10

unlock_apk

Android helper Activity to unlock + wakeup the device.
Java
39
star
11

screen_recording

Activate and record the iOS Simulator or Android emulator to a .mov
Objective-C
36
star
12

appium-plugins

Officially-maintained plugins for the Appium server
JavaScript
32
star
13

appium-instruments

IOS Instruments + instruments-without-delay launcher used by Appium
JavaScript
23
star
14

io.appium.android.ime

Android Input Manager for testing Unicode
Java
19
star
15

appium-uiautomator

Android uiautomator driver used by Appium
JavaScript
17
star
16

appium_apk_tools

Extract strings.xml from an APK and convert to JSON
Java
16
star
17

appium-webdriveragent-driver

WebDriverAgent integration for Appium
JavaScript
14
star
18

appium-uiauto

Appium uiauto ios driver
JavaScript
13
star
19

java-workshop

Java workshop for Appium
Java
10
star
20

flaky

Ruby
9
star
21

appium-selendroid-driver

Appium's Selendroid integration
JavaScript
9
star
22

authorize-ios

A little utility that pre-authorizes Instruments to run UIAutomation scripts against iOS devices
JavaScript
7
star
23

appium-ci

Standalone gulp wrapper for appium ci.
JavaScript
6
star
24

appium-jenkins

Tools and scripts used to manage Appium Jenkins CI server.
JavaScript
4
star
25

windows-phone-8-bootstrap

bootstrap server for windows phone 8
C#
4
star
26

javascript-workshop

Appium workshop using JavaScript
JavaScript
4
star
27

appium-atoms

WebDriver JS atoms built for Appium
Shell
3
star
28

verify

Verify APK cert md5 sum matches expected value
Java
2
star
29

logger

Logging utility for appium packages
JavaScript
2
star
30

XCUITest-driver

Swift
2
star
31

unsign_and_move

Deletes META-INF folder from a zip file. Also contains a jar to move manifest.
Java
2
star
32

node-mobile-json-wire-protocol

Routing and handling for the Mobile JSON Wire Protocol
JavaScript
2
star
33

appium-selendroid-installer

Selendroid installers used by appium
JavaScript
1
star
34

appium-ios-log

Access to iOS system and crash logs
JavaScript
1
star
35

appium-safari-driver

Connects to Safari Debugger, for automating Safari on iOS and iOS webviews
JavaScript
1
star