Asial Blog

Recruit! Asialで一緒に働きませんか?

タスクランナーとの親和性を向上。AppiumをNode.jsで動かす

カテゴリ :
Monaca
タグ :
JavaScript
テスト
Appium

前回までのコードはRubyで書いていましたが、MonacaアプリはHTML5/JavaScriptが主な利用言語になります。そこで今回はアプリを動かすスクリプトをNode.jsベースに書き直してみます。



これがうまく動けば、Gulpのようなテストランナーと組み合わせることで、コードの変更からテストまでがとてもスムーズになるはずです。DevOpsを積極的に進める上でも役立つのではないでしょうか。



Appiumのインストール、起動までは前回までの記事を参照してください。



Node.jsの設定



Node.jsについてはあらかじめインストールされていることとします。まだ未インストールの方はNode.jsよりダウンロード、インストールしてください。



まずテストスクリプトを書くフォルダを作成します。



  1. mkdir appium_test
  2. cd appium_test
  3. npm init

そして必要なライブラリをインストールします。



  1. npm install wd --save

これで準備は完了です。テストをスクリプトを書きます。まずAppiumに接続するまでの処理です。



  1. "use strict";
  2.  
  3. var wd = require("wd");
  4. var browser = wd.promiseChainRemote("0.0.0.0", 4723);

今回はローカルにAppiumサーバを立てています。そして接続する際の情報を定義します。今回はiOSシミュレータ向けに書いています。



  1. var desired = {
  2.   "appium-version": "1.0",
  3.   platformName: "iOS",
  4.   deviceName: "iPhone 6 Plus",
  5.   app: "/Monaca_project_path/platforms/ios/build/emulator/AppiumTest.app"
  6. };

接続がうまくいった場合は、アプリの起動した状態になっているはずです。



  1. browser.init(desired).then(function() {
  2.   // この中にテストの処理を書きます
  3. });

実際の処理ですが、XPathでエレメントを取得しなければなりません。これがとてもネストが深く、分かりづらいのでGUI版Appiumのインスペクタを使うのをお勧めします。Recordボタンを押して、要素をクリックすると、そこまでのXPathが表示されます。




Appium Inspector

Appium Inspector



そしてXPathが分かったらコードに反映していきます。例えば最初の画面のHelloWorld!を知りたい場合は次のように書きます。



  1. browser.elementByXPath("//UIAApplication[1]/UIAWindow[1]/UIAScrollView[1]/UIAWebView[1]/UIAStaticText[1]").text().then(function(text) {
  2.   console.log(text);  // -> HelloWorld!
  3. });

全体としてPromiseで作られていますので、text()メソッドを実行しても {status: “pending”} が返ってくるだけです。then()でつないでテキストを受け取る必要があります。



そして非同期ということもあって、テキストの取得とクリックなどの処理をそのまま書いてしまうと、text()メソッドが間に合わずに画面遷移がはじまってしまいます。そこで、一画面ずつ順番に処理を行っていきます。



  1. // テキストを取得
  2. browser.elementByXPath("//UIAApplication[1]/UIAWindow[1]/UIAScrollView[1]/UIAWebView[1]/UIAStaticText[1]").text().then(function(text) {
  3.   console.log(text);
  4.   // タップ処理
  5.   browser.elementByXPath("//UIAApplication[1]/UIAWindow[1]/UIAScrollView[1]/UIAWebView[1]/UIALink[1]/UIAStaticText[1]").click().then(function() {
  6.     // タップした後の処理
  7.   });
  8. });

最後にアプリを終了しますが、この時も非同期処理で行われているのを意識しないといけません。



  1. browser.elementByXPath("//UIAApplication[1]/UIAWindow[1]/UIAScrollView[1]/UIAWebView[1]/UIALink[1]/UIAStaticText[1]").click().then(function() {
  2.   // 処理を遅らせないといきなり終了してしまいます
  3.   setTimeout(function() {
  4.     browser.quit();
  5.   }, 5000);
  6.   // ここに browser.quit(); を書くといきなりアプリが終了します
  7.   // browser.quit();
  8. });

実際に実行した時の動画です。




テストコードを実行

テストコードを実行



最後に全体のコードです。




  1. "use strict";
  2.  
  3. var wd = require("wd");
  4.  
  5. var desired = {
  6.   "appium-version": "1.0",
  7.   platformName: "iOS",
  8.   deviceName: "iPhone 6 Plus",
  9.   app: "/Volumes/SD/Dropbox/DevRel/Monaca/AppiumTest/platforms/ios/build/emulator/AppiumTest.app"
  10. };
  11.  
  12. var browser = wd.promiseChainRemote("0.0.0.0", 4723);
  13.  
  14. browser.init(desired).then(function() {
  15.   browser.elementByXPath("//UIAApplication[1]/UIAWindow[1]/UIAScrollView[1]/UIAWebView[1]/UIAStaticText[1]").text().then(function(text) {
  16.     console.log(text);
  17.     browser.elementByXPath("//UIAApplication[1]/UIAWindow[1]/UIAScrollView[1]/UIAWebView[1]/UIALink[1]/UIAStaticText[1]").click().then(function() {
  18.       setTimeout(function() {
  19.         browser.quit();
  20.       }, 5000);
  21.     });
  22.   });
  23. }).done();

注意点



JavaScriptで書く時の注意点としては、



  1. XPathで書く必要がある(ないかも知れませんがクラスでどう指定するのかが分かりませんでした…)
  2. 全体的に非同期処理


となっています。XPathは慣れればさほど難しくないかも知れませんが、Appiumのインスペクタを積極的に活用した方が良いでしょう。ただし画面の変化に対して弱くなってしまうように見えます。非同期についてはネストが深くなってしまう傾向がありますが、テストを適切に分離することで深くなりすぎるのを防げるかと思います。



JavaScriptを使う利点としてはRubyでiOSをテストする際にあった落ちるエラーが出なかったので、テストの品質が高くなりそうです。また、Appium自体がNode.jsでできているので親和性が高いかと思います。






Web開発ではGulpを使ってテストを定期的に実行するのが当たり前になっています。Monacaを使ったハイブリッドアプリ開発においても同じようにテストを細かく行うことで品質の高いアプリ開発ができるようになるでしょう。