パイプラインでテストを実行する

1 つのテストをどのパイプラインでも

コマンドラインランナーの gtr-cli は、「テストを実行」ボタンとまったく同じようにテストを実行します: 同じアサーション、同じレポート、同じ履歴です。そこにパイプラインに必要なものが加わります: 終了コード、CI ツールが理解する結果ファイル、そして失敗のすべてのエビデンスが 1 つのフォルダーにまとまります。

jobs:  gui-tests:    runs-on: [self-hosted, windows]    steps:      - run: gtr-cli run tests --format github --junit results.xml

ビルドマシンを準備する

GUI テストは実際の画面上で再生されるので、実行するマシンには画面が必要です。

アカウントページのマシンキーでキーを作成し、エージェント上で、パイプラインが使う Windows アカウントとして、これを 1 回実行します:

gtr-cli login --key GTS-XXXX-XXXX-XXXX-XXXX

gtr-cli whoamiは、エージェントがサインインしているか、いつまでかを伝えます。サインインがないと実行は始まりません: COULD NOT RUN で始まる行を出力し、終了コード 3 で終わります。

ビルドエージェント: マシンキー

最初のコマンド

ビルドマシンのターミナルで、フォルダー内のすべてのテストを実行します:

gtr-cli run tests --countdown 0 --junit results\junit.xml --artifacts results\artifacts

--countdown 0はすぐに開始し (画面の前には誰もいません)、--junitは CI ツールが読む結果ファイルを書き、--artifactsは動画、レポート、失敗の画像を 1 つのフォルダーに集めます。

gtr-cli check tests

パイプラインが受け取るもの

実行は各テストの結果フォルダーにも保存されるので、GUI Test Runner-Recorder の履歴には、パイプラインの実行が自分の実行と並んで表示されます。

すぐに使える例

jobs:
  gui-tests:
    runs-on: [self-hosted, windows]
    steps:
      - uses: actions/checkout@v4
      - run: gtr-cli run tests --countdown 0 --format github --junit results\junit.xml --summary results\summary.md --artifacts results\artifacts
      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: gui-test-results
          path: results

入力せずにコマンドを組み立てる

どちらのアプリでも、コマンドラインと CI/CD (GUI Test Studio の「ファイル」メニュー、GUI Test Runner-Recorder の「テスト」メニュー) がコマンドを組み立ててくれます: 欲しいオプションにチェックを入れて結果をコピーするか、実際のパスが入った CI ツール向けのスニペットをコピーします。その「リファレンス」タブにすべてのオプションの説明があります。

拡大

よく使うオプション

gtr-cli help

失敗を Jira に報告する

不合格のテストは自動で Jira の課題になります: 再現手順、変化した所を囲んだ期待画像と実際の画像、PDF のバグレポート、そしてエビデンス付きです。同じ欠陥が別のビルド、ブラウザー、デバイスで再び見つかると、2 件目を作る代わりに、開いている課題にコメントが追加されます。

gtr-cli run tests --countdown 0 --jira on-failure --jira-project SCRUM --jira-labels ui-regression

接続情報は環境変数から取るので、トークンがコマンドラインやビルドログに現れることはありません: JIRA_BASE_URL (Jira サイト)、JIRA_USER_EMAIL、JIRA_API_TOKEN です。CI ツールでは、トークンをシークレットまたはパスワードパラメーターとして保管してください。GUI Test Runner-Recorder が Jira に接続されているコンピューターでは、代わりにその保存された接続が使われます。

実際の課題と実際のビルドによる流れの全体: Jira を信頼度レポートにつなぐ。

ビルドマシン上の Web アプリ

Web アプリで記録したテストは、自分でブラウザーを全画面のキオスクモードで開き、最後に閉じます。ビルドマシンでは、記録時の画面サイズと拡大縮小、サインイン済みでロックされていないデスクトップ、そして自身のタイムアウトで終わる実行が必要です。Web アプリを開くに、そうでないときに何が起こり、どうすればよいかが書かれています。

同じ注意事項はツール自体にもあります:

gtr-cli help web-apps

パイプラインですべてのブラウザーとデバイスを

複数のブラウザーとデバイス向けに作った Web テストは、--branch allですべてを実行し、それぞれが JUnit ファイルに自分の項目と自分の履歴を持ちます。スマートフォン、タブレット、その他のウィンドウなしのブランチは同時に実行されるので、専用の画面は必要ありません。gtr-cli infoがそれぞれの名前を一覧表示し、gtr-cli generateがまだないものを作ります。1 回の記録からすべてのブラウザーとデバイスへを参照してください。

gtr-cli generate tests --branch missing
gtr-cli run tests --branch all --countdown 0 --junit results\junit.xml

記録なしでテストを共有する

テストファイルには記録が含まれており、編集には必要ですが実行には必要ありません。GUI Test Studio のファイル、軽量な実行専用テスト (.GTR) としてエクスポートが、記録なしの同じテストを書き出します: ビルドマシンや、テストを実行するだけの同僚向けの、ずっと小さなファイルです。gtr-cli と GUI Test Runner-Recorder は、.GTR ファイルを他のテストと同じように実行します。

実行専用テストを使う場面

テストを実行するだけの場所ならどこでも使えます: ビルドマシン、テスターのコンピューター、持ち運ぶ必要があったりコードと一緒に保管したりするテスト一式など。実行専用テストの実行は、元のテストと同じ結果と同じレポートを出します。

テスト自体は残しておく

実行専用テストは編集できません: GUI Test Studio では開けません。.GTS を原本として残し、そこで編集し、変更後にもう一度エクスポートしてください。GUI Test Runner-Recorder も、テストメニューまたはテスト画面のエクスポートボタンからエクスポートできます。

複数のブラウザーとデバイスを持つ Web テスト

エクスポート時に何を含めるかを尋ねられます。すべてのブラウザーとデバイスは、生成済みのすべてのブランチを 1 つのファイルに入れ、--branch allですぐ使えるようにします。記録のみ、または表示中のブランチのみを選ぶと、それだけの実行専用テストになります。実行専用テストは実行しかできません: 新しいブラウザーとデバイスは .GTS から作られます。

テストをコードと一緒に保管する

テストは普通のファイルです: テスト対象のコードの隣のリポジトリに保管すれば、どのブランチにも合ったテストが付いてきます。