[Appium] Appium과 python-client를 이용해 안드로이드(Android) 테스트 환경 구축

Appium을 설치하고 Appium-Python-Client를 이용해 Android를 테스트 할 수 있는 환경을 구축해보자


환경 및 선수조건

  • Python
  • npm
  • Homebrew(for mac), apt-get(for Ubuntu)
  • Android SDK 설치(Android Studio가 설치되어 있어도 무방함)
  • Android AVD(안드로이드 에뮬레이터가 준비되어 있어야 합니다.)
  • Liunx or Mac(이 포스트는 Mac 기준입니다.)


Appium이란?

테스트 환경 구축을 중심으로 하는 포스트라 정리만 간단하게 하고 넘어가겠습니다.

  • Appium이란 네이티브, 모바일 웹 그리고 하이브리드 어플리케이션의 자동화를 해주는 오픈소스 툴입니다.

현재 iOS, Android 그리고 Windows Desktop 플랫폼을 지원하고 있습니다.

동일한 API를 이용해서 iOS, Android에 테스트를 실행할 수 있다고 공식문서에는 나와있는데 아직 직접 실행을 해보지는 않았습니다.(추후 확인 예정)

웹 브라우저 자동화 툴인 Selenium과 같은데 모바일 환경에서 제공해주는거라고 이해하면 쉽습니다.

Importantly, Appium is "cross-platform": it allows you to write tests against multiple platforms (iOS, Android, Windows), using the same API.
This enables code reuse between iOS, Android, and Windows testsuites

appium_homepage


Appium 구조

Appium은 크게 ServerClient의 구조로 되어 있습니다.

  • Server: Appium을 실행하며 REST API를 제공해 Client로부터 요청을 받아서 그 명령어들을 모바일 기기에서 실행하고 다시 그 결과를 Client에게 전달해주는 역할을 합니다.
  • Client: 테스트 혹은 자동화 코드를 작성해서 Server에 요청을 보냅니다. 실질적으로 Client는 요청을 하고 응답에 대한 처리만 하며 자동화나 에뮬레이팅은 Server에서 진행됩니다!

이렇게 구조를 분리함을 통해서 Client는 더 다양한 환경에서 테스트 혹은 자동화 코드를 작성할 수 있고 Server는 클라우드와 같은 여러 환경에서 돌려 볼 수 있습니다.


Appium 설치

이제 Appium을 설치해봅시다. node나 npm 관련해서 나오는 오류는 구글링을 통해서 해결해야 합니다.

npm 및 Node 설치

appium을 설치하려면 우선 npm이 설치되어있어야 하며 없는 분들은 아래 코드를 통해서 설치를 해야합니다.

$ brew install node


appium 설치

이제 npm을 통해서 appium을 설치합니다.

$ npm install appium


appium-doctor 설치

이제 npm을 통해서 appium-doctor을 설치합니다.

appium-doctor는 appium이 설치되고 나서 다른 환경들이(dependency같은 부분들이) 제대로 세팅 되어있는지 확인해도록 하게 도와주는 패키지 입니다.

$ npm install appium-doctor


appium-doctor 실행을 통한 의존성 및 환경 확인

다음 아래 코드를 통해서 appium-doctor를 실행하면 자동으로 의존성 확인을 진행하며 X표시가 난 부분이 있다면 세팅을 해줘야합니다.

$ appium-doctor

저와 같은 경우에는 JAVA_HOME과 ANDROID_HOME의 PATH가 설정이 되어있지 않았는데 설정해주고 나서 아래와 같이 정상 작동 하였습니다.

appium_homepage


Android 가상 머신 열기

Android Stuio를 설치했다면 sdk가 있습니다. appium-doctor를 사용해서 환경을 제대로 설정하셨다면 $ANDROID_HOME/tools/emulator를 통해서 emulator들이 있는 폴더에 접근해주시면 됩니다.

다음 아래 명령어를 통해서 avd 기기가 있는지 확인합니다.

$ $ANDROID_HOME/tools/emulator -list-avds

avd-list

만약에 기기가 하나도 없다면 Android Studio를 통해서 avd를 하나 만들거나 Commnad Line을 통해서 생성하시면 됩니다. 가상기기를 생성하는 부분을 여기서는 포스팅하지 않겠습니다.

안드로이드 가상 머신을 하나 생성합니다. 저는 위에 있는 Pixel_API_22를 통해서 해보겠습니다.

아래처럼 명령어를 실행하면 됩니다.

$ $ANDROID_HOME/tools/emulator -avd [avd name]

예시는 아래와 같으며 성공적으로 되면 avd가 나오고 다음 아래와 같은 결과를 출력합니다.

$ $ANDROID_HOME/tools/emulator -avd Pixel_API_22

avd-on


Chrome Driver 설치

이제 appium을 실행해주기 위해서는 chrome driver가 필요합니다.

상황에 따라서 컴퓨터에 설치되어 있는 분도 계시고 아닌분들도 계실텐데 Android 버전에 따라서 작동 안하는 부분도 있고 해서 직접 파일을 받아서 실행해보겠습니다.

https://chromedriver.storage.googleapis.com/index.html에서 다운 받을 수 있으며 여기서는 2.33 버전으로 진행하겠습니다.

들어가서 다운로드 하시고 자신의 컴퓨터에 설치된 경로를 기억해줍시다.

chromedriver-download-link


Appium 실행

다운 받은 chrome driver와 함께 아래의 명령어로 실행해줍니다.

$ appium --chromedriver-executable [Chrome Driver Path]

예시

$ appium --chromedriver-executable /Users/taewoo/Desktop/chromedriver_233

appium-with-chromedriver


Appium Python Client 설치 및 작성

appium/python-client 설치

아래의 명령어를 통해서 pip를 통해 설치합니다.

$ pip install Appium-Python-Client


코드 작성

아래처럼 코드를 작성합니다.

appium_test.py

# Android environment
import unittest
from appium import webdriver

# 아래 필요한 정보들을 기입해 줍니다.
# 안드로이드 버전은 5.1로 하였습니다.
desired_caps = {}
desired_caps['platformName'] = 'Android'
desired_caps['platformVersion'] = '5.1'
desired_caps['deviceName'] = 'Android Emulator'
# 아래 테스트하고자 하는 app의 apk경로를 넣어줍니다.
desired_caps['app'] = '/Users/taewoo/Documents/Unopen.Lab/TWpower/Undang-Android/app/build/outputs/apk/debug/app-debug.apk'

# appium이 돌아가고 있는 서버의 http 주소를 입력해줍니다.
# 현재를 local에서 실행하고 있기 때문에 아래처럼 작성하였습니다.
driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps)
# 웹뷰를 가져옵니다.
driver.switch_to.context('WEBVIEW')

# 가볍게 테스트를 해봅니다.
# 테스트 코드는 실행하는 앱에 따라서 다르게 나옵니다!
assert '지금 한강은' in driver.page_source
driver.quit()

실행

$ python appium_test.py


참고자료