{"id":558,"date":"2021-06-07T15:35:33","date_gmt":"2021-06-07T15:35:33","guid":{"rendered":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/2021\/06\/07\/getting-started-with-appium-setup-installation\/"},"modified":"2021-06-07T15:35:33","modified_gmt":"2021-06-07T15:35:33","slug":"getting-started-with-appium-setup-installation","status":"publish","type":"post","link":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/2021\/06\/07\/getting-started-with-appium-setup-installation\/","title":{"rendered":"Getting Started With Appium – Setup & Installation"},"content":{"rendered":"

<\/p>\n

\n

\n

\n

\n

<\/div>\n

\n

\n

<\/div>\n<\/div>\n

<\/div>\n

\n

<\/div>\n

\n

\n

Table of Contents<\/div>\n<\/p><\/div>\n<\/div>\n<\/div>\n

\n

\n

<\/div>\n

\n

\n

\n

\n

1<\/span><\/div>\n

What is appium?<\/a><\/div>\n

How does it work?<\/a><\/div>\n

Installation and setup.<\/a><\/div>\n

Install Java 8 and setup environment variable.<\/a><\/div>\n

For Mac<\/a><\/div>\n

For Windows:<\/a><\/div>\n

Install Maven and setup environment variable<\/a><\/div>\n

Method 1: Via homebrew for mac only.<\/a><\/div>\n

Method 2: Manual install<\/a><\/div>\n

Setting up Maven environment variable<\/a><\/div>\n

For Mac<\/a><\/div>\n

For Windows:<\/a><\/div>\n

Install Android studio for android SDK packages.<\/a><\/div>\n

Setup android environment variable<\/a><\/div>\n

For Mac <\/a><\/div>\n

For Windows<\/a><\/div>\n

For Mac only<\/a><\/div>\n

Creating an emulator via android studio<\/a><\/div>\n

Enabling Developer mode option in android phone\/Emulator<\/a><\/div>\n

Install PDANet (universal driver) to connect with Android devices<\/a><\/div>\n

Install Xcode (For Mac only).<\/a><\/div>\n

Install HomeBrew(For Mac Only)<\/a><\/div>\n

Appium Setup:<\/a><\/div>\n

Install Node.js<\/a><\/div>\n

Appium Installation<\/a><\/div>\n

Install Appium Doctor<\/a><\/div>\n<\/div>\n

\n

<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n

\n

What is appium?<\/h1>\n
As per official website: Appium is an open-source tool for automating native, mobile web, and hybrid applications on iOS mobile, Android mobile, and Windows desktop platforms. … Importantly, Appium is “cross-platform”: it allows you to write tests against multiple platforms (iOS, Android, Windows), using the same API.<\/p>\n
\n

\n<\/ins>\n<\/div>\n
How does it work?<\/h3>\n
Appium test script written in IDE will interact with the Appium Server which is nothing but the node server with the specified IP address and port number. Node server again passes the request to mobile devices or emulators using the uiautomator or XCUITest as a JSON format. All the UI elements associated with the mobile application can be controlled by using the appium client which is nothing but the derived one of selenium.<\/p>\n
Note: Remember using Windows only Android can be automated while in iOS both Android and iOS can be automated. <\/b><\/p>\n
Installation and setup.<\/u><\/h3>\n\n
Install Java 8 and setup environment variable.<\/li>\n
\u00a0Install Maven and setup environment variable.<\/li>\n
Install Android studio for android SDK packages.<\/li>\n
\u00a0Setup android environment variable.<\/li>\n
Creating an emulator via android studio.<\/li>\n
Enabling Developer mode option in android phone.<\/li>\n
Install PDANet (universal driver) to connect with Android devices.<\/li>\n
Install Xcode, HomeBrew, Carthage, appium-xcuitest-driver for (Mac only).<\/li>\n
Install Appium via npm.<\/li>\n
Install Appium via installer.<\/li>\n
Install Appium Doctor.<\/li>\n<\/ol>\n
Install Java 8 and setup environment variable.<\/u><\/b><\/span><\/h3>\n
Download Java 8 from https:\/\/www.oracle.com\/java\/technologies\/javase-jdk8-downloads.html<\/a> and install it.<\/p>\n
$\"\"$ <\/p>\n
$\"\"$ <\/p>\n
Next step is to set environment variables. We will set JAVA_HOME and the path variable.<\/p>\n
For Mac<\/b><\/h5>\n
For Mac OSX 10.5 or later, Apple recommends to set the $JAVA_HOME variable to \/usr\/libexec\/java_home, just export $JAVA_HOME in file ~\/. bash_profile<\/i> or ~\/.profile.<\/i><\/p>\n
Open terminal and type (You must be familiar with vi editor commands).<\/p>\n
$ vim .bash_profile<\/i><\/p>\n
Add below lines<\/p>\n
export JAVA_HOME=$(\/usr\/libexec\/java_home)<\/i><\/p>\n
export PATH=${JAVA_HOME}\/bin:$PATH<\/i><\/p>\n
Save the file<\/p>\n
Then run below command.<\/p>\n
$ source .bash_profile<\/i><\/p>\n
To confirm if it is set correctly type<\/p>\n
$ echo $JAVA_HOME<\/i><\/p>\n
It should return below path<\/p>\n
\/Library\/Java\/JavaVirtualMachines\/1.8.xx.jdk\/Contents\/Home<\/i><\/p>\n
Type \u201cjava -version<\/i>\u201d to confirm it.<\/p>\n
For Windows:<\/b><\/h5>\n
From windows search bar type advanced system settings.<\/p>\n
It will open System Properties<\/b> window.<\/p>\n
Select advance tab and click environment variable.<\/p>\n
From system variable, click to new button and enter variable name as JAVA_HOME and value as path to JDK installed.<\/p>\n
Next we have to edit the system path variable.<\/p>\n
\u00a0click on New button, and add this %JAVA_HOME%bin. Click OK<\/i><\/p>\n
From command prompt type java -version<\/i>. The output show java version example:<\/p>\n
$\"\"$ <\/p>\n
Install Maven and setup environment variable<\/b><\/h3>\nMethod 1: Via homebrew for mac only.<\/b><\/h5>\n
Run below command to install homebrew.<\/p>\n
\/usr\/bin\/ruby -e “$(curl -fsSL <\/i>https:\/\/raw.githubusercontent.com\/Homebrew\/install\/master\/install<\/i><\/a>)”<\/i><\/p>\n
To install maven<\/p>\n
brew install maven<\/i><\/p>\n
Method 2: Manual install<\/b><\/h5>\n1. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Download maven apache-maven-x.x.x-bin.zip<\/a> from path https:\/\/maven.apache.org\/download.cgi<\/a> and extract to your local \u00a0directory.<\/p>\n
$\"\"$ <\/p>\n
Setting up Maven environment variable<\/b><\/h3>\n
For Mac<\/b><\/h5>\n
1. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 The variable should be updated to bash_profile or ~\/.profile.<\/p>\n
2. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Open terminal and run below command.<\/p>\n
$ vim .bash_profile <\/i><\/p>\n
export MAVEN_HOME=\/Applications\/apache-maven-x.x.x<\/i><\/p>\n
export PATH=$MAVEN_HOME\/bin:$PATH<\/i><\/p>\n
$ source .bash_profile<\/i><\/p>\n
$ echo $MAVEN_HOME<\/i><\/p>\n
\/Applications\/apache-maven-x.x.x<\/i><\/p>\n
3. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 After setting environment variable run mvn -version<\/i><\/b> <\/b>to confirm if maven is set properly.<\/p>\n
$\"\"$ <\/p>\n
For Windows:<\/b><\/h5>\n
From windows search bar type advanced system settings.<\/p>\n
It will open System Properties<\/b> window.<\/p>\n
Select advance tab and click environment variable.<\/p>\n
From system variable, click to new button and enter variable name as MAVEN_HOME<\/b> and value as path to the Maven folder present.<\/p>\n
Next we have to edit the system path variable.<\/p>\n
Click on New button, and add this %MAVEN_HOME%bin<\/i>. Click OK<\/p>\n
From command prompt type mvn -version<\/i>. The output show maven<\/p>\n
Install Android studio for android SDK packages.<\/b><\/h3>\n
Android Studio Installation and download SDK packages. (Common for both Mac and Windows)<\/b><\/p>\n
<\/b><\/p>\n
1. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Download Android studio from https:\/\/developer.android.com\/studio<\/a> as per your OS and install.<\/p>\n
$\"\"$ <\/p>\n
2. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Launch android studio.<\/p>\n
3. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Create a dummy project, after Android studio is launched.<\/p>\n
4. \u00a0 \u00a0 \u00a0 \u00a0 Go to Tools \u00a0>> SDK manager. In the latest version of Android Studio, the ‘SDK Manager’ is an icon on the menu. This opens up the SDK manager dialog box.<\/p>\n
$\"\"$ $\"\"$ <\/p>\n
5. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Select the ‘Android SDK’ link under ‘System Settings’ on the left pane, and choose ‘SDK Tools’ and check the box \u201cIntel x86 Emulator Accelerator\u201d if not checked.<\/p>\n
\n
\u00a0Uncheck “Hide Obsolete Packages”\u00a0 option.<\/li>\n
\u00a0Tick mark “Android SDK Platform -Tools (obsolete)” .<\/li>\n
\u00a0Click on Apply -> click on OK Button. It will start downloading android sdk to your system.<\/li>\n
After installation cross check the path where you are able to see all sdk components.<\/li>\n<\/ol>\n
6. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Note down the Android SDK location path from sdk manager and copy to a notepad.<\/p>\n
7. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 For ex: \/Users\/username<\/b>\/Library\/Android\/sdk<\/p>\n
8. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Click OK to download start, it will take some time to download all the components.<\/p>\n
9. \u00a0 \u00a0 \u00a0 \u00a0 Close SDK manager.<\/p>\n
$\"\"$ <\/p>\n
Setup android environment variable<\/b><\/h3>\n
For Mac <\/b><\/h5>\n
Just like we set JAVA_HOME, set the Android environment variable.<\/b><\/p>\n
Open terminal and run below commands<\/p>\n
$ vim .bash_profile<\/i><\/p>\n
export ANDROID_HOME=\/Users\/username\/Library\/Android\/sdk<\/i><\/p>\n
export PATH=$ANDROID_HOME\/platform-tools:$PATH<\/i><\/p>\n
export PATH=$ANDROID_HOME\/tools:$PATH<\/i><\/p>\n
Save the file.<\/p>\n
$ source .bash_profile<\/i><\/p>\n
Open terminal and type adb version<\/i> to verify the environment is set properly.<\/p>\n
$\"\"$ <\/p>\n
For Windows<\/b><\/h5>\n
Steps for adding environment in windows are same as above for JAVA_HOME and MAVEN_HOME.<\/p>\n
Add ANDROID_HOME and value to sdk location under system variable.<\/p>\n
Variable Name: ANDROID_HOME<\/b><\/p>\n
Variable Value:<\/b> C:UsersxxxxxAppDataLocalAndroidSdk<\/i><\/p>\n
Then add <\/b>%ANDROID_HOME%platform-tools and %ANDROID_HOME%tools<\/i> in path variable.<\/b><\/p>\n
For Mac only<\/b><\/h5>\n
So if we add all environment variables then the file will look like this. Yes. there are some extra variables\u00a0 added which will come to know as you start automating.<\/p>\n
<\/i><\/p>\n
export JAVA_HOME=$(\/usr\/libexec\/java_home)<\/i><\/span><\/p>\n
export PATH=${JAVA_HOME}\/bin:$PATH<\/i><\/span><\/p>\n
export ANDROID_HOME=\/Users\/$(whoami)\/Library\/Android\/sdk<\/i><\/span><\/p>\n
export ANDROID_SDK_ROOT=$ANDROID_HOME<\/i><\/span><\/p>\n
export ANDROID_AVD_HOME=\/Users\/$(whoami)\/.android\/avd<\/i><\/span><\/p>\n
export PATH=$ANDROID_HOME\/tools:$ANDROID_HOME\/platform-tools:$ANDROID_SDK_ROOT\/emulator:$PATH <\/i><\/span><\/p>\n
export M2_HOME=\/Users\/$(whoami)\/Downloads\/Softwares\/Maven<\/i><\/span><\/p>\n
export PATH=$PATH:$M2_HOME\/bin<\/i><\/span><\/p>\n
Creating an emulator via android studio<\/b><\/h3>\n
Open Android studio.<\/li>\n
Go to Tools >> Android >> AVD Manager.<\/li>\n
From Virtual configuration window select >> Create a new device.<\/li>\n
Select the device you want to download. Ex. Pixel<\/b><\/li>\n
Select OS version as per your requirement. Ex.Oreo Android 8.0 with Google APIs.<\/b><\/li>\n
Accept the licence agreement.<\/li>\n
It will start downloading the image. (Takes time depending on network speed and size).<\/li>\n
After download start the emulator from avd manager \u00a0device list.<\/li>\n
Enabling Developer mode option in android phone\/Emulator<\/b><\/h3>\n
Go to settings and scroll down to About phone <\/b>\u00a0option.<\/p>\n
Scroll down to Build number and tap multiple times. You can see the toast message \u201cYou are now x steps away to being a developer\u201d.<\/p>\n
After tapping 5-7 times when you see \u201cNo you are a developer\u201d , which confirms that you have enabled developer mode.<\/p>\n
To confirm go back to the previous page and select System >> Advanced >> Developer option.<\/p>\n
From Developer option scroll down and enable USB debugging<\/b>, Verify apps over USB<\/b> option.<\/p>\n
Install PDANet (universal driver) to connect with Android devices<\/b><\/h3>\n
To interact with devices and system we need a USB driver, usb driver is different with respective to android devices. But we can install one driver which will work across all the android devices.<\/p>\n
\n
Go to http:\/\/pdanet.co\/install\/<\/a>.<\/li>\n
Download the installer as per your operating system and install it.<\/li>\n<\/ol>\n
$\"\"$ <\/p>\n
Install Xcode (For Mac only).<\/b><\/h5>\n
Open App store and search for xcode then install it.<\/p>\n
$\"\"$ <\/p>\n
Install HomeBrew(For Mac Only)<\/b><\/h5>\n
Open terminal.<\/p>\n
And type \/bin\/bash -c “$(curl -fsSL https:\/\/raw.githubusercontent.com\/Homebrew\/install\/master\/install.sh<\/a>)”<\/p>\n
This will install homebrew<\/b> in your mac machine.<\/p>\n
For more information go through https:\/\/brew.sh\/<\/a><\/p>\n
There is also a dependency, made necessary by Facebook’s WebDriverAgent<\/a>, for the Carthage<\/a> dependency manager. If you do not have Carthage on your system, it can also be installed with Homebrew<\/a><\/p>\n
brew install carthage<\/p>\n
$\"\"$ <\/p>\n
For real devices we can use xcpretty<\/a> to make Xcode output more reasonable. This can be installed by gem install xcpretty<\/p>\n
More information at : https:\/\/www.npmjs.com\/package\/appium-xcuitest-driver<\/a><\/p>\n
For appium-xcuitest-driver installation refer below link.<\/p>\n
https:\/\/github.com\/appium\/appium-xcuitest-driver\/blob\/HEAD\/docs\/real-device-config.md<\/a><\/p>\n
Appium Setup:<\/b><\/h3>\n
There are two ways to install such as via npm and installer.<\/p>\n
A) Installing via npm<\/b> which requires node.js installation.<\/p>\n
Install Node.js<\/b><\/h5>\n1. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Download node.js as per your operating system from https:\/\/nodejs.org\/en\/download\/<\/a>.<\/p>\n
$\"\"$ <\/p>\n
$\"\"$ <\/p>\n
2. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 After successful installation we have to set the environment variable for Windows OS but for mac it is not needed.<\/p>\n
Open command prompt or terminal and type \u201cnpm-v<\/i>\u201d it returns the version number which confirms that node.js is configured properly.<\/p>\n
Appium Installation<\/b><\/h3>\n
1. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Open command prompt or terminal in administrator mode<\/b> and run below command.<\/p>\n
2. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Run npm install -g appium<\/i>\u00a0 to install globally, if you want to install a particular version then run npm install -g appium@1.16.0<\/i><\/b>\u00a0 This will trigger the installation and it will take 5-10 mins depending on your network and RAM size.<\/p>\n
3. \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 After successful installation run appium<\/b> command in terminal\/command prompt.<\/p>\n
4. \u00a0 \u00a0 \u00a0 \u00a0 If this returns below result, then Appium is successfully installed to your system.<\/p>\n
B) Install via Appium installer.<\/b><\/p>\n
You can download appium installer from appium official website.<\/p>\n
Go to http:\/\/appium.io\/downloads.html<\/a> and click to download.<\/p>\n
$\"\"$ <\/p>\n
It will take you to https:\/\/github.com\/appium\/appium-desktop\/releases\/tag\/vx.<\/a>xx.x<\/p>\n
Select the installer as per your operating system and download.<\/p>\n
Appium-windows-x.xx.x.exe<\/a> file is for windows and Appium-mac-x.xx.x.dmg<\/a> file for mac.<\/p>\n
$\"\"$ <\/p>\n
$\"\"$ <\/p>\n
Install it. Then run it will open one window , hit the start button \u00a0appium server console.<\/p>\n
$\"\"$ <\/p>\n
$\"\"$ <\/p>\n
Install Appium Doctor<\/b><\/h3>\n
This tool is used to diagnose and fix common Node, iOS and Android configuration issues before starting Appium.<\/p>\n
To install run below command in terminal<\/p>\n
npm install appium-doctor -g<\/p>\n
$\"\"$ <\/p>\n
To execute, run\u00a0 appium-doctor<\/i><\/b> command.<\/p>\n
This will give you a report as below, if any configuration is missing please fix them and proceed.<\/p>\n
$\"\"$ <\/p>\n
<\/p>\n
In the next post, we shall discuss about Android ADB.<\/b><\/i><\/span><\/b><\/p>\n<\/div>\n<\/div>\n<\/div>\n
<\/div>\n<\/section>\n
<\/body><\/html><\/p>\n","protected":false},"excerpt":{"rendered":"
Table of Contents 1 What is appium? How does it work? Installation and setup. Install Java 8 and setup environment variable. For Mac For Windows: Install Maven and setup environment variable Method 1: Via homebrew for mac only. Method 2: Manual install Setting up Maven environment variable For Mac For Windows: Install Android studio for […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6],"tags":[],"class_list":["post-558","post","type-post","status-publish","format-standard","hentry","category-appium","post-wrapper","thrv_wrapper"],"_links":{"self":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/558","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/comments?post=558"}],"version-history":[{"count":0,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/558\/revisions"}],"wp:attachment":[{"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/media?parent=558"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/categories?post=558"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rahulshettyacademy.com\/blog\/index.php\/wp-json\/wp\/v2\/tags?post=558"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}