Appium 2.0 Migration Playbook

Appium 2.0 is now the default that can be installed through NPM:

npm i --g appium

This will install Appium globally so it can be run from anywhere in your command line . You can start the Appium server with the following command:

appium

You should see some output that starts with a line like this:

rohan@Rohans-MacBook-Pro-14 appium_2 % appium
[Appium] Welcome to Appium v2.0.1 (REV 0ccd099bff8e384043883c4ae01b589794b13d72)
[Appium] Appium REST http interface listener started on http://0.0.0.0:4723
[Appium] You can provide the following URLS in your client code to connect to this server:
[Appium] 	http://127.0.0.1:4723/ (only accessible from the same host)
[Appium] 	http://192.168.0.62:4723/
[Appium] No drivers have been installed in /Users/rohan/.appium. Use the "appium driver" command to install the one(s) you want to use.
[Appium] No plugins have been installed. Use the "appium plugin" command to install the one(s) you want to use.

Let’s go ahead and install the Android UIAutomator2 and iOS XCUITest drivers

appium driver install uiautomator2
appium driver install xcuitest

You should get two successfully installed messages

✔ Installing 'uiautomator2' using NPM install spec 'appium-uiautomator2-driver'
ℹ Driver uiautomator2@2.29.4 successfully installed
- automationName: UiAutomator2
- platformNames: ["Android"]

✔ Installing 'xcuitest' using NPM install spec 'appium-xcuitest-driver'
ℹ Driver xcuitest@4.33.2 successfully installed
- automationName: XCUITest

This can be changed when instantiating the webdriver request or changed on loading the Appium server with the following command:

appium --base-path=/wd/hub

First we can check which versions of Appium are available on each server with the following command:

curl -X GET https://{ headspin-host }:{ headspin-port }/v0/{your-api-token}/wd/hub/versions

Then take the Web Driver URL append /versions to the end. Eg:

curl -X GET "https://dev-au-mel-1.headspin.io:7024/v0/4707c0d8da834821b6862bdd7185c039/wd/hub/versions"
{"status": 0, "value": {"default": "1.22.3", "available": ["2.0.0", "1.21.0", "1.20.2", "1.22.1", "1.22.0", "1.22.3", "1.22.2"], "drivers": {"default": {"uiautomator2": "2.29.1"}}, "plugins": {"default": {}}}, "session_id": null}

To use the desired version of Appium with plugins, please add the following capability to your Appium script:

{
    "headspin:appiumOptions": {
        "version": "2.0.0",
        "plugins": ["images", "relaxed-caps"]
    }
}

You can also just change the version or plugins with the following capabilities:

headspin:appiumVersion
headspin:appiumPlugins