最短でAirTestでUIテストをしてSlackに定期的に結果を通知する方法！

今年も始まりましたAdventCalendar！
この記事はサムザップ Advent Calendar 2022 12/1の記事です！

ここでは手軽に出来る最小の自動テストの環境構築方法を記事にしました。
「とりあえず自動テスト環境を作ってみて試したい！」といった方に読んでいただきたいです。

UnityエディタとAirTestで自動テストを動かしている様子

本記事で扱うこと

最短最小構成で「毎日同じ時間に自動テストを走らせて、結果をSlackに共有する」 を目標に、本記事では環境を構築していきます。使用ソフトとしては、主に以下のものになります。

・AirTest
・Slack
・Unity
・タイムスケジューラー

今回はUnityを使用していますが、AirTestに対応したものであれば別のものでも適応が可能となっております。
また、Windowでの実行を前提としていますがMacでも動作が出来るように該当箇所では補足を記載しています。

本記事で扱わないこと

本記事ではAirTestを使った自動テストの環境構築を解説するため、実際のAirTestの使い方やPythonコードの書き方は扱いません。
しかし、これらの情報はQiitaのみならず本やブログなどですでに多くの解説があります。詳しく知りたい方はそちらを参考にしてもらえればと思います。

作成するテスト環境

改めて 「毎日同じ時間に自動テストを走らせて、結果をSlackに共有する」 を目標にテスト環境を作っていきます。

この環境には大きく分けて3つの機能が必要です。
「アプリに対して自動テストを行う機能」
「自動テストの結果をSlackに共有する機能」
「毎日同じ時間に処理を実行する機能」

それではこの機能を一つずつ作成していきましょう。

アプリに対して自動テストを行う機能

この機能は AirTest と PocoSDK を使って作成をします。
AirTestとはEetEase社が開発をしているUIテストツールです。
AirTest単体でも画像認識などを使ったUIのテストができますが、PocoSDKを使うことでより強力なテストを実施ができます。

まずはAirTestIDEとPocoSDKの導入方法を解説します。

AirTestIDEの導入

AirTestには専用のIDEが用意されています。

１）AirTestのサイトに以下のURLからアクセス

２）以下のボタンをクリックし、IDEをダウンロードします

３）解凍後、[AirtestIDE]を起動します。
サインインを求められるポップアップが出ますが、[Skip]を押して問題ありません。

これでAirTestの導入は完了です。

PocoSDKの導入

１）POCOのSDKを以下のURLから取得

２）Unityプロジェクトの作成をします。今回はサンプルとしてUnityの[Runner Game]テンプレートを使用し、使用するUnityバージョンは2021.3.6f１となります。

UnityHubから[Runner Game]を選択し、プロジェクトを作成をクリック。

３）SDKからUnity3Dフォルダー以下を作成したUnityにコピーし、今回使用しない[ngui]、[fairygui]、[uguiWithTMPro]フォルダーを削除。
[3rdLib]フォルダー内の[Newtonsoft.Json.dll]を削除。

４）[PocoManager.cs]をメインカメラにアタッチ

これでPOCOの導入が完了しました。

それではUnityのビルドをして実行ファイルを生成しましょう。

５）[File]から[Build Setting]をクリック

６）設定を確認し、[build]をクリックします。保存先を聞かれるので、指定をするとビルドが始まります。

これで作成したビルドはAirTestとPocoの環境で使用できるようになりました。

AirTestとPocoの使い方について

AirTest自体の使い方についてはすでに素晴らしいページがいくつもあるため割愛をさせていただきますが、参考となるページを記載しておきます。
実際のテスト用のコードを書く際はこちらを参考に記載していくと良いでしょう。

テストの結果をSlackに送る

次は「テストの結果をSlackに送る」機能です。

今回のようにSlack上に通知を飛ばすなら SlackBot を使う簡単にできます。
SlackBotを使えばAirTestに記載したPythonのコードから以下のような投稿を行うことが可能です。

ここではSlackBotの設定方法とAirTest上のPythonを使って、Slackへメッセージを送る方法を解説します。

SlackBotの作成

テストの結果をSlackに通知するため、SlackBotを作成します。
Slackのアカウントとうがまだない場合はこちらから作成をしてください。(アイコン設定とうは不要です。無料のアカウント作成までで大丈夫です。)

１）以下のSlackのページにアクセスしてください

２）[Create an App]をクリック

３）ポップアップが出てくるので、[AppName]にボット名を、[Pick A wokspace to develop your app]に使用するワークスペース名を入れてください。(ワークスペース名が出てこない場合はこちらを参考にSlackのワークスペースを作成してください)

４）[OAuth & Permissions]を選択

５）ページ下部のScopesの[Add an OAuthScope]をクリックし[chat:write]と[chat:write.customize]を追加します

６）[Install App]から[Install to Workspace]をクリック

７）[許可する]をクリック

８）Slackのト－クン確認
(後の項目でトークンを使用するため、コピーやメモをしておくとスムーズです)

９）Slack上でボットを使用するチャンネルを右クリックし、出てきたウィンドウから[チャンネル詳細を表示する]をくりっく

１０）[インテグレーション]の[App]にある[アプリを追加する]をクリック

１１）先ほど[AppName]で設定したボット名があるはずなので、追加

これでSlackBotの追加は完了です。

AirTestで通信の確認

それでは実際に動かして確認をしてみましょう。
AirTestで新しいファイルを作成し、下記のコードを実行して動作の確認をしてみてください。
（TOKENのところには先ほどのトークンをコピー&ペーストしてください）

import requests

TOKEN = 'ここにTOKENを入れてください'
CHANNEL = 'airtest'

url = "https://slack.com/api/chat.postMessage"

headers = {"Authorization": "Bearer "+TOKEN}
data  = {
   'channel': CHANNEL,
   'text': '通信テスト！'
}
r = requests.post(url, headers=headers, data=data)
print("return ", r.json())

以下のようなチャットが投稿されれば無事に設定完了です！

これでAirTestのPythonからSlackに通知を飛ばすことができました。
あとはテスト内容に応じて上記のtextの部分に必要な情報を追って記載すれば問題ないでしょう。

毎日同じ時間に処理を実行する機能

それでは最後の機能ですが、Windowsであれば定期実行のために タスクスケジューラー という機能があります。
この機能はWindowsには最初から付いており、実行ファイルを指定の時間に起動できます。
今回作成したAirTestのPythonの実行ファイルも例外ではありませんので、この機能を使いましょう。
（タスクスケジューラーはWindowsの機能のため、Macにはありません。Macの方は別の方法がありますので、こちらの記事を参考にしてみてください。）

１）タスクスケジューラーを起動し、タスクの作成をクリックします。

２）タスクの作成ウィンドウで名前を設定します。ここでは[AirTest]としました。

３）操作タブに移動し、[新規]をクリックします。

４）[プログラム/スクリプト]の部分で今回AirTestで作成をしたPythonを指定します。

５）トリガータブに移動し、[新規]をクリックします。

６）実施のスケジュールを設定します。

これで設定した時間にAirTestが実行されるようになりました。

構築環境の実行

それでは実際にタスクスケジューラーから自動テストを実行してみましょう。
タスクスケジューラーで直近の時刻を設定し確認をしてみてください。
問題なく実行され、Slackに通知が飛んでいれば成功です！

今後の環境の拡張について

今回紹介したテスト環境はいかがだったでしょうか？
最小の機能しかないため、実際に扱うとなると足りない機能があったかもしれません。

例えばUnityのビルドはAirTestを行う前に自動で最新の状態をビルドしてくれたらとても楽になるかと思います。

今回は最小構成であることと構築難易度を下げることからJenkinsを用いませんでしたが、こういった機能はJenkinsや他のSlack API、GithubActionsを用いると実装できます。

ここでは紹介だけにとどめますが、Jenkinsとの連携方法はさまざまな資料があるため、ぜひご自身の環境にあった構築を模索してみてください。

毎晩の自動で最新ビルドに対してAirTestを実行したい

Jenkinsを用いて、毎晩決まったブランチをビルドすることが可能です。
UnityもPythonもJenkinsからコマンドをたたくことでUnityのビルド、AirTestの実行といったことをスケジュールに合わせて行うことができます

プッシュしたら自動テストを実行したい

GithubActionを使うことでプッシュをした際に自動ビルドをすることも可能です。
ただ、GithubActionsだけでは今回の自動テストの実行は難しいため、ビルドだけ行ってテストはJenkinsでコマンドをたたいて実行する必要が出てくるでしょう。

Jenkinsを用いた弊社のAirTest活用例について

弊社でのAirTestの活用についてをCEDEC 2020で登壇しております。
こちらも確認していただくと実際の活用例が分かるかと思います。

終わりに

今回は最短でできる自動テストの環境構築について書かせていただきました。

この記事が皆様のテスト環境導入の第一歩になればと思います。

明日は@shiimanさんの「S3ストレージクラス変更時の注意点」です。