4. セットアップ¶
Accel Studio テスト機能 は、 iAP とは別に、Accel Studio テスト機能 テスト実行エージェント を用意する必要があります。
項目
4.1. エージェントの実行環境について¶
4.1.1. 必要なネットワーク環境¶
Accel Studio テスト機能 テスト実行エージェント は、Playwrightを経由してアプリケーションサーバと通信します。また、アプリケーションサーバは Accel Studio テスト機能 テスト実行エージェント に対して、テスト実行などのリクエストを送ります。そのため、アプリケーションサーバとインストールされた端末で、双方向に通信が可能であることを確認してください。Accel Studio テスト機能 テスト実行エージェント は、アプリケーションサーバとの通信時にプロキシを経由せずに接続できる必要があります。
4.1.2. 利用されるブラウザ¶
Accel Studio テスト機能 は、Playwright を利用してテストを実行します。テストの実行は Chromium で行われます。動作するブラウザバージョンは、Playwright のサポートポリシーに準拠します。
4.1.3. エージェントの実行環境OS¶
エージェントは、 intra-mart Accel Platform の「クライアント要件」の種別PCでの利用をサポートしています。利用するクライアント環境に合わせたOS上でエージェントを起動してください。また、動作するOSは、Playwright のサポートポリシーに準拠します。使用する Playwright のバージョンがサポートするOSを確認してください。Playwright 公式ドキュメント: https://playwright.dev/docs/intro#system-requirements
コラム
エージェントは、サーバ要件の環境でも動作を確認しています。
テスト実行環境は、クライアント要件に合わせることを推奨しますが、 iAP サーバと別環境が用意できない場合、サーバ環境への構築も可能です。
サーバ要件は、「 システム要件 」を確認してください。
4.2. テスト機能API実行者へのロールの付与¶
Accel Studio テスト機能 テスト実行エージェント とアプリケーションの通信を行うユーザとして、テスト機能API実行者を設定します。設定されたユーザでAPIキーの発行を行い、テストの結果登録、ログインの解決などアプリケーションサーバとの通信を担当します。ロールには、テストを実行する上で必要となるテスト機能のREST APIに対する認可が設定してあります。
- 「Accel Studio テスト機能 API実行者」ロール
4.3. APIキーの取得¶
「 Accel Studio テスト機能 API実行者」ロールを持つユーザで、OAuth APIキーを取得してください。下記のスコープでOAuth APIキーを取得してください。Playwright でのテスト実行時に、このOAuth APIキーを利用して通信します。OAuth APIキーは、後続手順のエージェントの実行時に、引数として利用します。
- im-accel-studio-testing-execution
- im-workflow-rest
取得手順は、「API キーを発行する」を参照してください。
4.4. 設定ファイルの変更¶
Accel Studio テスト機能 の設定 の下記を変更してください。Accel Studio テスト機能 は、開発環境や検証環境での利用を想定しています。そのため、本番環境で Accel Studio テスト機能 を利用しない場合、testing-enabledをfalseとすることで、テスト実行を無効にできます。バーチャルテナントによる複数テナント を利用する場合、agentはテナントの数だけ定義してください。
- testing-enabled
- agent base-url
- agent tenant-id
Accel Studio テスト機能 の設定 の下記でテスト定義画面からリソースをアップロードする際のサイズ制限を設定できます。環境に応じて設定を変更してください。テスト実行中のキャプチャ取得、定義のインポート時等、上記操作以外の処理は制限の対象外です。
- resource-size-limit
- resource-total-size-limit
Accel Studio テスト機能 Copilot を利用する場合、 IM-Copilot 生成AI連携ドライバ設定で使用するモデルなどの個別変更が可能です。IM-Copilot 生成AI連携ドライバ設定については、IM-Copilot 生成AI連携ドライバ設定 を参照してください。
4.5. 非同期タスクキューの設定(2025 Spring(Kamille) からアップデートの場合)¶
バーチャルテナント環境でデフォルトテナント以外のテナントでもテスト機能を利用できるようにします。上記の対応において、 2025 Spring(Kamille) で作成した非同期タスクキュー(タスクキューID: imbqasttestingtaskmanager)が不要となりました。そのため、「 2025 Spring(Kamille)からアップデート 」を参照して非同期タスクキューを削除してください。
4.6. エージェントの実行¶
4.6.1. エージェントのダウンロード¶
Accel Studio テスト機能 テスト実行エージェント は、「プロダクトファイルダウンロード」よりダウンロードしてください。ダウンロードには、ライセンスキーが必要です。
4.6.2. オフライン環境の場合の事前準備¶
Accel Studio テスト機能 テスト実行エージェント の実行環境で外部へのネットワークアクセスが許可されない場合、エージェント起動前に使用ライブラリとブラウザデータの事前準備が必要です。オンライン環境の場合はエージェント起動時に自動でセットアップされるため、この手順は不要です。使用する Playwright のバージョンがサポートするバージョンの Node.js を選択してください。最新バージョンの Node.js で過去バージョンの Playwright を使用した場合は動作しない可能性があります。Playwright 公式ドキュメント: https://playwright.dev/docs/intro#system-requirements
4.6.2.1. 使用ライブラリの事前構築¶
別途、オンライン(実際に Accel Studio テスト機能 テスト実行エージェント を稼働させる環境と同じ OS)かつ、Node.js が利用できる環境で、以下のようなコマンド等により node_modules ディレクトリを構築してください。
Accel Studio テスト機能 Copilot を利用しない場合
- npm install @playwright/test
Accel Studio テスト機能 Copilot を利用する場合
- npm install @playwright/mcp @playwright/test
オンライン環境で構築した node_modules ディレクトリをオフライン環境にコピーしてください。例: c:\accel_studio_testing_agent\node_modules エージェントの起動 で説明しているオプションに対して、値を設定してください。imbq.ast.agent.prebuilt-node-modules-path にコピーした node_modules のルートディレクトリへのパスを指定してください。例: -Dimbq.ast.agent.prebuilt-node-modules-path=c:\accel_studio_testing_agent\node_modules
4.6.2.2. ブラウザデータの事前準備¶
以下について、原則として実際に Accel Studio テスト機能 テスト実行エージェント を稼働させる環境と同じ OS で実施する必要があります。
Node.js が利用できる環境で、以下のようなコマンド等により、 PLAYWRIGHT_BROWSERS_PATH を指定してブラウザデータを任意のディレクトリにダウンロードしてください。--with-deps による依存関係のインストールは原則 Accel Studio テスト機能 テスト実行エージェント を稼働させるマシン上で実施する必要があります。ネットワークの制限がある場合は、必要に応じてライブラリを手動でコピーしてください。Playwright のバージョンを指定する場合はここでもバージョンを指定してください。
npx cross-env PLAYWRIGHT_BROWSERS_PATH="xxx" npx playwright install --with-deps例: npx cross-env PLAYWRIGHT_BROWSERS_PATH="C:\Playwright" npx playwright install --with-deps エージェントの起動 で説明しているオプションに対して、値を設定してください。imbq.ast.agent.playwright-browsers-path にブラウザデータのルートディレクトリへのパスを指定してください。例: -Dimbq.ast.agent.playwright-browsers-path=c:\accel_studio_testing_agent\playwright-browsers
4.6.3. エージェントの起動¶
Accel Studio テスト機能 テスト実行エージェント は、実行可能jar形式で同梱しています。jarファイルを配置した各端末にて、以下の手順を実施し、エージェントを起動してください。
Java JDKをインストールします。(JDKバージョン:intra-mart Accel Platformのシステム要件に準拠)
「accel_studio_testing_agent-8.x.x.jar」を任意のフォルダに配置します。
jarファイルを配置したフォルダにて、以下のコマンドを実行し、エージェントを起動します。オンライン環境向け:java -Dfile.encoding=UTF-8 -Dimbq.ast.agent.oauth-api-key="OAuth APIキー" -Dimbq.ast.agent.testing-target-base-url="iAP URL" -Dimbq.ast.agent.playwright-mcp-version="Playwright MCPバージョン" -jar accel_studio_testing_agent-8.x.x.jarオフライン環境向け:java -Dfile.encoding=UTF-8 -Dimbq.ast.agent.oauth-api-key="OAuth APIキー" -Dimbq.ast.agent.testing-target-base-url="iAP URL" -Dimbq.ast.agent.prebuilt-node-modules-path="node_modulesパス" -Dimbq.ast.agent.playwright-browsers-path="ブラウザデータ配置パス" -jar accel_studio_testing_agent-8.x.x.jar エージェントが起動すると、リクエスト受付の待機状態が始まります。アプリケーションサーバからのリクエストを受信すると、Accel Studio テスト機能 が自動的に起動され、シナリオが実行されます。
コラム
エージェントの起動時に、以下の表のシステムプロパティをJavaの引数として -Dxxx=xxx 形式で指定可能です。
-Dfile.encoding=UTF-8 は必ず指定してください。
次のコマンドのように、引数は -jar よりも前に指定してください。
下記はオンライン環境向けのコマンド例です。
java -Dfile.encoding=UTF-8 -Dimbq.ast.agent.oauth-api-key=xxx -Dimbq.ast.agent.testing-target-base-url=http://127.0.0.1:8080/imart/ -Dimbq.ast.agent.playwright-mcp-version=0.0.68 -jar accel_studio_testing_agent-8.x.x.jar
下記はオフライン環境向けのコマンド例です。
java -Dfile.encoding=UTF-8 -Dimbq.ast.agent.oauth-api-key=xxx -Dimbq.ast.agent.testing-target-base-url=http://127.0.0.1:8080/imart/ -Dimbq.ast.agent.prebuilt-node-modules-path=C:/accel_studio_testing_agent/node_modules -Dimbq.ast.agent.playwright-browsers-path=C:/playwright -jar accel_studio_testing_agent-8.x.x.jar
| プロパティ名 | デフォルト値 | 必須 | 意味 |
|---|---|---|---|
| imbq.ast.agent.oauth-api-key | なし | 〇 | OAuth APIキー |
| imbq.ast.agent.testing-target-base-url | http://127.0.0.1:8080/imart/ | 〇 | iAP のベースURL |
| imbq.ast.agent.prebuilt-node-modules-path | なし | ー | 事前構築済み node_modules ディレクトリパス(未指定時は外部への通信が可能と判定し npm install を自動実行) |
| imbq.ast.agent.playwright-browsers-path | なし | ー | Playwright で使用するブラウザデータ配置先ディレクトリパス(未指定時はブラウザデータを自動ダウンロード) |
| imbq.ast.agent.playwright-version | なし | ー | 使用する Playwright のバージョン(未指定時は最新バージョンを取得、 imbq.ast.agent.prebuilt-node-modules-path が指定されている場合は無視) |
| imbq.ast.agent.playwright-mcp-version | なし | ー | 使用する Playwright MCP のバージョン(未指定時は Playwright MCP のインストールをスキップ、 imbq.ast.agent.prebuilt-node-modules-path が指定されている場合は無視) |
| imbq.ast.agent.script-playwright-config-path | なし | ー | Playwright 用設定ファイル |
| imbq.ast.agent.script-playwright-mcp-config-path | なし | ー | Playwright MCP 用設定ファイル |
| imbq.ast.agent.ignore-playwright-report | なし | ー | Playwright のカスタムレポートを出力しない 2025 Spring(Kamille) 用互換オプション |
| server.port | 8188 | ー | エージェントのポート番号 |
| logging.file.name | accel_studio_testing_agent.log | ー | 出力ログファイル名 |
| logging.level.root | INFO | ー | 出力ログレベル |
| logging.level.jp.co.intra_mart | logging.level.rootの値 | ー | 製品実装部分の出力ログレベル |
※ imbq.ast.agent.playwright-browsers-path の詳細は ブラウザデータの事前準備 を参照してください。
※ imbq.ast.agent.prebuilt-node-modules-path の詳細は 使用ライブラリの事前構築 を参照してください。
コラム
バージョン解決の優先順位
Playwright 関連パッケージのバージョンは、以下の優先順位で解決されます。
- imbq.ast.agent.prebuilt-node-modules-path が指定されている場合、指定した node_modules 内のパッケージが使用されます。この場合、 imbq.ast.agent.playwright-version および imbq.ast.agent.playwright-mcp-version の指定は無視されます。
- imbq.ast.agent.prebuilt-node-modules-path が未指定の場合、 imbq.ast.agent.playwright-version と imbq.ast.agent.playwright-mcp-version の指定に基づいてバージョンが決定されます。imbq.ast.agent.playwright-version を指定せずに imbq.ast.agent.playwright-mcp-version を指定すると、 @playwright/mcp の依存先である playwright-core が自動インストールされ、 npx playwright --version でバージョンが検出されます。imbq.ast.agent.playwright-mcp-version を指定しない場合は Playwright MCP がインストールされません。
- imbq.ast.agent.prebuilt-node-modules-path ・ imbq.ast.agent.playwright-mcp-version ・ imbq.ast.agent.playwright-version のいずれも未指定の場合、Playwright の最新バージョンが取得され、Playwright MCP はインストールされません。
コラム
Playwright 用設定ファイルについて
設定ファイルを配置することで、Playwright の動作を調整できます。
設定値は、Playwright の公式サイト( https://playwright.dev/docs/test-configuration#expect-options や https://playwright.dev/docs/test-use-options)を参考にしてください。
設定ファイルは、各種テストステップの動作調整を目的として利用してください。それ以外の目的による設定は推奨しません。
また、以下の設定項目はエージェントが内部で使用するため、変更できません。
- outputDir
- snapshotPathTemplate
- globalSetup
- globalTeardown
- reporter
- use.baseURL
- use.storageState
下記は、タイムアウト時間と Visual Regression Test の画像比較にて、異なる可能性のあるピクセルの許容量をデフォルト設定から変更、またテスト実行時の画面収録とスクリーンショットの取得を設定した例です。
import { PlaywrightTestConfig } from '@playwright/test'; const config: PlaywrightTestConfig = { name: 'custom-config', timeout: 50000, globalTimeout: 100000, use: { video: 'on', // テスト実行時の画面録画をテスト結果として取得するオプションです。 screenshot: 'on', // テスト終了時やエラー発生時の画面キャプチャをテスト結果として取得するオプションです。 }, expect: { toMatchSnapshot: { maxDiffPixelRatio: 0.02, maxDiffPixels: 200 }, toHaveScreenshot: { maxDiffPixelRatio: 0.02, maxDiffPixels: 200 }, }, }; export default config;
コラム
Playwright MCP 用設定ファイルについて
設定ファイルを配置することで、Playwright MCP の動作を調整できます。
設定値は、Playwright MCP の公式サイト( https://github.com/microsoft/playwright-mcp/blob/main/README.md#configuration-file )を参考にしてください。
設定項目によっては正常に動作しなくなる可能性があるため、充分な検証の上ご利用ください。