auto_check_cui.exe

テストシーケンスファイルを使った自動チェックを GUI ではなくコマンドラインで実行するためのツールです。

$ ./auto_check_cui.exe --help
usage: auto_check_cui.exe [-h] [-settings SETTINGS] [-product_name PRODUCT_NAME] [-platform PLATFORM] [-target_address TARGET_ADDRESS] [-device_id DEVICE_ID] [-port PORT] [-check_list CHECK_LIST] [-force_terminate FORCE_TERMINATE]

options:
  -h, --help            show this help message and exit
  -settings SETTINGS    path of settings.yaml (default: settings.yaml)
  -product_name PRODUCT_NAME
                        Target Product Name (default: None)
  -platform PLATFORM    Target Platform (default: None)
  -target_address TARGET_ADDRESS
                        Target IPv4 Address (default: None)
  -device_id DEVICE_ID  Target DeviceID (for Android) (default: None)
  -application APPLICATION
                        Windows: Path of Target App, Android: Target Activity (default: None)
  -port PORT            TCP Port Num(Default=8001) (default: 8001)
  -check_list CHECK_LIST
                        Path of Excel file (default: )
  -force_terminate FORCE_TERMINATE
                        Kill process when Check is Finished (default: False)

実行すると、以下の一連の処理を行います。

  1. ゲームとの通信を確立する
  2. 指定したテストシーケンスを実行する
  3. ゲームを終了させる
  4. 結果概要をコンソールに出力する

実行例

Windows 上で動作するゲームが対象の場合

./auto_check_cui.exe -platform=Windows -application=C:/build/PlayableMobileSample.exe -check_list=test_sample.xlsx

Android 上で動作するゲームが対象の場合

./auto_check_cui.exe -product_name=PlayableMobileSample -platform=Android -device_id=66eb298a -application=com.Morikatron.PlayableMobileSample/com.unity3d.player.UnityPlayerActivity -check_list=test_sample.xlsx

起動オプション

-settings

Playable! General Agent for Mobile で使用している設定ファイルを指定します。

  • このオプションを省略すると Playable! General Agent for Mobile が使用している settings.yaml を利用します。

-settings=settings.yaml

-product_name

Unity 製ゲームの Product Name を指定します。
ツールが接続すべきゲームを特定するのに使用します。

Unity エディターの Project Settings > Player > Product Name のことです。

  • Windows 上で動作するゲームが対象の場合は省略可能です。

-product_name=PlayableMobileSample

-platform

テスト対象のゲームが動作する環境を指定します。 現在、以下のプラットフォームが選択可能です。

  • Windows
  • Android

-platform=Windows

-device_id

ツールと同一のマシンでゲームを動かさない場合のゲームを実行する端末のデバイスIDです。

  • Android の場合、adb devices で取得できる、端末ごとに割り振られた device ID の事です。

-device_id=66eb298a

-application

対象のゲームに関する情報です。各プラットフォームごとに意味が異なります。

Windows の場合

Windows の場合にはゲームの実行ファイルへの path です。

-application=C:/build/PlayableMobileSample.exe
  • このオプションを省略すると、settings.yamlgame_binary_file_path_for_windows (ゲームバイナリ)が対象になります。

Android の場合

Android の場合には、対象となるアクティビティです。

-application=com.Morikatron.PlayableMobileSample/com.unity3d.player.UnityPlayerActivity
  • 端末には対象のゲームをあらかじめインストールしておく必要があります。
  • このオプションを省略すると、settings.yamlprev_android_activity (前回接続したアプリ)が対象になります。

-target_address

接続対象の IPv4 アドレスを指定します。

  • このオプションを省略すると設定ファイルに書かれている実行ファイルを起動します
  • アドレスを指定すると、当該クライアントを発見次第自動的にマッチングを行います

-target_address=192.168.0.10

-port

使用する TCP ポート番号を指定します。

  • このオプションを省略すると 8001 を使用します

-port=8002

-check_list

使用するテストシーケンス(テストシーケンスが書かれた Excel ファイル)を指定します。

-check_list=test_sample.xlsx

-force_terminate

終了時にゲームを強制終了するかのフラグです。 True を指定すると、Playble! Mobile Unity Plugin がゲームを終了できないような状況に陥った場合にゲームプロセスの終了を試みます。

  • このオプションを省略すると False となり、強制終了はしません

同一 PC 上で動作するゲームの自動での終了方法がない場合のワークアラウンドですので、 通常の場合はオプション指定の必要はありません。

-force_terminate=False