Appium

Selenium WebDriver API 準拠のマルチプラットフォーム対応 E2E テスティングフレームワーク。

サポートプラットフォームは iOS, Android, Windows ということで React Native の守備範囲とけっこうかぶる。

すべて Appium サーバーにリクエストを出してテストする形になるが、ざっくり動作を説明すると次のようになる。

Appium サーバーがシミュレーター起動
Appium サーバーがシミュレーターに目的のアプリをインストール
Appium サーバーがシミュレーターに WebDriver API を解するアプリ操作用アプリをインストール
テストスクリプトが Appium サーバーにもろもろの操作リクエストを出すとアプリ操作用アプリが動く

iOS でしか試していないものの動作自体はけっこう安定している。テストを流すタイミングによってはシミュレーターの終了とかちあってタイムアウトあけまでしばらくおあずけを食らうこともあるが、手元で流す分には問題なかった。

公式ドキュメントは最新の情報が整備されているが、 API などについては多くの言語で叩けることもあってかちょっと参照しづらい。

環境構築

Node.js version

バージョン 6 以上が必要とのことなので 6 の最新を使うよう設定する。チームメンバーが同じものを使えるように avn-n などいれて .node-version でバージョン固定。

.node-version

6.9.1

react-native init

react-native init してプロジェクトを作る。これはいつものことですね。

react-native init AppiumSample

yarn 0.16.0 以上が使える状態だと yarn を使ってくれるようになったので事前に npm install -g yarn@latest しておくと爆速開発できる。爆速開発したくない ?

Appium セットアップ

公式ドキュメントや動いているものの package.json を参照すると手っ取り早い。

https://github.com/appium/appium/blob/master/docs/en/appium-setup/running-on-osx.md
https://github.com/januswel/rn-appium-sample/blob/master/package.json

yarn add appium wd --dev

もひとつ、 appium-doctor というコマンドが前提が揃っているかを確かめてくれるのでこれを使うといい。公式だと global install しているけど依存は少ないほうがいいのでということと、メンバーのセットアップがうまくいっているかをすぐに確かめられるのでプロジェクトの devDependencies に突っ込む。

yarn add appium-doctor --dev
$(yarn bin)/appium-doctor

うちの場合、環境変数がいくつか足りてなかったのでそれを追加。

.zshrc

export JAVA_HOME=$(/usr/libexec/java_home)
export PATH=${PATH}:${JAVA_HOME}/bin

あと Xcode 8 以降だと依存管理に carthage を使っているようなのでこれもいれろと言われる。

brew update
brew install carthage

iOS simulator の authorize

You need to do this every time you install a new version of Xcode.

と書かれているのでこれもやってしまう。

yarn global add authorize-ios
sudo authorise-ios

テストスクリプト

大安定の mocha で書く。今回は最低限のサンプルということで Node.js 標準の assert を使っている。

公式のサンプルがかなりわかりやすいが、最低限ではないので参考に最低限のテストスクリプトをてろてろ書いていく。

WebDriver client の API リファレンスはここに。

できたものがこれ。

CONFIG.DEVICE の app については実行時に指定できたほうがいいと思うが最低限ということで決め打ち。

このパスは react-native run-ios すると生成される。事前に作っておこう。もしくは Xcode 開いてビルドした結果でもよし。その場合 ~/Library/Developer/Xcode/DerivedData/ 以下に生成される。

Appium Inspector

この部分、 xpath で指定する方式だと iOS と Android で違うものを指定しないといけないので class 指定とかで逃げたかったんだけど Appium Inspector が Xcode 8 に対応していないので無理だった。

Appium Inspector は公式提供の Appium.app をインストールすると使えるようになるらしい。

brew cask install appium

あと iOS 9.3 以降は XCUITest というものに変わったらしく、余計に Appium Inspector 使えないとテストがまともに書けない。 xpath で地道に //* から辿っていった結果がこれだよ !!

間が悪すぎる。宿題ですね。

簡単なまとめ

簡単にセットアップできたものの、いま現在肝心のテストスクリプトが書けない状態なので評価しようがないというのが正直なところ。テストのためにビルドツールのバージョン下げるというのも本末転倒なので。

ただ、 Appium 含め E2E テスティングフレームワークは進化が早すぎて投資するにはまだ早いかなという印象が非常に強い。

Appium は js.foundation に移管されたということ、 WebDriver API 準拠ということもあり、今後安定していくと思っているが、専門部隊でない限りまだコスパが悪すぎる。

まずは React コンポーネントのテストを書いて地道に品質あげていくのがいいかな。