Setup Appium (Appium Server, Appium Doctor, dan Appium Inspector) pada macOS

Wahyu Ivan
6 min readJan 31, 2023

--

Image Source: pCloudy

Halo gais, ini cuma series kecil yang aku tulis untuk melengkapi series yang lebih besar di tulisan berikutnya. Nah jadi disini aku mau sharing ke kalian setup dan konfigurasi yang dibutuhin untuk menggunakan Appium di mac kalian. Sebelumnya aku mau kasi list nih ada beberapa hal yang kalian perlu persiapkan buat keperluan setup Appium.

  • Node.js
  • Java & JDK
  • Android Studio (untuk ADB dan AVD, platform Android)
  • Xcode (untuk Simulator, platform iOS)

Semua hal diatas akan di cek lebih lanjut oleh Appium Doctor jika sudah ter-install semua atau belum. Oke mari langung saja kita mulai install dan downloadnya.

1. Download dan Instal Node.js
Buat kalian yang sudah install Node.js, step ini bisa di skip ya. Kalian menuju halaman Node.js (nodejs.org), setelah itu kalian akan diarahkan menuju halaman untuk mendownload Node.js.

Halaman Utama Node.js

Kita pilih yang versi 18 agar lebih stabil, setelah itu tinggal menunggu download selesai. Kemudian kita jalankan instalasinya hingga selesai.

2. Download dan Instal Java dan JDK
Buat kalian yang sudah install Java dan JDK, step ini bisa di skip ya. Untuk download Java, kalian bisa menuju halaman Download Java for macOS.

Halaman Utama Website Java

Setelah menekan link diatas, kalian akan diarahkan menuju halaman utama dari halaman web Java dan klik tombol diatas untuk mendownload, dan untuk download JDK kalian bisa menuju halaman Java Downloads | Oracle.

Nah khusus buat JDK, saat kalian memilih salah satu link download diatas, kalian akan diminta membuat akun Oracle dulu sebelum bisa mendownload filenya. Jika keduanya sudah terdownload, kalian install dan tunggu hingga semua selesai.

3. Download dan Install Android Studio
Buat kalian yang sudah install Android Studio, step ini bisa di skip ya. Untuk download Android Studio, kalian bisa menuju halaman Download Android Studio & App Tools — Android Developers.

Halaman Utama Android Studio

Setelah menekan link diatas, kalian akan diarahkan menuju halaman web Android Studio. Tekan tombol download di halaman utama, lalu tunggu hingga selesai mendownload.

Jika sudah, maka tinggal langsung di-install saja. Setelah selesai install, kalian buka Android Studio dan buat project dummy agar semua tools di dalam Android Studio otomatis ter-install. Lalu setelah selesai, kalian buka setting pada Android Studio kalian.

Menu Setting

Setelah itu, kalian akan diarahkan menuju halaman setting dan buka menu System Setting, lalu pilih sub menu Android SDK. Setelah itu, pada halaman Android SDK, pilih tab SDK Tools dan centang pada Android SDK Command-line Tools (latest).

Android SDK Tools

Setelah itu, klik tombol “Apply” dan tunggu prosesnya hingga selesai. Lalu langkah berikutnya kita akan membuat virtual device melalui Android Studio. Kalian buka menu Tools yang ada di atas, lalu pilih opsi Device Manager.

Menu Device Manager

Setelah kalian ada di menu Device Manager, pilih opsi Create Device. Kalian bebas memilih device apapun untuk menjadi emulator kalian. Sebagai contoh aku bakal memilih device Pixel 6 dengan pilihan system image Android 11 (jika kalian belum ada mendownload system image, kalian akan disuruh mendownload dulu).

4. Download dan Install Xcode
Buat kalian yang sudah install Xcode, step ini bisa di skip ya. Untuk mendownload dan install Xcode, kalian bisa buka App Store kalian lalu ketik pada pencarian “xcode”. Setelah kalian temukan, kalian tinggal download dan install.

Aplikasi Xcode pada App Store

Nah setelah selesai terinstall, kalian tinggal buka Xcode, lalu kita akan coba buka untuk Simulator dari Xcode. Kalian tinggal cari tulisan Xcode di pojok kiri atas, tekan lalu pilih Open Developer Tool. Setelah itu, akan tampil beberapa sub-menu dan pilih menu Simulator.

Menu Simulator

Setelah kalian tekan, maka otomatis Simulator akan menampilkan emulator default yaitu emulator iPhone terbaru (untuk saat ini yaitu iPhone 14 Pro Max dengan iOS 16.2). Tampilannya akan seperti ini.

Tampilan Simulator

Oke semuanya aman, sekarang kita akan lanjut ke step berikutnya yaitu set path dan alias di terminal kita.

5. Set Variable dan Alias di Terminal
Step berikutnya yaitu set variable dan alias di terminal. Kalian jalankan perintah nano ~/.bashrc atau nano ~/.zshrc di terminal kalian, lalu copy kode di bawah ini.

export ANDROID_HOME=/Users/{user}/Library/Android/sdk
export JAVA_HOME=$(/usr/libexec/java_home)
export ANDROID_SDK_HOME="~/Library/Android/Sdk"

alias emulator="$ANDROID_SDK_HOME/emulator/emulator"

Variable yang dibutuhkan oleh Appium yaitu ANDROID_HOME dan JAVA_HOME, dan alias emulator diatas sebenarnya cuma untuk membantu menjalankan emulator Android tanpa membuka Android Studio kalian. Jika sudah, kalian save dan jalankan perintah source ~/.bashrc atau source ~/.zshrc. Untuk mencoba apakah alias kalian sudah bekerja, kalian bisa menjalankan perintah emulator -list-avd dan perintah ini akan memberi kalian list virtual device Android kalian.

Hasil Menjalankan Command emulator -list-avds

Nah, sekarang kita akan lanjut ke step terakhir yaitu download dan install Appium Server dan Appium Doctor.

6. Download dan Install Appium Server dan Appium Doctor
Pertama buka terminal kalian, lalu jalankan perintah npm i appium@next -g dan npm i appium-doctor -g. Tunggu hingga proses instalasi keduanya selesai. Jika sudah, kalian bisa cek dengan menjalankan perintah appium -v dan appium-doctor --version.

Kita akan menginstall beberapa driver untuk Appium server kita. Pertama jalankan perintah appium driver list pada terminal kalian. Maka akan menampilkan hasil seperti ini.

Hasil Menjalankan Command appium driver list

Nah, dapat kalian lihat beberapa driver pada server Appium kalian belum terinstall. Sebagai contoh, aku akan menginstall driver untuk Android dan iOS yaitu uiautomator2 dan xcuitest. Kalian tinggal menjalankan perintah appium driver install uiautomator2 dan appium driver install xcuitest. Jika sudah berhasil, maka di terminal kalian akan menampilkan seperti ini.

Hasil Instalasi Driver UIAutomator2
Hasil Instalasi Driver XCUITest

Langkah berikutnya jika tidak menemukan kendala, buka 2 window terminal baru, lalu jalankan perintah appium danappium-doctor. Perintah pertama berfungsi untuk start server Appium dan yang kedua berfungsi untuk menjalankan Appium Doctor untuk mengecek apakah ada konfigurasi yang kurang sebelum menggunakan Appium untuk testing. Hasilnya dapat kalian lihat di bawah ini.

Hasil Menjalankan Command Appium
Hasil Menjalankan Command appium-doctor

Nah, kalau kaya gini sih artinya semua requirement yang dibutuhkan sudah terpenuhi. Sekarang kita menuju step terakhir yaitu download dan instalasi Appium Inspector.

7. Download dan Install Appium Inpsector
Langkah terakhir yaitu download dan install Appium Inspector. Aplikasi ini bertujuan untuk mempermudah kita mendapatkan x-path atau accesibility id dari komponen aplikasi yang ingin kita uji (singkatnya sejenis tools inspect element tapi bisa untuk aplikasi selain web contohnya aplikasi mobile Android atau iOS). Kalian bisa mendownloadnya disini Releases · appium/appium-inspector (github.com). Jika sudah tinggal install dan jalankan aplikasinya.

Tampilan Aplikasi Appium Inspector

Sebagai contoh, kita akan buatkan konfigurasi untuk versi Android dan iOS. Kalian bisa ikuti setup di bawah ini.

Konfigurasi Appium Inspector untuk Android
Konfigurasi Appium Inspector untuk iOS

Untuk variabel platformVersion dan deviceName kalian bisa cek di Device Manager Android Studio kalian atau Simulator di Xcode kalian. Nah jika sudah, kalian jalankan dulu emulator Android kalian untuk yang versi Android, untuk yang iOS tidak perlu dijalankan dahulu karena nanti akan otomatis berjalan, setelah itu tekan tombol “Start Session”. Jika sudah berhasil maka tampilan Appium Inspector kalian akan seperti ini.

Tampilan Appium Inspector Untuk Android Setelah Berhasil Dijalankan
Tampilan Appium Inspector Untuk iOS Setelah Berhasil Dijalankan

Okay sekian aja untuk konfigurasi di mac. Jika kalian ada kendala bisa langsung komentar aja ya, sebisa mungkin akan ku bantu untuk memecahkan kendala yang kalian hadapi. Terimakasih sudah membaca!

--

--

Wahyu Ivan
Wahyu Ivan

Written by Wahyu Ivan

Tech Enthusiast • Software Engineer 💻 wahyuivan.dev

No responses yet